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

Class PageCriterionDefinition

java.lang.Object

org.ametys.runtime.model.AbstractModelItem

org.ametys.runtime.model.DefaultElementDefinition<String>

org.ametys.cms.search.model.impl.AbstractCriterionDefinition<String>

org.ametys.web.frontoffice.search.metamodel.impl.AbstractSearchServiceCriterionDefinition<String>

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

All Implemented Interfaces:

Comparable<ModelItem>, CriterionDefinition<String>, ElementDefinition<String>, ModelItem, Labelable, ModifiableLabelable, SearchServiceCriterionDefinition<String>

public class PageCriterionDefinition
extends AbstractSearchServiceCriterionDefinition<String>

SearchServiceCriterionDefinition proposing a criterion definition on the page of the indexed document.

Field Summary

Fields inherited from class org.ametys.web.frontoffice.search.metamodel.impl.AbstractSearchServiceCriterionDefinition

_criterionTypeExtensionPoint, _searchServiceCriterionDefinitionHelper

Fields inherited from class org.ametys.cms.search.model.impl.AbstractCriterionDefinition

_criterionDefinitionHelper, _joinedPaths, _multipleOperandOperator, _solrFacetFieldName

Fields inherited from class org.ametys.runtime.model.DefaultElementDefinition

_logger

Fields inherited from class org.ametys.runtime.model.AbstractModelItem

__context, __serviceManager

Fields inherited from interface org.ametys.runtime.model.ElementDefinition

CONFIG_DEFAULT_VALUE_TYPE

Fields inherited from interface org.ametys.runtime.model.ModelItem

ITEM_PATH_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
PageCriterionDefinition()

Method Summary

Modifier and Type	Method	Description
protected AmetysObjectResolver	_getAmetysObjectResolver()	Retrieves the AmetysObjectResolver
Query	getEmptyValueQuery(String language, Map<String,Object> contextualParameters)	Gets the query for testing the value is empty
Query	getQuery(Object value, Query.Operator operator, Map<String,Object> allValues, String language, Map<String,Object> contextualParameters)	Get the Query associated to the given value.
RestrictedEnumerator<String>	getRestrictedEnumerator(Map<String,Object> contextualParameters)	Gets the RestrictedEnumerator used by the final user to fill the criterion.
IndexableElementType<String>	getType()	Retrieves the type.
Validator	getValidator()	Retrieves the validator.
String	getWidget()	Retrieves the widget to use for rendering.
Map<String,I18nizableText>	getWidgetParameters()	Get the widget's parameters
protected boolean	isTooBigForStaticEnumerator()	Determines if the current criterion definition is enumerated but can contain too much data

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

_getCriterionTypeExtensionPoint, _getSearchServiceCriterionDefinitionHelper, _toJSON, dispose, getSearchable, isEnumerated, setSearchable

Methods inherited from class org.ametys.cms.search.model.impl.AbstractCriterionDefinition

_defaultValueToJSON, _getCriterionDefinitionHelper, _getDefaultWidget, _getDefaultWidgetParameters, convertQueryValue, getJoinedPaths, getMultipleOperandOperator, getQueryContext, getSolrFacetFieldName, setJoinedPaths, setSolrFacetFieldName

Methods inherited from class org.ametys.runtime.model.DefaultElementDefinition

_getDefaultValues, _widgetToJSON, _widgetToSAX, getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, getEnumeratorConfiguration, getParsedDefaultValues, getValidatorConfiguration, isMultiple, of, setCustomEnumerator, setCustomValidator, setDefaultValue, setEnumerator, setEnumeratorConfiguration, setMultiple, setParsedDefaultValues, setType, setValidator, setValidatorConfiguration, setWidget, setWidgetParameters, toSAX

Methods inherited from class org.ametys.runtime.model.AbstractModelItem

_getModelItemHelper, _shouldJSONBeEmpty, _widgetParameterToSAX, addItemChecker, compareTo, disableConditionsToJSON, equals, getDescription, getDisableConditions, getItemCheckers, getLabel, getModel, getName, getParent, getPath, getPluginName, hashCode, setContext, setDescription, setDisableConditions, setLabel, setModel, setName, setParent, setPluginName, setServiceManager, toJSON, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

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

convertQueryValue, getJoinedPaths, getQuery, getQuery, getSolrFacetFieldName

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

getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, getEnumeratorConfiguration, getParsedDefaultValues, getValidatorConfiguration, isEditable, isMultiple, setCustomEnumerator, setCustomValidator, setDefaultValue, setEnumerator, setEnumeratorConfiguration, setMultiple, setParsedDefaultValues, setValidator, setValidatorConfiguration

Methods inherited from interface org.ametys.runtime.util.Labelable

getDescription, getLabel, getName

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

addItemChecker, getDisableConditions, getItemCheckers, getModel, getParent, getPath, getPluginName, setDisableConditions, setModel, setParent, setPluginName, setType, setWidget, setWidgetParameters, toJSON, toSAX

Methods inherited from interface org.ametys.runtime.util.ModifiableLabelable

setDescription, setLabel, setName

Methods inherited from interface org.ametys.web.frontoffice.search.metamodel.SearchServiceCriterionDefinition

convertRestrictedValue, facetValueToSAX, getContextPrefixLabels

Constructor Details

PageCriterionDefinition

public PageCriterionDefinition()

Method Details

isTooBigForStaticEnumerator

protected boolean isTooBigForStaticEnumerator()

Description copied from class: AbstractSearchServiceCriterionDefinition

Determines if the current criterion definition is enumerated but can contain too much data

Overrides:

isTooBigForStaticEnumerator in class AbstractSearchServiceCriterionDefinition<String>

Returns:

true if the criterion definition can contain too much data, false otherwise

getRestrictedEnumerator

public RestrictedEnumerator<String> getRestrictedEnumerator(Map<String,Object> contextualParameters)

Description copied from interface: SearchServiceCriterionDefinition

Gets the RestrictedEnumerator used by the final user to fill the criterion. Values of this Enumerator can be restricted according to entered values during service configuration

Specified by:

getRestrictedEnumerator in interface SearchServiceCriterionDefinition<String>

Overrides:

getRestrictedEnumerator in class AbstractSearchServiceCriterionDefinition<String>

Parameters:

contextualParameters - The contextual parameters

Returns:

the enumerated entries

getWidget

public String getWidget()

Description copied from interface: ModelItem

Retrieves the widget to use for rendering.

Specified by:

getWidget in interface ModelItem

Overrides:

getWidget in class AbstractCriterionDefinition<String>

Returns:

the widget or null if none is defined.

getWidgetParameters

public Map<String,I18nizableText> getWidgetParameters()

Description copied from interface: ModelItem

Get the widget's parameters

Specified by:

getWidgetParameters in interface ModelItem

Overrides:

getWidgetParameters in class AbstractCriterionDefinition<String>

Returns:

the widget's parameters

getType

public IndexableElementType<String> getType()

Description copied from interface: ModelItem

Retrieves the type.

Specified by:

getType in interface CriterionDefinition<String>

Specified by:

getType in interface ElementDefinition<String>

Specified by:

getType in interface ModelItem

Overrides:

getType in class AbstractCriterionDefinition<String>

Returns:

the type.

getQuery

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

Description copied from interface: CriterionDefinition

Get the Query associated to the given value.

Specified by:

getQuery in interface CriterionDefinition<String>

Overrides:

getQuery in class AbstractCriterionDefinition<String>

Parameters:

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

operator - 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.

getValidator

public Validator getValidator()

Description copied from interface: ElementDefinition

Retrieves the validator.

Specified by:

getValidator in interface ElementDefinition<String>

Overrides:

getValidator in class DefaultElementDefinition<String>

Returns:

the validator or null if none is defined.

getEmptyValueQuery

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

Description copied from interface: SearchServiceCriterionDefinition

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

_getAmetysObjectResolver

protected AmetysObjectResolver _getAmetysObjectResolver()

Retrieves the AmetysObjectResolver

Returns:

the AmetysObjectResolver