Package org.ametys.cms.model.properties

Class ElementReferencingProperty<T,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.AbstractElementsReferencingProperty<T,X>

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

Type Parameters:

T - Type of the element value

X - Type of ametys object supported by this property

All Implemented Interfaces:

Comparable<ModelItem>, Property<T,X>, ReferencingProperty<T,X>, ElementDefinition<T>, ModelItem, PluginAware, Labelable, ModifiableLabelable, Configurable

Direct Known Subclasses:

ContentElementReferencingProperty

public class ElementReferencingProperty<T,X extends ModelAwareDataAwareAmetysObject>
extends AbstractElementsReferencingProperty<T,X>

Property referencing an ElementDefinition

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_reference	The path to the referenced element

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

_availableTypesExtensionPoint

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

_logger

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

__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
ElementReferencingProperty()

Method Summary

Modifier and Type	Method	Description
protected String	_getTypeId()	Retrieves the id of the property's type
protected void	configureReferences(Configuration configuration)	Configures the references
Enumerator	getCriterionEnumerator(Configuration configuration, ThreadSafeComponentManager<Enumerator> enumeratorManager)	Get the enumerator to use when rendering this element as a criterion
String	getCriterionWidget()	Get the default widget to use when rendering this item as a criterion.
Map<String,I18nizableText>	getCriterionWidgetParameters(Configuration configuration)	Get the widget parameters to use when rendering this item as a criterion.
Enumerator<T>	getEnumerator()	Retrieves the enumerator.
List<String>	getReferences()	Retrieves the paths of the referenced model items
Object	getValue(X ametysObject)	Get the property's value
boolean	isMultiple()	Test if the element is multiple.

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

_getReferenceDefinition, _parseI18nizableText, configure, getDescription, getLabel, getName, indexValue, initializeAfterModelItemsInitialization

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

_getNameConfigurationAttribute, getType, isEditable, setAvailableTypeExtensionPoint, setPluginInfo

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

_getDefaultValues, _toJSON, _widgetToJSON, _widgetToSAX, getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumeratorConfiguration, getParsedDefaultValues, getValidator, getValidatorConfiguration, getWidget, getWidgetParameters, 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, 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.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.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, setAvailableTypeExtensionPoint, valueToJSON, valueToSAX

Field Details

_reference

protected String _reference

The path to the referenced element

Constructor Details

ElementReferencingProperty

public ElementReferencingProperty()

Method Details

configureReferences

protected void configureReferences(Configuration configuration)
                            throws ConfigurationException

Description copied from class: AbstractElementsReferencingProperty

Configures the references

Specified by:

configureReferences in class AbstractElementsReferencingProperty<T,X extends ModelAwareDataAwareAmetysObject>

Parameters:

configuration - the property configuration

Throws:

ConfigurationException - if an error occurred

getReferences

public List<String> getReferences()

Description copied from interface: ReferencingProperty

Retrieves the paths of the referenced model items

Returns:

the paths of the referenced model items

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.

getValue

public Object getValue(X ametysObject)

Description copied from interface: Property

Get the property's value

Parameters:

ametysObject - the ametysObject containing the property

Returns:

the values to index.

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.

_getTypeId

protected String _getTypeId()

Description copied from class: AbstractProperty

Retrieves the id of the property's type

Specified by:

_getTypeId in class AbstractProperty<T,X extends ModelAwareDataAwareAmetysObject>

Returns:

the id of the property's type

getCriterionEnumerator

public Enumerator getCriterionEnumerator(Configuration configuration,
 ThreadSafeComponentManager<Enumerator> enumeratorManager)
                                  throws ConfigurationException

Description copied from interface: ElementDefinition

Get the enumerator to use when rendering this element as a criterion

Parameters:

configuration - The enumerator configuration.

enumeratorManager - ComponentManager for the criterion's Enumerator

Returns:

The enumerator or null if the element'critérion is not enumerated.

Throws:

ConfigurationException - If an error occurs while initializing the enumerator

getCriterionWidget

public String getCriterionWidget()

Description copied from interface: ModelItem

Get the default widget to use when rendering this item as a criterion.

Returns:

The default widget to use, or null if no specific widget is necessary.

getCriterionWidgetParameters

public Map<String,I18nizableText> getCriterionWidgetParameters(Configuration configuration)

Description copied from interface: ModelItem

Get the widget parameters to use when rendering this item as a criterion.

Parameters:

configuration - The widget parameters configuration

Returns:

The default widget parameters to use, or an empty Map if no specific widget parameters are necessary.