Package org.ametys.web.frontoffice.search.requesttime.impl

Class FacetSearchComponent

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.frontoffice.search.requesttime.AbstractSearchComponent

org.ametys.web.frontoffice.search.requesttime.impl.FacetSearchComponent

All Implemented Interfaces:

LogEnabled, PluginAware, Prioritizable, Supporter<SearchComponentArguments>, SearchComponent

public class FacetSearchComponent
extends AbstractSearchComponent

SearchComponent for executing the search with facets.

Field Summary

Fields inherited from interface org.ametys.web.frontoffice.search.requesttime.SearchComponent

DISABLE_DEFAULT_SAX_PARAMETER_NAME, MAX_PRIORITY, MIN_PRIORITY, SEARCH_PRIORITY

Constructor Summary

Constructors

Constructor	Description
FacetSearchComponent()

Method Summary

Modifier and Type	Method	Description
protected Map<String,List<String>>	checkValidInputs(Collection<SearchServiceFacetDefinition> serviceFacets, Map<String,List<String>> userFacets, boolean isFromUserPref, Logger logger)	Checks the user inputs are valid
void	execute(SearchComponentArguments args)	Executes the component.
int	getPriority()	Get the priority for the component.
boolean	supports(SearchComponentArguments args)	Check if an element is supported

Methods inherited from class org.ametys.web.frontoffice.search.requesttime.AbstractSearchComponent

getId, 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

Constructor Details

FacetSearchComponent

public FacetSearchComponent()

Method Details

getPriority

public int getPriority()

Description copied from interface: Prioritizable

Get the priority for the component. On components using Prioritizable interface, each implementation define the order. In most cases, less is the number, more prior is the component.

Returns:

the priority

supports

public boolean supports(SearchComponentArguments args)

Description copied from interface: Supporter

Check if an element is supported

Parameters:

args - The element

Returns:

true if the element is supported, false otherwise

execute

public void execute(SearchComponentArguments args)
             throws Exception

Description copied from interface: SearchComponent

Executes the component.

Parameters:

args - the arguments

Throws:

Exception - if an exception occurs. Other search components will be attempted to be executed

checkValidInputs

protected Map<String,List<String>> checkValidInputs(Collection<SearchServiceFacetDefinition> serviceFacets,
 Map<String,List<String>> userFacets,
 boolean isFromUserPref,
 Logger logger)
                                             throws org.ametys.web.frontoffice.search.requesttime.impl.InvalidUserInputException

Checks the user inputs are valid

Parameters:

serviceFacets - The facets of the service instance

userFacets - The user input facets

isFromUserPref - true if the facets are from user pref. Then return only the valid input, otherwise throw an exception

logger - The logger

Returns:

the filtered user facets

Throws:

org.ametys.web.frontoffice.search.requesttime.impl.InvalidUserInputException - if at least user one input is invalid