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
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description (package private) static class
TagSearchCriterionDefinition.TagEnumeratedValues
(package private) static class
TagSearchCriterionDefinition.TagRestrictedValues
-
Field Summary
Fields Modifier and Type Field Description (package private) JSONUtils
_jsonUtils
(package private) TagProviderExtensionPoint
_tagProviderEP
-
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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description private Object
_tryToParseJson(Object value)
private static String
_widget()
private static Map<String,I18nizableText>
_widgetParameters(SearchUICriterion criterion)
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 valueboolean
isEnumerated()
Returnstrue
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
-
-
-
-
Field Detail
-
_tagProviderEP
TagProviderExtensionPoint _tagProviderEP
-
_jsonUtils
JSONUtils _jsonUtils
-
-
Constructor Detail
-
TagSearchCriterionDefinition
public TagSearchCriterionDefinition(String id, String pluginName, Optional<Searchable> searchable, SearchUICriterion criterion, Optional<ContentType> contentType, TagProviderExtensionPoint tagProviderEP, JSONUtils jsonUtils)
Default constructor- Parameters:
id
- The idpluginName
- The plugin namesearchable
- theSearchable
criterion
- The linkedSearchUICriterion
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 providersjsonUtils
- The JSON utils
-
-
Method Detail
-
_widgetParameters
private static Map<String,I18nizableText> _widgetParameters(SearchUICriterion criterion)
-
isEnumerated
public boolean isEnumerated()
Description copied from interface:SearchCriterionDefinition
Returnstrue
if this criterion definition is enumerated- Specified by:
isEnumerated
in interfaceSearchCriterionDefinition
- Overrides:
isEnumerated
in classAbstractDefaultSearchCriterionDefinition
- 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
ifSearchCriterionDefinition.isEnumerated()
returnstrue
.- Specified by:
getEnumeratedValues
in interfaceSearchCriterionDefinition
- Overrides:
getEnumeratedValues
in classAbstractDefaultSearchCriterionDefinition
- 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 interfaceSearchCriterionDefinition
- Overrides:
getQuery
in classContentSearchCriterionDefinition
- Parameters:
value
- the valueoperator
- the operatorlanguage
- The current search language.contextualParameters
- the search contextual parameters.- Returns:
- the query associated to the given value
-
_tryToParseJson
private Object _tryToParseJson(Object value)
-
-