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

Class AbstractDefaultSearchCriterionDefinition

java.lang.Object

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

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

All Implemented Interfaces:

SearchCriterionDefinition

Direct Known Subclasses:

ContentSearchCriterionDefinition, DublinCoreSearchCriterionDefinition, PageSearchCriterionDefinition, PageTitleSearchCriterionDefinition, SitemapSearchCriterionDefinition, SiteSearchCriterionDefinition, WordingSearchCriterionDefinition

public abstract class AbstractDefaultSearchCriterionDefinition
extends Parameter<MetadataType>
implements SearchCriterionDefinition

Default implementation of SearchCriterionDefinition

Constructor Summary

Constructors

Constructor	Description
AbstractDefaultSearchCriterionDefinition(String id, String pluginName, I18nizableText label, MetadataType type, Optional<String> widget, Optional<Map<String,I18nizableText>> widgetParams, Optional<Enumerator> enumerator, Optional<Validator> validator, Optional<Object> defaultValue, Optional<Searchable> searchable)	Constructs a SearchCriterionDefinition

Method Summary

Modifier and Type	Method	Description
protected void	dispose()	Releases and destroys any resource it owns.
Optional<EnumeratedValues>	getEnumeratedValues(Map<String,Object> contextualParameters)	Gets the enumerated entries.
Optional<Searchable>	getSearchable()	Gets the (Searchable) the criterion belongs to.
boolean	isEnumerated()	Returns true if this criterion definition is enumerated
boolean	isTooBigForStaticEnumerator()	Returns true if this criterion definition is enumerated but can contains too much data
Map<String,Object>	toJSON()	Gets the JSON representation of this criterion definition

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

getContextPrefixLabels, getEmptyValueQuery, getId, getLabel, getQuery, getType, getValidator, getWidget, getWidgetParameters

Constructor Details

AbstractDefaultSearchCriterionDefinition

public AbstractDefaultSearchCriterionDefinition(String id,
 String pluginName,
 I18nizableText label,
 MetadataType type,
 Optional<String> widget,
 Optional<Map<String,I18nizableText>> widgetParams,
 Optional<Enumerator> enumerator,
 Optional<Validator> validator,
 Optional<Object> defaultValue,
 Optional<Searchable> searchable)

Constructs a SearchCriterionDefinition

Parameters:

id - The id

pluginName - The plugin name

label - The label

type - The type

widget - The widget

widgetParams - The widget parameters

enumerator - The enumerator

validator - The validator

defaultValue - The default value

searchable - the Searchable

Method Details

getSearchable

public Optional<Searchable> getSearchable()

Description copied from interface: SearchCriterionDefinition

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 SearchCriterionDefinition

Returns:

the (Searchable) the criterion belongs to.

isEnumerated

public boolean isEnumerated()

Description copied from interface: SearchCriterionDefinition

Returns true if this criterion definition is enumerated

Specified by:

isEnumerated in interface SearchCriterionDefinition

Returns:

true if this criterion definition is enumerated

isTooBigForStaticEnumerator

public boolean isTooBigForStaticEnumerator()

Description copied from interface: SearchCriterionDefinition

Returns true if this criterion definition is enumerated but can contains too much data

Specified by:

isTooBigForStaticEnumerator in interface SearchCriterionDefinition

Returns:

true if this criterion definition is enumerated but can contains too much data

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

Parameters:

contextualParameters - The contextual parameters

Returns:

the enumerated entries

toJSON

public Map<String,Object> toJSON()
                          throws Exception

Description copied from interface: SearchCriterionDefinition

Gets the JSON representation of this criterion definition

Specified by:

toJSON in interface SearchCriterionDefinition

Returns:

the JSON representation of this criterion definition

Throws:

Exception - if an exception occurs

dispose

protected void dispose()

Releases and destroys any resource it owns.