Package org.ametys.cms.search.model.impl

Class AbstractStaticSearchModelCriterionDefinition<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.cms.search.model.impl.DefaultSearchModelCriterionDefinition<T>

org.ametys.cms.search.model.impl.AbstractStaticSearchModelCriterionDefinition<T>

Type Parameters:

T - Type of the criterion value

All Implemented Interfaces:

Comparable<ModelItem>, CriterionDefinition<T>, SearchModelCriterionDefinition<T>, ElementDefinition<T>, ModelItem, Labelable, ModifiableLabelable, Component, Configurable, Serviceable

Direct Known Subclasses:

CompatibleRegimesCriterionDefinition, ContentPrivacyCriterionDefinition, ExcludeSkillsOrphansCriterionDefinition, MicroSkillsAttachedToCourseCriterionDefinition, ODFContributorOrManagerCriterionDefinition, PageCriterionDefinition, ProgramItemContextCriterionDefinition, ReferencingAggregatorCriterionDefinition, ShareableCourseCriterionDefinition, StaticSolrFilterCriterionDefinition

public abstract class AbstractStaticSearchModelCriterionDefinition<T>
extends DefaultSearchModelCriterionDefinition<T>
implements Component, Serviceable, Configurable

Base class for static SearchModelCriterionDefinition

Field Summary

Fields

Modifier and Type	Field	Description
protected ModelItemTypeExtensionPoint	_criterionTypeExtensionPoint	The extension point containing all available criterion types

Fields inherited from class org.ametys.cms.search.model.impl.DefaultSearchModelCriterionDefinition

_operator

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
AbstractStaticSearchModelCriterionDefinition()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
IndexableElementType<T>	getType()	Retrieves the type.
protected abstract String	getTypeId()	Retrieves the id of the property's type
void	service(ServiceManager manager)
void	setMultipleOperandOperator(Query.LogicalOperator multipleOperand)	Set the the logical operator for multi-valued criteria
void	setOperator(Query.Operator operator)	Set the criterion Operator.

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

_getDefaultOperator, _toJSON, copyTo, getModel, getOperator, getQuery, toSAX

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

_getCriterionDefinitionHelper, _getDefaultWidget, _getDefaultWidgetParameters, convertQueryValue, getJoinedPaths, getMultipleOperandOperator, 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

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

_getModelItemHelper, _shouldJSONBeEmpty, _widgetParameterToSAX, addItemChecker, compareTo, disableConditionsToJSON, equals, getDescription, getDisableConditions, getItemCheckers, getLabel, getName, 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, getJoinedPaths, 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, getLabel, getName

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

addItemChecker, getDisableConditions, getItemCheckers, getParent, getPath, getPluginName, getWidget, getWidgetParameters, setDisableConditions, setModel, setParent, setPluginName, setType, setWidget, setWidgetParameters, toJSON

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

setDescription, setLabel, setName

Field Details

_criterionTypeExtensionPoint

protected ModelItemTypeExtensionPoint _criterionTypeExtensionPoint

The extension point containing all available criterion types

Constructor Details

AbstractStaticSearchModelCriterionDefinition

public AbstractStaticSearchModelCriterionDefinition()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

setOperator

public void setOperator(Query.Operator operator)

Description copied from interface: SearchModelCriterionDefinition

Set the criterion Operator.

Specified by:

setOperator in interface SearchModelCriterionDefinition<T>

Overrides:

setOperator in class DefaultSearchModelCriterionDefinition<T>

Parameters:

operator - the Operator to set.

setMultipleOperandOperator

public void setMultipleOperandOperator(Query.LogicalOperator multipleOperand)

Description copied from interface: SearchModelCriterionDefinition

Set the the logical operator for multi-valued criteria

Specified by:

setMultipleOperandOperator in interface SearchModelCriterionDefinition<T>

Overrides:

setMultipleOperandOperator in class DefaultSearchModelCriterionDefinition<T>

Parameters:

multipleOperand - the logical operator to set

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.

getTypeId

protected abstract String getTypeId()

Retrieves the id of the property's type

Returns:

the id of the property's type