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

Class ReferencingAggregatorCriterionDefinition<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.DefaultSearchModelCriterionDefinition<T>

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

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

Type Parameters:

T - Type of the criteria values

All Implemented Interfaces:

Comparable<ModelItem>, CriterionDefinition<T>, SearchModelCriterionDefinition<T>, ElementDefinition<T>, ModelItem, Labelable, ModifiableLabelable, Component, Configurable, Contextualizable, Serviceable

public class ReferencingAggregatorCriterionDefinition<T>
extends AbstractStaticSearchModelCriterionDefinition<T>
implements Contextualizable

Aggregate multiple referencing criterion definitions as a unique criterion definition. The resulting query is an OR query on all the terms.

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentTypeExtensionPoint	_contentTypeExtensionPoint	The content type extension point
protected ContentTypesHelper	_contentTypesHelper	The helper for convenient methods on content types
protected Context	_context	The avalon context
protected List<SearchModelCriterionDefinition<T>>	_criteria	The aggregated criteria
protected ServiceManager	_manager	The service manager
protected SearchModelCriterionDefinitionHelper	_searchModelCriterionDefinitionHelper	The helper for search model criterion definition
protected String	_typeId	the criterion type identifier
static final String	CRITERION_DEFINITION_AGGREGATOR_PREFIX	Prefix for name of referencing aggregator criterion definition

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

_criterionTypeExtensionPoint

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

_operator

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
ReferencingAggregatorCriterionDefinition()

Method Summary

Modifier and Type	Method	Description
protected Map<String,I18nizableText>	_getDefaultWidgetParameters()	Retrieves the default widget parameters for the criterion
protected void	_setTypeId(String typeId)	Set the criterion's type identifier
void	configure(Configuration configuration)
void	contextualize(Context context)
protected List<SearchModelCriterionDefinition<T>>	getCriteria()	Retrieves the aggregated criteria
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.
protected String	getTypeId()	Retrieves the id of the property's type
void	service(ServiceManager manager)
protected void	setCriteria(List<SearchModelCriterionDefinition<T>> criteria)	Set the criteria to aggregate.
void	setModel(Model model)	Sets the model of the element

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

getType, setMultipleOperandOperator, setOperator

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

_getDefaultOperator, _toJSON, copyTo, getModel, toSAX

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

_getCriterionDefinitionHelper, _getDefaultWidget, convertQueryValue, getJoinedPaths, getMultipleOperandOperator, getQueryContext, getSolrFacetFieldName, getWidget, getWidgetParameters, setJoinedPaths, setSolrFacetFieldName

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

_defaultValueToJSON, _getDefaultValues, _getSimpleDefaultValue, _widgetToJSON, _widgetToSAX, getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, 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, getDescription, getDisableConditions, getItemCheckers, getLabel, getParent, getPath, getPluginName, hashCode, setContext, setDescription, setDisableConditions, setLabel, 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, 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, setParent, setPluginName, setType, setWidget, setWidgetParameters, toJSON

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

setDescription, setLabel, setName

Field Details

CRITERION_DEFINITION_AGGREGATOR_PREFIX

public static final String CRITERION_DEFINITION_AGGREGATOR_PREFIX

Prefix for name of referencing aggregator criterion definition

See Also:

• Constant Field Values

_manager

protected ServiceManager _manager

The service manager

_context

protected Context _context

The avalon context

_contentTypeExtensionPoint

protected ContentTypeExtensionPoint _contentTypeExtensionPoint

The content type extension point

_contentTypesHelper

protected ContentTypesHelper _contentTypesHelper

The helper for convenient methods on content types

_searchModelCriterionDefinitionHelper

protected SearchModelCriterionDefinitionHelper _searchModelCriterionDefinitionHelper

The helper for search model criterion definition

_criteria

protected List<SearchModelCriterionDefinition<T>> _criteria

The aggregated criteria

_typeId

protected String _typeId

the criterion type identifier

Constructor Details

ReferencingAggregatorCriterionDefinition

public ReferencingAggregatorCriterionDefinition()

Method Details

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractStaticSearchModelCriterionDefinition<T>

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class AbstractStaticSearchModelCriterionDefinition<T>

Throws:

ConfigurationException

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

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.

getCriteria

protected List<SearchModelCriterionDefinition<T>> getCriteria()

Retrieves the aggregated criteria

Returns:

the aggregated criteria

setCriteria

protected void setCriteria(List<SearchModelCriterionDefinition<T>> criteria)

Set the criteria to aggregate.

Parameters:

criteria - the criteria to aggregate.

setModel

public void setModel(Model model)

Description copied from interface: ModelItem

Sets the model of the element

Specified by:

setModel in interface ModelItem

Overrides:

setModel in class AbstractModelItem

Parameters:

model - the model to set

_getDefaultWidgetParameters

protected Map<String,I18nizableText> _getDefaultWidgetParameters()

Description copied from class: AbstractCriterionDefinition

Retrieves the default widget parameters for the criterion

Overrides:

_getDefaultWidgetParameters in class AbstractCriterionDefinition<T>

Returns:

the default widget parameters for the criterion

getOperator

public Query.Operator getOperator()

Description copied from interface: SearchModelCriterionDefinition

Get the criterion Operator.

Specified by:

getOperator in interface SearchModelCriterionDefinition<T>

Overrides:

getOperator in class DefaultSearchModelCriterionDefinition<T>

Returns:

the criterion Operator.

_setTypeId

protected void _setTypeId(String typeId)

Set the criterion's type identifier

Parameters:

typeId - the type identifier to set

getTypeId

protected String getTypeId()

Description copied from class: AbstractStaticSearchModelCriterionDefinition

Retrieves the id of the property's type

Specified by:

getTypeId in class AbstractStaticSearchModelCriterionDefinition<T>

Returns:

the id of the property's type