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

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

Type Parameters:

T - the type of the criterion value

All Implemented Interfaces:

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

Direct Known Subclasses:

FormEntryAuthorSearchCriterionDefinition, FormEntryLastUpdateSearchCriterionDefinition, FormEntrySubmissionDateSearchCriterionDefinition, FormEntryWorkflowStepSearchCriterionDefinition, FormQuestionSearchCriterionDefinition

public abstract class AbstractFormEntrySearchCriterionDefinition<T>
extends AbstractSearchServiceCriterionDefinition<T>

SearchServiceCriterionDefinition for form entry

Field Summary

Fields

Modifier and Type	Field	Description
protected Form	_form	The form on which the criterion is based
protected FormEntryDAO	_formEntryDAO	The form entry DAO
protected ModelItemTypeExtensionPoint	_modelItemTypeEP	The model item type extension point
protected UserManager	_userManager	The user manager

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
AbstractFormEntrySearchCriterionDefinition(Form form)	The constructor of the criterion definition.

Method Summary

Modifier and Type	Method	Description
Query	getEmptyValueQuery(String language, Map<String,Object> contextualParameters)	Gets the query for testing the value is empty
Optional<I18nizableText>	getFacetLabel(String value, Map<String,Object> contextualParameters)	Gets the label of a facet value
protected FormEntryDAO	getFormEntryDAO()	Retrieves the FormEntryDAO
List<String>	getJoinedPaths(Map<String,Object> contextualParameters)	Retrieves the joined paths of the criterion
I18nizableText	getLabel()	Retrieves the label.
abstract String	getModelItemId()	Get the model item id of the form entry on which the criterion is based.
abstract I18nizableText	getModelItemLabel()	Get the model item label of the form entry on which the criterion is based.
protected ModelItemTypeExtensionPoint	getModelItemTypeEP()	Retrieves the ModelItemTypeExtensionPoint
String	getName()	Get the name.
Optional<Searchable>	getSearchable()	Gets the (Searchable) the criterion belongs to.
IndexableElementType<T>	getType()	Retrieves the type.
protected UserManager	getUserManager()	Retrieves the UserManager
void	setSearchable(Searchable searchable)	Sets the (Searchable) the criterion belongs to.

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, getSolrFacetFieldName, getWidget, getWidgetParameters, setJoinedPaths, setSolrFacetFieldName

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

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

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

getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, getEnumeratorConfiguration, getParsedDefaultValues, getValidator, getValidatorConfiguration, isEditable, isMultiple, 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, getWidget, getWidgetParameters, 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

_form

protected Form _form

The form on which the criterion is based

_userManager

protected UserManager _userManager

The user manager

_formEntryDAO

protected FormEntryDAO _formEntryDAO

The form entry DAO

_modelItemTypeEP

protected ModelItemTypeExtensionPoint _modelItemTypeEP

The model item type extension point

Constructor Details

AbstractFormEntrySearchCriterionDefinition

public AbstractFormEntrySearchCriterionDefinition(Form form)

The constructor of the criterion definition.

Parameters:

form - The form on which the criterion is based

Method Details

getName

public String getName()

Description copied from interface: Labelable

Get the name.

Specified by:

getName in interface Labelable

Overrides:

getName in class AbstractModelItem

Returns:

the name.

getLabel

public I18nizableText getLabel()

Description copied from interface: Labelable

Retrieves the label.

Specified by:

getLabel in interface Labelable

Overrides:

getLabel in class AbstractModelItem

Returns:

the label.

getType

public IndexableElementType<T> getType()

Description copied from interface: ModelItem

Retrieves the type.

Specified by:

getType in interface CriterionDefinition<T>

Specified by:

getType in interface ElementDefinition<T>

Specified by:

getType in interface ModelItem

Overrides:

getType in class AbstractCriterionDefinition<T>

Returns:

the type.

getJoinedPaths

public List<String> getJoinedPaths(Map<String,Object> contextualParameters)

Description copied from interface: CriterionDefinition

Retrieves the joined paths of the criterion

Specified by:

getJoinedPaths in interface CriterionDefinition<T>

Overrides:

getJoinedPaths in class AbstractCriterionDefinition<T>

Parameters:

contextualParameters - the search contextual parameters.

Returns:

the joined paths, or an empty list if the criterion is not joined

getSearchable

public Optional<Searchable> getSearchable()

Description copied from interface: SearchServiceCriterionDefinition

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 SearchServiceCriterionDefinition<T>

Overrides:

getSearchable in class AbstractSearchServiceCriterionDefinition<T>

Returns:

the (Searchable) the criterion belongs to.

setSearchable

public void setSearchable(Searchable searchable)

Description copied from interface: SearchServiceCriterionDefinition

Sets the (Searchable) the criterion belongs to.

Specified by:

setSearchable in interface SearchServiceCriterionDefinition<T>

Overrides:

setSearchable in class AbstractSearchServiceCriterionDefinition<T>

Parameters:

searchable - the Searchable to set

getFacetLabel

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

Gets the label of a facet value

Parameters:

value - the facet value

contextualParameters - the contextual parameters

Returns:

the label of a facet value

getEmptyValueQuery

public Query getEmptyValueQuery(String language,
 Map<String,Object> contextualParameters)

Description copied from interface: SearchServiceCriterionDefinition

Gets the query for testing the value is empty

Parameters:

language - The current search language.

contextualParameters - the search contextual parameters.

Returns:

the query for testing the value is empty

getUserManager

protected UserManager getUserManager()

Retrieves the UserManager

Returns:

the UserManager

getFormEntryDAO

protected FormEntryDAO getFormEntryDAO()

Retrieves the FormEntryDAO

Returns:

the FormEntryDAO

getModelItemTypeEP

protected ModelItemTypeExtensionPoint getModelItemTypeEP()

Retrieves the ModelItemTypeExtensionPoint

Returns:

the ModelItemTypeExtensionPoint

getModelItemId

public abstract String getModelItemId()

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

Returns:

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

getModelItemLabel

public abstract I18nizableText getModelItemLabel()

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

Returns:

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