Package org.ametys.web.search.model.impl

Class PageSearchUICriterion

java.lang.Object

org.ametys.runtime.parameter.Parameter<MetadataType>

org.ametys.cms.search.ui.model.impl.AbstractSearchUICriterion

org.ametys.cms.search.ui.model.impl.AbstractCustomSearchUICriterion

org.ametys.web.search.model.impl.PageSearchUICriterion

All Implemented Interfaces:

Field, SearchCriterion, SearchUICriterion, LogEnabled, Disposable, Configurable, Contextualizable, Serviceable

public class PageSearchUICriterion
extends AbstractCustomSearchUICriterion

Custom SearchUICriterion searching a specific page and its sub-tree.

Field Summary

Fields inherited from class org.ametys.cms.search.ui.model.impl.AbstractSearchUICriterion

_contentHelper, _context, _cTypeEP, _enumeratorManager, _logger, _manager, _resolver, _userManager, _userPopulationDAO

Constructor Summary

Constructors

Constructor	Description
PageSearchUICriterion()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
String	getFieldId()	Get the field identifier.
Query.Operator	getOperator()	Get the criterion Operator.
Query	getQuery(Object value, Query.Operator customOperator, Map<String,Object> allValues, String language, Map<String,Object> contextualParameters)	Get the Query associated to the given value.
MetadataType	getType()	Retrieves the type.
String	getWidget()	Retrieves the widget to use for rendering.
Map<String,I18nizableText>	getWidgetParameters()	Get the widget's parameters
boolean	isSortable()	Test if the SearchCriterion is sortable.

Methods inherited from class org.ametys.cms.search.ui.model.impl.AbstractCustomSearchUICriterion

configureId

Methods inherited from class org.ametys.cms.search.ui.model.impl.AbstractSearchUICriterion

_configureI18nizableText, _initializeValidator, configureEnumerator, configureEnumerator, configureLabelsAndGroup, configureUIProperties, configureValues, configureWidget, configureWidget, configureWidgetParameters, configureWidgetParameters, configureWidgetParameters, contextualize, dispose, getChangeClassName, getContentTypeId, getFacetLabel, getGroup, getInitClassName, getSearchField, getSubmitClassName, isHidden, isMultiple, service, setChangeClassName, setContentTypeId, setGroup, setHidden, setInitClassName, setLogger, setMultiple, setSubmitClassName

Methods inherited from class org.ametys.runtime.parameter.Parameter

getDefaultValue, getDescription, getEnumerator, getId, getLabel, getPluginName, getValidator, setDefaultValue, setDescription, setEnumerator, setId, setLabel, setPluginName, setType, setValidator, setWidget, setWidgetParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.cms.search.model.Field

getEnumerator

Methods inherited from interface org.ametys.cms.search.model.SearchCriterion

getId, getQuery, isFacetable

Methods inherited from interface org.ametys.cms.search.ui.model.SearchUICriterion

getDefaultValue, getDescription, getLabel, getValidator

Constructor Details

PageSearchUICriterion

public PageSearchUICriterion()

Method Details

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class AbstractSearchUICriterion

Throws:

ConfigurationException

getType

public MetadataType getType()

Description copied from class: Parameter

Retrieves the type.

Specified by:

getType in interface Field

Overrides:

getType in class Parameter<MetadataType>

Returns:

the type.

getQuery

public Query getQuery(Object value,
 Query.Operator customOperator,
 Map<String,Object> allValues,
 String language,
 Map<String,Object> contextualParameters)

Description copied from interface: SearchCriterion

Get the Query associated to the given value.

Parameters:

value - The user-submitted value (or the default value if not set) for this criterion.

customOperator - In advanced search mode, the operator chosen by the user. null to use the criterion-defined operator (simple search mode).

allValues - All the user-submitted values.

language - The current search language.

contextualParameters - the search contextual parameters.

Returns:

Query associated to the given value.

getWidget

public String getWidget()

Description copied from class: Parameter

Retrieves the widget to use for rendering.

Specified by:

getWidget in interface SearchUICriterion

Overrides:

getWidget in class Parameter<MetadataType>

Returns:

the widget or null if none is defined.

getWidgetParameters

public Map<String,I18nizableText> getWidgetParameters()

Description copied from class: Parameter

Get the widget's parameters

Specified by:

getWidgetParameters in interface SearchUICriterion

Overrides:

getWidgetParameters in class Parameter<MetadataType>

Returns:

the widget's parameters

getFieldId

public String getFieldId()

Description copied from interface: SearchUICriterion

Get the field identifier. Used to match standard, advanced and faceted criterion (even if the operator is different), whatever their ID is.

Returns:

the field identifier.

isSortable

public boolean isSortable()

Description copied from interface: SearchCriterion

Test if the SearchCriterion is sortable.

Returns:

true if the criterion is sortable, false otherwise.

getOperator

public Query.Operator getOperator()

Description copied from interface: SearchCriterion

Get the criterion Operator.

Returns:

the criterion Operator.