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

Class PageSearchCriterionDefinition

java.lang.Object

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

org.ametys.web.frontoffice.search.metamodel.impl.AbstractDefaultSearchCriterionDefinition

org.ametys.web.frontoffice.search.metamodel.impl.PageSearchCriterionDefinition

All Implemented Interfaces:

SearchCriterionDefinition

public class PageSearchCriterionDefinition
extends AbstractDefaultSearchCriterionDefinition

SearchCriterionDefinition proposing a search criterion on the page of the indexed document.

Constructor Summary

Constructors

Constructor	Description
PageSearchCriterionDefinition(String id, String pluginName, I18nizableText label, AmetysObjectResolver resolver, Optional<Searchable> searchable)	Default constructor

Method Summary

Modifier and Type	Method	Description
Query	getEmptyValueQuery(String language, Map<String,Object> contextualParameters)	Gets the query for testing the value is empty
Optional<EnumeratedValues>	getEnumeratedValues(Map<String,Object> contextualParameters)	Gets the enumerated entries.
Query	getQuery(Object value, Query.Operator operator, String language, Map<String,Object> contextualParameters)	Gets the query associated to the given value
Validator	getValidator()	Retrieves the validator.
boolean	isEnumerated()	Returns true if this criterion definition is enumerated
boolean	isTooBigForStaticEnumerator()	Returns true if this criterion definition is enumerated but can contains too much data

Methods inherited from class org.ametys.web.frontoffice.search.metamodel.impl.AbstractDefaultSearchCriterionDefinition

dispose, getSearchable, toJSON

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

getDefaultValue, getDescription, getEnumerator, getId, getLabel, getPluginName, getType, getWidget, getWidgetParameters, 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.web.frontoffice.search.metamodel.SearchCriterionDefinition

getContextPrefixLabels, getId, getLabel, getType, getWidget, getWidgetParameters

Constructor Detail

PageSearchCriterionDefinition

public PageSearchCriterionDefinition(String id,
                                     String pluginName,
                                     I18nizableText label,
                                     AmetysObjectResolver resolver,
                                     Optional<Searchable> searchable)

Default constructor

Parameters:

id - The id

pluginName - The plugin name

label - The label

resolver - the AmetysObjectResolver

searchable - The Searchable

Method Detail

isEnumerated

public boolean isEnumerated()

Description copied from interface: SearchCriterionDefinition

Returns true if this criterion definition is enumerated

Specified by:

isEnumerated in interface SearchCriterionDefinition

Overrides:

isEnumerated in class AbstractDefaultSearchCriterionDefinition

Returns:

true if this criterion definition is enumerated

isTooBigForStaticEnumerator

public boolean isTooBigForStaticEnumerator()

Description copied from interface: SearchCriterionDefinition

Returns true if this criterion definition is enumerated but can contains too much data

Specified by:

isTooBigForStaticEnumerator in interface SearchCriterionDefinition

Overrides:

isTooBigForStaticEnumerator in class AbstractDefaultSearchCriterionDefinition

Returns:

true if this criterion definition is enumerated but can contains too much data

getEnumeratedValues

public Optional<EnumeratedValues> getEnumeratedValues(Map<String,Object> contextualParameters)

Description copied from interface: SearchCriterionDefinition

Gets the enumerated entries.
Must be non-empty if SearchCriterionDefinition.isEnumerated() returns true.

Specified by:

getEnumeratedValues in interface SearchCriterionDefinition

Overrides:

getEnumeratedValues in class AbstractDefaultSearchCriterionDefinition

Parameters:

contextualParameters - The contextual parameters

Returns:

the enumerated entries

getQuery

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

Description copied from interface: SearchCriterionDefinition

Gets the query associated to the given value

Parameters:

value - the value

operator - the operator

language - The current search language.

contextualParameters - the search contextual parameters.

Returns:

the query associated to the given value

getValidator

public Validator getValidator()

Description copied from class: Parameter

Retrieves the validator.

Specified by:

getValidator in interface SearchCriterionDefinition

Overrides:

getValidator in class Parameter<MetadataType>

Returns:

the validator or null if none is defined.

getEmptyValueQuery

public Query getEmptyValueQuery(String language,
                                Map<String,Object> contextualParameters)

Description copied from interface: SearchCriterionDefinition

Gets the query for testing the value is empty

Parameters:

language - The current search language.

contextualParameters - the search contextual parameters.

Returns:

the query for testing the value is empty