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

Class ReferencingCriterionDefinition<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>

Type Parameters:

T - Type of the criterion value

All Implemented Interfaces:

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

Direct Known Subclasses:

ReferencingSearchModelCriterionDefinition, ReferencingSearchServiceCriterionDefinition

public class ReferencingCriterionDefinition<T>
extends AbstractCriterionDefinition<T>

Default implementation for CriterionDefinition searching on a model item.

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentSearchHelper	_contentSearchHelper	The content search helper
protected ContentTypeExtensionPoint	_contentTypeExtensionPoint	The content type extension point
protected Set<String>	_contentTypeIds	The identifiers of the content types defining the reference
protected ModelItemTypeExtensionPoint	_criterionTypeExtensionPoint	The extension point containing all available criterion types
protected ElementDefinition	_reference	The referenced definition used for this criterion
protected String	_referencePath	The path of the field from the containing search model
static final String	NONE_VALUE	None value to search for reference where the attribute does not exist

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

Method Summary

Modifier and Type	Method	Description
protected ContentSearchHelper	_getContentSearchHelper()	Retrieves the content search helper
protected ContentTypeExtensionPoint	_getContentTypeExtensionPoint()	Retrieves The content type extension point
protected ModelItemTypeExtensionPoint	_getCriterionTypeExtensionPoint()	Retrieves The extension point containing all available criterion types
protected Enumerator<T>	_getDefaultEnumerator()	Retrieves the default Enumerator for the current criterion definition
protected String	_getDefaultWidget()	Retrieves the default widget for the criterion
protected Map<String,I18nizableText>	_getDefaultWidgetParameters()	Retrieves the default widget parameters for the criterion
protected String	_getFacetFieldNameSuffix()	Retrieves the suffix of the facet field name
protected Configuration	_getRootCriterionConfiguration()	Retrieves the root criterion configuration Used to wrap it for enumerator and widget parameters
protected boolean	_isFacetable()	Determine if the current criterion definition can be used as facet
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
Set<String>	getContentTypeIds(Map<String,Object> contextualParameters)	Retrieves the identifiers of the content types defining the reference
I18nizableText	getDescription()	Retrieves the description.
Enumerator<T>	getEnumerator()	Retrieves the enumerator.
List<String>	getJoinedPaths(Map<String,Object> contextualParameters)	Retrieves the joined paths of the criterion
I18nizableText	getLabel()	Retrieves the label.
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.
ElementDefinition<T>	getReference()	Retrieves the referenced element definition
String	getReferencePath()	Get the path in the criterion's reference.
String	getSolrFacetFieldName(Map<String,Object> contextualParameters)	Retrieves the name of the criterion's solr facet field
IndexableElementType<T>	getType()	Retrieves the type.
void	setContentTypeIds(Set<String> contentTypeIds)	Set the identifiers of the content types defining the reference
protected void	setReference(ElementDefinition<T> reference)	Set the referenced element definition
protected void	setReferencePath(String referencePath)	Set the path of the criterion's reference

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, _toJSON, _widgetToJSON, _widgetToSAX, getCustomEnumerator, getCustomValidator, getDefaultValue, 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, getDisableConditions, getItemCheckers, 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

getQuery, getQuery

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

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

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

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

Field Details

NONE_VALUE

public static final String NONE_VALUE

None value to search for reference where the attribute does not exist

See Also:

• Constant Field Values

_contentTypeExtensionPoint

protected ContentTypeExtensionPoint _contentTypeExtensionPoint

The content type extension point

_criterionTypeExtensionPoint

protected ModelItemTypeExtensionPoint _criterionTypeExtensionPoint

The extension point containing all available criterion types

_contentSearchHelper

protected ContentSearchHelper _contentSearchHelper

The content search helper

_reference

protected ElementDefinition _reference

The referenced definition used for this criterion

_referencePath

protected String _referencePath

The path of the field from the containing search model

_contentTypeIds

protected Set<String> _contentTypeIds

The identifiers of the content types defining the reference

Constructor Details

ReferencingCriterionDefinition

public ReferencingCriterionDefinition()

Default constructor.

ReferencingCriterionDefinition

public ReferencingCriterionDefinition(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

getReferencePath

public String getReferencePath()

Get the path in the criterion's reference.

Returns:

the path in the criterion's reference.

setReferencePath

protected void setReferencePath(String referencePath)

Set the path of the criterion's reference

Parameters:

referencePath - the reference path to set

getReference

public ElementDefinition<T> getReference()

Retrieves the referenced element definition

Returns:

the referenced element definition

setReference

protected void setReference(ElementDefinition<T> reference)

Set the referenced element definition

Parameters:

reference - the referenced element definition to set

getContentTypeIds

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

Retrieves the identifiers of the content types defining the reference

Parameters:

contextualParameters - the contextual parameters

Returns:

the identifiers of the content types defining the reference

setContentTypeIds

public void setContentTypeIds(Set<String> contentTypeIds)

Set the identifiers of the content types defining the reference

Parameters:

contentTypeIds - the content type identifiers to set

getLabel

public I18nizableText getLabel()

Description copied from interface: Labelable

Retrieves the label.

Specified by:

getLabel in interface Labelable

Overrides:

getLabel in class AbstractModelItem

Returns:

the label.

getDescription

public I18nizableText getDescription()

Description copied from interface: Labelable

Retrieves the description.

Specified by:

getDescription in interface Labelable

Overrides:

getDescription in class AbstractModelItem

Returns:

the description.

getType

public IndexableElementType<T> getType()

Description copied from interface: ModelItem

Retrieves the type.

Specified by:

getType in interface CriterionDefinition<T>

Specified by:

getType in interface ElementDefinition<T>

Specified by:

getType in interface ModelItem

Overrides:

getType in class AbstractCriterionDefinition<T>

Returns:

the type.

_getDefaultWidget

protected String _getDefaultWidget()

Description copied from class: AbstractCriterionDefinition

Retrieves the default widget for the criterion

Overrides:

_getDefaultWidget in class AbstractCriterionDefinition<T>

Returns:

the default widget for the criterion

_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

getEnumerator

public Enumerator<T> getEnumerator()

Description copied from interface: ElementDefinition

Retrieves the enumerator.

Specified by:

getEnumerator in interface ElementDefinition<T>

Overrides:

getEnumerator in class DefaultElementDefinition<T>

Returns:

the enumerator or null if none is defined.

_getDefaultEnumerator

protected Enumerator<T> _getDefaultEnumerator()

Retrieves the default Enumerator for the current criterion definition

Returns:

the default Enumerator for the current criterion definition

_getRootCriterionConfiguration

protected Configuration _getRootCriterionConfiguration()

Retrieves the root criterion configuration Used to wrap it for enumerator and widget parameters

Returns:

the root criterion configuration

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<T>

Overrides:

convertQueryValue in class AbstractCriterionDefinition<T>

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<T>

Overrides:

getQuery in class AbstractCriterionDefinition<T>

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.

getSolrFacetFieldName

public String getSolrFacetFieldName(Map<String,Object> contextualParameters)

Description copied from interface: CriterionDefinition

Retrieves the name of the criterion's solr facet field

Specified by:

getSolrFacetFieldName in interface CriterionDefinition<T>

Overrides:

getSolrFacetFieldName in class AbstractCriterionDefinition<T>

Parameters:

contextualParameters - the search contextual parameters.

Returns:

the name of the criterion's solr facet field. Can be null if the criterion is not facetable

_isFacetable

protected boolean _isFacetable()

Determine if the current criterion definition can be used as facet

Returns:

true if the current criterion definition can be used as facet, false otherwise

_getFacetFieldNameSuffix

protected String _getFacetFieldNameSuffix()

Retrieves the suffix of the facet field name

Returns:

the suffix of the facet field name

getJoinedPaths

public List<String> getJoinedPaths(Map<String,Object> contextualParameters)

Description copied from interface: CriterionDefinition

Retrieves the joined paths of the criterion

Specified by:

getJoinedPaths in interface CriterionDefinition<T>

Overrides:

getJoinedPaths in class AbstractCriterionDefinition<T>

Parameters:

contextualParameters - the search contextual parameters.

Returns:

the joined paths, or an empty list if the criterion is not joined

_getContentTypeExtensionPoint

protected ContentTypeExtensionPoint _getContentTypeExtensionPoint()

Retrieves The content type extension point

Returns:

The content type extension point

_getCriterionTypeExtensionPoint

protected ModelItemTypeExtensionPoint _getCriterionTypeExtensionPoint()

Retrieves The extension point containing all available criterion types

Returns:

The extension point containing all available criterion types

_getContentSearchHelper

protected ContentSearchHelper _getContentSearchHelper()

Retrieves the content search helper

Returns:

the content search helper