Package org.ametys.web.frontoffice.search.fast

Class AbstractAutocompletionSearchServiceAction

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.acting.AbstractAction

org.apache.cocoon.acting.ServiceableAction

org.ametys.web.frontoffice.search.fast.AbstractAutocompletionSearchServiceAction

All Implemented Interfaces:

Component, LogEnabled, Serviceable, Action

Direct Known Subclasses:

ProgramItemAutocompletionSearchServiceAction

public abstract class AbstractAutocompletionSearchServiceAction
extends ServiceableAction

Abstract to get the proposed ametys object while beginning a search from a given search service

Field Summary

Fields

Modifier and Type	Field	Description
protected URIPrefixHandler	_prefixHandler	The prefix handler
protected RenderingContextHandler	_renderingContextHandler	The rendering context handler
protected AmetysObjectResolver	_resolver	The ametys object resolver
protected SearchComponentHelper	_searchComponentHelper	The search component helper
protected SearcherFactory	_searcherFactory	The search factory
protected SearchServiceInstanceManager	_searchServiceInstanceManager	Component for search service
protected SiteManager	_siteManager	The site manager
protected static final int	NB_MAX_RESULTS	The default max number of 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	Description
AbstractAutocompletionSearchServiceAction()

Method Summary

Modifier and Type	Method	Description
protected AmetysObjectIterable<AmetysObject>	_search(Site site, String zoneItemId, String lang, String escapedQuery, int limit, RightCheckingMode rightCheckingMode)	Get the ametys object matching the query
protected Map<String,Object>	_searchAmetysObject(Site site, String zoneItemId, String lang, String escapedQuery, int limit, RightCheckingMode rightCheckingMode)	Search ametys object and set the results
protected void	_setRightCheckingMode(SearcherFactory.Searcher searcher, RightCheckingMode rightCheckingMode)	Set whether to check rights when searching,
Map	act(Redirector redirector, SourceResolver resolver, Map objectModel, String source, Parameters parameters)
protected RightCheckingMode	getRightCheckingMode(String zoneItemId)	Get the mode for checking rights
void	service(ServiceManager serviceManager)
protected abstract void	setHitsInResults(Map<String,Object> results, AmetysObjectIterable<AmetysObject> searchHits, Site site, String zoneItemId, String lang)	Set the hits in the results

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 Details

NB_MAX_RESULTS

protected static final int NB_MAX_RESULTS

The default max number of results

See Also:

• Constant Field Values

_searcherFactory

protected SearcherFactory _searcherFactory

The search factory

_searchServiceInstanceManager

protected SearchServiceInstanceManager _searchServiceInstanceManager

Component for search service

_searchComponentHelper

protected SearchComponentHelper _searchComponentHelper

The search component helper

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver

_siteManager

protected SiteManager _siteManager

The site manager

_prefixHandler

protected URIPrefixHandler _prefixHandler

The prefix handler

_renderingContextHandler

protected RenderingContextHandler _renderingContextHandler

The rendering context handler

Constructor Details

AbstractAutocompletionSearchServiceAction

public AbstractAutocompletionSearchServiceAction()

Method Details

service

public void service(ServiceManager serviceManager)
             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

Throws:

Exception

_searchAmetysObject

protected Map<String,Object> _searchAmetysObject(Site site,
 String zoneItemId,
 String lang,
 String escapedQuery,
 int limit,
 RightCheckingMode rightCheckingMode)
                                          throws Exception

Search ametys object and set the results

Parameters:

site - the site

zoneItemId - the zone item id

lang - the lang

escapedQuery - the escaped query

limit - the limit

rightCheckingMode - the right checking mode

Returns:

the search results

Throws:

Exception - if an error occurred during search

setHitsInResults

protected abstract void setHitsInResults(Map<String,Object> results,
 AmetysObjectIterable<AmetysObject> searchHits,
 Site site,
 String zoneItemId,
 String lang)

Set the hits in the results

Parameters:

results - the results

searchHits - the search hits

site - the site

zoneItemId - the zone item it

lang - the lang

_search

protected AmetysObjectIterable<AmetysObject> _search(Site site,
 String zoneItemId,
 String lang,
 String escapedQuery,
 int limit,
 RightCheckingMode rightCheckingMode)
                                              throws Exception

Get the ametys object matching the query

Parameters:

site - the site

zoneItemId - the zone item it

lang - the language

escapedQuery - the query

limit - the max number of results

rightCheckingMode - the mode for checking rights

Returns:

the matching ametys object

Throws:

Exception - if an error occurred during search

_setRightCheckingMode

protected void _setRightCheckingMode(SearcherFactory.Searcher searcher,
 RightCheckingMode rightCheckingMode)

Set whether to check rights when searching,

Parameters:

searcher - the searcher

rightCheckingMode - the the mode for checking rights

getRightCheckingMode

protected RightCheckingMode getRightCheckingMode(String zoneItemId)

Get the mode for checking rights

Parameters:

zoneItemId - the id of zone item

Returns:

the mode for checking rights