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

Interface Composite

All Superinterfaces:

DataHolder

All Known Subinterfaces:

IndexableComposite, IndexableRepeaterEntry, ModelAwareComposite, ModelAwareRepeaterEntry, ModelLessComposite, ModifiableComposite, ModifiableIndexableComposite, ModifiableIndexableRepeaterEntry, ModifiableModelAwareComposite, ModifiableModelAwareRepeaterEntry, ModifiableModelLessComposite, ModifiableRepeaterEntry, RepeaterEntry

All Known Implementing Classes:

DefaultModelAwareComposite, DefaultModelAwareRepeaterEntry, DefaultModelLessComposite, DefaultModifiableModelAwareComposite, DefaultModifiableModelAwareRepeaterEntry, DefaultModifiableModelLessComposite

public interface Composite
extends DataHolder

Interface for composites

Method Summary

Modifier and Type	Method	Description
default void	copyTo(ModifiableDataHolder dataHolder)	Copies the current DataHolder to the given ModifiableModelAwareDataHolder.
default Object	dataToJSON(String dataPath, DataContext context)	Convert the data at the given path into a JSON object
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 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 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

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

dataToJSON, dataToSAX, getComposite, getParentDataHolder, getRepositoryData, getRootDataHolder

Method Details

hasValue

default 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, 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: 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, false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

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

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 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,
 String dataPath,
 DataContext context)
                throws SAXException

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

dataToJSON

default Object dataToJSON(String dataPath,
 DataContext context)

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

getDefaultDataHolder

DataHolder getDefaultDataHolder()

Retrieves the default implementation of a DataHolder to use

Returns:

the DataHolder