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

Interface Composite

All Superinterfaces:

DataHolder

All Known Subinterfaces:

IndexableComposite, IndexableRepeaterEntry, ModelAwareComposite, ModifiableComposite, ModifiableIndexableComposite, ModifiableIndexableRepeaterEntry, ModifiableModelAwareComposite, ModifiableRepeaterEntry, RepeaterEntry

All Known Implementing Classes:

DefaultComposite, DefaultIndexableComposite, DefaultIndexableRepeaterEntry, DefaultModelAwareComposite, DefaultModifiableComposite, DefaultModifiableIndexableComposite, DefaultModifiableIndexableRepeaterEntry, DefaultModifiableModelAwareComposite, DefaultModifiableRepeaterEntry, DefaultRepeaterEntry

public interface Composite
extends DataHolder

Interface for composites

Method Summary

Modifier and Type	Method	Description
default Object	dataToJSON(String dataPath, DataContext context)	Convert the data at the given path into a JSON object
default Map<String,Object>	dataToJSON(DataContext context)	Convert the data contained in this DataHolder
default 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
default void	dataToSAX(ContentHandler contentHandler, DataContext context)	Generates SAX events for data contained in this DataHolder
default Composite	getComposite(String compositePath)	Retrieves the composite at the given path
default 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
DataHolder	getDefaultDataHolder()	Retrieves the default implementation of a DataHolder to use
default ModelItemTypeExtensionPoint	getModelItemTypeExtensionPoint()	Provide the ModelItemTypeExtensionPoint linked with the DataHolder
default Optional<? extends DataHolder>	getParentDataHolder()	Retrieves the optional parent of the current DataHolder There can be no parent if the current DataHolder is the root
default DataHolder	getRootDataHolder()	Retrieves the DataHolder that is the root of the current one
default <X extends ModelItemType> X	getType(String dataPath)	Retrieves the type of the data at the given path
default <T> T	getValue(String dataPath)	Retrieves the value of the data at the given path
default <T> T	getValueOfType(String dataPath, String dataTypeId)	Retrieves the value of the data at the given path
default <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
default <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
default boolean	hasDifferences(Map<String,Object> values)	Check if there are differences between the given values and the current ones
default boolean	hasValue(String dataPath)	Checks if there is a non empty value for the data at the given path
default boolean	hasValue(String dataPath, String dataTypeId)	Checks if there is a non empty value for the data at the given path
default boolean	hasValueOrEmpty(String dataPath)	Checks if there is a value, even empty, for the data at the given path
default boolean	isMultiple(String dataPath)	Checks if the value of the data at the given path is multiple
default boolean	isMultiple(String dataPath, String dataTypeId)	Checks if the value of the data at the given path is multiple

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

copyTo, copyTo, dataToJSON, dataToJSON, dataToSAX, dataToSAX, getRepositoryData

Method Details

getComposite

default Composite getComposite(String compositePath)
                        throws IllegalArgumentException,
UnknownTypeException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

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

UndefinedItemPathException - if the data holder has a model and the given composite path is not defined by this model

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

hasValue

default boolean hasValue(String dataPath)
                  throws IllegalArgumentException,
BadDataPathCardinalityException

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

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

hasValue

default boolean hasValue(String dataPath,
 String dataTypeId)
                  throws IllegalArgumentException,
BadDataPathCardinalityException

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

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

hasValueOrEmpty

default boolean hasValueOrEmpty(String dataPath)
                         throws IllegalArgumentException,
BadDataPathCardinalityException

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

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

getDataNames

default 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

getValue

default <T> T getValue(String dataPath)
                throws IllegalArgumentException,
UnknownTypeException,
NotUniqueTypeException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

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

UndefinedItemPathException - if the data holder has a model and the given data path is not defined by this model

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

getValueOrDefault

default <T> T getValueOrDefault(String dataPath,
 T defaultValue)
                         throws IllegalArgumentException,
UnknownTypeException,
NotUniqueTypeException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

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

UndefinedItemPathException - if the data holder has a model and the given data path is not defined by this model

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

getValueOfType

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

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

UndefinedItemPathException - if the data holder has a model and the given data path is not defined by this model

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

getValueOfTypeOrDefault

default <T> T getValueOfTypeOrDefault(String dataPath,
 String dataTypeId,
 T defaultValue)
                               throws IllegalArgumentException,
UnknownTypeException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

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

UndefinedItemPathException - if the data holder has a model and the given data path is not defined by this model

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

isMultiple

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

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

UndefinedItemPathException - if the data holder has a model and the given data path is not defined by this model

isMultiple

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

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

UndefinedItemPathException - if the data holder has a model and the given data path is not defined by this model

getType

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

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)

UndefinedItemPathException - if the data holder has a model and the given data path is not defined by this model

getModelItemTypeExtensionPoint

default ModelItemTypeExtensionPoint getModelItemTypeExtensionPoint()

Description copied from interface: DataHolder

Provide the ModelItemTypeExtensionPoint linked with the DataHolder

Specified by:

getModelItemTypeExtensionPoint in interface DataHolder

Returns:

the extension point

dataToSAX

default 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

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

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

UndefinedItemPathException - if the data holder has a model and the given data path is not defined by this model

dataToJSON

default 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

dataToJSON

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

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

UndefinedItemPathException - if the data holder has a model and the given data path is not defined by this model

hasDifferences

default 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

getParentDataHolder

default 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

default 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

getDefaultDataHolder

DataHolder getDefaultDataHolder()

Retrieves the default implementation of a DataHolder to use

Returns:

the DataHolder