Package org.ametys.cms.data.holder.group.impl

Class DefaultModifiableIndexableComposite

java.lang.Object

org.ametys.plugins.repository.data.holder.group.impl.DefaultModelAwareComposite

org.ametys.plugins.repository.data.holder.group.impl.DefaultModifiableModelAwareComposite

org.ametys.cms.data.holder.group.impl.DefaultModifiableIndexableComposite

All Implemented Interfaces:

IndexableComposite, ModifiableIndexableComposite, IndexableDataHolder, ModifiableIndexableDataHolder, DataHolder, Composite, ModelAwareComposite, ModifiableComposite, ModifiableModelAwareComposite, ModelAwareDataHolder, ModifiableDataHolder, ModifiableModelAwareDataHolder

public class DefaultModifiableIndexableComposite
extends DefaultModifiableModelAwareComposite
implements ModifiableIndexableComposite

Class for modifiable indexable composites

Field Summary

Fields inherited from class org.ametys.plugins.repository.data.holder.group.impl.DefaultModifiableModelAwareComposite

_modifiableDefaultDataHolder, _modifiableRepositoryData

Fields inherited from class org.ametys.plugins.repository.data.holder.group.impl.DefaultModelAwareComposite

_defaultDataHolder, _definition, _repositoryData

Fields inherited from interface org.ametys.plugins.repository.data.holder.ModelAwareDataHolder

ALTERNATIVE_SUFFIX, STATUS_SUFFIX

Constructor Summary

Constructors

Constructor	Description
DefaultModifiableIndexableComposite(ModifiableRepositoryData repositoryData, ModelItemGroup definition, Optional<LockableAmetysObject> lockableAmetysObject, ModifiableIndexableDataHolder parent, ModifiableIndexableDataHolder root)	Creates a default modifiable indexable composite

Method Summary

Modifier and Type	Method	Description
ModifiableIndexableDataHolder	getDefaultDataHolder()	Retrieves the default implementation of a DataHolder to use
ModifiableIndexableRepeater	getExternalRepeater(String repeaterPath)	Retrieves the external repeater at the given path
ModifiableIndexableRepeater	getLocalRepeater(String repeaterPath)	Retrieves the local repeater at the given path
ModifiableIndexableRepeater	getRepeater(String repeaterPath)	Retrieves the repeater at the given path

Methods inherited from class org.ametys.plugins.repository.data.holder.group.impl.DefaultModifiableModelAwareComposite

getRepositoryData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.ametys.plugins.repository.data.holder.group.Composite

dataToJSON, dataToSAX, dataToSAX, getDataNames, getModelItemTypeExtensionPoint, getType, getValue, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, hasDifferences, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple

Methods inherited from interface org.ametys.plugins.repository.data.holder.DataHolder

copyTo, copyTo, dataToJSON, dataToSAX

Methods inherited from interface org.ametys.plugins.repository.data.holder.group.ModelAwareComposite

dataToJSON, dataToJSON, dataToJSON, dataToJSONForEdition, dataToMap, dataToSAX, dataToSAX, dataToSAXForEdition, getDataNames, getDefinition, getDifferences, getDifferences, getDifferences, getDifferences, getExternalValue, getLocalValue, getModel, getModelItemTypeExtensionPoint, getStatus, getType, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, getValueWithMultiValuedPathSegments, hasDefinition, hasDifferences, hasDifferences, hasDifferences, hasDifferences, hasExternalValue, hasExternalValueOrEmpty, hasLocalValue, hasLocalValueOrEmpty, hasValue, isMultiple, isMultiple

Methods inherited from interface org.ametys.plugins.repository.data.holder.ModelAwareDataHolder

dataToJSON, dataToJSON, dataToMap, dataToMap, dataToMap, dataToSAX, dataToSAX

Methods inherited from interface org.ametys.plugins.repository.data.holder.group.ModifiableComposite

removeValue, synchronizeValues

Methods inherited from interface org.ametys.plugins.repository.data.holder.ModifiableDataHolder

getRepositoryData

Methods inherited from interface org.ametys.cms.data.holder.group.ModifiableIndexableComposite

getComposite, getComposite, getExternalComposite, getExternalComposite, getExternalRepeater, getLocalComposite, getLocalComposite, getLocalRepeater, getParentDataHolder, getRepeater, getRootDataHolder

Methods inherited from interface org.ametys.plugins.repository.data.holder.group.ModifiableModelAwareComposite

getComposite, getExternalComposite, getLocalComposite, getParentDataHolder, getRootDataHolder, removeExternalizableMetadataIfExists, removeExternalValue, removeLocalValue, setExternalValue, setLocalValue, setStatus, setValue, setValue, synchronizeValues, synchronizeValues, synchronizeValues

Methods inherited from interface org.ametys.plugins.repository.data.holder.ModifiableModelAwareDataHolder

setValue, setValue

Constructor Details

DefaultModifiableIndexableComposite

public DefaultModifiableIndexableComposite(ModifiableRepositoryData repositoryData,
 ModelItemGroup definition,
 Optional<LockableAmetysObject> lockableAmetysObject,
 ModifiableIndexableDataHolder parent,
 ModifiableIndexableDataHolder root)

Creates a default modifiable indexable composite

Parameters:

repositoryData - the repository data of the composite

definition - the definition of the composite

lockableAmetysObject - the ametys object that can be locked on data modification

parent - the parent of the created DataHolder

root - the root DataHolder

Method Details

getDefaultDataHolder

public ModifiableIndexableDataHolder getDefaultDataHolder()

Description copied from interface: Composite

Retrieves the default implementation of a DataHolder to use

Specified by:

getDefaultDataHolder in interface Composite

Specified by:

getDefaultDataHolder in interface IndexableComposite

Specified by:

getDefaultDataHolder in interface ModelAwareComposite

Specified by:

getDefaultDataHolder in interface ModifiableComposite

Specified by:

getDefaultDataHolder in interface ModifiableIndexableComposite

Specified by:

getDefaultDataHolder in interface ModifiableModelAwareComposite

Overrides:

getDefaultDataHolder in class DefaultModifiableModelAwareComposite

Returns:

the DataHolder

getRepeater

public ModifiableIndexableRepeater getRepeater(String repeaterPath)
                                        throws IllegalArgumentException,
UndefinedItemPathException,
BadItemTypeException,
BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the repeater at the given path

Specified by:

getRepeater in interface IndexableComposite

Specified by:

getRepeater in interface IndexableDataHolder

Specified by:

getRepeater in interface ModelAwareComposite

Specified by:

getRepeater in interface ModelAwareDataHolder

Specified by:

getRepeater in interface ModifiableIndexableComposite

Specified by:

getRepeater in interface ModifiableIndexableDataHolder

Specified by:

getRepeater in interface ModifiableModelAwareComposite

Specified by:

getRepeater in interface ModifiableModelAwareDataHolder

Parameters:

repeaterPath - path of the repeater to retrieve

Returns:

the repeater or null if not exists or is empty

Throws:

IllegalArgumentException - if the given repeater path is null or empty

UndefinedItemPathException - if the given repeater path is not defined by the model

BadItemTypeException - if the stored value at the given path is not a repeater

BadDataPathCardinalityException - if the definition of a part of the data path is multiple. Only the last part can be multiple

getLocalRepeater

public ModifiableIndexableRepeater getLocalRepeater(String repeaterPath)
                                             throws IllegalArgumentException,
UndefinedItemPathException,
BadItemTypeException,
BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the local repeater at the given path

Specified by:

getLocalRepeater in interface IndexableComposite

Specified by:

getLocalRepeater in interface IndexableDataHolder

Specified by:

getLocalRepeater in interface ModelAwareComposite

Specified by:

getLocalRepeater in interface ModelAwareDataHolder

Specified by:

getLocalRepeater in interface ModifiableIndexableComposite

Specified by:

getLocalRepeater in interface ModifiableIndexableDataHolder

Specified by:

getLocalRepeater in interface ModifiableModelAwareComposite

Specified by:

getLocalRepeater in interface ModifiableModelAwareDataHolder

Parameters:

repeaterPath - path of the externalizable repeater to retrieve

Returns:

the repeater or null if not exists or is empty

Throws:

IllegalArgumentException - if the given repeater path is null or empty

UndefinedItemPathException - if the given repeater path is not defined by the model

BadItemTypeException - if the stored value at the given path is not a repeater

BadDataPathCardinalityException - if the definition of a part of the data path is multiple. Only the last part can be multiple

getExternalRepeater

public ModifiableIndexableRepeater getExternalRepeater(String repeaterPath)
                                                throws IllegalArgumentException,
UndefinedItemPathException,
BadItemTypeException,
BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the external repeater at the given path

Specified by:

getExternalRepeater in interface IndexableComposite

Specified by:

getExternalRepeater in interface IndexableDataHolder

Specified by:

getExternalRepeater in interface ModelAwareComposite

Specified by:

getExternalRepeater in interface ModelAwareDataHolder

Specified by:

getExternalRepeater in interface ModifiableIndexableComposite

Specified by:

getExternalRepeater in interface ModifiableIndexableDataHolder

Specified by:

getExternalRepeater in interface ModifiableModelAwareComposite

Specified by:

getExternalRepeater in interface ModifiableModelAwareDataHolder

Parameters:

repeaterPath - path of the externalizable repeater to retrieve

Returns:

the repeater or null if not exists or is empty

Throws:

IllegalArgumentException - if the given repeater path is null or empty

UndefinedItemPathException - if the given repeater path is not defined by the model

BadItemTypeException - if the stored value at the given path is not a repeater

BadDataPathCardinalityException - if the definition of a part of the data path is multiple. Only the last part can be multiple