Package org.ametys.cms.model.properties

Class AbstractElementsReferencingProperty<T,C,X extends ModelAwareDataAwareAmetysObject>

java.lang.Object

org.ametys.runtime.model.AbstractModelItem

org.ametys.runtime.model.DefaultElementDefinition<T>

org.ametys.cms.model.properties.AbstractProperty<T,X>

org.ametys.cms.model.properties.AbstractStaticProperty<T,X>

org.ametys.cms.model.properties.AbstractIndexableStaticProperty<T,C,X>

org.ametys.cms.model.properties.AbstractElementsReferencingProperty<T,C,X>

Type Parameters:

T - Type of the property values

C - Type of criterion

X - Type of ametys object supported by this property

All Implemented Interfaces:

Comparable<ModelItem>, Property<T,X>, ReferencingProperty<T,X>, CriterionDefinitionAwareElementDefinition<T,C,X>, IndexationAwareElementDefinition<T,X>, ElementDefinition<T>, ModelItem, PluginAware, Labelable, ModifiableLabelable, Configurable, Contextualizable, Serviceable

Direct Known Subclasses:

AbstractMultiValuesProperty, ElementReferencingProperty

public abstract class AbstractElementsReferencingProperty<T,C,X extends ModelAwareDataAwareAmetysObject>
extends AbstractIndexableStaticProperty<T,C,X>
implements ReferencingProperty<T,X>

Abstract implementation for a property referencing ElementDefinitions

Field Summary

Fields inherited from class org.ametys.cms.model.properties.AbstractIndexableStaticProperty

_criterionDefinitionHelper, _indexationAwareElementDefinitionHelper

Fields inherited from class org.ametys.cms.model.properties.AbstractStaticProperty

_context

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

Method Summary

Modifier and Type	Method	Description
protected ElementDefinition<T>	_getReferenceDefinition(String reference)	Retrieves the definition of the given referenced element
protected I18nizableText	_parseDescription(Configuration configuration)	Parses the description of the property
protected I18nizableText	_parseLabel(Configuration configuration)	Parses the label of the property
void	configure(Configuration configuration)
protected abstract void	configureReferences(Configuration configuration)	Configures the references
I18nizableText	getDescription()	Retrieves the description.
I18nizableText	getLabel()	Retrieves the label.
String	getName()	Get the name.
void	init(String availableTypesRole)	Used to do more initialization, checks...

Methods inherited from class org.ametys.cms.model.properties.AbstractIndexableStaticProperty

getCriterionType, getCriterionTypeId, getSolrSortFieldName, service

Methods inherited from class org.ametys.cms.model.properties.AbstractStaticProperty

_getNameConfigurationAttribute, _parseAndSetEnumerator, _parseName, contextualize

Methods inherited from class org.ametys.cms.model.properties.AbstractProperty

getType, getTypeId, isEditable, setPluginInfo

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

_defaultValueToJSON, _getDefaultValues, _getSimpleDefaultValue, _toJSON, _widgetToJSON, _widgetToSAX, getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, getEnumeratorConfiguration, getParsedDefaultValues, getValidator, getValidatorConfiguration, getWidget, getWidgetParameters, 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, 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.CriterionDefinitionAwareElementDefinition

convertQueryValue, getDefaultCriterionEnumerator, getDefaultCriterionOperator, getDefaultCriterionWidget, getDefaultCriterionWidgetParameters, getQuery

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.cms.search.model.IndexationAwareElementDefinition

getSolrFacetFieldName, getSolrFieldName, getType, getValue, indexValue, isFacetable, isSortable

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.cms.model.properties.Property

getType, getValue, valueToJSON, valueToSAX

Methods inherited from interface org.ametys.cms.model.properties.ReferencingProperty

getReferences

Constructor Details

AbstractElementsReferencingProperty

public AbstractElementsReferencingProperty()

Method Details

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class AbstractStaticProperty<T,X extends ModelAwareDataAwareAmetysObject>

Throws:

ConfigurationException

_parseLabel

protected I18nizableText _parseLabel(Configuration configuration)
                              throws ConfigurationException

Description copied from class: AbstractStaticProperty

Parses the label of the property

Overrides:

_parseLabel in class AbstractStaticProperty<T,X extends ModelAwareDataAwareAmetysObject>

Parameters:

configuration - the property configuration to use.

Returns:

the label of the property.

Throws:

ConfigurationException - if the configuration is not valid.

_parseDescription

protected I18nizableText _parseDescription(Configuration configuration)
                                    throws ConfigurationException

Description copied from class: AbstractStaticProperty

Parses the description of the property

Overrides:

_parseDescription in class AbstractStaticProperty<T,X extends ModelAwareDataAwareAmetysObject>

Parameters:

configuration - the property configuration to use.

Returns:

the description of the property.

Throws:

ConfigurationException - if the configuration is not valid.

configureReferences

protected abstract void configureReferences(Configuration configuration)
                                     throws ConfigurationException

Configures the references

Parameters:

configuration - the property configuration

Throws:

ConfigurationException - if an error occurred

init

public void init(String availableTypesRole)
          throws Exception

Description copied from interface: Property

Used to do more initialization, checks... needing the role of extension point containing the types available for this property Called by Model parsing when the model items of all models have been initialized.

Specified by:

init in interface Property<T,C>

Overrides:

init in class AbstractProperty<T,X extends ModelAwareDataAwareAmetysObject>

Parameters:

availableTypesRole - the extension point's role for available types

Throws:

Exception - if an error occurs or if an additional check fails.

_getReferenceDefinition

protected ElementDefinition<T> _getReferenceDefinition(String reference)

Retrieves the definition of the given referenced element

Parameters:

reference - the reference

Returns:

the referenced element's definition

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.

getDescription

public I18nizableText getDescription()

Description copied from interface: Labelable

Retrieves the description.

Specified by:

getDescription in interface Labelable

Overrides:

getDescription in class AbstractModelItem

Returns:

the description.