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

Class DefaultModifiableDataHolder

java.lang.Object

org.ametys.plugins.repository.data.holder.impl.DefaultDataHolder

org.ametys.plugins.repository.data.holder.impl.DefaultModifiableDataHolder

All Implemented Interfaces:

DataHolder, ModifiableDataHolder

public class DefaultModifiableDataHolder
extends DefaultDataHolder
implements ModifiableDataHolder

Default implementation for modifiable data holder without model

Field Summary

Fields

Modifier and Type	Field	Description
protected Optional<LockableAmetysObject>	_lockableAmetysObject	Ametys object that can be locked on data modification
protected Optional<? extends ModifiableDataHolder>	_modifiableParent	Parent of the current DataHolder
protected ModifiableRepositoryData	_modifiableRepositoryData	Repository data to use to store data in the repository
protected ModifiableDataHolder	_modifiableRoot	Root DataHolder

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

_parent, _repositoryData, _root, _typeExtensionPoint

Constructor Summary

Constructors

Constructor	Description
DefaultModifiableDataHolder(ModelItemTypeExtensionPoint typeExtensionPoint, ModifiableRepositoryData repositoryData)	Creates a modifiable default model free data holder
DefaultModifiableDataHolder(ModelItemTypeExtensionPoint typeExtensionPoint, ModifiableRepositoryData repositoryData, Optional<LockableAmetysObject> lockableAmetysObject)	Creates a modifiable default model free data holder
DefaultModifiableDataHolder(ModelItemTypeExtensionPoint typeExtensionPoint, ModifiableRepositoryData repositoryData, Optional<LockableAmetysObject> lockableAmetysObject, Optional<? extends ModifiableDataHolder> parent, Optional<? extends ModifiableDataHolder> root)	Creates a modifiable default model free data holder

Method Summary

Modifier and Type	Method	Description
protected Composite	_getComposite(String name)	Retrieves the composite with the given name
protected ModifiableComposite	_getComposite(String name, boolean createNew)	Retrieves the composite with the given name
protected static ModifiableDataHolder	_getParentValue(ModifiableDataHolder modifiableDataHolder, String dataPath)	Retrieves the modifiable data holder, last parent segment of the given data path Example : call this method with a path like 'my-composite1/my-composite2/my-data' will retrieve the composite 'my-composite2' in the composite 'my-composite1'
ModifiableComposite	getComposite(String compositePath)	Retrieves the composite at the given path
ModifiableComposite	getComposite(String compositePath, boolean createNew)	Retrieves the composite at the given path
Optional<? extends ModifiableDataHolder>	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
ModifiableDataHolder	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
<T extends SynchronizationResult> T	synchronizeValues(Map<String,Object> values)	Synchronizes the given values with the current ones

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

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

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, copyTo, dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToSAX, dataToSAX, dataToSAX, dataToSAX, getDataNames, getModelItemTypeExtensionPoint, getType, getValue, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, hasDifferences, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple

Field Details

_modifiableRepositoryData

protected ModifiableRepositoryData _modifiableRepositoryData

Repository data to use to store data in the repository

_lockableAmetysObject

protected Optional<LockableAmetysObject> _lockableAmetysObject

Ametys object that can be locked on data modification

_modifiableParent

protected Optional<? extends ModifiableDataHolder> _modifiableParent

Parent of the current DataHolder

_modifiableRoot

protected ModifiableDataHolder _modifiableRoot

Root DataHolder

Constructor Details

DefaultModifiableDataHolder

public DefaultModifiableDataHolder(ModelItemTypeExtensionPoint typeExtensionPoint,
 ModifiableRepositoryData repositoryData)

Creates a modifiable default model free data holder

Parameters:

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

repositoryData - the repository data to use

DefaultModifiableDataHolder

public DefaultModifiableDataHolder(ModelItemTypeExtensionPoint typeExtensionPoint,
 ModifiableRepositoryData repositoryData,
 Optional<LockableAmetysObject> lockableAmetysObject)

Creates a modifiable default model free data holder

Parameters:

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

repositoryData - the repository data to use

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

DefaultModifiableDataHolder

public DefaultModifiableDataHolder(ModelItemTypeExtensionPoint typeExtensionPoint,
 ModifiableRepositoryData repositoryData,
 Optional<LockableAmetysObject> lockableAmetysObject,
 Optional<? extends ModifiableDataHolder> parent,
 Optional<? extends ModifiableDataHolder> root)

Creates a modifiable default model free data holder

Parameters:

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

repositoryData - the repository data to use

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

parent - the parent of the created DataHolder, can be null if the created DataHolder is the root DataHolder

root - the root DataHolder

Method Details

getComposite

public ModifiableComposite getComposite(String compositePath)
                                 throws IllegalArgumentException,
UnknownTypeException,
BadItemTypeException

Description copied from interface: DataHolder

Retrieves the composite at the given path

Specified by:

getComposite in interface DataHolder

Specified by:

getComposite in interface ModifiableDataHolder

Overrides:

getComposite in class DefaultDataHolder

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

_getComposite

protected Composite _getComposite(String name)
                           throws BadItemTypeException

Description copied from class: DefaultDataHolder

Retrieves the composite with the given name

Overrides:

_getComposite in class DefaultDataHolder

Parameters:

name - name of the composite to retrieve

Returns:

the composite

Throws:

BadItemTypeException - if the value stored in the repository with the given name is not a composite

getComposite

public ModifiableComposite getComposite(String compositePath,
 boolean createNew)
                                 throws IllegalArgumentException,
UnknownTypeException,
BadItemTypeException

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

_getComposite

protected ModifiableComposite _getComposite(String name,
 boolean createNew)
                                     throws BadItemTypeException

Retrieves the composite with the given name

Parameters:

name - name of the composite to retrieve

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

Returns:

the composite

Throws:

BadItemTypeException - if the value stored in the repository with the given name is not a composite

synchronizeValues

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

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

setValue

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

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

setValue

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

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

removeValue

public void removeValue(String dataPath)
                 throws IllegalArgumentException,
UnknownTypeException,
BadItemTypeException

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

_getParentValue

protected static ModifiableDataHolder _getParentValue(ModifiableDataHolder modifiableDataHolder,
 String dataPath)
                                               throws UnknownTypeException,
BadItemTypeException

Retrieves the modifiable data holder, last parent segment of the given data path Example : call this method with a path like 'my-composite1/my-composite2/my-data' will retrieve the composite 'my-composite2' in the composite 'my-composite1'

Parameters:

modifiableDataHolder - the modifiable data holder

dataPath - the data path

Returns:

the parent data holder

Throws:

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

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

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 DefaultDataHolder

Returns:

the repository data used by this DataHolder

getParentDataHolder

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

Specified by:

getParentDataHolder in interface ModifiableDataHolder

Overrides:

getParentDataHolder in class DefaultDataHolder

Returns:

the parent of the current DataHolder

getRootDataHolder

public ModifiableDataHolder 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 ModifiableDataHolder

Overrides:

getRootDataHolder in class DefaultDataHolder

Returns:

the root DataHolder