Package 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	Description
protected Optional<? extends ModelLessDataHolder>	_parent	Parent of the current DataHolder
protected RepositoryData	_repositoryData	Repository data to use to store data in the repository
protected ModelLessDataHolder	_root	Root DataHolder
protected ModelItemTypeExtensionPoint	_typeExtensionPoint	Extension point to use to get available element types

Constructor Summary

Constructors

Constructor	Description
DefaultModelLessDataHolder(ModelItemTypeExtensionPoint typeExtensionPoint, RepositoryData repositoryData)	Creates a default model free data holder
DefaultModelLessDataHolder(ModelItemTypeExtensionPoint typeExtensionPoint, RepositoryData repositoryData, Optional<? extends ModelLessDataHolder> parent, Optional<? extends ModelLessDataHolder> root)	Creates a default model free data holder

Method Summary

Modifier and Type	Method	Description
protected ModelLessComposite	_getComposite(String name)	Retrieves the composite with the given name
protected static ModelLessDataHolder	_getParentValue(ModelLessDataHolder dataHolder, String dataPath)	Retrieves the data holder, last parent segment of the given data path Example : call this method with a path like 'my-composite1/my-composite2/my-data' will retrieve the composite 'my-composite2' in the composite 'my-composite1'
Object	dataToJSON(String dataPath, DataContext context)	Convert the data at the given path into a JSON object
Map<String,Object>	dataToJSON(DataContext context)	Convert the data contained in this DataHolder
void	dataToSAX(ContentHandler contentHandler, String dataPath, DataContext context)	Generates SAX events for the data at the given data path in the current DataHolder Do not generate any event if there is no values at the given path
void	dataToSAX(ContentHandler contentHandler, DataContext context)	Generates SAX events for data contained in this DataHolder
ModelLessComposite	getComposite(String compositePath)	Retrieves the composite at the given path
Collection<String>	getDataNames()	Retrieves the names of data contained by this data holder Retrieves only the data at first level, does not check composite data
ModelItemTypeExtensionPoint	getModelItemTypeExtensionPoint()	Provide the ModelItemTypeExtensionPoint linked with the DataHolder
Optional<? extends ModelLessDataHolder>	getParentDataHolder()	Retrieves the optional parent of the current DataHolder There can be no parent if the current DataHolder is the root
RepositoryData	getRepositoryData()	Retrieves the repository data used by this DataHolder
ModelLessDataHolder	getRootDataHolder()	Retrieves the DataHolder that is the root of the current one
RepositoryModelItemType	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 if exists and is not empty, 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 if exists and is not empty, or the default value
boolean	hasDifferences(Map<String,Object> values)	Check if there are differences between the given values and the current ones
boolean	hasValue(String dataPath)	Checks if there is a non empty value for the data at the given path
boolean	hasValue(String dataPath, String dataTypeId)	Checks if there is a non empty value for the data at the given path
boolean	hasValueOrEmpty(String dataPath)	Checks if there is a value, even empty, for the data at the given path
boolean	isMultiple(String dataPath)	Checks if the value of the data at the given path is multiple
boolean	isMultiple(String dataPath, String dataTypeId)	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.DataHolder

copyTo, copyTo, dataToJSON, dataToSAX

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

dataToJSON, dataToSAX

Field Details

_typeExtensionPoint

protected ModelItemTypeExtensionPoint _typeExtensionPoint

Extension point to use to get available element types

_repositoryData

protected RepositoryData _repositoryData

Repository data to use to store data in the repository

_parent

protected Optional<? extends ModelLessDataHolder> _parent

Parent of the current DataHolder

_root

protected ModelLessDataHolder _root

Root DataHolder

Constructor Details

DefaultModelLessDataHolder

public DefaultModelLessDataHolder(ModelItemTypeExtensionPoint 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

DefaultModelLessDataHolder

public DefaultModelLessDataHolder(ModelItemTypeExtensionPoint typeExtensionPoint,
 RepositoryData repositoryData,
 Optional<? extends ModelLessDataHolder> parent,
 Optional<? extends ModelLessDataHolder> root)

Creates a default model free data holder

Parameters:

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

parent - the parent of the created DataHolder, empty if the created DataHolder is the root DataHolder

root - the root DataHolder

repositoryData - the repository data to use

Method Details

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 or is empty

Throws:

IllegalArgumentException - if the given composite path is null or empty

BadItemTypeException - if the stored value 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

getValue

public <T> T getValue(String dataPath)
               throws IllegalArgumentException,
UnknownTypeException,
NotUniqueTypeException,
BadItemTypeException,
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 or is empty. 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)

BadItemTypeException - if value at the sub data path of the given one is not a composite

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,
BadItemTypeException,
BadDataPathCardinalityException

Description copied from interface: ModelLessDataHolder

Retrieves the value of the data at the given path if exists and is not empty, 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, null if the data exists but is empty, or the given default value

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)

BadItemTypeException - if value at the sub data path of the given one is not a composite

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 if exists and is not empty, 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, null if the data exists but is empty, or the given default value

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 stored value 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)
                     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 or is empty

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 stored value at the given path

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

_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

hasValue

public boolean hasValue(String dataPath)
                 throws IllegalArgumentException,
BadDataPathCardinalityException

Description copied from interface: ModelLessDataHolder

Checks if there is a non empty 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 a non empty value for the data, false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

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

hasValue

public boolean hasValue(String dataPath,
 String dataTypeId)
                 throws IllegalArgumentException,
UnknownTypeException,
BadDataPathCardinalityException

Description copied from interface: ModelLessDataHolder

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

Specified by:

hasValue in interface ModelLessDataHolder

Parameters:

dataPath - path of the data

dataTypeId - type identifier of the data

Returns:

true if there is a non empty value for the data, false otherwise

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

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

hasValueOrEmpty

public boolean hasValueOrEmpty(String dataPath)
                        throws IllegalArgumentException,
BadDataPathCardinalityException

Description copied from interface: ModelLessDataHolder

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

Specified by:

hasValueOrEmpty in interface DataHolder

Specified by:

hasValueOrEmpty in interface ModelLessDataHolder

Parameters:

dataPath - path of the data

Returns:

true if there is value, even empty, for the data, false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

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,
UnknownTypeException,
NotUniqueTypeException,
BadItemTypeException,
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

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)

BadItemTypeException - if value at the sub data path of the given one is not a composite

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,
 String dataTypeId)
                   throws IllegalArgumentException,
UnknownDataException,
UnknownTypeException,
BadItemTypeException,
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

dataTypeId - type identifier of the data

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

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

BadItemTypeException - if value at the sub data path of the given one is not a composite

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

getType

public RepositoryModelItemType 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 stored 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

_getParentValue

protected static ModelLessDataHolder _getParentValue(ModelLessDataHolder dataHolder,
 String dataPath)
                                              throws BadItemTypeException,
BadDataPathCardinalityException

Retrieves the data holder, last parent segment of the given data path Example : call this method with a path like 'my-composite1/my-composite2/my-data' will retrieve the composite 'my-composite2' in the composite 'my-composite1'

Parameters:

dataHolder - the data holder

dataPath - the data path

Returns:

the parent data holder

Throws:

BadItemTypeException - if the value at the given data 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

getDataNames

public Collection<String> getDataNames()

Description copied from interface: DataHolder

Retrieves the names of data contained by this data holder Retrieves only the data at first level, does not check composite data

Specified by:

getDataNames in interface DataHolder

Returns:

the names of all data contained by this data holder

dataToSAX

public void dataToSAX(ContentHandler contentHandler,
 String dataPath,
 DataContext context)
               throws SAXException,
UnknownTypeException,
NotUniqueTypeException

Description copied from interface: DataHolder

Generates SAX events for the data at the given data path in the current DataHolder Do not generate any event if there is no values at the given path

Specified by:

dataToSAX in interface DataHolder

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

dataPath - the path of the data to SAX

context - The context of the data to SAX

Throws:

SAXException - if an error occurs during the SAX events generation

UnknownTypeException

NotUniqueTypeException

dataToSAX

public void dataToSAX(ContentHandler contentHandler,
 DataContext context)
               throws SAXException,
UnknownTypeException,
NotUniqueTypeException

Description copied from interface: ModelLessDataHolder

Generates SAX events for data contained in this DataHolder

Specified by:

dataToSAX in interface ModelLessDataHolder

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

context - The context of the data to SAX

Throws:

SAXException - if an error occurs during the SAX events generation

UnknownTypeException - if there is no compatible type with the saxed value

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

dataToJSON

public Object dataToJSON(String dataPath,
 DataContext context)
                  throws UnknownTypeException,
NotUniqueTypeException

Description copied from interface: DataHolder

Convert the data at the given path into a JSON object

Specified by:

dataToJSON in interface DataHolder

Parameters:

dataPath - the path of the data to convert

context - The context of the data to convert

Returns:

The value as JSON

Throws:

UnknownTypeException

NotUniqueTypeException

dataToJSON

public Map<String,Object> dataToJSON(DataContext context)
                              throws UnknownTypeException,
NotUniqueTypeException

Description copied from interface: ModelLessDataHolder

Convert the data contained in this DataHolder

Specified by:

dataToJSON in interface ModelLessDataHolder

Parameters:

context - The context of the data to convert

Returns:

The data of the current DataHolder as JSON

Throws:

UnknownTypeException - if there is no compatible type with the value to convert

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

hasDifferences

public boolean hasDifferences(Map<String,Object> values)
                       throws UnknownTypeException,
NotUniqueTypeException

Description copied from interface: ModelLessDataHolder

Check if there are differences between the given values and the current ones

Specified by:

hasDifferences in interface ModelLessDataHolder

Parameters:

values - the values to check

Returns:

true if there are differences, false otherwise

Throws:

UnknownTypeException - if there is no available type compatible with a given value for this data holder's type extension point

NotUniqueTypeException - if there is more than one available types compatibles with the a value for this data holder's type extension point

getRepositoryData

public RepositoryData getRepositoryData()

Description copied from interface: DataHolder

Retrieves the repository data used by this DataHolder

Specified by:

getRepositoryData in interface DataHolder

Returns:

the repository data used by this DataHolder

getParentDataHolder

public Optional<? extends ModelLessDataHolder> getParentDataHolder()

Description copied from interface: DataHolder

Retrieves the optional parent of the current DataHolder There can be no parent if the current DataHolder is the root

Specified by:

getParentDataHolder in interface DataHolder

Specified by:

getParentDataHolder in interface ModelLessDataHolder

Returns:

the parent of the current DataHolder

getRootDataHolder

public ModelLessDataHolder getRootDataHolder()

Description copied from interface: DataHolder

Retrieves the DataHolder that is the root of the current one

Specified by:

getRootDataHolder in interface DataHolder

Specified by:

getRootDataHolder in interface ModelLessDataHolder

Returns:

the root DataHolder

getModelItemTypeExtensionPoint

public ModelItemTypeExtensionPoint getModelItemTypeExtensionPoint()

Description copied from interface: ModelLessDataHolder

Provide the ModelItemTypeExtensionPoint linked with the DataHolder

Specified by:

getModelItemTypeExtensionPoint in interface ModelLessDataHolder

Returns:

the extension point