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

Class ModifiableModelLessComposite

java.lang.Object

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

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

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

All Implemented Interfaces:

DataHolder, Composite, ModifiableComposite, ModelLessDataHolder, ModifiableDataHolder, ModifiableModelLessDataHolder

public class ModifiableModelLessComposite
extends ModelLessComposite
implements ModifiableComposite, ModifiableModelLessDataHolder

Class for modifiable model free composites

Field Summary

Fields

Modifier and Type	Field	Description
protected ModifiableModelLessDataHolder	_modifiableDefaultDataHolder	the default implementation of a ModifiableModelLessDataHolder to use
protected ModifiableRepositoryData	_modifiableRepositoryData	The modifiable repository data of this composite

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

_defaultDataHolder

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

_repositoryData

Constructor Summary

Constructors

Constructor	Description
ModifiableModelLessComposite(AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType> typeExtensionPoint, ModifiableRepositoryData repositoryData, ModifiableModelLessDataHolder parent, ModifiableModelLessDataHolder root)	Creates a modifiable model free composite

Method Summary

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

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

dataToSAX, dataToSAX, getType, getValue, getValue, getValueOfType, getValueOfType, isMultiple

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

copyTo, dataToSAX, getDataNames, hasNonEmptyValue, hasValue

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.DataHolder

copyTo, dataToSAX, dataToSAX, getDataNames

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

dataToSAX, dataToSAX, getType, getValue, getValue, getValueOfType, getValueOfType, hasNonEmptyValue, hasValue, isMultiple

Field Detail

_modifiableRepositoryData

protected ModifiableRepositoryData _modifiableRepositoryData

The modifiable repository data of this composite

_modifiableDefaultDataHolder

protected ModifiableModelLessDataHolder _modifiableDefaultDataHolder

the default implementation of a ModifiableModelLessDataHolder to use

Constructor Detail

ModifiableModelLessComposite

public ModifiableModelLessComposite(AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType> typeExtensionPoint,
                                    ModifiableRepositoryData repositoryData,
                                    ModifiableModelLessDataHolder parent,
                                    ModifiableModelLessDataHolder root)

Creates a modifiable model free composite

Parameters:

typeExtensionPoint - the extension point to use to get available element types

repositoryData - the repository data to use

parent - the parent of the created DataHolder

root - the root DataHolder

Method Detail

getComposite

public ModifiableModelLessComposite getComposite(String compositePath)
                                          throws IllegalArgumentException,
                                                 BadItemTypeException,
                                                 BadDataPathCardinalityException

Description copied from interface: ModelLessDataHolder

Retrieves the composite at the given path

Specified by:

getComposite in interface DataHolder

Specified by:

getComposite in interface ModelLessDataHolder

Specified by:

getComposite in interface ModifiableDataHolder

Specified by:

getComposite in interface ModifiableModelLessDataHolder

Overrides:

getComposite in class ModelLessComposite

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

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

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

getComposite

public ModifiableModelLessComposite getComposite(String compositePath,
                                                 boolean createNew)
                                          throws IllegalArgumentException,
                                                 BadItemTypeException,
                                                 BadDataPathCardinalityException

Description copied from interface: ModifiableDataHolder

Retrieves the composite at the given path

Specified by:

getComposite in interface ModifiableDataHolder

Specified by:

getComposite in interface ModifiableModelLessDataHolder

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

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

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

synchronizeValues

public boolean synchronizeValues(Map<String,Object> values)
                          throws IOException

Description copied from interface: ModifiableModelLessDataHolder

Synchronizes the given values with the current ones

Specified by:

synchronizeValues in interface ModifiableModelLessDataHolder

Parameters:

values - the values to synchronize

Returns:

true if some values have changed, false otherwise

Throws:

IOException - if an error occurs while synchronizing I/O data

setValue

public void setValue(String dataPath,
                     Object value)
              throws IllegalArgumentException,
                     UnknownTypeException,
                     NotUniqueTypeException,
                     UnknownDataException,
                     BadDataPathCardinalityException

Description copied from interface: ModifiableModelLessDataHolder

Sets the value of the data at the given path

Specified by:

setValue in interface ModifiableModelLessDataHolder

Parameters:

dataPath - path of the data

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

Throws:

IllegalArgumentException - if the given data path is null or empty

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

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

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

setValue

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

Description copied from interface: ModifiableModelLessDataHolder

Sets the value of the data at the given path

Specified by:

setValue in interface ModifiableModelLessDataHolder

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

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

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

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

removeValue

public void removeValue(String dataPath)
                 throws IllegalArgumentException,
                        UnknownDataException,
                        BadDataPathCardinalityException

Description copied from interface: ModifiableDataHolder

Removes the stored value of the data at the given path

Specified by:

removeValue in interface ModifiableDataHolder

Specified by:

removeValue in interface ModifiableModelLessDataHolder

Parameters:

dataPath - path of the data

Throws:

IllegalArgumentException - if the given data path is null or empty

UnknownDataException - if the value at the given data path does not exist

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

getParentDataHolder

public Optional<? extends ModifiableModelLessDataHolder> 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 DataHolder

Specified by:

getParentDataHolder in interface ModelLessDataHolder

Specified by:

getParentDataHolder in interface ModifiableDataHolder

Specified by:

getParentDataHolder in interface ModifiableModelLessDataHolder

Overrides:

getParentDataHolder in class ModelLessComposite

Returns:

the parent of the current DataHolder

getRootDataHolder

public ModifiableModelLessDataHolder getRootDataHolder()

Description copied from interface: DataHolder

Retrieves the DataHolder that is the root of the current one

Specified by:

getRootDataHolder in interface DataHolder

Specified by:

getRootDataHolder in interface ModelLessDataHolder

Specified by:

getRootDataHolder in interface ModifiableDataHolder

Specified by:

getRootDataHolder in interface ModifiableModelLessDataHolder

Overrides:

getRootDataHolder in class ModelLessComposite

Returns:

the root DataHolder

getDefaultDataHolder

protected ModifiableModelLessDataHolder getDefaultDataHolder()

Description copied from class: AbstractComposite

Retrieves the default implementation of a DataHolder to use

Overrides:

getDefaultDataHolder in class ModelLessComposite

Returns:

the DataHolder

getRepositoryData

public ModifiableRepositoryData getRepositoryData()

Description copied from interface: DataHolder

Retrieves the repository data used by this DataHolder

Specified by:

getRepositoryData in interface DataHolder

Specified by:

getRepositoryData in interface ModifiableDataHolder

Overrides:

getRepositoryData in class AbstractComposite

Returns:

the repository data used by this DataHolder