Package org.ametys.plugins.forms.search.criteria

Class FormQuestionSearchCriterionDefinition<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>

org.ametys.plugins.forms.search.criteria.AbstractFormEntrySearchCriterionDefinition<T>

org.ametys.plugins.forms.search.criteria.FormQuestionSearchCriterionDefinition<T>

Type Parameters:

T - the type of the criterion value

All Implemented Interfaces:

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

public class FormQuestionSearchCriterionDefinition<T>
extends AbstractFormEntrySearchCriterionDefinition<T>

Form question search criterion definition, based on a form question. The criterion definition is used to create search criteria based on form questions, and to provide information about the criterion (label, widget, etc.).

Field Summary

Fields

Modifier and Type	Field	Description
protected FormQuestion	_question	The form question on which the criterion is based

Fields inherited from class org.ametys.plugins.forms.search.criteria.AbstractFormEntrySearchCriterionDefinition

_form, _formEntryDAO, _modelItemTypeEP, _userManager

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

_criterionTypeExtensionPoint, _searchServiceCriterionDefinitionHelper

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
FormQuestionSearchCriterionDefinition(FormQuestion question)	Constructor of the criterion definition for a form question

Method Summary

Modifier and Type	Method	Description
Enumerator<T>	getEnumerator()	Retrieves the enumerator.
Optional<I18nizableText>	getFacetLabel(String value, Map<String,Object> contextualParameters)	Gets the label of a facet value
String	getModelItemId()	Get the model item id of the form entry on which the criterion is based.
I18nizableText	getModelItemLabel()	Get the model item label of the form entry on which the criterion is based.
String	getSolrFacetFieldName(Map<String,Object> contextualParameters)	Retrieves the name of the criterion's solr facet field
String	getWidget()	Retrieves the widget to use for rendering.
Map<String,I18nizableText>	getWidgetParameters()	Get the widget's parameters
boolean	isMultiple()	Test if the element is multiple.

Methods inherited from class org.ametys.plugins.forms.search.criteria.AbstractFormEntrySearchCriterionDefinition

getEmptyValueQuery, getFormEntryDAO, getJoinedPaths, getLabel, getModelItemTypeEP, getName, getSearchable, getType, getUserManager, setSearchable

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

_getCriterionTypeExtensionPoint, _getSearchServiceCriterionDefinitionHelper, _toJSON, dispose, getRestrictedEnumerator, isEnumerated, isTooBigForStaticEnumerator

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

_getCriterionDefinitionHelper, _getDefaultWidget, _getDefaultWidgetParameters, convertQueryValue, getMultipleOperandOperator, getQuery, getQueryContext, setJoinedPaths, setSolrFacetFieldName

Methods inherited from class org.ametys.runtime.model.DefaultElementDefinition

_defaultValueToJSON, _getDefaultValues, _getSimpleDefaultValue, _widgetToJSON, _widgetToSAX, getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumeratorConfiguration, getParsedDefaultValues, getValidator, getValidatorConfiguration, 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, getModel, 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, getQuery, getQuery, getQuery

Methods inherited from interface org.ametys.runtime.model.ElementDefinition

getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumeratorConfiguration, getParsedDefaultValues, getValidator, getValidatorConfiguration, isEditable, setCustomEnumerator, setCustomValidator, setDefaultValue, setEnumerator, setEnumeratorConfiguration, setMultiple, setParsedDefaultValues, setValidator, setValidatorConfiguration

Methods inherited from interface org.ametys.runtime.util.Labelable

getDescription

Methods inherited from interface org.ametys.runtime.model.ModelItem

addItemChecker, getDisableConditions, getItemCheckers, getModel, getParent, getPath, getPluginName, 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, getContextPrefixLabel

Field Details

_question

protected FormQuestion _question

The form question on which the criterion is based

Constructor Details

FormQuestionSearchCriterionDefinition

public FormQuestionSearchCriterionDefinition(FormQuestion question)

Constructor of the criterion definition for a form question

Parameters:

question - the form question

Method Details

getModelItemLabel

public I18nizableText getModelItemLabel()

Description copied from class: AbstractFormEntrySearchCriterionDefinition

Get the model item label of the form entry on which the criterion is based.

Specified by:

getModelItemLabel in class AbstractFormEntrySearchCriterionDefinition<T>

Returns:

the model item label of the form entry on which the criterion is based.

getModelItemId

public String getModelItemId()

Description copied from class: AbstractFormEntrySearchCriterionDefinition

Get the model item id of the form entry on which the criterion is based.

Specified by:

getModelItemId in class AbstractFormEntrySearchCriterionDefinition<T>

Returns:

the model item id of the form entry on which the criterion is based.

getWidget

public String getWidget()

Description copied from interface: ModelItem

Retrieves the widget to use for rendering.

Specified by:

getWidget in interface ModelItem

Overrides:

getWidget in class AbstractCriterionDefinition<T>

Returns:

the widget or null if none is defined.

getWidgetParameters

public Map<String,I18nizableText> getWidgetParameters()

Description copied from interface: ModelItem

Get the widget's parameters

Specified by:

getWidgetParameters in interface ModelItem

Overrides:

getWidgetParameters in class AbstractCriterionDefinition<T>

Returns:

the widget's parameters

isMultiple

public boolean isMultiple()

Description copied from interface: ElementDefinition

Test if the element is multiple.

Specified by:

isMultiple in interface ElementDefinition<T>

Overrides:

isMultiple in class DefaultElementDefinition<T>

Returns:

true if the metadata is multiple.

getEnumerator

public Enumerator<T> getEnumerator()

Description copied from interface: ElementDefinition

Retrieves the enumerator.

Specified by:

getEnumerator in interface ElementDefinition<T>

Overrides:

getEnumerator in class DefaultElementDefinition<T>

Returns:

the enumerator or null if none is defined.

getSolrFacetFieldName

public String getSolrFacetFieldName(Map<String,Object> contextualParameters)

Description copied from interface: CriterionDefinition

Retrieves the name of the criterion's solr facet field

Specified by:

getSolrFacetFieldName in interface CriterionDefinition<T>

Overrides:

getSolrFacetFieldName in class AbstractCriterionDefinition<T>

Parameters:

contextualParameters - the search contextual parameters.

Returns:

the name of the criterion's solr facet field. Can be null if the criterion is not facetable

getFacetLabel

public Optional<I18nizableText> getFacetLabel(String value,
 Map<String,Object> contextualParameters)

Description copied from class: AbstractFormEntrySearchCriterionDefinition

Gets the label of a facet value

Overrides:

getFacetLabel in class AbstractFormEntrySearchCriterionDefinition<T>

Parameters:

value - the facet value

contextualParameters - the contextual parameters

Returns:

the label of a facet value