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

Class ModelLessRepeaterEntry

java.lang.Object

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

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

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

All Implemented Interfaces:

DataHolder, Composite, RepeaterEntry, ModelLessDataHolder

Direct Known Subclasses:

ModifiableModelLessRepeaterEntry

public class ModelLessRepeaterEntry
extends AbstractRepeaterEntry
implements ModelLessDataHolder

Class for model free repeater entries

Field Summary

Fields

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

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

_modifiableRepositoryData

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

_repositoryData

Constructor Summary

Constructors

Constructor and Description
ModelLessRepeaterEntry(AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType> typeExtensionPoint, RepositoryData repositoryData) Creates a model free repeater entry

Method Summary

Modifier and Type	Method and Description
void	copyTo(ModifiableDataHolder dataHolder) Copies the current DataHolder to the given ModifiableModelAwareDataHolder.
ModelLessComposite	getComposite(String compositePath) Retrieves the composite at the given path
protected ModelLessDataHolder	getDefaultDataHolder() Retrieves the default implementation of a DataHolder to use
ModelLessRepeater	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 The type of the value will be deduced from the stored data.
<T> T	getValue(String dataPath, T defaultValue) Retrieves the value of the data at the given path, or the default value
<T> T	getValueOfType(String dataPath, String dataTypeId) Retrieves the value of the data at the given path
<T> T	getValueOfType(String dataPath, String dataTypeId, T defaultValue) Retrieves the value of the data at the given path, or the default value
boolean	isMultiple(String dataPath) Checks if the value of the data at the given path is multiple

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

getPosition, setPosition

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.ModelLessDataHolder

hasValue, toSAX, toSAX

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

dataToSAX, dataToSAX, dataToSAX, dataToSAX, getDataNames

Field Detail

_defaultDataHolder

protected ModelLessDataHolder _defaultDataHolder

the default implementation of a ModelLessDataHolder to use

Constructor Detail

ModelLessRepeaterEntry

public ModelLessRepeaterEntry(AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType> typeExtensionPoint,
                              RepositoryData repositoryData)

Creates a model free repeater entry

Parameters:

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

repositoryData - the repository data to use

Method Detail

getComposite

public ModelLessComposite getComposite(String compositePath)
                                throws IllegalArgumentException,
                                       BadItemTypeException,
                                       BadDataPathCardinalityException

Description copied from interface: ModelLessDataHolder

Retrieves the composite at the given path

Specified by:

getComposite in interface DataHolder

Specified by:

getComposite in interface ModelLessDataHolder

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

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

getRepeater

public ModelLessRepeater getRepeater(String repeaterPath)
                              throws IllegalArgumentException,
                                     BadItemTypeException,
                                     BadDataPathCardinalityException

Description copied from interface: ModelLessDataHolder

Retrieves the repeater at the given path

Specified by:

getRepeater in interface DataHolder

Specified by:

getRepeater in interface ModelLessDataHolder

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

BadDataPathCardinalityException - if the value 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,
                      UnknownTypeException,
                      NotUniqueTypeException,
                      BadDataPathCardinalityException

Description copied from interface: ModelLessDataHolder

Retrieves the value of the data at the given path The type of the value will be deduced from the stored data. In some cases, the type can be wrong. For example, it is impossible to know if a stored date is a date or a date time

Specified by:

getValue in interface ModelLessDataHolder

Type Parameters:

T - type of the value to retrieve. Should match the given data type

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. For example, an url may be returned as a String. Use the 2 arguments version to ensure to get the right kind of Object.

Throws:

IllegalArgumentException - if the given data path is null or empty

UnknownTypeException - if there is no compatible type with the data at the given data path

NotUniqueTypeException - if there are many compatible types (there is no way to determine which type is the good one)

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

getValue

public <T> T getValue(String dataPath,
                      T defaultValue)
               throws IllegalArgumentException,
                      UnknownTypeException,
                      NotUniqueTypeException,
                      BadDataPathCardinalityException

Description copied from interface: ModelLessDataHolder

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

Specified by:

getValue in interface ModelLessDataHolder

Type Parameters:

T - type of the value to retrieve. Should match the given data type

Parameters:

dataPath - path of the data

defaultValue - default value

Returns:

the value of the data

Throws:

IllegalArgumentException - if the given data path is null or empty

UnknownTypeException - if there is no compatible type with the data at the given data path

NotUniqueTypeException - if there are many compatible types (there is no way to determine which type is the good one)

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

getValueOfType

public <T> T getValueOfType(String dataPath,
                            String dataTypeId)
                     throws IllegalArgumentException,
                            UnknownTypeException,
                            BadItemTypeException,
                            BadDataPathCardinalityException

Description copied from interface: ModelLessDataHolder

Retrieves the value of the data at the given path

Specified by:

getValueOfType in interface ModelLessDataHolder

Type Parameters:

T - type of the value to retrieve. Should match the given data type

Parameters:

dataPath - path of the data

dataTypeId - type identifier of the data

Returns:

the value of the data or null if not exists

Throws:

IllegalArgumentException - if the given data path is null or empty

UnknownTypeException - if the given type isn't available for this data holder's type extension point

BadItemTypeException - if the given type doesn't match the type of the value stored in the repository at the given path

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

getValueOfType

public <T> T getValueOfType(String dataPath,
                            String dataTypeId,
                            T defaultValue)
                     throws IllegalArgumentException,
                            UnknownTypeException,
                            BadItemTypeException,
                            BadDataPathCardinalityException

Description copied from interface: ModelLessDataHolder

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

Specified by:

getValueOfType in interface ModelLessDataHolder

Type Parameters:

T - type of the value to retrieve. Should match the given data type

Parameters:

dataPath - path of the data

dataTypeId - type identifier of the data

defaultValue - default value

Returns:

the value of the data

Throws:

IllegalArgumentException - if the given data path is null or empty

UnknownTypeException - if the given type isn't available for this data holder's type extension point

BadItemTypeException - if the given type doesn't match the type of the value stored in the repository at the given path

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

isMultiple

public boolean isMultiple(String dataPath)
                   throws IllegalArgumentException,
                          UnknownDataException,
                          BadDataPathCardinalityException

Description copied from interface: ModelLessDataHolder

Checks if the value of the data at the given path is multiple

Specified by:

isMultiple in interface ModelLessDataHolder

Parameters:

dataPath - path of the data to check

Returns:

true if the value of the data is multiple, false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

UnknownDataException - the data at the given path does not exist

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

getType

public ModelItemType getType(String dataPath)
                      throws IllegalArgumentException,
                             UnknownDataException,
                             UnknownTypeException,
                             NotUniqueTypeException,
                             BadDataPathCardinalityException

Description copied from interface: ModelLessDataHolder

Retrieves the type of the data at the given path

Specified by:

getType in interface ModelLessDataHolder

Parameters:

dataPath - path of the data

Returns:

the type of the data

Throws:

IllegalArgumentException - if the given data path is null or empty

UnknownDataException - if there is no data in the repository at the given path

UnknownTypeException - if there is no compatible type with the data at the given data path or if the data is a repeater entry but the composite type is not available

NotUniqueTypeException - if there are many compatible types (there is no way to determine which type is the good one)

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

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 ModelLessDataHolder getDefaultDataHolder()

Description copied from class: AbstractComposite

Retrieves the default implementation of a DataHolder to use

Specified by:

getDefaultDataHolder in class AbstractComposite

Returns:

the DataHolder