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

Class ModelAwareComposite

java.lang.Object

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

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

All Implemented Interfaces:

DataHolder, Composite, ModelAwareDataHolder

Direct Known Subclasses:

ModifiableModelAwareComposite

public class ModelAwareComposite
extends AbstractComposite
implements ModelAwareDataHolder

Class for model aware composites

Field Summary

Fields

Modifier and Type	Field and Description
protected ModelAwareDataHolder	_defaultDataHolder the default implementation of a ModelAwareDataHolder to use

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

_repositoryData

Constructor Summary

Constructors

Constructor and Description
ModelAwareComposite(RepositoryData repositoryData, ModelItemGroup definition) Creates a model aware composite

Method Summary

Modifier and Type	Method and Description
void	copyTo(ModifiableDataHolder dataHolder) Copies the current DataHolder to the given ModifiableModelAwareDataHolder.
ModelAwareComposite	getComposite(String compositePath) Retrieves the composite at the given path
protected ModelAwareDataHolder	getDefaultDataHolder() Retrieves the default implementation of a DataHolder to use
ModelAwareRepeater	getRepeater(String repeaterPath) Retrieves the repeater at the given path
ModelItemType	getType(String dataPath) Retrieves the type of the data at the given path
<T> T	getValue(String dataPath) Retrieves the value of the data at the given path
<T> T	getValue(String dataPath, boolean useDefaultFromModel, T defaultValue) Retrieves the value of the data at the given path, or the default value
boolean	isMultiple(String path) Checks if the definition of the element at the given path is multiple

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

hasValue, toSAX, toSAX

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

dataToSAX, dataToSAX, dataToSAX, dataToSAX, getDataNames

Field Detail

_defaultDataHolder

protected ModelAwareDataHolder _defaultDataHolder

the default implementation of a ModelAwareDataHolder to use

Constructor Detail

ModelAwareComposite

public ModelAwareComposite(RepositoryData repositoryData,
                           ModelItemGroup definition)

Creates a model aware composite

Parameters:

repositoryData - the repository data of the composite

definition - the definition of the composite

Method Detail

getComposite

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

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 ModelAwareRepeater 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

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

getValue

public <T> T getValue(String dataPath)
               throws IllegalArgumentException,
                      UndefinedItemPathException,
                      BadItemTypeException,
                      BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the value of the data at the given path

Specified by:

getValue in interface ModelAwareDataHolder

Type Parameters:

T - type of the value to retrieve

Parameters:

dataPath - path of the data

Returns:

the value of the data or null if not exists. The object returned may be of a generic class defined by the storage (if the model is unknown). For example, an url may be returned as a String.

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

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

getValue

public <T> T getValue(String dataPath,
                      boolean useDefaultFromModel,
                      T defaultValue)
               throws IllegalArgumentException,
                      UndefinedItemPathException,
                      BadItemTypeException,
                      BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the value of the data at the given path, or the default value

Specified by:

getValue in interface ModelAwareDataHolder

Type Parameters:

T - type of the value to retrieve

Parameters:

dataPath - path of the data

useDefaultFromModel - true to use the default value from the model, false to use the given default value

defaultValue - default value used if value is null and useDefaultFromModel is false, or if there is no default value on model

Returns:

the value of the data or null if not exists.

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

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

isMultiple

public boolean isMultiple(String path)
                   throws IllegalArgumentException,
                          UndefinedItemPathException,
                          BadItemTypeException

Description copied from interface: ModelAwareDataHolder

Checks if the definition of the element at the given path is multiple

Specified by:

isMultiple in interface ModelAwareDataHolder

Parameters:

path - path of the element. No matter if it is a definition or data path (with repeater entry positions)

Returns:

true if the element is multiple, false otherwise

Throws:

IllegalArgumentException - if the given path is null or empty

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

BadItemTypeException

getType

public ModelItemType getType(String dataPath)
                      throws IllegalArgumentException,
                             UndefinedItemPathException,
                             BadItemTypeException

Description copied from interface: ModelAwareDataHolder

Retrieves the type of the data at the given path

Specified by:

getType in interface ModelAwareDataHolder

Parameters:

dataPath - path of the data. No matter if it is a definition or data path (with repeater entry positions)

Returns:

the type 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

BadItemTypeException

copyTo

public void copyTo(ModifiableDataHolder dataHolder)
            throws UndefinedItemPathException,
                   BadItemTypeException,
                   UnknownTypeException,
                   NotUniqueTypeException

Description copied from interface: DataHolder

Copies the current DataHolder to the given ModifiableModelAwareDataHolder.

Specified by:

copyTo in interface DataHolder

Parameters:

dataHolder - The destination dataHolder. Can not be null.

Throws:

UndefinedItemPathException - if one of the copied data is not defined by the model of the destination ModifiableModelAwareDataHolder

BadItemTypeException - if the type defined by the model of the destination ModifiableModelAwareDataHolder doesn't match the copied value

UnknownTypeException - if there is no available type compatible with the copied value for the type extension point of the destination ModifiableModelLessDataHolder

NotUniqueTypeException - if there is more than one available types compatibles with the copied value for the type extension point of the destination ModifiableModelLessDataHolder

getDefaultDataHolder

protected ModelAwareDataHolder getDefaultDataHolder()

Description copied from class: AbstractComposite

Retrieves the default implementation of a DataHolder to use

Specified by:

getDefaultDataHolder in class AbstractComposite

Returns:

the DataHolder