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

Interface Repeater

All Known Subinterfaces:

ModifiableRepeater

All Known Implementing Classes:

AbstractRepeater, ModelAwareRepeater, ModifiableModelAwareRepeater

public interface Repeater

Interface for repeaters

Method Summary

Modifier and Type	Method	Description
void	copyTo(ModifiableRepeater repeater)	Copies the current Repeater to the given ModifiableRepeater.
default 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
void	dataToSAX(ContentHandler contentHandler, String dataPath, Locale locale)	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
List<? extends RepeaterEntry>	getEntries()	Retrieves the repeater entries, sorted by position
RepeaterEntry	getEntry(int position)	Retrieves the repeater entry at the given position.
RepositoryData	getRepositoryData()	Retrieves the repository data used by this Repeater
int	getSize()	Retrieves the size of the repeater
boolean	hasEntry(int position)	Determines if the repeater has an entry at the given position.

Method Detail

getEntries

List<? extends RepeaterEntry> getEntries()

Retrieves the repeater entries, sorted by position

Returns:

the repeater entries

getEntry

RepeaterEntry getEntry(int position)

Retrieves the repeater entry at the given position. The position starts at index 1. The position can be an integer between 1 and the repeater size to get an entry from the beginning Or the position can an integer between 0 and - the repeater size to get an entry from the end (0 means at the end, -1 means before the last one and so on)

Parameters:

position - the position of the entry to retrieve

Returns:

the repeater entry, null if there is no entry at this position

getSize

int getSize()

Retrieves the size of the repeater

Returns:

the size of the repeater

hasEntry

boolean hasEntry(int position)

Determines if the repeater has an entry at the given position. The position starts at index 1. The position can be an integer between 1 and the repeater size to get an entry from the beginning Or the position can an integer between 0 and - the repeater size to get an entry from the end (0 means at the end, -1 means before the last one and so on)

Parameters:

position - the position

Returns:

true if the repeater has an entry at the given position, false otherwise

copyTo

void copyTo(ModifiableRepeater repeater)
     throws UndefinedItemPathException,
            BadItemTypeException

Copies the current Repeater to the given ModifiableRepeater.

Parameters:

repeater - The destination repeater. Can not be null.

Throws:

UndefinedItemPathException - if one of the copied data is not defined by the model of the destination ModifiableModelAwareRepeater

BadItemTypeException - if the type defined by the model of the destination ModifiableModelAwareRepeater doesn't match the copied value

dataToSAX

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

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

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

dataToSAX

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

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

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

dataPath - the path of the data to SAX

locale - The locale to use for localized data, such as MultilingualString. Can be null to generate SAX events for all existing Locales.

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

getRepositoryData

RepositoryData getRepositoryData()

Retrieves the repository data used by this Repeater

Returns:

the repository data used by this Repeater