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

Class DefaultModelLessDataHolder

java.lang.Object

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

All Implemented Interfaces:

DataHolder, ModelLessDataHolder

Direct Known Subclasses:

DefaultModifiableModelLessDataHolder

public class DefaultModelLessDataHolder
extends Object
implements ModelLessDataHolder

Default implementation for data holder without model

Field Summary

Fields

Modifier and Type	Field and Description
protected RepositoryData	_repositoryData Repository data to use to store data in the repository
protected AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType>	_typeExtensionPoint Extension point to use to get available element types

Constructor Summary

Constructors

Constructor and Description
DefaultModelLessDataHolder(AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType> typeExtensionPoint, RepositoryData repositoryData) Creates a 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 ModelLessDataHolder	_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
private ModelItemType	_getType(String dataName)
ModelLessComposite	getComposite(String compositePath) Retrieves the composite at the given path
Collection<String>	getDataNames() Retrieves the names of data contained by this data holder
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	hasValue(String dataPath) Checks if there is a value for the data at the given path
boolean	isMultiple(String dataPath) Checks if the value of the data at the given path is multiple

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

toSAX, toSAX

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

copyTo, dataToSAX, dataToSAX, dataToSAX, dataToSAX

Field Detail

_typeExtensionPoint

protected AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType> _typeExtensionPoint

Extension point to use to get available element types

_repositoryData

protected RepositoryData _repositoryData

Repository data to use to store data in the repository

Constructor Detail

DefaultModelLessDataHolder

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

Creates a 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 ModelLessComposite 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

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

getRepeater

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

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

getValue

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

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)

getValue

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

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)

getValueOfType

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

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

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

getValueOfType

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

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

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

_getComposite

protected ModelLessComposite _getComposite(String name)
                                    throws BadItemTypeException

Retrieves the composite with the given name

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

protected ModelLessRepeater _getRepeater(String name)
                                  throws BadItemTypeException

Retrieves the repeater with the given name

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

hasValue

public boolean hasValue(String dataPath)
                 throws IllegalArgumentException

Description copied from interface: ModelLessDataHolder

Checks if there is a value for the data at the given path

Specified by:

hasValue in interface DataHolder

Specified by:

hasValue in interface ModelLessDataHolder

Parameters:

dataPath - path of the data

Returns:

true if there is value for the data, false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

isMultiple

public boolean isMultiple(String dataPath)
                   throws IllegalArgumentException,
                          UnknownDataException

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

getType

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

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

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

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

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

_getType

private ModelItemType _getType(String dataName)
                        throws UnknownTypeException,
                               UnknownDataException,
                               NotUniqueTypeException

Throws:

UnknownTypeException

UnknownDataException

NotUniqueTypeException

_getParentValue

protected ModelLessDataHolder _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'

Parameters:

dataPath - the data path

Returns:

the parent data holder

getDataNames

public Collection<String> getDataNames()

Description copied from interface: DataHolder

Retrieves the names of data contained by this data holder

Specified by:

getDataNames in interface DataHolder

Returns:

the paths of all data contained by this data holder