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 and Description
protected ModifiableRepositoryData	_modifiableRepositoryData Repository data to use to store data in the repository

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

_repositoryData, _typeExtensionPoint

Constructor Summary

Constructors

Constructor and Description
DefaultModifiableModelLessDataHolder(AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType> typeExtensionPoint, ModifiableRepositoryData repositoryData) Creates a modifiable default model free data holder

Method Summary

Modifier and Type	Method and 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 ModifiableModelLessDataHolder	_getParentValue(String dataPath) Retrieves the data holder, last parent segment of the given data path Example : call this method with a path like 'my-composite/my-repeater[1]/my-data' will retrieve the first repeater entry of the repeater 'my-repeater' in the composite 'my-composite'
protected ModelLessRepeater	_getRepeater(String name) Retrieves the repeater with the given name
protected ModifiableModelLessRepeater	_getRepeater(String name, boolean createNew) Retrieves the repeater with the given name
ModifiableModelLessComposite	getComposite(String compositePath) Retrieves the composite at the given path
ModifiableModelLessComposite	getComposite(String compositePath, boolean createNew) Retrieves the composite at the given path
ModifiableModelLessRepeater	getRepeater(String repeaterPath) Retrieves the repeater at the given path
ModifiableModelLessRepeater	getRepeater(String repeaterPath, boolean createNew) Retrieves the repeater at the given path
void	removeValue(String dataPath) Removes the value of the data stored in the repository 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

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

getDataNames, getType, getValue, getValue, getValueOfType, getValueOfType, hasValue, 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.ModelLessDataHolder

getType, getValue, getValue, getValueOfType, getValueOfType, hasValue, isMultiple, toSAX, toSAX

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

copyTo, dataToSAX, dataToSAX, dataToSAX, dataToSAX, getDataNames

Field Detail

_modifiableRepositoryData

protected ModifiableRepositoryData _modifiableRepositoryData

Repository data to use to store data in the repository

Constructor Detail

DefaultModifiableModelLessDataHolder

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

Method Detail

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

Throws:

IllegalArgumentException - if the given composite path is null or empty

BadItemTypeException - if the value stored in the repository 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

getRepeater

public ModifiableModelLessRepeater getRepeater(String repeaterPath)
                                        throws IllegalArgumentException,
                                               BadItemTypeException

Description copied from interface: ModelLessDataHolder

Retrieves the repeater at the given path

Specified by:

getRepeater in interface DataHolder

Specified by:

getRepeater in interface ModelLessDataHolder

Specified by:

getRepeater in interface ModifiableDataHolder

Specified by:

getRepeater in interface ModifiableModelLessDataHolder

Overrides:

getRepeater in class DefaultModelLessDataHolder

Parameters:

repeaterPath - path of the repeater to retrieve

Returns:

the repeater or null if not exists

Throws:

IllegalArgumentException - if the given repeater path is null or empty

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

_getRepeater

protected ModelLessRepeater _getRepeater(String name)
                                  throws BadItemTypeException

Description copied from class: DefaultModelLessDataHolder

Retrieves the repeater with the given name

Overrides:

_getRepeater in class DefaultModelLessDataHolder

Parameters:

name - name of the repeater to retrieve

Returns:

the repeater

Throws:

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

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

Throws:

IllegalArgumentException - if the given composite path is null or empty

BadItemTypeException - if the value stored in the repository 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 repeater 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

getRepeater

public ModifiableModelLessRepeater getRepeater(String repeaterPath,
                                               boolean createNew)
                                        throws IllegalArgumentException,
                                               BadItemTypeException

Description copied from interface: ModifiableModelLessDataHolder

Retrieves the repeater at the given path

Specified by:

getRepeater in interface ModifiableDataHolder

Specified by:

getRepeater in interface ModifiableModelLessDataHolder

Parameters:

repeaterPath - path of the repeater to retrieve

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

Returns:

the repeater

Throws:

IllegalArgumentException - if the given repeater path is null or empty

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

_getRepeater

protected ModifiableModelLessRepeater _getRepeater(String name,
                                                   boolean createNew)
                                            throws BadItemTypeException

Retrieves the repeater with the given name

Parameters:

name - name of the repeater to retrieve

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

Returns:

the repeater

Throws:

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

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

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

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,
                        UnknownDataException

Description copied from interface: ModifiableModelLessDataHolder

Removes the value of the data stored in the repository 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

_getParentValue

protected ModifiableModelLessDataHolder _getParentValue(String dataPath)

Description copied from class: DefaultModelLessDataHolder

Retrieves the data holder, last parent segment of the given data path Example : call this method with a path like 'my-composite/my-repeater[1]/my-data' will retrieve the first repeater entry of the repeater 'my-repeater' in the composite 'my-composite'

Overrides:

_getParentValue in class DefaultModelLessDataHolder

Parameters:

dataPath - the data path

Returns:

the parent data holder