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

Class SiteCriterionDefinition

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

All Implemented Interfaces:

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

public class SiteCriterionDefinition
extends AbstractSearchServiceCriterionDefinition<String>

SearchServiceCriterionDefinition proposing a criterion definition on the site 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
SiteCriterionDefinition()

Method Summary

Modifier and Type	Method	Description
protected SiteQueryHelper	_getSiteQueryHelper()	Retrieves the SiteQueryHelper
Object	convertQueryValue(Object value, Map<String,Object> contextualParameters)	Converts the given value to have the right typed for value to give to the CriterionDefinition.getQuery(Object, Map, String, Map) method
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.
IndexableElementType<String>	getType()	Retrieves the type.
String	getWidget()	Retrieves the widget to use for rendering.

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

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

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

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

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

_getDefaultValues, _widgetToJSON, _widgetToSAX, getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, getEnumeratorConfiguration, getParsedDefaultValues, getValidator, 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

getJoinedPaths, getQuery, getQuery, getSolrFacetFieldName

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

getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, getEnumeratorConfiguration, getParsedDefaultValues, getValidator, 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, getWidgetParameters, 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

SiteCriterionDefinition

public SiteCriterionDefinition()

Method Details

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.

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.

convertQueryValue

public Object convertQueryValue(Object value,
 Map<String,Object> contextualParameters)

Description copied from interface: CriterionDefinition

Converts the given value to have the right typed for value to give to the CriterionDefinition.getQuery(Object, Map, String, Map) method

Specified by:

convertQueryValue in interface CriterionDefinition<String>

Overrides:

convertQueryValue in class AbstractCriterionDefinition<String>

Parameters:

value - the value to convert

contextualParameters - the search contextual parameters.

Returns:

the value, converted to a well typed value

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.

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

_getSiteQueryHelper

protected SiteQueryHelper _getSiteQueryHelper()

Retrieves the SiteQueryHelper

Returns:

the SiteQueryHelper