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

Interface ModelLessComposite

All Superinterfaces:

Composite, DataHolder, ModelLessDataHolder

All Known Subinterfaces:

ModifiableModelLessComposite

All Known Implementing Classes:

DefaultModelLessComposite, DefaultModifiableModelLessComposite

public interface ModelLessComposite
extends ModelLessDataHolder, Composite

Interface for model less composites

Method Summary

Modifier and Type	Method	Description
default void	copyTo(ModifiableDataHolder dataHolder)	Copies the current DataHolder to the given ModifiableModelAwareDataHolder.
default Map<String,Object>	dataToJSON(DataContext context)	Convert the data contained in this DataHolder
default void	dataToSAX(ContentHandler contentHandler, DataContext context)	Generates SAX events for data contained in this DataHolder
default ModelLessComposite	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
ModelLessDataHolder	getDefaultDataHolder()	Retrieves the default implementation of a DataHolder to use
default Optional<? extends ModelLessDataHolder>	getParentDataHolder()	Retrieves the optional parent of the current DataHolder There can be no parent if the current DataHolder is the root
default ModelLessDataHolder	getRootDataHolder()	Retrieves the DataHolder that is the root of the current one
default RepositoryModelItemType	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 The type of the value will be deduced from the stored data.
default <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
default <T> T	getValueOfType(String dataPath, String dataTypeId)	Retrieves the value of the data at the given path
default <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
default boolean	hasValue(String dataPath)	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

Methods inherited from interface org.ametys.plugins.repository.data.holder.group.Composite

dataToJSON, dataToSAX

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

dataToJSON, dataToSAX, getRepositoryData

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

dataToJSON, dataToSAX, getModelItemTypeExtensionPoint

Method Details

getComposite

default 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

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

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

getValue

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

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

getValueOfType

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

hasValue

default boolean hasValue(String dataPath)
                  throws IllegalArgumentException

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 Composite

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

hasValueOrEmpty

default boolean hasValueOrEmpty(String dataPath)
                         throws IllegalArgumentException

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 Composite

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

isMultiple

default 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

default 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

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 Composite

Specified by:

getDataNames in interface DataHolder

Returns:

the names of all data contained by this data holder

copyTo

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

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

dataToSAX

default 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

default 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

getParentDataHolder

default 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

default 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

getDefaultDataHolder

ModelLessDataHolder getDefaultDataHolder()

Description copied from interface: Composite

Retrieves the default implementation of a DataHolder to use

Specified by:

getDefaultDataHolder in interface Composite

Returns:

the DataHolder