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

Interface ModifiableRepeater

All Superinterfaces:

Repeater

All Known Subinterfaces:

ModifiableIndexableRepeater

All Known Implementing Classes:

DefaultModifiableIndexableRepeater, DefaultModifiableRepeater

public interface ModifiableRepeater
extends Repeater

Interface for modifiable repeaters

Method Summary

Modifier and Type	Method	Description
ModifiableRepeaterEntry	addEntry()	Creates a Repeater entry at the last position.
ModifiableRepeaterEntry	addEntry(int position)	Creates a Repeater entry at the given position.
List<? extends ModifiableRepeaterEntry>	getEntries()	Retrieves the repeater entries, sorted by position
ModifiableRepeaterEntry	getEntry(int position)	Retrieves the repeater entry at the given position.
ModifiableModelAwareDataHolder	getParentDataHolder()	Retrieves the parent of the current Repeater
ModifiableRepositoryData	getRepositoryData()	Retrieves the repository data used by this Repeater
ModifiableModelAwareDataHolder	getRootDataHolder()	Retrieves the root DataHolder of the current repeater
boolean	moveEntries(Map<Integer,Integer> positionsMapping, int targetSize)	Moves the entries according to the given position mapping.
void	removeEntries(Set<Integer> positions)	Removes the repeater entries at the given positions.
void	removeEntry(int position)	Removes the repeater entry at the given position.
default <T extends SynchronizationResult> T	synchronizeValues(ViewItemAccessor viewItemAccessor, SynchronizableRepeater repeaterValues)	Synchronizes the given values with each repeater's entry
<T extends SynchronizationResult> T	synchronizeValues(ViewItemAccessor viewItemAccessor, SynchronizableRepeater repeaterValues, SynchronizationContext context)	Synchronizes the given values with each repeater's entry

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

copyTo, copyTo, dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToJSONForEdition, dataToSAX, dataToSAX, dataToSAX, dataToSAX, dataToSAX, dataToSAX, dataToSAXForEdition, getDifferences, getDifferences, getModel, getSize, hasDifferences, hasDifferences, hasEntry, hasToMoveEntries

Method Details

getEntries

List<? extends ModifiableRepeaterEntry> getEntries()

Description copied from interface: Repeater

Retrieves the repeater entries, sorted by position

Specified by:

getEntries in interface Repeater

Returns:

the repeater entries

getEntry

ModifiableRepeaterEntry 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

addEntry

ModifiableRepeaterEntry addEntry()

Creates a Repeater entry at the last position.

Returns:

the created entry

addEntry

ModifiableRepeaterEntry addEntry(int position)
                          throws IllegalArgumentException

Creates a Repeater entry at the given position. The position starts at index 1. The position can be an integer between 1 and the repeater size + 1 to insert an entry from the beginning Or the position can an integer between 0 and - the repeater size to insert 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 new entry

Returns:

the created entry

Throws:

IllegalArgumentException - if the position is not between the negative and positive repeater size

moveEntries

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

Moves the entries 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 will 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

removeEntries

void removeEntries(Set<Integer> positions)
            throws UnknownDataException

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

Parameters:

positions - The positions of the entries to remove

Throws:

UnknownDataException - if there is no entry for one of the given positions

removeEntry

void removeEntry(int position)
          throws UnknownDataException

Removes 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 remove an entry from the beginning Or the position can an integer between 0 and - the repeater size to remove an entry from the end (0 means the last entry, -1 means before the last one and so on)

Parameters:

position - The position of the entry to remove

Throws:

UnknownDataException - if there is no entry at the given position

synchronizeValues

default <T extends SynchronizationResult> T synchronizeValues(ViewItemAccessor viewItemAccessor,
 SynchronizableRepeater repeaterValues)
                                                       throws BadItemTypeException,
UndefinedItemPathException

Synchronizes the given values with each repeater's entry

Type Parameters:

T - the type of the SynchronizationResult

Parameters:

viewItemAccessor - The ViewItemAccessor for all items to synchronize

repeaterValues - the values of the repeater to synchronize

Returns:

the SynchronizationResult

Throws:

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

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

synchronizeValues

<T extends SynchronizationResult> T synchronizeValues(ViewItemAccessor viewItemAccessor,
 SynchronizableRepeater repeaterValues,
 SynchronizationContext context)
                                               throws BadItemTypeException,
UndefinedItemPathException

Synchronizes the given values with each repeater's entry

Type Parameters:

T - the type of the SynchronizationResult

Parameters:

viewItemAccessor - The ViewItemAccessor for all items to synchronize

repeaterValues - the values of the repeater to synchronize

context - the context of the synchronization

Returns:

the SynchronizationResult

Throws:

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

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

getRepositoryData

ModifiableRepositoryData getRepositoryData()

Description copied from interface: Repeater

Retrieves the repository data used by this Repeater

Specified by:

getRepositoryData in interface Repeater

Returns:

the repository data used by this Repeater

getParentDataHolder

ModifiableModelAwareDataHolder 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

ModifiableModelAwareDataHolder getRootDataHolder()

Description copied from interface: Repeater

Retrieves the root DataHolder of the current repeater

Specified by:

getRootDataHolder in interface Repeater

Returns:

the root DataHolder