Package org.ametys.cms.search.model.impl

Class ReferencingSearchModelCriterionDefinition<T>

java.lang.Object

org.ametys.runtime.model.AbstractModelItem

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

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

org.ametys.cms.search.model.impl.ReferencingCriterionDefinition<T>

org.ametys.cms.search.model.impl.ReferencingSearchModelCriterionDefinition<T>

Type Parameters:

T - Type of the criterion value

All Implemented Interfaces:

Comparable<ModelItem>, CriterionDefinition<T>, SearchModelCriterionDefinition<T>, ElementDefinition<T>, ModelItem, Labelable, ModifiableLabelable

Direct Known Subclasses:

ContentReferencingSearchModelCriterionDefinition, ContentTypesAwareReferencingCriterionDefinition, LanguageAwareReferencingCriterionDefinition, StaticReferencingSearchModelCriterionDefinition

public class ReferencingSearchModelCriterionDefinition<T>
extends ReferencingCriterionDefinition<T>
implements SearchModelCriterionDefinition<T>

Default implementation for SearchModelCriterionDefinition searching on a model item.

Field Summary

Fields

Modifier and Type	Field	Description
protected Query.Operator	_operator	The criteria operator
static final String	CRITERION_DEFINITION_PREFIX	Prefix for name of referencing criterion definitions

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

_contentSearchHelper, _contentTypeExtensionPoint, _contentTypeIds, _criterionTypeExtensionPoint, _reference, _referencePath, NONE_VALUE

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
ReferencingSearchModelCriterionDefinition()	Default constructor.
ReferencingSearchModelCriterionDefinition(ElementDefinition reference, String referencePath)	Constructor used to create a BO criterion definition on a referenced item

Method Summary

Modifier and Type	Method	Description
protected Query.Operator	_getDefaultOperator()	Retrieves the default operator for the criterion
protected Map<String,Object>	_toJSON(DefinitionContext context)	Converts the model item in a JSON map
void	copyTo(SearchModelCriterionDefinition<T> criterion, Map<String,Object> contextualParameters)	Copy the current criterion definition in the given one.
Set<String>	getContentTypeIds(Map<String,Object> contextualParameters)	Retrieves the identifiers of the content types defining the reference
SearchModel	getModel()	Retrieves the model of the item
String	getName()	Get the name.
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.
void	setMultipleOperandOperator(Query.LogicalOperator multipleOperand)	Set the the logical operator for multi-valued criteria
void	setOperator(Query.Operator operator)	Set the criterion Operator.
void	toSAX(ContentHandler contentHandler, DefinitionContext context)	Generates SAX events for the model item

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

_getContentSearchHelper, _getContentTypeExtensionPoint, _getCriterionTypeExtensionPoint, _getDefaultEnumerator, _getDefaultWidget, _getDefaultWidgetParameters, _getFacetFieldNameSuffix, _getRootCriterionConfiguration, _isFacetable, convertQueryValue, getDescription, getEnumerator, getJoinedPaths, getLabel, getReference, getReferencePath, getSolrFacetFieldName, getType, setContentTypeIds, setReference, setReferencePath

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

_getCriterionDefinitionHelper, getMultipleOperandOperator, getQueryContext, getWidget, getWidgetParameters, setJoinedPaths, setSolrFacetFieldName

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

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

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

_getModelItemHelper, _shouldJSONBeEmpty, _widgetParameterToSAX, addItemChecker, compareTo, disableConditionsToJSON, equals, getDisableConditions, getItemCheckers, 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, getType

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

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

addItemChecker, getDisableConditions, getItemCheckers, getParent, getPath, getPluginName, getWidget, getWidgetParameters, setDisableConditions, setModel, setParent, setPluginName, setType, setWidget, setWidgetParameters, toJSON

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

setDescription, setLabel, setName

Field Details

CRITERION_DEFINITION_PREFIX

public static final String CRITERION_DEFINITION_PREFIX

Prefix for name of referencing criterion definitions

See Also:

• Constant Field Values

_operator

protected Query.Operator _operator

The criteria operator

Constructor Details

ReferencingSearchModelCriterionDefinition

public ReferencingSearchModelCriterionDefinition()

Default constructor.

ReferencingSearchModelCriterionDefinition

public ReferencingSearchModelCriterionDefinition(ElementDefinition reference,
 String referencePath)

Constructor used to create a BO criterion definition on a referenced item

Parameters:

reference - the item referenced by this criterion

referencePath - the path of the criterion's reference

Method Details

getContentTypeIds

public Set<String> getContentTypeIds(Map<String,Object> contextualParameters)

Description copied from class: ReferencingCriterionDefinition

Retrieves the identifiers of the content types defining the reference

Overrides:

getContentTypeIds in class ReferencingCriterionDefinition<T>

Parameters:

contextualParameters - the contextual parameters

Returns:

the identifiers of the content types defining the reference

getName

public String getName()

Description copied from interface: Labelable

Get the name.

Specified by:

getName in interface Labelable

Overrides:

getName in class AbstractModelItem

Returns:

the name.

getQuery

public Query getQuery(Object value,
 Query.Operator customOperator,
 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<T>

Overrides:

getQuery in class ReferencingCriterionDefinition<T>

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.

getOperator

public Query.Operator getOperator()

Description copied from interface: SearchModelCriterionDefinition

Get the criterion Operator.

Specified by:

getOperator in interface SearchModelCriterionDefinition<T>

Returns:

the criterion Operator.

_getDefaultOperator

protected Query.Operator _getDefaultOperator()

Retrieves the default operator for the criterion

Returns:

the default operator for the criterion

setOperator

public void setOperator(Query.Operator operator)

Description copied from interface: SearchModelCriterionDefinition

Set the criterion Operator.

Specified by:

setOperator in interface SearchModelCriterionDefinition<T>

Parameters:

operator - the Operator to set.

setMultipleOperandOperator

public void setMultipleOperandOperator(Query.LogicalOperator multipleOperand)

Description copied from interface: SearchModelCriterionDefinition

Set the the logical operator for multi-valued criteria

Specified by:

setMultipleOperandOperator in interface SearchModelCriterionDefinition<T>

Parameters:

multipleOperand - the logical operator to set

_toJSON

protected Map<String,Object> _toJSON(DefinitionContext context)

Description copied from class: AbstractModelItem

Converts the model item in a JSON map

Overrides:

_toJSON in class DefaultElementDefinition<T>

Parameters:

context - the context of the definition

Returns:

The model item as a JSON map

toSAX

public void toSAX(ContentHandler contentHandler,
 DefinitionContext context)
           throws SAXException

Description copied from interface: ModelItem

Generates SAX events for the model item

Specified by:

toSAX in interface ModelItem

Overrides:

toSAX in class DefaultElementDefinition<T>

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

context - the context of the definition

Throws:

SAXException - if an error occurs during the SAX events generation

copyTo

public void copyTo(SearchModelCriterionDefinition<T> criterion,
 Map<String,Object> contextualParameters)

Description copied from interface: SearchModelCriterionDefinition

Copy the current criterion definition in the given one.

Specified by:

copyTo in interface SearchModelCriterionDefinition<T>

Parameters:

criterion - the copy

contextualParameters - the contextual parameters

getModel

public SearchModel getModel()

Description copied from interface: ModelItem

Retrieves the model of the item

Specified by:

getModel in interface ModelItem

Specified by:

getModel in interface SearchModelCriterionDefinition<T>

Overrides:

getModel in class AbstractModelItem

Returns:

the model