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

Class DefaultDataHolder

java.lang.Object

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

All Implemented Interfaces:

DataHolder

Direct Known Subclasses:

DefaultModifiableDataHolder

public class DefaultDataHolder
extends Object
implements DataHolder

Default implementation for data holder without model

Field Summary

Fields

Modifier and Type	Field	Description
protected Optional<? extends DataHolder>	_parent	Parent of the current DataHolder
protected RepositoryData	_repositoryData	Repository data to use to store data in the repository
protected DataHolder	_root	Root DataHolder
protected ModelItemTypeExtensionPoint	_typeExtensionPoint	Extension point to use to get available element types

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected Composite	_getComposite(String name)	Retrieves the composite with the given name
protected static DataHolder	_getParentValue(DataHolder 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
Composite	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 DataHolder>	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
DataHolder	getRootDataHolder()	Retrieves the DataHolder that is the root of the current one
<X extends ModelItemType> X	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	getValueOfType(String dataPath, String dataTypeId)	Retrieves the value of the data at the given path
<T> T	getValueOfTypeOrDefault(String dataPath, String dataTypeId, T defaultValue)	Retrieves the value of the data at the given path if exists and is not empty, or the given default value
<T> T	getValueOrDefault(String dataPath, T defaultValue)	Retrieves the value of the data at the given path if exists and is not empty, or the given 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, dataToJSON, dataToSAX, 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 DataHolder> _parent

Parent of the current DataHolder

_root

protected DataHolder _root

Root DataHolder

Constructor Details

DefaultDataHolder

public DefaultDataHolder(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

DefaultDataHolder

public DefaultDataHolder(ModelItemTypeExtensionPoint typeExtensionPoint,
 RepositoryData repositoryData,
 Optional<? extends DataHolder> parent,
 Optional<? extends DataHolder> root)

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

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

root - the root DataHolder

Method Details

getComposite

public Composite getComposite(String compositePath)
                       throws IllegalArgumentException,
UnknownTypeException,
BadItemTypeException

Description copied from interface: DataHolder

Retrieves the composite at the given path

Specified by:

getComposite in interface DataHolder

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

UnknownTypeException - if the type composite is not available for this data holder

BadItemTypeException - if the stored value at the given path is not a composite

getValue

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

Description copied from interface: DataHolder

Retrieves the value of the data at the given path

Specified by:

getValue in interface DataHolder

Type Parameters:

T - type of the value to retrieve. If the data holder has a model, the type of the value is defined by this model. Otherwise, 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

Parameters:

dataPath - path of the data

Returns:

the value of the data or null if not exists or is empty. A typed array is returned for multiple empty data, and an empty string is returned for single empty string 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)

BadItemTypeException - if the data holder has a model and the type defined by the model doesn't match the type of the stored value, or if value at the sub data path of the given one is not a composite

getValueOrDefault

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

Description copied from interface: DataHolder

Retrieves the value of the data at the given path if exists and is not empty, or the given default value

Specified by:

getValueOrDefault in interface DataHolder

Type Parameters:

T - type of the value to retrieve. If the data holder has a model, the type of the value is defined by this model. Otherwise, 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

Parameters:

dataPath - path of the data

defaultValue - default value

Returns:

the value of the data, or the given default value if the value does not exist or is empty

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

getValueOfType

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

Description copied from interface: DataHolder

Retrieves the value of the data at the given path

Specified by:

getValueOfType in interface DataHolder

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. A typed array is returned for multiple empty data, and an empty string is returned for single empty string 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 stored value at the given path

getValueOfTypeOrDefault

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

Description copied from interface: DataHolder

Retrieves the value of the data at the given path if exists and is not empty, or the given default value

Specified by:

getValueOfTypeOrDefault in interface DataHolder

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, or the given default value if the value does not exist 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

_getComposite

protected Composite _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

Description copied from interface: DataHolder

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

Specified by:

hasValue in interface DataHolder

Parameters:

dataPath - path of the data

Returns:

true if there is a non empty value for the data. If the data holder has a model and the data at the given path is defined by the model and the type of this value matches the type of the definition. false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

hasValue

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

Description copied from interface: DataHolder

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

Specified by:

hasValue in interface DataHolder

Parameters:

dataPath - path of the data

dataTypeId - type identifier of the data

Returns:

true if there is a non empty value for the data. If the data holder has a model and the data at the given path is defined by the model and the type of this value matches the type of the definition. 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

hasValueOrEmpty

public boolean hasValueOrEmpty(String dataPath)
                        throws IllegalArgumentException

Description copied from interface: DataHolder

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

Specified by:

hasValueOrEmpty in interface DataHolder

Parameters:

dataPath - path of the data

Returns:

true if there is value, even empty, for the data. If the data holder has a model and the data at the given path is defined by the model and the type of this value matches the type of the definition. false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

isMultiple

public boolean isMultiple(String dataPath)
                   throws IllegalArgumentException,
UnknownDataException,
UnknownTypeException,
NotUniqueTypeException,
BadItemTypeException

Description copied from interface: DataHolder

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

Specified by:

isMultiple in interface DataHolder

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

isMultiple

public boolean isMultiple(String dataPath,
 String dataTypeId)
                   throws IllegalArgumentException,
UnknownDataException,
UnknownTypeException,
BadItemTypeException

Description copied from interface: DataHolder

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

Specified by:

isMultiple in interface DataHolder

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

getType

public <X extends ModelItemType> X getType(String dataPath)
                                    throws IllegalArgumentException,
UnknownDataException,
UnknownTypeException,
NotUniqueTypeException

Description copied from interface: DataHolder

Retrieves the type of the data at the given path

Specified by:

getType in interface DataHolder

Type Parameters:

X - type of the item type

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)

_getParentValue

protected static DataHolder _getParentValue(DataHolder dataHolder,
 String dataPath)
                                     throws BadItemTypeException,
UnknownTypeException

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

UnknownTypeException - if the composite type is not available for this data holder

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,
 DataContext context)
               throws SAXException,
UnknownTypeException,
NotUniqueTypeException,
BadItemTypeException

Description copied from interface: DataHolder

Generates SAX events for data contained in this DataHolder

Specified by:

dataToSAX in interface DataHolder

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

BadItemTypeException - if the saxed value's type does not matches the stored data

dataToSAX

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

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

BadItemTypeException - if the saxed value's type does not matches the stored data

dataToJSON

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

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

BadItemTypeException - if the value's type does not matches the stored data

dataToJSON

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

Description copied from interface: DataHolder

Convert the data contained in this DataHolder

Specified by:

dataToJSON in interface DataHolder

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

BadItemTypeException - if the value's type does not matches the stored data

hasDifferences

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

Description copied from interface: DataHolder

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

Specified by:

hasDifferences in interface DataHolder

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

BadItemTypeException - if value doesn't match the data at corresponding path

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

Returns:

the parent of the current DataHolder

getRootDataHolder

public DataHolder getRootDataHolder()

Description copied from interface: DataHolder

Retrieves the DataHolder that is the root of the current one

Specified by:

getRootDataHolder in interface DataHolder

Returns:

the root DataHolder

getModelItemTypeExtensionPoint

public ModelItemTypeExtensionPoint getModelItemTypeExtensionPoint()

Description copied from interface: DataHolder

Provide the ModelItemTypeExtensionPoint linked with the DataHolder

Specified by:

getModelItemTypeExtensionPoint in interface DataHolder

Returns:

the extension point