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

Class TagSearchCriterionDefinition

java.lang.Object

org.ametys.runtime.parameter.Parameter<MetadataType>

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

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

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

All Implemented Interfaces:

SearchCriterionDefinition

public class TagSearchCriterionDefinition
extends ContentSearchCriterionDefinition

ContentSearchCriterionDefinition for the 'tag' SystemProperty.

Field Summary

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

_contentType, _searchUICriterion

Constructor Summary

Constructors

Constructor	Description
TagSearchCriterionDefinition(String id, String pluginName, Optional<Searchable> searchable, SearchUICriterion criterion, Optional<ContentType> contentType, TagProviderExtensionPoint tagProviderEP, JSONUtils jsonUtils)	Default constructor

Method Summary

Modifier and Type	Method	Description
Optional<EnumeratedValues>	getEnumeratedValues(Map<String,Object> contextualParameters)	Gets the enumerated entries.
Query	getQuery(Object value, Query.Operator operator, String language, Map<String,Object> contextualParameters)	Gets the query associated to the given value
boolean	isEnumerated()	Returns true if this criterion definition is enumerated

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

getContextPrefixLabels, getEmptyValueQuery, getSearchUICriterion, toJSON

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

dispose, getSearchable, isTooBigForStaticEnumerator

Methods inherited from class org.ametys.runtime.parameter.Parameter

getDefaultValue, getDescription, getEnumerator, getId, getLabel, getPluginName, getType, getValidator, getWidget, getWidgetParameters, setDefaultValue, setDescription, setEnumerator, setId, setLabel, setPluginName, setType, setValidator, setWidget, setWidgetParameters

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getId, getLabel, getType, getValidator, getWidget, getWidgetParameters

Constructor Details

TagSearchCriterionDefinition

public TagSearchCriterionDefinition(String id,
 String pluginName,
 Optional<Searchable> searchable,
 SearchUICriterion criterion,
 Optional<ContentType> contentType,
 TagProviderExtensionPoint tagProviderEP,
 JSONUtils jsonUtils)

Default constructor

Parameters:

id - The id

pluginName - The plugin name

searchable - the Searchable

criterion - The linked SearchUICriterion

contentType - The content type on which this criterion definition applies. Can be empty if it applies to all types of contents.

tagProviderEP - The extension point for tag providers

jsonUtils - The JSON utils

Method Details

isEnumerated

public boolean isEnumerated()

Description copied from interface: SearchCriterionDefinition

Returns true if this criterion definition is enumerated

Specified by:

isEnumerated in interface SearchCriterionDefinition

Overrides:

isEnumerated in class AbstractDefaultSearchCriterionDefinition

Returns:

true if this criterion definition is enumerated

getEnumeratedValues

public Optional<EnumeratedValues> getEnumeratedValues(Map<String,Object> contextualParameters)

Description copied from interface: SearchCriterionDefinition

Gets the enumerated entries.
Must be non-empty if SearchCriterionDefinition.isEnumerated() returns true.

Specified by:

getEnumeratedValues in interface SearchCriterionDefinition

Overrides:

getEnumeratedValues in class AbstractDefaultSearchCriterionDefinition

Parameters:

contextualParameters - The contextual parameters

Returns:

the enumerated entries

getQuery

public Query getQuery(Object value,
 Query.Operator operator,
 String language,
 Map<String,Object> contextualParameters)

Description copied from interface: SearchCriterionDefinition

Gets the query associated to the given value

Specified by:

getQuery in interface SearchCriterionDefinition

Overrides:

getQuery in class ContentSearchCriterionDefinition

Parameters:

value - the value

operator - the operator

language - The current search language.

contextualParameters - the search contextual parameters.

Returns:

the query associated to the given value