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

Class ModifiableModelAwareComposite

java.lang.Object

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

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

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

All Implemented Interfaces:

DataHolder, Composite, ModifiableComposite, ModelAwareDataHolder, ModifiableDataHolder, ModifiableModelAwareDataHolder

public class ModifiableModelAwareComposite
extends ModelAwareComposite
implements ModifiableComposite, ModifiableModelAwareDataHolder

Class for modifiable model aware composites

Field Summary

Fields

Modifier and Type	Field and Description
protected ModifiableModelAwareDataHolder	_modifiableDefaultDataHolder the default implementation of a ModifiableModelAwareDataHolder to use

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

_defaultDataHolder

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

_repositoryData

Constructor Summary

Constructors

Constructor and Description
ModifiableModelAwareComposite(ModifiableRepositoryData repositoryData, ModelItemGroup definition) Creates a modifiable model aware composite

Method Summary

Modifier and Type	Method and Description
ModifiableModelAwareComposite	getComposite(String compositePath) Retrieves the composite at the given path
ModifiableModelAwareComposite	getComposite(String compositePath, boolean createNew) Retrieves the composite at the given path
protected ModifiableModelAwareDataHolder	getDefaultDataHolder() Retrieves the default implementation of a DataHolder to use
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.group.impl.ModelAwareComposite

copyTo, getType, getValue, getValue, isMultiple

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

getDataNames, 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.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

_modifiableDefaultDataHolder

protected ModifiableModelAwareDataHolder _modifiableDefaultDataHolder

the default implementation of a ModifiableModelAwareDataHolder to use

Constructor Detail

ModifiableModelAwareComposite

public ModifiableModelAwareComposite(ModifiableRepositoryData repositoryData,
                                     ModelItemGroup definition)

Creates a modifiable model aware composite

Parameters:

repositoryData - the repository data of the composite

definition - the definition of the composite

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 ModelAwareComposite

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

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 ModelAwareComposite

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

getComposite

public ModifiableModelAwareComposite getComposite(String compositePath,
                                                  boolean createNew)
                                           throws IllegalArgumentException,
                                                  UndefinedItemPathException,
                                                  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 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

getRepeater

public ModifiableModelAwareRepeater getRepeater(String repeaterPath,
                                                boolean createNew)
                                         throws IllegalArgumentException,
                                                UndefinedItemPathException,
                                                BadItemTypeException,
                                                BadDataPathCardinalityException

Description copied from interface: ModifiableDataHolder

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

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

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

getDefaultDataHolder

protected ModifiableModelAwareDataHolder getDefaultDataHolder()

Description copied from class: AbstractComposite

Retrieves the default implementation of a DataHolder to use

Overrides:

getDefaultDataHolder in class ModelAwareComposite

Returns:

the DataHolder