org.ametys.cms.search.ui.model

Class DynamicWrappedSearchUIModel.WrappedSearchUICriterion

java.lang.Object

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

org.ametys.cms.search.ui.model.impl.AbstractSearchUICriterion

org.ametys.cms.search.ui.model.DynamicWrappedSearchUIModel.WrappedSearchUICriterion

All Implemented Interfaces:

Field, SearchCriterion, SearchUICriterion, Configurable, Serviceable

Enclosing class:

DynamicWrappedSearchUIModel

protected class DynamicWrappedSearchUIModel.WrappedSearchUICriterion
extends AbstractSearchUICriterion

Search criteria wrapper.

Field Summary

Fields

Modifier and Type	Field and Description
protected SearchUICriterion	_wrappedCriterion The wrapped search criteria.

Fields inherited from class org.ametys.cms.search.ui.model.impl.AbstractSearchUICriterion

_contentHelper, _cTypeEP, _resolver, _userManager, _userPopulationDAO

Constructor Summary

Constructors

Constructor and Description
WrappedSearchUICriterion(SearchUICriterion wrappedCriteria, Enumerator enumerator) Build a search criteria wrapper.

Method Summary

Modifier and Type	Method and Description
String	getChangeClassName() Get the JS class name to execute on 'change' event
String	getContentTypeId() Get the content type ID (only when the search criteria is of type CONTENT).
Object	getDefaultValue() Retrieves the default value.
I18nizableText	getDescription() Retrieves the description.
Enumerator	getEnumerator() Retrieves the enumerator.
String	getFieldId() Get the field identifier.
String	getId() Get the id.
String	getInitClassName() Get the JS class name to execute on 'init' event
I18nizableText	getLabel() Retrieves the label.
Query.Operator	getOperator() Get the criterion Operator.
Query	getQuery(Object value, Query.Operator customOperator, Map<String,Object> allValues, String language, Map<String,Object> contextualParameters) Get the Query associated to the given value.
String	getSubmitClassName() Get the JS class name to execute on 'submit' event
MetadataType	getType() Retrieves the type.
Validator	getValidator() Retrieves the validator.
String	getWidget() Retrieves the widget to use for rendering.
Map<String,I18nizableText>	getWidgetParameters() Get the widget's parameters
boolean	isHidden() Determines if the criteria is hidden
boolean	isMultiple() Determines if the column value is multiple

Methods inherited from class org.ametys.cms.search.ui.model.impl.AbstractSearchUICriterion

_configureI18nizableText, _initializeValidator, configure, configureId, configureLabelsAndGroup, configureUIProperties, configureValues, configureWidget, configureWidgetParameters, getFacetLabel, getGroup, getMetadataDefinition, getSearchField, service, setChangeClassName, setContentTypeId, setGroup, setHidden, setInitClassName, setMultiple, setSubmitClassName

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

getPluginName, 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.cms.search.model.SearchCriterion

getQuery, isFacetable, isFacetable, isSortable, isSortable

Field Detail

_wrappedCriterion

protected SearchUICriterion _wrappedCriterion

The wrapped search criteria.

Constructor Detail

WrappedSearchUICriterion

public WrappedSearchUICriterion(SearchUICriterion wrappedCriteria,
                                Enumerator enumerator)

Build a search criteria wrapper.

Parameters:

wrappedCriteria - wrapped search criteria.

enumerator - the new enumerator.

Method Detail

getEnumerator

public Enumerator getEnumerator()

Description copied from class: Parameter

Retrieves the enumerator.

Specified by:

getEnumerator in interface Field

Overrides:

getEnumerator in class Parameter<MetadataType>

Returns:

the enumerator or null if none is defined.

getId

public String getId()

Description copied from class: Parameter

Get the id.

Specified by:

getId in interface SearchCriterion

Overrides:

getId in class Parameter<MetadataType>

Returns:

Returns the id.

getLabel

public I18nizableText getLabel()

Description copied from class: Parameter

Retrieves the label.

Specified by:

getLabel in interface SearchUICriterion

Overrides:

getLabel in class Parameter<MetadataType>

Returns:

the label.

getDescription

public I18nizableText getDescription()

Description copied from class: Parameter

Retrieves the description.

Specified by:

getDescription in interface SearchUICriterion

Overrides:

getDescription in class Parameter<MetadataType>

Returns:

the description.

getFieldId

public String getFieldId()

Description copied from interface: SearchUICriterion

Get the field identifier. Used to match standard, advanced and faceted criterion (even if the operator is different), whatever their ID is.

Returns:

the field identifier.

getInitClassName

public String getInitClassName()

Description copied from class: AbstractSearchUICriterion

Get the JS class name to execute on 'init' event

Specified by:

getInitClassName in interface SearchUICriterion

Overrides:

getInitClassName in class AbstractSearchUICriterion

Returns:

the JS class name to execute on 'init' event

getSubmitClassName

public String getSubmitClassName()

Description copied from class: AbstractSearchUICriterion

Get the JS class name to execute on 'submit' event

Specified by:

getSubmitClassName in interface SearchUICriterion

Overrides:

getSubmitClassName in class AbstractSearchUICriterion

Returns:

the JS class name to execute on 'submit' event

getChangeClassName

public String getChangeClassName()

Description copied from class: AbstractSearchUICriterion

Get the JS class name to execute on 'change' event

Specified by:

getChangeClassName in interface SearchUICriterion

Overrides:

getChangeClassName in class AbstractSearchUICriterion

Returns:

the JS class name to execute on 'change' event

isHidden

public boolean isHidden()

Description copied from class: AbstractSearchUICriterion

Determines if the criteria is hidden

Specified by:

isHidden in interface SearchUICriterion

Overrides:

isHidden in class AbstractSearchUICriterion

Returns:

true if the criteria is hidden

getType

public MetadataType getType()

Description copied from class: Parameter

Retrieves the type.

Specified by:

getType in interface Field

Overrides:

getType in class Parameter<MetadataType>

Returns:

the type.

isMultiple

public boolean isMultiple()

Description copied from class: AbstractSearchUICriterion

Determines if the column value is multiple

Specified by:

isMultiple in interface Field

Overrides:

isMultiple in class AbstractSearchUICriterion

Returns:

true if the value is multiple

getWidget

public String getWidget()

Description copied from class: Parameter

Retrieves the widget to use for rendering.

Specified by:

getWidget in interface SearchUICriterion

Overrides:

getWidget in class Parameter<MetadataType>

Returns:

the widget or null if none is defined.

getWidgetParameters

public Map<String,I18nizableText> getWidgetParameters()

Description copied from class: Parameter

Get the widget's parameters

Specified by:

getWidgetParameters in interface SearchUICriterion

Overrides:

getWidgetParameters in class Parameter<MetadataType>

Returns:

the widget's parameters

getValidator

public Validator getValidator()

Description copied from class: Parameter

Retrieves the validator.

Specified by:

getValidator in interface SearchUICriterion

Overrides:

getValidator in class Parameter<MetadataType>

Returns:

the validator or null if none is defined.

getDefaultValue

public Object getDefaultValue()

Description copied from class: Parameter

Retrieves the default value.

Specified by:

getDefaultValue in interface SearchUICriterion

Overrides:

getDefaultValue in class Parameter<MetadataType>

Returns:

the default value or null if none is defined.

getContentTypeId

public String getContentTypeId()

Description copied from class: AbstractSearchUICriterion

Get the content type ID (only when the search criteria is of type CONTENT).

Specified by:

getContentTypeId in interface Field

Overrides:

getContentTypeId in class AbstractSearchUICriterion

Returns:

the content type ID.

getOperator

public Query.Operator getOperator()

Description copied from interface: SearchCriterion

Get the criterion Operator.

Returns:

the criterion Operator.

getQuery

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

Description copied from interface: SearchCriterion

Get the Query associated to the given value.

Parameters:

value - The user-submitted value (or the default value if not set) for this criterion.

customOperator - In advanced search mode, the operator chosen by the user. null to use the criterion-defined operator (simple search mode).

allValues - All the user-submitted values.

language - The current search language.

contextualParameters - the search contextual parameters.

Returns:

Query associated to the given value.