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

Class ContentReferencingSearchServiceCriterionDefinition

java.lang.Object

org.ametys.runtime.model.AbstractModelItem

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

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

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

org.ametys.web.frontoffice.search.metamodel.impl.ReferencingSearchServiceCriterionDefinition<ContentValue>

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

All Implemented Interfaces:

Comparable<ModelItem>, ContentElementDefinition, CriterionDefinition<ContentValue>, ElementDefinition<ContentValue>, ModelItem, ModelItemAccessor, Labelable, ModifiableLabelable, SearchServiceCriterionDefinition<ContentValue>

Direct Known Subclasses:

DegreeUniversityCriterionDefinition

public class ContentReferencingSearchServiceCriterionDefinition
extends ReferencingSearchServiceCriterionDefinition<ContentValue>
implements ContentElementDefinition

ReferencingSearchServiceCriterionDefinition for a ModelItemTypeConstants.CONTENT_ELEMENT_TYPE_ID attribute.

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentHelper	_contentHelper	The content helper
protected AmetysObjectResolver	_resolver	The resolver

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

_searchServiceCriterionDefinitionHelper

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
ContentReferencingSearchServiceCriterionDefinition(ElementDefinition reference, String referencePath, ContentType baseContentType)	Constructor used to create a FO criterion definition on a referenced item of type content

Method Summary

Modifier and Type	Method	Description
protected AmetysObjectResolver	_getAmetysObjectResolver()	Retrieves the AmetysObjectResolver
protected ContentHelper	_getContentHelper()	Retrieves the ContentHelper
protected Expression	getContentTypeExpression(String parentCTypeId)	Gets the content type expression for retrieving enumeration of contents
String	getContentTypeId()	Get the element's content type identifier.
Collection<? extends ModelItem>	getModelItems()	Retrieves all the model items of this accessor
Long	getOrder(ContentValue contentValue)	Get the order of the content id value for a search criterion definition referencing a model item of type content
ContentElementDefinition	getReference()	Retrieves the referenced element definition
RestrictedEnumerator<ContentValue>	getRestrictedEnumerator(Map<String,Object> contextualParameters)	Gets the RestrictedEnumerator used by the final user to fill the criterion.
boolean	isEnumerated()	Determines if this criterion definition is enumerated
void	setContentTypeId(String contentTypeId)	Set the element's content type identifier.

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

_getSearchServiceCriterionDefinitionHelper, _toJSON, getContextPrefixLabels, getEmptyValueQuery, getFacetLabel, getSearchable, getValidator, isMultiple, isTooBigForStaticEnumerator, setSearchable

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

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

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

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

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

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

convertQueryValue, getJoinedPaths, getQuery, 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, getName

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

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

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

getChild, getModelItem, hasModelItem

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

Field Details

_resolver

protected AmetysObjectResolver _resolver

The resolver

_contentHelper

protected ContentHelper _contentHelper

The content helper

Constructor Details

ContentReferencingSearchServiceCriterionDefinition

public ContentReferencingSearchServiceCriterionDefinition(ElementDefinition reference,
 String referencePath,
 ContentType baseContentType)

Constructor used to create a FO criterion definition on a referenced item of type content

Parameters:

reference - the item referenced by this criterion

referencePath - the path of the criterion's reference

baseContentType - the content type defining the reference

Method Details

isEnumerated

public boolean isEnumerated()

Description copied from interface: SearchServiceCriterionDefinition

Determines if this criterion definition is enumerated

Specified by:

isEnumerated in interface SearchServiceCriterionDefinition<ContentValue>

Overrides:

isEnumerated in class ReferencingSearchServiceCriterionDefinition<ContentValue>

Returns:

true if this criterion definition is enumerated, false otherwise

getRestrictedEnumerator

public RestrictedEnumerator<ContentValue> 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<ContentValue>

Overrides:

getRestrictedEnumerator in class ReferencingSearchServiceCriterionDefinition<ContentValue>

Parameters:

contextualParameters - The contextual parameters

Returns:

the enumerated entries

getContentTypeExpression

protected Expression getContentTypeExpression(String parentCTypeId)

Gets the content type expression for retrieving enumeration of contents

Parameters:

parentCTypeId - The parent content type id

Returns:

The Expression

getOrder

public Long getOrder(ContentValue contentValue)

Get the order of the content id value for a search criterion definition referencing a model item of type content

Parameters:

contentValue - the content value

Returns:

the order or null if there is no order

getReference

public ContentElementDefinition getReference()

Description copied from class: ReferencingCriterionDefinition

Retrieves the referenced element definition

Overrides:

getReference in class ReferencingCriterionDefinition<ContentValue>

Returns:

the referenced element definition

getContentTypeId

public String getContentTypeId()

Description copied from interface: ContentElementDefinition

Get the element's content type identifier.

Specified by:

getContentTypeId in interface ContentElementDefinition

Returns:

the element's content type identifier.

setContentTypeId

public void setContentTypeId(String contentTypeId)

Description copied from interface: ContentElementDefinition

Set the element's content type identifier.

Specified by:

setContentTypeId in interface ContentElementDefinition

Parameters:

contentTypeId - the content type identifier to set.

getModelItems

public Collection<? extends ModelItem> getModelItems()

Description copied from interface: ModelItemAccessor

Retrieves all the model items of this accessor

Specified by:

getModelItems in interface ContentElementDefinition

Specified by:

getModelItems in interface ModelItemAccessor

Returns:

the model items

_getAmetysObjectResolver

protected AmetysObjectResolver _getAmetysObjectResolver()

Retrieves the AmetysObjectResolver

Returns:

the AmetysObjectResolver

_getContentHelper

protected ContentHelper _getContentHelper()

Retrieves the ContentHelper

Returns:

the ContentHelper