Package org.ametys.plugins.odfweb.service.search

Class ProgramItemAutocompletionSearchServiceAction

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

org.ametys.plugins.odfweb.service.search.ProgramItemAutocompletionSearchServiceAction

All Implemented Interfaces:

Component, LogEnabled, Serviceable, Action

public class ProgramItemAutocompletionSearchServiceAction
extends AbstractAutocompletionSearchServiceAction

Get the proposed program's pages and skills for auto-completion while beginning a search

Field Summary

Fields

Modifier and Type	Field	Description
protected OdfPageResolver	_odfPageResolver	The ODF page resolver

Fields inherited from class org.ametys.web.frontoffice.search.fast.AbstractAutocompletionSearchServiceAction

_prefixHandler, _renderingContextHandler, _resolver, _searchComponentHelper, _searcherFactory, _searchServiceInstanceManager, _siteManager, NB_MAX_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
ProgramItemAutocompletionSearchServiceAction()

Method Summary

Modifier and Type	Method	Description
protected List<String>	_getCatalogNames(String zoneItemId)	Get the configured catalog in criterion definitions
protected Map<String,Object>	_getContentHit(Content content)	Get the JSON representation of a content hit
protected Map<String,Object>	_getPageHit(Content content, String siteName, Page odfRootPage)	Get the JSON representation of a page hit
protected AmetysObjectIterable<Content>	_getSkills(String escapedQuery, List<String> catalogNames, String lang, int limit, RightCheckingMode rightCheckingMode)	Get the skills contents 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
void	service(ServiceManager serviceManager)
protected 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.ametys.web.frontoffice.search.fast.AbstractAutocompletionSearchServiceAction

_search, _setRightCheckingMode, act, getRightCheckingMode

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

_odfPageResolver

protected OdfPageResolver _odfPageResolver

The ODF page resolver

Constructor Details

ProgramItemAutocompletionSearchServiceAction

public ProgramItemAutocompletionSearchServiceAction()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractAutocompletionSearchServiceAction

Throws:

ServiceException

_searchAmetysObject

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

Description copied from class: AbstractAutocompletionSearchServiceAction

Search ametys object and set the results

Overrides:

_searchAmetysObject in class AbstractAutocompletionSearchServiceAction

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 void setHitsInResults(Map<String,Object> results,
 AmetysObjectIterable<AmetysObject> searchHits,
 Site site,
 String zoneItemId,
 String lang)

Description copied from class: AbstractAutocompletionSearchServiceAction

Set the hits in the results

Specified by:

setHitsInResults in class AbstractAutocompletionSearchServiceAction

Parameters:

results - the results

searchHits - the search hits

site - the site

zoneItemId - the zone item it

lang - the lang

_getCatalogNames

protected List<String> _getCatalogNames(String zoneItemId)

Get the configured catalog in criterion definitions

Parameters:

zoneItemId - The id of zone item

Returns:

the catalog's name

_getSkills

protected AmetysObjectIterable<Content> _getSkills(String escapedQuery,
 List<String> catalogNames,
 String lang,
 int limit,
 RightCheckingMode rightCheckingMode)
                                            throws Exception

Get the skills contents matching the query

Parameters:

escapedQuery - the query

catalogNames - The catalog names

lang - the language

limit - the max number of results

rightCheckingMode - the mode for checking rights

Returns:

the matching contents

Throws:

Exception - if an error occurred during search

_getPageHit

protected Map<String,Object> _getPageHit(Content content,
 String siteName,
 Page odfRootPage)

Get the JSON representation of a page hit

Parameters:

content - the content

siteName - the current site name

odfRootPage - the ODF root page. Can be null if search is configured for multiple catalogs

Returns:

the page as json

_getContentHit

protected Map<String,Object> _getContentHit(Content content)

Get the JSON representation of a content hit

Parameters:

content - the content

Returns:

the content as json