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

Class DefaultModifiableModelAwareDataHolder

java.lang.Object

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

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

All Implemented Interfaces:

DataHolder, ModelAwareDataHolder, ModifiableDataHolder, ModifiableModelAwareDataHolder

public class DefaultModifiableModelAwareDataHolder
extends DefaultModelAwareDataHolder
implements ModifiableModelAwareDataHolder

Default implementation for modifiable data holder with 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.DefaultModelAwareDataHolder

_itemContainers, _repositoryData

Constructor Summary

Constructors

Constructor and Description
DefaultModifiableModelAwareDataHolder(ModifiableRepositoryData repositoryData, Collection<? extends ModelItemContainer> itemContainers) Creates a modifiable default model aware data holder
DefaultModifiableModelAwareDataHolder(ModifiableRepositoryData repositoryData, ModelItemContainer... itemContainers) Creates a modifiable default model aware data holder

Method Summary

Modifier and Type	Method and Description
protected ModifiableModelAwareComposite	_getComposite(String name, CompositeDefinition compositeDefinition) Retrieves the composite with the given name
protected ModifiableModelAwareComposite	_getComposite(String name, CompositeDefinition compositeDefinition, boolean createNew) Retrieves the composite with the given name
protected ModifiableModelAwareRepeater	_getRepeater(String name, RepeaterDefinition repeaterDefinition) Retrieves the repeater with the given name
protected ModifiableModelAwareRepeater	_getRepeater(String name, RepeaterDefinition repeaterDefinition, boolean createNew) Retrieves the repeater with the given name
ModifiableModelAwareComposite	getComposite(String compositePath) Retrieves the composite at the given path
ModifiableModelAwareComposite	getComposite(String compositePath, boolean createNew) Retrieves the composite at the given path
ModifiableModelAwareRepeater	getRepeater(String repeaterPath) Retrieves the repeater at the given path
ModifiableModelAwareRepeater	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

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

getDataNames, getType, getValue, getValue, 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.ModelAwareDataHolder

getType, getValue, getValue, 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

DefaultModifiableModelAwareDataHolder

public DefaultModifiableModelAwareDataHolder(ModifiableRepositoryData repositoryData,
                                             ModelItemContainer... itemContainers)

Creates a modifiable default model aware data holder

Parameters:

repositoryData - the repository data to use

itemContainers - the model containers to use to get information about definitions. Must match the given repository data. A repository data can have several item containers. For example, a content can have several content types.

DefaultModifiableModelAwareDataHolder

public DefaultModifiableModelAwareDataHolder(ModifiableRepositoryData repositoryData,
                                             Collection<? extends ModelItemContainer> itemContainers)

Creates a modifiable default model aware data holder

Parameters:

repositoryData - the repository data to use

itemContainers - the model containers to use to get information about definitions. Must match the given repository data. A repository data can have several item containers. For example, a content can have several content types.

Method Detail

getComposite

public ModifiableModelAwareComposite getComposite(String compositePath)
                                           throws IllegalArgumentException,
                                                  UndefinedItemPathException,
                                                  BadItemTypeException,
                                                  BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the composite at the given path

Specified by:

getComposite in interface DataHolder

Specified by:

getComposite in interface ModelAwareDataHolder

Specified by:

getComposite in interface ModifiableDataHolder

Specified by:

getComposite in interface ModifiableModelAwareDataHolder

Overrides:

getComposite in class DefaultModelAwareDataHolder

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

UndefinedItemPathException - if the given composite path is not defined by the model

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

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

_getComposite

protected ModifiableModelAwareComposite _getComposite(String name,
                                                      CompositeDefinition compositeDefinition)
                                               throws BadItemTypeException

Description copied from class: DefaultModelAwareDataHolder

Retrieves the composite with the given name

Overrides:

_getComposite in class DefaultModelAwareDataHolder

Parameters:

name - name of the composite to retrieve

compositeDefinition - the definition 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 ModifiableModelAwareRepeater getRepeater(String repeaterPath)
                                         throws IllegalArgumentException,
                                                UndefinedItemPathException,
                                                BadItemTypeException,
                                                BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the repeater at the given path

Specified by:

getRepeater in interface DataHolder

Specified by:

getRepeater in interface ModelAwareDataHolder

Specified by:

getRepeater in interface ModifiableDataHolder

Specified by:

getRepeater in interface ModifiableModelAwareDataHolder

Overrides:

getRepeater in class DefaultModelAwareDataHolder

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

UndefinedItemPathException - if the given repeater path is not defined by the model

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

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

_getRepeater

protected ModifiableModelAwareRepeater _getRepeater(String name,
                                                    RepeaterDefinition repeaterDefinition)
                                             throws BadItemTypeException

Description copied from class: DefaultModelAwareDataHolder

Retrieves the repeater with the given name

Overrides:

_getRepeater in class DefaultModelAwareDataHolder

Parameters:

name - name of the repeater to retrieve

repeaterDefinition - the definition 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 ModifiableModelAwareComposite getComposite(String compositePath,
                                                  boolean createNew)
                                           throws IllegalArgumentException,
                                                  UndefinedItemPathException,
                                                  BadItemTypeException,
                                                  BadDataPathCardinalityException

Description copied from interface: ModifiableModelAwareDataHolder

Retrieves the composite at the given path

Specified by:

getComposite in interface ModifiableDataHolder

Specified by:

getComposite in interface ModifiableModelAwareDataHolder

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

UndefinedItemPathException - if the given composite path is not defined by the model

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

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

_getComposite

protected ModifiableModelAwareComposite _getComposite(String name,
                                                      CompositeDefinition compositeDefinition,
                                                      boolean createNew)
                                               throws BadItemTypeException

Retrieves the composite with the given name

Parameters:

name - name of the composite to retrieve

compositeDefinition - the definition 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 ModifiableModelAwareRepeater getRepeater(String repeaterPath,
                                                boolean createNew)
                                         throws IllegalArgumentException,
                                                UndefinedItemPathException,
                                                BadItemTypeException,
                                                BadDataPathCardinalityException

Description copied from interface: ModifiableModelAwareDataHolder

Retrieves the repeater at the given path

Specified by:

getRepeater in interface ModifiableDataHolder

Specified by:

getRepeater in interface ModifiableModelAwareDataHolder

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

UndefinedItemPathException - if the given composite path is not defined by the model

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

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

_getRepeater

protected ModifiableModelAwareRepeater _getRepeater(String name,
                                                    RepeaterDefinition repeaterDefinition,
                                                    boolean createNew)
                                             throws BadItemTypeException

Retrieves the repeater with the given name

Parameters:

name - name of the repeater to retrieve

repeaterDefinition - the definition 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,
                     UndefinedItemPathException,
                     BadItemTypeException,
                     BadDataPathCardinalityException

Description copied from interface: ModifiableModelAwareDataHolder

Sets the value of the data at the given path

Specified by:

setValue in interface ModifiableModelAwareDataHolder

Parameters:

dataPath - path of the data

value - the value to set. The type of this value will be given by the model, but if not model is associated to the path, an UnsupportedOperationException is thrown. Use the 3 arguments versions in that case.

Throws:

IllegalArgumentException - if the given data path is null or empty

UndefinedItemPathException - if the given data path is not defined by the model

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

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

removeValue

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

Description copied from interface: ModifiableModelAwareDataHolder

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 ModifiableModelAwareDataHolder

Parameters:

dataPath - path of the data

Throws:

IllegalArgumentException - if the given data path is null or empty

UndefinedItemPathException - if the given data path is not defined by the model

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

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