Package org.ametys.web.frontoffice.search

Class SearchService

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.service.StaticService

org.ametys.web.frontoffice.search.SearchService

All Implemented Interfaces:

Model, ModelItemContainer, LogEnabled, PluginAware, Labelable, Service, Disposable, Configurable, Contextualizable, Serviceable

public class SearchService
extends StaticService

Front search service.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	SearchService.ParsedAdditionalParameterConf

Field Summary

Fields

Modifier and Type	Field	Description
protected SearchServiceCreationHelper	_creationHelper	The helper component for defining this service
protected RenderingContextHandler	_renderingContextHandler	The handler of rendering context
protected SearchServiceInstanceManager	_searchServiceInstanceManager	The manager for SearchServiceInstance
static String	PARAM_NAME_COMPUTE_COUNTS	The parameter name for computing counts
static String	PARAM_NAME_CONTEXTS	The parameter name for contexts
static String	PARAM_NAME_CRITERIA	The parameter name for criteria
static String	PARAM_NAME_FACETS	The parameter name for facets
static String	PARAM_NAME_HEADER	The parameter name for header
static String	PARAM_NAME_INITIAL_SORTS	The parameter name for initial sorts
static String	PARAM_NAME_LAUNCH_SEARCH_AT_STARTUP	The parameter name for launching search at startup
static String	PARAM_NAME_LINK_PAGE	The parameter name for link page
static String	PARAM_NAME_LINK_TITLE	The parameter name for link title
static String	PARAM_NAME_MAX_RESULTS	The parameter name for maximum number of results
static String	PARAM_NAME_PROPOSED_SORTS	The parameter name for proposed sorts
static String	PARAM_NAME_RESULT_PAGE	The parameter name for result page
static String	PARAM_NAME_RESULT_PLACE	The parameter name for result place
static String	PARAM_NAME_RESULTS_PER_PAGE	The parameter name for number of results per page
static String	PARAM_NAME_RETURNABLES	The parameter name for returnables
static String	PARAM_NAME_RIGHT_CHECKING_MODE	The parameter name for right checking mode
static String	PARAM_NAME_RSS	The parameter name for handling RSS
static String	PARAM_NAME_SAVE_USER_PREFS	The parameter name for saving user preferences
static String	PARAM_NAME_SERVICE_GROUP_ID	The parameter name for service group id
static String	PARAM_NAME_XSLT	The parameter name for XSLT
static String	ROLE	Avalon Role

Fields inherited from class org.ametys.web.service.StaticService

_context, _featureName, _manager, _modelItems, _paramsScript, _pluginName, _repeaterDefinitionParser, _serviceParameterDefinitionParser, _view, _viewAndParametersParser

Constructor Summary

Constructors

Constructor	Description
SearchService()

Method Summary

Modifier and Type	Method	Description
protected Collection<AdditionalSearchServiceParameter>	_buildAdditionalSearchServiceParameters(Map<String,SearchService.ParsedAdditionalParameterConf> parsedAdditionalParameterConfs)	Build the AdditionalSearchServiceParameters from intermediate SearchService.ParsedAdditionalParameterConf objects.
private void	_ensureCreationHelperIsReady()
protected List<String>	_fieldsReloadingWidget(Collection<AdditionalSearchServiceParameter> additionalParameters)	Gets the names of the fields which will launch a reload of this widget when their value change
private static boolean	_hasUserInput(SearchServiceInstance serviceInstance)
private boolean	_isDebug(Request request, RenderingContextHandler renderingContextHandler)
protected Map<String,SearchService.ParsedAdditionalParameterConf>	_parseAndInjectDisplayAdditionalParameters(DefaultConfiguration lastGroupConf)	Retrieve the configurations of additional parameters for 'Display' group, inject them into the group configuration and return their parsed representation.
protected Map<String,SearchService.ParsedAdditionalParameterConf>	_parseAndInjectGeneralAdditionalParameters(DefaultConfiguration firstGroupConf)	Retrieve the configurations of additional parameters for 'General' group, inject them into the group configuration and return their parsed representation.
protected void	_setWidgetParameters(String parameterName, List<String> fieldsReloadingCriteriaWidget)	Set the widget parameters of the given parameter, by adding the list of the fields reloading the widget
protected void	configureParameters(Configuration parametersConfiguration)	Configure the service parameters
static boolean	hasUserCriteria(Optional<AbstractTreeNode<FOSearchCriterion>> criterionTree)	Returns true if the given instance of search service has at least one user criterion
static boolean	hasUserInput(Optional<AbstractTreeNode<FOSearchCriterion>> criterionTree, Collection<FacetDefinition> facets, Collection<SortDefinition> proposedSorts)	Returns true if the given instance of search service has some user input
boolean	isCacheable(Page currentPage, ZoneItem zoneItem)	Returns true if the result of this service may be cached, depending on the ZoneItem containing an instance of this service.
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.web.service.StaticService

_configureClass, _configureImports, _configureScript, _parseI18nizableText, configure, configureDialogBoxDimension, configureIndexation, contextualize, dispose, getCategory, getCreationBoxHeight, getCreationBoxWidth, getCSSFiles, getDescription, getIconDecorator, getIconGlyph, getId, getLabel, getLargeIcon, getMediumIcon, getModelItems, getName, getParameters, getParametersScript, getPluginName, getRight, getSmallIcon, getURL, getView, index, isPrivate, setPluginInfo

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.runtime.model.ModelItemContainer

getChild, getModelItem, hasModelItem

Methods inherited from interface org.ametys.web.service.Service

getFamilyId

Field Detail

ROLE

public static final String ROLE

Avalon Role

See Also:

Constant Field Values

PARAM_NAME_HEADER

public static final String PARAM_NAME_HEADER

The parameter name for header

See Also:

Constant Field Values

PARAM_NAME_RETURNABLES

public static final String PARAM_NAME_RETURNABLES

The parameter name for returnables

See Also:

Constant Field Values

PARAM_NAME_CONTEXTS

public static final String PARAM_NAME_CONTEXTS

The parameter name for contexts

See Also:

Constant Field Values

PARAM_NAME_CRITERIA

public static final String PARAM_NAME_CRITERIA

The parameter name for criteria

See Also:

Constant Field Values

PARAM_NAME_COMPUTE_COUNTS

public static final String PARAM_NAME_COMPUTE_COUNTS

The parameter name for computing counts

See Also:

Constant Field Values

PARAM_NAME_FACETS

public static final String PARAM_NAME_FACETS

The parameter name for facets

See Also:

Constant Field Values

PARAM_NAME_INITIAL_SORTS

public static final String PARAM_NAME_INITIAL_SORTS

The parameter name for initial sorts

See Also:

Constant Field Values

PARAM_NAME_PROPOSED_SORTS

public static final String PARAM_NAME_PROPOSED_SORTS

The parameter name for proposed sorts

See Also:

Constant Field Values

PARAM_NAME_RESULTS_PER_PAGE

public static final String PARAM_NAME_RESULTS_PER_PAGE

The parameter name for number of results per page

See Also:

Constant Field Values

PARAM_NAME_MAX_RESULTS

public static final String PARAM_NAME_MAX_RESULTS

The parameter name for maximum number of results

See Also:

Constant Field Values

PARAM_NAME_RIGHT_CHECKING_MODE

public static final String PARAM_NAME_RIGHT_CHECKING_MODE

The parameter name for right checking mode

See Also:

Constant Field Values

PARAM_NAME_XSLT

public static final String PARAM_NAME_XSLT

The parameter name for XSLT

See Also:

Constant Field Values

PARAM_NAME_RESULT_PLACE

public static final String PARAM_NAME_RESULT_PLACE

The parameter name for result place

See Also:

Constant Field Values

PARAM_NAME_RESULT_PAGE

public static final String PARAM_NAME_RESULT_PAGE

The parameter name for result page

See Also:

Constant Field Values

PARAM_NAME_LAUNCH_SEARCH_AT_STARTUP

public static final String PARAM_NAME_LAUNCH_SEARCH_AT_STARTUP

The parameter name for launching search at startup

See Also:

Constant Field Values

PARAM_NAME_SERVICE_GROUP_ID

public static final String PARAM_NAME_SERVICE_GROUP_ID

The parameter name for service group id

See Also:

Constant Field Values

PARAM_NAME_LINK_PAGE

public static final String PARAM_NAME_LINK_PAGE

The parameter name for link page

See Also:

Constant Field Values

PARAM_NAME_LINK_TITLE

public static final String PARAM_NAME_LINK_TITLE

The parameter name for link title

See Also:

Constant Field Values

PARAM_NAME_RSS

public static final String PARAM_NAME_RSS

The parameter name for handling RSS

See Also:

Constant Field Values

PARAM_NAME_SAVE_USER_PREFS

public static final String PARAM_NAME_SAVE_USER_PREFS

The parameter name for saving user preferences

See Also:

Constant Field Values

_creationHelper

protected SearchServiceCreationHelper _creationHelper

The helper component for defining this service

_renderingContextHandler

protected RenderingContextHandler _renderingContextHandler

The handler of rendering context

_searchServiceInstanceManager

protected SearchServiceInstanceManager _searchServiceInstanceManager

The manager for SearchServiceInstance

Constructor Detail

SearchService

public SearchService()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class StaticService

Throws:

ServiceException

hasUserInput

public static boolean hasUserInput(Optional<AbstractTreeNode<FOSearchCriterion>> criterionTree,
                                   Collection<FacetDefinition> facets,
                                   Collection<SortDefinition> proposedSorts)

Returns true if the given instance of search service has some user input

Parameters:

criterionTree - The tree of criteria of the search service instance

facets - The facets of the search service instance

proposedSorts - The proposed sorts of the search service instance

Returns:

true if the given instance of search service has some user input

hasUserCriteria

public static boolean hasUserCriteria(Optional<AbstractTreeNode<FOSearchCriterion>> criterionTree)

Returns true if the given instance of search service has at least one user criterion

Parameters:

criterionTree - The tree of criteria of the search service instance

Returns:

true if the given instance of search service has at least one user criterion

_hasUserInput

private static boolean _hasUserInput(SearchServiceInstance serviceInstance)

isCacheable

public boolean isCacheable(Page currentPage,
                           ZoneItem zoneItem)

Description copied from interface: Service

Returns true if the result of this service may be cached, depending on the ZoneItem containing an instance of this service.

Specified by:

isCacheable in interface Service

Overrides:

isCacheable in class StaticService

Parameters:

currentPage - the current Page containing the service.

zoneItem - the ZoneItem containing an instance of this service.
N.B: The ZoneItem can belong to a page that is not the current page, when it is inherited.

Returns:

true if the result of this service may be cached.

_isDebug

private boolean _isDebug(Request request,
                         RenderingContextHandler renderingContextHandler)

configureParameters

protected void configureParameters(Configuration parametersConfiguration)
                            throws ConfigurationException

Description copied from class: StaticService

Configure the service parameters

Overrides:

configureParameters in class StaticService

Parameters:

parametersConfiguration - the parameters configuration

Throws:

ConfigurationException - if a configuration exception occurred

_ensureCreationHelperIsReady

private void _ensureCreationHelperIsReady()
                                   throws ConfigurationException

Throws:

ConfigurationException

_parseAndInjectGeneralAdditionalParameters

protected Map<String,SearchService.ParsedAdditionalParameterConf> _parseAndInjectGeneralAdditionalParameters(DefaultConfiguration firstGroupConf)

Retrieve the configurations of additional parameters for 'General' group, inject them into the group configuration and return their parsed representation.

Parameters:

firstGroupConf - The first group configuration ('General') for injecting.

Returns:

the SearchService.ParsedAdditionalParameterConfs

_parseAndInjectDisplayAdditionalParameters

protected Map<String,SearchService.ParsedAdditionalParameterConf> _parseAndInjectDisplayAdditionalParameters(DefaultConfiguration lastGroupConf)

Retrieve the configurations of additional parameters for 'Display' group, inject them into the group configuration and return their parsed representation.

Parameters:

lastGroupConf - The last group configuration ('Display') for injecting.

Returns:

the SearchService.ParsedAdditionalParameterConfs

_buildAdditionalSearchServiceParameters

protected Collection<AdditionalSearchServiceParameter> _buildAdditionalSearchServiceParameters(Map<String,SearchService.ParsedAdditionalParameterConf> parsedAdditionalParameterConfs)

Build the AdditionalSearchServiceParameters from intermediate SearchService.ParsedAdditionalParameterConf objects.

Parameters:

parsedAdditionalParameterConfs - The parsed configurations for each additional parameter

Returns:

the AdditionalSearchServiceParameters

_setWidgetParameters

protected void _setWidgetParameters(String parameterName,
                                    List<String> fieldsReloadingCriteriaWidget)

Set the widget parameters of the given parameter, by adding the list of the fields reloading the widget

Parameters:

parameterName - The parameter name

fieldsReloadingCriteriaWidget - the names of the fields which will launch a reload of the widget when their value change

_fieldsReloadingWidget

protected List<String> _fieldsReloadingWidget(Collection<AdditionalSearchServiceParameter> additionalParameters)

Gets the names of the fields which will launch a reload of this widget when their value change

Parameters:

additionalParameters - The additional parameters

Returns:

the names of the fields which will launch a reload of this widget when their value change