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

Interface Repeater

All Known Subinterfaces:

IndexableRepeater, ModifiableIndexableRepeater, ModifiableRepeater

All Known Implementing Classes:

DefaultIndexableRepeater, DefaultModifiableIndexableRepeater, DefaultModifiableRepeater, DefaultRepeater

public interface Repeater

Interface for 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 void	copyTo(ModifiableRepeater repeater)	Copies the current Repeater to the given ModifiableRepeater.
void	copyTo(ModifiableRepeater repeater, DataContext context)	Copies the current Repeater to the given ModifiableRepeater.
default Map<String,Object>	dataToJSON()	Convert into a JSON object the data in the model of the current Repeater
default Map<String,Object>	dataToJSON(String dataPath)	Convert the data at the given path into a JSON object
Map<String,Object>	dataToJSON(String dataPath, DataContext context)	Convert the data at the given path into a JSON object
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
Map<String,Object>	dataToJSONForEdition(ViewItemAccessor viewItemAccessor, DataContext context)	Convert into a JSON object the data in the given view in edition mode of the current Repeater
default void	dataToSAX(ContentHandler contentHandler)	Generates SAX events for the data in the model of the current DataHolder
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, 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
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
void	dataToSAXForEdition(ContentHandler contentHandler, ViewItemAccessor viewItemAccessor, DataContext context)	Generates SAX events for the data in the given view in edition mode in the current Repeater
default Collection<ModelItem>	getDifferences(ViewItemAccessor viewItemAccessor, SynchronizableRepeater repeaterValues)	Get the collection of model items where there are differences between the given values and the repeater's entries
Collection<ModelItem>	getDifferences(ViewItemAccessor viewItemAccessor, SynchronizableRepeater repeaterValues, SynchronizationContext context)	Get the collection of model items where there are differences between the given values and the repeater's entries
List<? extends RepeaterEntry>	getEntries()	Retrieves the repeater entries, sorted by position
RepeaterEntry	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
RepositoryData	getRepositoryData()	Retrieves the repository data used by this Repeater
ModelAwareDataHolder	getRootDataHolder()	Retrieves the root DataHolder of the current repeater
int	getSize()	Retrieves the size of the repeater
default boolean	hasDifferences(ViewItemAccessor viewItemAccessor, SynchronizableRepeater repeaterValues)	Check if there are differences between the given values and the repeater's entries
boolean	hasDifferences(ViewItemAccessor viewItemAccessor, SynchronizableRepeater repeaterValues, SynchronizationContext context)	Check if there are differences between the given values and the repeater's entries
boolean	hasEntry(int position)	Determines if the repeater has an entry at the given position.
boolean	hasToMoveEntries(Map<Integer,Integer> positionsMapping, int targetSize)	Check if has to be moved according to the given position mapping.

Method Details

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

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

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

copyTo

void copyTo(ModifiableRepeater repeater,
 DataContext context)
     throws UndefinedItemPathException,
BadItemTypeException

Copies the current Repeater to the given ModifiableRepeater.

Parameters:

repeater - The destination repeater. Can not be null.

context - The context of the data to copy

Throws:

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

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

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,
 String dataPath)
                throws SAXException,
BadItemTypeException,
UndefinedItemPathException

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

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

UndefinedItemPathException - if the given data path is not defined by the model of the repeater

dataToSAX

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

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

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

UndefinedItemPathException - if the given data path is not defined by the model of the repeater

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

dataToSAXForEdition

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

Generates SAX events for the data in the given view in edition mode 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(String dataPath)
                               throws BadItemTypeException,
UndefinedItemPathException

Convert the data at the given path into a JSON object

Parameters:

dataPath - the path of the data to convert

Returns:

The value as JSON

Throws:

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

UndefinedItemPathException - if the given data path is not defined by the model of the repeater

dataToJSON

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

Convert the data at the given path into a JSON object

Parameters:

dataPath - the path of the data to convert

context - The context of the data to convert

Returns:

The value as JSON

Throws:

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

UndefinedItemPathException - if the given data path is not defined by the model of the repeater

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

dataToJSONForEdition

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

Convert into a JSON object the data in the given view in edition mode 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

hasToMoveEntries

boolean hasToMoveEntries(Map<Integer,Integer> positionsMapping,
 int targetSize)

Check if has to be moved according to the given position mapping. The given position mapping's key is the previous position and the value is the new one The existent entries with no corresponding entry in the position mapping should be removed the given size is taken into account to create new empty entries if needed

Parameters:

positionsMapping - the position mapping

targetSize - the target size of the repeater

Returns:

true if some entries have moved, false otherwise

hasDifferences

default boolean hasDifferences(ViewItemAccessor viewItemAccessor,
 SynchronizableRepeater repeaterValues)
                        throws BadItemTypeException

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

Parameters:

viewItemAccessor - The ViewItemAccessor for all items to check

repeaterValues - the values of the repeater to check

Returns:

true if there are differences, false otherwise

Throws:

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

hasDifferences

boolean hasDifferences(ViewItemAccessor viewItemAccessor,
 SynchronizableRepeater repeaterValues,
 SynchronizationContext context)
                throws BadItemTypeException

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

Parameters:

viewItemAccessor - The ViewItemAccessor for 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:

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

getDifferences

default Collection<ModelItem> getDifferences(ViewItemAccessor viewItemAccessor,
 SynchronizableRepeater repeaterValues)
                                      throws BadItemTypeException

Get the collection of model items where there are differences between the given values and the repeater's entries

Parameters:

viewItemAccessor - The ViewItemAccessor for all items to check

repeaterValues - the values of the repeater to check

Returns:

a collection of model items with differences

Throws:

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

getDifferences

Collection<ModelItem> getDifferences(ViewItemAccessor viewItemAccessor,
 SynchronizableRepeater repeaterValues,
 SynchronizationContext context)
                              throws BadItemTypeException

Get the collection of model items where there are differences between the given values and the repeater's entries

Parameters:

viewItemAccessor - The ViewItemAccessor for all items to check

repeaterValues - the values of the repeater to check

context - the context of the synchronization

Returns:

a collection of model items with differences

Throws:

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

getRepositoryData

RepositoryData getRepositoryData()

Retrieves the repository data used by this Repeater

Returns:

the repository data used by this Repeater

getParentDataHolder

ModelAwareDataHolder getParentDataHolder()

Retrieves the parent of the current Repeater

Returns:

the parent of the current Repeater

getRootDataHolder

ModelAwareDataHolder getRootDataHolder()

Retrieves the root DataHolder of the current repeater

Returns:

the root DataHolder

getModel

RepeaterDefinition getModel()

Retrieves the repeater's model

Returns:

the repeater's model