Package org.ametys.plugins.repository.data.holder.group

Interface ModifiableComposite

All Superinterfaces:

Composite, DataHolder, ModifiableDataHolder

All Known Subinterfaces:

ModifiableIndexableComposite, ModifiableIndexableRepeaterEntry, ModifiableModelAwareComposite, ModifiableRepeaterEntry

All Known Implementing Classes:

DefaultModifiableComposite, DefaultModifiableIndexableComposite, DefaultModifiableIndexableRepeaterEntry, DefaultModifiableModelAwareComposite, DefaultModifiableRepeaterEntry

public interface ModifiableComposite
extends ModifiableDataHolder, Composite

Interface for modifiable composites

Method Summary

Modifier and Type	Method	Description
default ModifiableComposite	getComposite(String compositePath)	Retrieves the composite at the given path
default ModifiableComposite	getComposite(String compositePath, boolean createNew)	Retrieves the composite at the given path
ModifiableDataHolder	getDefaultDataHolder()	Retrieves the default implementation of a DataHolder to use
default Optional<? extends ModifiableDataHolder>	getParentDataHolder()	Retrieves the optional parent of the current DataHolder There can be no parent if the current DataHolder is the root
default ModifiableDataHolder	getRootDataHolder()	Retrieves the DataHolder that is the root of the current one
default void	removeValue(String dataPath)	Removes the stored value of the data at the given path
default void	setValue(String dataPath, Object value)	Sets the value of the data at the given path
default void	setValue(String dataPath, Object value, String dataTypeId)	Sets the value of the data at the given path
default <T extends SynchronizationResult> T	synchronizeValues(Map<String,Object> values)	Synchronizes the given values with the current ones

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

dataToJSON, 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, dataToJSON, dataToSAX, dataToSAX

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

getRepositoryData

Method Details

getComposite

default ModifiableComposite getComposite(String compositePath)
                                  throws IllegalArgumentException,
UnknownTypeException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Description copied from interface: DataHolder

Retrieves the composite at the given path

Specified by:

getComposite in interface Composite

Specified by:

getComposite in interface DataHolder

Specified by:

getComposite in interface ModifiableDataHolder

Parameters:

compositePath - path of the composite to retrieve

Returns:

the composite or null if not exists or is empty

Throws:

IllegalArgumentException - if the given composite path is null or empty

UnknownTypeException - if the type composite is not available for this data holder

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

UndefinedItemPathException - if the data holder has a model and the given composite path is not defined by this model

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

getComposite

default ModifiableComposite getComposite(String compositePath,
 boolean createNew)
                                  throws IllegalArgumentException,
UnknownTypeException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Description copied from interface: ModifiableDataHolder

Retrieves the composite at the given path

Specified by:

getComposite in interface ModifiableDataHolder

Parameters:

compositePath - path of the composite to retrieve

createNew - true to create the composite if it does not exist, false otherwise

Returns:

the composite or null if createNew is false and value not exists or is empty

Throws:

IllegalArgumentException - if the given composite path is null or empty

UnknownTypeException - if the type composite is not available for this data holder

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

UndefinedItemPathException - if the data holder has a model and the given composite path is not defined by this model

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

synchronizeValues

default <T extends SynchronizationResult> T synchronizeValues(Map<String,Object> values)
                                                       throws UnknownTypeException,
NotUniqueTypeException,
BadItemTypeException,
UndefinedItemPathException

Description copied from interface: ModifiableDataHolder

Synchronizes the given values with the current ones

Specified by:

synchronizeValues in interface ModifiableDataHolder

Type Parameters:

T - the type of the SynchronizationResult

Parameters:

values - the values to synchronize

Returns:

the SynchronizationResult

Throws:

UnknownTypeException - if there is no available type compatible with a given value for this data holder's type extension point

NotUniqueTypeException - if there is more than one available types compatibles with the a value for this data holder's type extension point

BadItemTypeException - if type of the a data doesn't match the corresponding given value to set

UndefinedItemPathException - if the data holder has a model and a key in the given Map refers to a data that is not defined by the model

setValue

default void setValue(String dataPath,
 Object value)
               throws IllegalArgumentException,
UnknownDataException,
UnknownTypeException,
NotUniqueTypeException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Description copied from interface: ModifiableDataHolder

Sets the value of the data at the given path

Specified by:

setValue in interface ModifiableDataHolder

Parameters:

dataPath - path of the data

value - the value to set. To empty a value, use ModifiableDataHolder.setValue(String, Object, String) with a null value

Throws:

IllegalArgumentException - if the given data path is null or empty

UnknownDataException - if the given the data path is composed of an non existing group

UnknownTypeException - if there is no available type compatible with the given value for this data holder's type extension point

NotUniqueTypeException - if there is more than one available types compatibles with the given value for this data holder's type extension point

BadItemTypeException - if type of the data at the given path doesn't match the given value to set

UndefinedItemPathException - if the data holder has a model and the given data path is not defined by the model

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

setValue

default void setValue(String dataPath,
 Object value,
 String dataTypeId)
               throws IllegalArgumentException,
UnknownDataException,
UnknownTypeException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Description copied from interface: ModifiableDataHolder

Sets the value of the data at the given path

Specified by:

setValue in interface ModifiableDataHolder

Parameters:

dataPath - path of the data

value - the value to set. Give null to empty the value.

dataTypeId - type identifier of the data

Throws:

IllegalArgumentException - if the given data path is null or empty

UnknownDataException - if the given data path is composed of an non existing group

UnknownTypeException - if the given type is not available for this data holder's type extension point

BadItemTypeException - if the given type doesn't match the given value to set

UndefinedItemPathException - if the data holder has a model and the given data path is not defined by the model

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

removeValue

default void removeValue(String dataPath)
                  throws IllegalArgumentException,
UnknownTypeException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Description copied from interface: ModifiableDataHolder

Removes the stored value of the data at the given path

Specified by:

removeValue in interface ModifiableDataHolder

Parameters:

dataPath - path of the data

Throws:

IllegalArgumentException - if the given data path is null or empty

UnknownTypeException - if the the data to remove is in a group and there is no available type compatible with this group

BadItemTypeException - if the value of the parent of the given path is not an item container

UndefinedItemPathException - if the data holder has a model and the given data path is not defined by the model

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

getParentDataHolder

default Optional<? extends ModifiableDataHolder> getParentDataHolder()

Description copied from interface: DataHolder

Retrieves the optional parent of the current DataHolder There can be no parent if the current DataHolder is the root

Specified by:

getParentDataHolder in interface Composite

Specified by:

getParentDataHolder in interface DataHolder

Specified by:

getParentDataHolder in interface ModifiableDataHolder

Returns:

the parent of the current DataHolder

getRootDataHolder

default ModifiableDataHolder getRootDataHolder()

Description copied from interface: DataHolder

Retrieves the DataHolder that is the root of the current one

Specified by:

getRootDataHolder in interface Composite

Specified by:

getRootDataHolder in interface DataHolder

Specified by:

getRootDataHolder in interface ModifiableDataHolder

Returns:

the root DataHolder

getDefaultDataHolder

ModifiableDataHolder getDefaultDataHolder()

Description copied from interface: Composite

Retrieves the default implementation of a DataHolder to use

Specified by:

getDefaultDataHolder in interface Composite

Returns:

the DataHolder