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

Class AbstractComposite

java.lang.Object

org.ametys.plugins.repository.data.holder.group.impl.AbstractComposite

All Implemented Interfaces:

DataHolder, Composite

Direct Known Subclasses:

AbstractRepeaterEntry, ModelAwareComposite, ModelLessComposite

public abstract class AbstractComposite
extends Object
implements Composite

Abstract class for composites

Field Summary

Fields

Modifier and Type	Field	Description
protected RepositoryData	_repositoryData	The repository data of the repeater entry

Constructor Summary

Constructors

Constructor	Description
AbstractComposite(RepositoryData repositoryData)	Creates a repeater entry

Method Summary

Modifier and Type	Method	Description
void	copyTo(ModifiableDataHolder dataHolder)	Copies the current DataHolder to the given ModifiableModelAwareDataHolder.
void	dataToSAX(ContentHandler contentHandler, String dataPath)	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
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
protected abstract DataHolder	getDefaultDataHolder()	Retrieves the default implementation of a DataHolder to use
RepositoryData	getRepositoryData()	Retrieves the repository data used by this DataHolder
boolean	hasNonEmptyValue(String dataPath)	Checks if there is a non empty value for the data at the given path
boolean	hasValue(String dataPath)	Checks if there is a value for the data at the given path

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

dataToSAX, getComposite, getParentDataHolder, getRootDataHolder

Field Detail

_repositoryData

protected RepositoryData _repositoryData

The repository data of the repeater entry

Constructor Detail

AbstractComposite

public AbstractComposite(RepositoryData repositoryData)

Creates a repeater entry

Parameters:

repositoryData - the repository data of the repeater entry

Method Detail

hasValue

public boolean hasValue(String dataPath)
                 throws IllegalArgumentException,
                        BadDataPathCardinalityException

Description copied from interface: DataHolder

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

Throws:

IllegalArgumentException - if the given data path is null or empty

BadDataPathCardinalityException

hasNonEmptyValue

public boolean hasNonEmptyValue(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:

hasNonEmptyValue 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

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

copyTo

public 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

public void dataToSAX(ContentHandler contentHandler,
                      String dataPath)
               throws SAXException,
                      IOException

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

Throws:

SAXException - if an error occurs during the SAX events generation

IOException - if an error occurs while reading a value using the I/O API

getDefaultDataHolder

protected abstract DataHolder getDefaultDataHolder()

Retrieves the default implementation of a DataHolder to use

Returns:

the DataHolder

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