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

Class AbstractRepeater

java.lang.Object

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

All Implemented Interfaces:

Repeater

Direct Known Subclasses:

ModelAwareRepeater, ModelLessRepeater

public abstract class AbstractRepeater
extends Object
implements Repeater

Abstract class for repeaters

Field Summary

Fields

Modifier and Type	Field and Description
protected RepositoryData	_repositoryData Repository data to use to store entries in the repository
private static String	ENTRIES_TEMPORARY_NAME_PREFIX

Constructor Summary

Constructors

Constructor and Description
AbstractRepeater(RepositoryData repositoryData) Creates a repeater

Method Summary

Modifier and Type	Method and Description
void	copyTo(ModifiableRepeater repeater) Copies the current Repeater to the given ModifiableRepeater.
List<? extends RepeaterEntry>	getEntries() Retrieves the repeater entries, sorted by position
int	getSize() Retrieves the size of the repeater
boolean	hasEntry(int position) Determines if the repeater has an entry at the given position.
protected void	moveEntries(Map<Integer,Integer> positionsMapping, ModifiableRepositoryData repeaterData) Moves the entries according to the given position mapping.
protected void	removeEntry(int position, ModifiableRepositoryData repositoryData) Removes the repeater entry at the given position.

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

getEntry

Field Detail

ENTRIES_TEMPORARY_NAME_PREFIX

private static final String ENTRIES_TEMPORARY_NAME_PREFIX

See Also:

Constant Field Values

_repositoryData

protected RepositoryData _repositoryData

Repository data to use to store entries in the repository

Constructor Detail

AbstractRepeater

public AbstractRepeater(RepositoryData repositoryData)

Creates a repeater

Parameters:

repositoryData - the repository data to use

Method Detail

getEntries

public List<? extends RepeaterEntry> getEntries()

Description copied from interface: Repeater

Retrieves the repeater entries, sorted by position

Specified by:

getEntries in interface Repeater

Returns:

the repeater entries

getSize

public int getSize()

Description copied from interface: Repeater

Retrieves the size of the repeater

Specified by:

getSize in interface Repeater

Returns:

the size of the repeater

hasEntry

public boolean hasEntry(int position)

Description copied from interface: Repeater

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)

Specified by:

hasEntry in interface Repeater

Parameters:

position - the position

Returns:

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

moveEntries

protected void moveEntries(Map<Integer,Integer> positionsMapping,
                           ModifiableRepositoryData repeaterData)

Moves the entries according to the given position mapping. The given position mapping's key is the new position and the value is the previous position Put negative value for new entries The existent entries with no corresponding entry in the position mapping will be removed

Parameters:

positionsMapping - the position mapping

repeaterData - the repository data of the repeater

removeEntry

protected void removeEntry(int position,
                           ModifiableRepositoryData repositoryData)
                    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 at the end, -1 means before the last one and so on)

Parameters:

position - The position of the entry to remove

repositoryData - the repository data of the repeater

Throws:

UnknownDataException - if there is no entry at this position

copyTo

public void copyTo(ModifiableRepeater repeater)
            throws UndefinedItemPathException,
                   BadItemTypeException,
                   UnknownTypeException,
                   NotUniqueTypeException

Description copied from interface: Repeater

Copies the current Repeater to the given ModifiableRepeater.

Specified by:

copyTo in interface Repeater

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

UnknownTypeException - if there is no available type compatible with the copied value for the type extension point of the destination ModifiableModelLessRepeater

NotUniqueTypeException - if there is more than one available types compatibles with the copied value for the type extension point of the destination ModifiableModelLessRepeater