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

Interface ModelAwareRepeater

All Superinterfaces:

Repeater

All Known Subinterfaces:

IndexableRepeater, ModifiableIndexableRepeater, ModifiableModelAwareRepeater

All Known Implementing Classes:

DefaultModelAwareRepeater, DefaultModifiableModelAwareRepeater

public interface ModelAwareRepeater
extends Repeater

Class for model aware repeaters Here is the format of generated SAX events for data in a repeater: <entry name="<entry position>"> <sax events for data1 in the current entry> <sax events for data2 in the current entry> ... <\entry> ... Here is the format of JSON object for data in a repeater: { "entryCount" : <size>, "entries" : [ { "position" : <entry position>, "values" : { "<data1>" : <value of data1 in current entry> "<data2>" : <value of data2 in current entry> ... } }, ... ] }

Method Summary

Modifier and Type	Method	Description
default Map<String,Object>	dataToJSON()	Convert into a JSON object the data in the model of the current Repeater
Map<String,Object>	dataToJSON(DataContext context)	Convert into a JSON object the data in the model of the current Repeater
default Map<String,Object>	dataToJSON(ViewItemAccessor viewItemAccessor)	Convert into a JSON object the data in the given view of the current Repeater
Map<String,Object>	dataToJSON(ViewItemAccessor viewItemAccessor, DataContext context)	Convert into a JSON object the data in the given view of the current Repeater
default void	dataToSAX(ContentHandler contentHandler)	Generates SAX events for the data in the model of the current DataHolder
void	dataToSAX(ContentHandler contentHandler, DataContext context)	Generates SAX events for the data in the model of the current DataHolder
default void	dataToSAX(ContentHandler contentHandler, ViewItemAccessor viewItemAccessor)	Generates SAX events for the data in the given view in the current Repeater
void	dataToSAX(ContentHandler contentHandler, ViewItemAccessor viewItemAccessor, DataContext context)	Generates SAX events for the data in the given view in the current Repeater
List<? extends ModelAwareRepeaterEntry>	getEntries()	Retrieves the repeater entries, sorted by position
ModelAwareRepeaterEntry	getEntry(int position)	Retrieves the repeater entry at the given position.
RepeaterDefinition	getModel()	Retrieves the repeater's model
ModelAwareDataHolder	getParentDataHolder()	Retrieves the parent of the current Repeater
ModelAwareDataHolder	getRootDataHolder()	Retrieves the root DataHolder of the current repeater
boolean	hasDifferences(ViewItemContainer viewItemContainer, SynchronizableRepeater repeaterValues, SynchronizationContext context)	Check if there are differences between the given values and the repeater's entries

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

copyTo, dataToJSON, dataToJSON, dataToSAX, dataToSAX, getRepositoryData, getSize, hasEntry, hasToMoveEntries

Method Details

getEntries

List<? extends ModelAwareRepeaterEntry> getEntries()

Description copied from interface: Repeater

Retrieves the repeater entries, sorted by position

Specified by:

getEntries in interface Repeater

Returns:

the repeater entries

getEntry

ModelAwareRepeaterEntry getEntry(int position)

Description copied from interface: Repeater

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)

Specified by:

getEntry in interface Repeater

Parameters:

position - the position of the entry to retrieve

Returns:

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

dataToSAX

default void dataToSAX(ContentHandler contentHandler)
                throws SAXException,
BadItemTypeException

Generates SAX events for the data in the model of the current DataHolder

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

Throws:

SAXException - if an error occurs during the SAX events generation

BadItemTypeException - if the saxed value's type does not matches the stored data

dataToSAX

void dataToSAX(ContentHandler contentHandler,
 DataContext context)
        throws SAXException,
BadItemTypeException

Generates SAX events for the data in the model of the current 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

BadItemTypeException - if the saxed value's type does not matches the stored data

dataToSAX

default void dataToSAX(ContentHandler contentHandler,
 ViewItemAccessor viewItemAccessor)
                throws SAXException,
BadItemTypeException

Generates SAX events for the data in the given view in the current Repeater

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

viewItemAccessor - the ViewItemAccessor referencing the items for which generate SAX events

Throws:

SAXException - if an error occurs during the SAX events generation

BadItemTypeException - if the saxed value's type does not matches the stored data

dataToSAX

void dataToSAX(ContentHandler contentHandler,
 ViewItemAccessor viewItemAccessor,
 DataContext context)
        throws SAXException,
BadItemTypeException

Generates SAX events for the data in the given view in the current Repeater

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

viewItemAccessor - the ViewItemAccessor referencing the items for which generate SAX events

context - The context of the data to SAX

Throws:

SAXException - if an error occurs during the SAX events generation

BadItemTypeException - if the saxed value's type does not matches the stored data

dataToJSON

default Map<String,Object> dataToJSON()
                               throws BadItemTypeException

Convert into a JSON object the data in the model of the current Repeater

Returns:

The data of the current DataHolder as JSON

Throws:

BadItemTypeException - if the value's type does not matches the stored data

dataToJSON

Map<String,Object> dataToJSON(DataContext context)
                       throws BadItemTypeException

Convert into a JSON object the data in the model of the current Repeater

Parameters:

context - The context of the data to convert

Returns:

The data of the current DataHolder as JSON

Throws:

BadItemTypeException - if the value's type does not matches the stored data

dataToJSON

default Map<String,Object> dataToJSON(ViewItemAccessor viewItemAccessor)
                               throws BadItemTypeException

Convert into a JSON object the data in the given view of the current Repeater

Parameters:

viewItemAccessor - the ViewItemAccessor referencing the items to convert

Returns:

The data of the given view as JSON

Throws:

BadItemTypeException - if the value's type does not matches the stored data

dataToJSON

Map<String,Object> dataToJSON(ViewItemAccessor viewItemAccessor,
 DataContext context)
                       throws BadItemTypeException

Convert into a JSON object the data in the given view of the current Repeater

Parameters:

viewItemAccessor - the ViewItemAccessor referencing the items to convert

context - The context of the data to convert

Returns:

The data of the given view as JSON

Throws:

BadItemTypeException - if the value's type does not matches the stored data

hasDifferences

boolean hasDifferences(ViewItemContainer viewItemContainer,
 SynchronizableRepeater repeaterValues,
 SynchronizationContext context)
                throws UndefinedItemPathException,
BadItemTypeException

Check if there are differences between the given values and the repeater's entries

Parameters:

viewItemContainer - The ViewItemContainer containing all items to check

repeaterValues - the values of the repeater to check

context - the context of the synchronization

Returns:

true if there are differences, false otherwise

Throws:

UndefinedItemPathException - if an entry's key refers to a data that is not defined by the model

BadItemTypeException - if the type defined by the model of one of the entry's key doesn't match the corresponding value

getParentDataHolder

ModelAwareDataHolder getParentDataHolder()

Description copied from interface: Repeater

Retrieves the parent of the current Repeater

Specified by:

getParentDataHolder in interface Repeater

Returns:

the parent of the current Repeater

getRootDataHolder

ModelAwareDataHolder getRootDataHolder()

Description copied from interface: Repeater

Retrieves the root DataHolder of the current repeater

Specified by:

getRootDataHolder in interface Repeater

Returns:

the root DataHolder

getModel

RepeaterDefinition getModel()

Retrieves the repeater's model

Returns:

the repeater's model