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

Class ModifiableModelAwareRepeater

java.lang.Object

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

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

All Implemented Interfaces:

ModifiableRepeater, Repeater

public class ModifiableModelAwareRepeater
extends ModelAwareRepeater
implements ModifiableRepeater

CLass for modifiable model aware repeaters

Field Summary

Fields

Modifier and Type	Field	Description
private static String	__ENTRIES_TEMPORARY_NAME_PREFIX
protected ModifiableModelAwareDataHolder	_modifiableParent	Parent of the current Repeater
protected ModifiableRepositoryData	_modifiableRepositoryData	Modifiable repository data to use to store entries in the repository
protected ModifiableModelAwareDataHolder	_modifiableRoot	Root DataHolder

Fields inherited from class org.ametys.plugins.repository.data.holder.group.impl.ModelAwareRepeater

_definition, _parent, _repositoryData, _root

Constructor Summary

Constructors

Constructor	Description
ModifiableModelAwareRepeater(ModifiableRepositoryData repositoryData, ModifiableModelAwareDataHolder parent, ModifiableModelAwareDataHolder root, RepeaterDefinition definition)	Creates a modifiable model aware repeater

Method Summary

Modifier and Type	Method	Description
ModifiableModelAwareRepeaterEntry	addEntry()	Creates a Repeater entry at the last position.
ModifiableModelAwareRepeaterEntry	addEntry(int position)	Creates a Repeater entry at the given position.
List<? extends ModifiableModelAwareRepeaterEntry>	getEntries()	Retrieves the repeater entries, sorted by position
ModifiableModelAwareRepeaterEntry	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.
<T extends SynchronizationResult> T	synchronizeValues(ViewItemContainer viewItemContainer, SynchronizableRepeater repeaterValues)	Synchronizes the given values with each repeater's entry
<T extends SynchronizationResult> T	synchronizeValues(ViewItemContainer viewItemContainer, SynchronizableRepeater repeaterValues, SynchronizationContext context)	Synchronizes the given values with each repeater's entry

Methods inherited from class org.ametys.plugins.repository.data.holder.group.impl.ModelAwareRepeater

commentsToSAX, copyTo, dataToSAX, dataToSAX, dataToSAX, dataToSAX, dataToSAX, getModel, getSize, hasEntry

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.group.Repeater

copyTo, dataToSAX, dataToSAX, getSize, hasEntry

Field Detail

__ENTRIES_TEMPORARY_NAME_PREFIX

private static final String __ENTRIES_TEMPORARY_NAME_PREFIX

See Also:

Constant Field Values

_modifiableRepositoryData

protected ModifiableRepositoryData _modifiableRepositoryData

Modifiable repository data to use to store entries in the repository

_modifiableParent

protected ModifiableModelAwareDataHolder _modifiableParent

Parent of the current Repeater

_modifiableRoot

protected ModifiableModelAwareDataHolder _modifiableRoot

Root DataHolder

Constructor Detail

ModifiableModelAwareRepeater

public ModifiableModelAwareRepeater(ModifiableRepositoryData repositoryData,
                                    ModifiableModelAwareDataHolder parent,
                                    ModifiableModelAwareDataHolder root,
                                    RepeaterDefinition definition)

Creates a modifiable model aware repeater

Parameters:

repositoryData - the repository data of the repeater

parent - the parent of the created Repeater

root - the root DataAwareAmetysObject

definition - the definition of the repeater

Method Detail

getEntries

public List<? extends ModifiableModelAwareRepeaterEntry> getEntries()

Description copied from interface: Repeater

Retrieves the repeater entries, sorted by position

Specified by:

getEntries in interface Repeater

Overrides:

getEntries in class ModelAwareRepeater

Returns:

the repeater entries

getEntry

public ModifiableModelAwareRepeaterEntry 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 ModifiableRepeater

Specified by:

getEntry in interface Repeater

Overrides:

getEntry in class ModelAwareRepeater

Parameters:

position - the position of the entry to retrieve

Returns:

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

addEntry

public ModifiableModelAwareRepeaterEntry addEntry()

Description copied from interface: ModifiableRepeater

Creates a Repeater entry at the last position.

Specified by:

addEntry in interface ModifiableRepeater

Returns:

the created entry

addEntry

public ModifiableModelAwareRepeaterEntry addEntry(int position)
                                           throws IllegalArgumentException

Description copied from interface: ModifiableRepeater

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)

Specified by:

addEntry in interface ModifiableRepeater

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

synchronizeValues

public <T extends SynchronizationResult> T synchronizeValues(ViewItemContainer viewItemContainer,
                                                             SynchronizableRepeater repeaterValues)
                                                      throws UndefinedItemPathException,
                                                             BadItemTypeException,
                                                             IOException

Synchronizes the given values with each repeater's entry

Type Parameters:

T - the type of the SynchronizationResult

Parameters:

viewItemContainer - The ViewItemContainer containing all items to synchronize

repeaterValues - the values of the repeater to synchronize

Returns:

the SynchronizationResult

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 entry's key doesn't match the corresponding value

IOException - if an error occurs while synchronizing I/O data

synchronizeValues

public <T extends SynchronizationResult> T synchronizeValues(ViewItemContainer viewItemContainer,
                                                             SynchronizableRepeater repeaterValues,
                                                             SynchronizationContext context)
                                                      throws UndefinedItemPathException,
                                                             BadItemTypeException,
                                                             IOException

Synchronizes the given values with each repeater's entry

Type Parameters:

T - the type of the SynchronizationResult

Parameters:

viewItemContainer - The ViewItemContainer containing all items to synchronize

repeaterValues - the values of the repeater to synchronize

context - the context of the synchronization

Returns:

the SynchronizationResult

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 entry's key doesn't match the corresponding value

IOException - if an error occurs while synchronizing I/O data

moveEntries

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

Description copied from interface: ModifiableRepeater

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

Specified by:

moveEntries in interface ModifiableRepeater

Parameters:

positionsMapping - the position mapping

targetSize - the target size of the repeater

Returns:

true if some entries have moved, false otherwise

removeEntries

public void removeEntries(Set<Integer> positions)
                   throws UnknownDataException

Description copied from interface: ModifiableRepeater

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)

Specified by:

removeEntries in interface ModifiableRepeater

Parameters:

positions - The positions of the entries to remove

Throws:

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

removeEntry

public void removeEntry(int position)
                 throws UnknownDataException

Description copied from interface: ModifiableRepeater

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)

Specified by:

removeEntry in interface ModifiableRepeater

Parameters:

position - The position of the entry to remove

Throws:

UnknownDataException - if there is no entry at the given position

getRepositoryData

public ModifiableRepositoryData getRepositoryData()

Description copied from interface: Repeater

Retrieves the repository data used by this Repeater

Specified by:

getRepositoryData in interface ModifiableRepeater

Specified by:

getRepositoryData in interface Repeater

Overrides:

getRepositoryData in class ModelAwareRepeater

Returns:

the repository data used by this Repeater

getParentDataHolder

public ModifiableModelAwareDataHolder getParentDataHolder()

Description copied from interface: Repeater

Retrieves the parent of the current Repeater

Specified by:

getParentDataHolder in interface ModifiableRepeater

Specified by:

getParentDataHolder in interface Repeater

Overrides:

getParentDataHolder in class ModelAwareRepeater

Returns:

the parent of the current Repeater

getRootDataHolder

public ModifiableModelAwareDataHolder getRootDataHolder()

Description copied from interface: Repeater

Retrieves the root DataHolder of the current repeater

Specified by:

getRootDataHolder in interface ModifiableRepeater

Specified by:

getRootDataHolder in interface Repeater

Overrides:

getRootDataHolder in class ModelAwareRepeater

Returns:

the root DataHolder