org.ametys.cms.search.cocoon

Class SearchAction

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.acting.AbstractAction

org.apache.cocoon.acting.ServiceableAction

org.ametys.cms.search.cocoon.SearchAction

All Implemented Interfaces:

Component, Contextualizable, LogEnabled, Serviceable, Action

Direct Known Subclasses:

GetSolrSearchModelAction, SelectContentSearchAction, SolrQuerySearchAction

public class SearchAction
extends ServiceableAction
implements Contextualizable

Search contents and put a result object in the request (to be serialized in JSON).

Field Summary

Fields

Modifier and Type	Field and Description
protected ContentTypeExtensionPoint	_contentTypeExtensionPoint The ContentType Manager
protected Context	_context The avalon context
protected GetQueryFromJSONHelper	_getQueryFromJSONHelper the helper to get query infos from JSON
protected QueryBuilder	_queryBuilder The query builder
protected ContentSearcherFactory	_searcherFactory The searcher factory.
protected SearchUIModelExtensionPoint	_searchModelManager The search model manager
protected ServerCommHelper	_serverCommHelper The server comm helper
static String	QUERY_ERROR Name of request attribute for storing the query error, if any.
static String	SEARCH_CONTENTS Name of request attribute for storing contents' ids
static String	SEARCH_LOCALE Name of request attribute for storing the language of search
static String	SEARCH_MODEL Name of request attribute for storing the search model
static String	SEARCH_RESULTS Name of request attribute for storing search results

Fields inherited from class org.apache.cocoon.acting.ServiceableAction

manager

Fields inherited from class org.apache.cocoon.acting.AbstractAction

EMPTY_MAP

Fields inherited from interface org.apache.cocoon.acting.Action

ROLE

Constructor Summary

Constructors

Constructor and Description
SearchAction()

Method Summary

Modifier and Type	Method and Description
Map	act(Redirector redirector, SourceResolver resolver, Map objectModel, String source, Parameters parameters)
void	contextualize(Context context)
protected void	doSearch(Request request, SearchUIModel model, int offset, int maxResults, Map<String,Object> jsParameters, Map<String,Object> contextualParameters) Do the search and set the results in request attributes.
protected int	getMaxResults(SearchUIModel uiModel, Map<String,Object> jsParameters, Map<String,Object> contextualParameters) Get the max number of results
protected int	getOffset(Map<String,Object> jsParameters) Get the index of search
protected SearchUIModel	getSearchUIModel(Map<String,Object> jsParameters, Map<String,Object> contextualParameters) Get the search UI model
protected List<Sort>	getSort(String sortString, String groupString) Get the sort criteria from a sort string.
void	service(ServiceManager smanager)

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SEARCH_CONTENTS

public static final String SEARCH_CONTENTS

Name of request attribute for storing contents' ids

SEARCH_RESULTS

public static final String SEARCH_RESULTS

Name of request attribute for storing search results

SEARCH_LOCALE

public static final String SEARCH_LOCALE

Name of request attribute for storing the language of search

SEARCH_MODEL

public static final String SEARCH_MODEL

Name of request attribute for storing the search model

QUERY_ERROR

public static final String QUERY_ERROR

Name of request attribute for storing the query error, if any.

_searchModelManager

protected SearchUIModelExtensionPoint _searchModelManager

The search model manager

_contentTypeExtensionPoint

protected ContentTypeExtensionPoint _contentTypeExtensionPoint

The ContentType Manager

_serverCommHelper

protected ServerCommHelper _serverCommHelper

The server comm helper

_context

protected Context _context

The avalon context

_searcherFactory

protected ContentSearcherFactory _searcherFactory

The searcher factory.

_getQueryFromJSONHelper

protected GetQueryFromJSONHelper _getQueryFromJSONHelper

the helper to get query infos from JSON

_queryBuilder

protected QueryBuilder _queryBuilder

The query builder

Constructor Detail

SearchAction

public SearchAction()

Method Detail

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class ServiceableAction

Throws:

ServiceException

act

public Map act(Redirector redirector,
               SourceResolver resolver,
               Map objectModel,
               String source,
               Parameters parameters)
        throws Exception

Specified by:

act in interface Action

Throws:

Exception

doSearch

protected void doSearch(Request request,
                        SearchUIModel model,
                        int offset,
                        int maxResults,
                        Map<String,Object> jsParameters,
                        Map<String,Object> contextualParameters)
                 throws Exception

Do the search and set the results in request attributes.

Parameters:

request - The request. The results or contents' id have to be set in request attributes

model - The search UI model

offset - The index of search

maxResults - The max results

jsParameters - The JS parameters

contextualParameters - The contextual parameters

Throws:

Exception - if the search failed

getSearchUIModel

protected SearchUIModel getSearchUIModel(Map<String,Object> jsParameters,
                                         Map<String,Object> contextualParameters)

Get the search UI model

Parameters:

jsParameters - The JS parameters

contextualParameters - The contextual parameters

Returns:

the search UI model

getOffset

protected int getOffset(Map<String,Object> jsParameters)

Get the index of search

Parameters:

jsParameters - The JS parameters

Returns:

The offset

getMaxResults

protected int getMaxResults(SearchUIModel uiModel,
                            Map<String,Object> jsParameters,
                            Map<String,Object> contextualParameters)

Get the max number of results

Parameters:

uiModel - The search UI model

jsParameters - The JS parameters

contextualParameters - The contextual parameters

Returns:

The max number of results

getSort

protected List<Sort> getSort(String sortString,
                             String groupString)

Get the sort criteria from a sort string.

Parameters:

sortString - The sort criteria as a JSON-encoded string.

groupString - The group criteria as a JSON-encoded string (for server-side grouping feature). Can be null.

Returns:

the sort criteria as a List of Sort.