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

Class DefaultModifiableModelLessDataHolder

java.lang.Object

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

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

All Implemented Interfaces:

DataHolder, ModelLessDataHolder, ModifiableDataHolder, ModifiableModelLessDataHolder

public class DefaultModifiableModelLessDataHolder
extends DefaultModelLessDataHolder
implements ModifiableModelLessDataHolder

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 ModifiableModelLessDataHolder>	_modifiableParent	Parent of the current DataHolder
protected ModifiableRepositoryData	_modifiableRepositoryData	Repository data to use to store data in the repository
protected ModifiableModelLessDataHolder	_modifiableRoot	Root DataHolder

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

_parent, _repositoryData, _root, _typeExtensionPoint

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected ModelLessComposite	_getComposite(String name)	Retrieves the composite with the given name
protected ModifiableModelLessComposite	_getComposite(String name, boolean createNew)	Retrieves the composite with the given name
protected static ModifiableModelLessDataHolder	_getParentValue(ModifiableModelLessDataHolder 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'
ModifiableModelLessComposite	getComposite(String compositePath)	Retrieves the composite at the given path
ModifiableModelLessComposite	getComposite(String compositePath, boolean createNew)	Retrieves the composite at the given path
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.impl.DefaultModelLessDataHolder

_getParentValue, dataToJSON, dataToJSON, dataToSAX, dataToSAX, getDataNames, getModelItemTypeExtensionPoint, getType, getValue, getValue, getValueOfType, getValueOfType, 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, dataToSAX, dataToSAX, getDataNames

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

dataToJSON, dataToJSON, dataToSAX, dataToSAX, getModelItemTypeExtensionPoint, getType, getValue, getValue, getValueOfType, getValueOfType, 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 ModifiableModelLessDataHolder> _modifiableParent

Parent of the current DataHolder

_modifiableRoot

protected ModifiableModelLessDataHolder _modifiableRoot

Root DataHolder

Constructor Details

DefaultModifiableModelLessDataHolder

public DefaultModifiableModelLessDataHolder(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

DefaultModifiableModelLessDataHolder

public DefaultModifiableModelLessDataHolder(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

DefaultModifiableModelLessDataHolder

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

Creates a modifiable default model free data holder

Parameters:

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

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

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

root - the root DataHolder

repositoryData - the repository data to use

Method Details

getComposite

public ModifiableModelLessComposite getComposite(String compositePath)
                                          throws IllegalArgumentException,
BadItemTypeException

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 DefaultModelLessDataHolder

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

_getComposite

protected ModelLessComposite _getComposite(String name)
                                    throws BadItemTypeException

Description copied from class: DefaultModelLessDataHolder

Retrieves the composite with the given name

Overrides:

_getComposite in class DefaultModelLessDataHolder

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 ModifiableModelLessComposite getComposite(String compositePath,
 boolean createNew)
                                          throws IllegalArgumentException,
BadItemTypeException

Description copied from interface: ModifiableModelLessDataHolder

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

_getComposite

protected ModifiableModelLessComposite _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 boolean synchronizeValues(Map<String,Object> values)
                          throws UnknownTypeException,
NotUniqueTypeException

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:

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

setValue

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

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

setValue

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

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

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

removeValue

public void removeValue(String dataPath)
                 throws IllegalArgumentException,
BadItemTypeException

Description copied from interface: ModifiableModelLessDataHolder

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

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

_getParentValue

protected static ModifiableModelLessDataHolder _getParentValue(ModifiableModelLessDataHolder modifiableDataHolder,
 String dataPath)
                                                        throws BadDataPathCardinalityException,
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:

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

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 DefaultModelLessDataHolder

Returns:

the repository data used by this DataHolder

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 DefaultModelLessDataHolder

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 DefaultModelLessDataHolder

Returns:

the root DataHolder