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

Class AbstractSearchServiceCriterionDefinition<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.web.frontoffice.search.metamodel.impl.AbstractSearchServiceCriterionDefinition<T>

Type Parameters:

T - Type of the criterion value

All Implemented Interfaces:

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

Direct Known Subclasses:

DublinCoreCriterionDefinition, PageCriterionDefinition, PageTitleCriterionDefinition, SiteCriterionDefinition, SitemapCriterionDefinition, WordingCriterionDefinition

public abstract class AbstractSearchServiceCriterionDefinition<T>
extends AbstractCriterionDefinition<T>
implements SearchServiceCriterionDefinition<T>

Default implementation of SearchServiceCriterionDefinition

Field Summary

Fields

Modifier and Type	Field	Description
protected ModelItemTypeExtensionPoint	_criterionTypeExtensionPoint	The extension point containing all available criterion types
protected SearchServiceCriterionDefinitionHelper	_searchServiceCriterionDefinitionHelper	The search service criterion definition helper

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

Method Summary

Modifier and Type	Method	Description
protected ModelItemTypeExtensionPoint	_getCriterionTypeExtensionPoint()	Retrieves the ModelItemTypeExtensionPoint for available criterion types
protected SearchServiceCriterionDefinitionHelper	_getSearchServiceCriterionDefinitionHelper()	Retrieves the search service criterion definition helper
protected Map<String,Object>	_toJSON(DefinitionContext context)	Converts the model item in a JSON map
protected void	dispose()	Releases and destroys any resource it owns.
RestrictedEnumerator<T>	getRestrictedEnumerator(Map<String,Object> contextualParameters)	Gets the RestrictedEnumerator used by the final user to fill the criterion.
Optional<Searchable>	getSearchable()	Gets the (Searchable) the criterion belongs to.
boolean	isEnumerated()	Determines if this criterion definition is enumerated
protected boolean	isTooBigForStaticEnumerator()	Determines if the current criterion definition is enumerated but can contain too much data
void	setSearchable(Searchable searchable)	Sets the (Searchable) the criterion belongs to.

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

_getCriterionDefinitionHelper, _getDefaultWidget, _getDefaultWidgetParameters, convertQueryValue, getJoinedPaths, getMultipleOperandOperator, getQuery, getQueryContext, getSolrFacetFieldName, getType, 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, 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

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.util.ModifiableLabelable

setDescription, setLabel, setName

Methods inherited from interface org.ametys.web.frontoffice.search.metamodel.SearchServiceCriterionDefinition

convertRestrictedValue, facetValueToSAX, getContextPrefixLabels, getEmptyValueQuery

Field Details

_criterionTypeExtensionPoint

protected ModelItemTypeExtensionPoint _criterionTypeExtensionPoint

The extension point containing all available criterion types

_searchServiceCriterionDefinitionHelper

protected SearchServiceCriterionDefinitionHelper _searchServiceCriterionDefinitionHelper

The search service criterion definition helper

Constructor Details

AbstractSearchServiceCriterionDefinition

public AbstractSearchServiceCriterionDefinition()

Method Details

getSearchable

public Optional<Searchable> getSearchable()

Description copied from interface: SearchServiceCriterionDefinition

Gets the (Searchable) the criterion belongs to.
Important: if the criterion definition is brought by a specific Searchable, then this searchable must be returned in a non-empty Optional. If the criterion definition is brought by SearchServiceCommonImpls, then an Optional.empty() must be returned.

Specified by:

getSearchable in interface SearchServiceCriterionDefinition<T>

Returns:

the (Searchable) the criterion belongs to.

setSearchable

public void setSearchable(Searchable searchable)

Description copied from interface: SearchServiceCriterionDefinition

Sets the (Searchable) the criterion belongs to.

Specified by:

setSearchable in interface SearchServiceCriterionDefinition<T>

Parameters:

searchable - the Searchable to set

isEnumerated

public boolean isEnumerated()

Description copied from interface: SearchServiceCriterionDefinition

Determines if this criterion definition is enumerated

Specified by:

isEnumerated in interface SearchServiceCriterionDefinition<T>

Returns:

true if this criterion definition is enumerated, false otherwise

isTooBigForStaticEnumerator

protected boolean isTooBigForStaticEnumerator()

Determines if the current criterion definition is enumerated but can contain too much data

Returns:

true if the criterion definition can contain too much data, false otherwise

getRestrictedEnumerator

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

Parameters:

contextualParameters - The contextual parameters

Returns:

the enumerated entries

_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

dispose

protected void dispose()

Releases and destroys any resource it owns.

_getCriterionTypeExtensionPoint

protected ModelItemTypeExtensionPoint _getCriterionTypeExtensionPoint()

Retrieves the ModelItemTypeExtensionPoint for available criterion types

Returns:

the ModelItemTypeExtensionPoint for available criterion types

_getSearchServiceCriterionDefinitionHelper

protected SearchServiceCriterionDefinitionHelper _getSearchServiceCriterionDefinitionHelper()

Retrieves the search service criterion definition helper

Returns:

the search service criterion definition helper