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

Class ModifiableModelLessRepeaterEntry

java.lang.Object

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

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

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

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

All Implemented Interfaces:

DataHolder, Composite, ModifiableComposite, ModifiableRepeaterEntry, RepeaterEntry, ModelLessDataHolder, ModifiableDataHolder, ModifiableModelLessDataHolder

public class ModifiableModelLessRepeaterEntry
extends ModelLessRepeaterEntry
implements ModifiableRepeaterEntry, ModifiableModelLessDataHolder

Class for modifiable model free repeater entries

Field Summary

Fields

Modifier and Type	Field and Description
private ModifiableModelLessDataHolder	_modifiableDefaultDataHolder the default implementation of a ModifiableModelLessDataHolder to use
protected ModifiableModelLessRepeater	_repeater the repeater containing this entry

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

_defaultDataHolder

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

_modifiableRepositoryData

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

_repositoryData

Constructor Summary

Constructors

Constructor and Description
ModifiableModelLessRepeaterEntry(AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType> typeExtensionPoint, ModifiableRepositoryData repositoryData, ModifiableModelLessRepeater repeater) Creates a modifiable model free composite

Method Summary

Modifier and Type	Method and Description
ModifiableModelLessComposite	getComposite(String compositePath) Retrieves the composite at the given path
ModifiableModelLessComposite	getComposite(String compositePath, boolean createNew) Retrieves the composite at the given path
protected ModifiableModelLessDataHolder	getDefaultDataHolder() Retrieves the default implementation of a DataHolder to use
ModifiableModelLessRepeater	getRepeater(String repeaterPath) Retrieves the repeater at the given path
ModifiableModelLessRepeater	getRepeater(String repeaterPath, boolean createNew) Retrieves the repeater at the given path
void	removeValue(String dataPath) Removes the value of the data stored in the repository at the given path
void	setPosition(int position) Sets the position of the entry in the repeater.
void	setValue(String dataPath, Object value) Sets the value of the data at the given path
void	setValue(String dataPath, Object value, String dataTypeId) Sets the value of the data at the given path

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

copyTo, getType, getValue, getValue, getValueOfType, getValueOfType, isMultiple

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

getPosition, setPosition

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

getDataNames, hasValue

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.RepeaterEntry

getPosition

Methods inherited from interface org.ametys.plugins.repository.data.holder.DataHolder

copyTo, dataToSAX, dataToSAX, dataToSAX, dataToSAX, getDataNames, hasValue, toSAX, toSAX

Methods inherited from interface org.ametys.plugins.repository.data.holder.ModelLessDataHolder

getType, getValue, getValue, getValueOfType, getValueOfType, hasValue, isMultiple, toSAX, toSAX

Field Detail

_repeater

protected ModifiableModelLessRepeater _repeater

the repeater containing this entry

_modifiableDefaultDataHolder

private ModifiableModelLessDataHolder _modifiableDefaultDataHolder

the default implementation of a ModifiableModelLessDataHolder to use

Constructor Detail

ModifiableModelLessRepeaterEntry

public ModifiableModelLessRepeaterEntry(AbstractThreadSafeComponentExtensionPoint<RepositoryModelItemType> typeExtensionPoint,
                                        ModifiableRepositoryData repositoryData,
                                        ModifiableModelLessRepeater repeater)

Creates a modifiable model free composite

Parameters:

typeExtensionPoint - the extension point to use to get available element types

repositoryData - the repository data to use

repeater - the repeater containing this entry

Method Detail

getComposite

public ModifiableModelLessComposite getComposite(String compositePath)
                                          throws IllegalArgumentException,
                                                 BadItemTypeException,
                                                 BadDataPathCardinalityException

Description copied from interface: ModelLessDataHolder

Retrieves the composite at the given path

Specified by:

getComposite in interface DataHolder

Specified by:

getComposite in interface ModelLessDataHolder

Specified by:

getComposite in interface ModifiableDataHolder

Specified by:

getComposite in interface ModifiableModelLessDataHolder

Overrides:

getComposite in class ModelLessRepeaterEntry

Parameters:

compositePath - path of the composite to retrieve

Returns:

the composite or null if not exists

Throws:

IllegalArgumentException - if the given composite path is null or empty

BadItemTypeException - if the value stored in the repository at the given path is not a composite

BadDataPathCardinalityException - if the value of a part of the data path is multiple. Only the last part can be multiple

getRepeater

public ModifiableModelLessRepeater getRepeater(String repeaterPath)
                                        throws IllegalArgumentException,
                                               BadItemTypeException,
                                               BadDataPathCardinalityException

Description copied from interface: ModelLessDataHolder

Retrieves the repeater at the given path

Specified by:

getRepeater in interface DataHolder

Specified by:

getRepeater in interface ModelLessDataHolder

Specified by:

getRepeater in interface ModifiableDataHolder

Specified by:

getRepeater in interface ModifiableModelLessDataHolder

Overrides:

getRepeater in class ModelLessRepeaterEntry

Parameters:

repeaterPath - path of the repeater to retrieve

Returns:

the repeater or null if not exists

Throws:

IllegalArgumentException - if the given repeater path is null or empty

BadItemTypeException - if the value stored in the repository at the given path is not a repeater

BadDataPathCardinalityException - if the value of a part of the data path is multiple. Only the last part can be multiple

getComposite

public ModifiableModelLessComposite getComposite(String compositePath,
                                                 boolean createNew)
                                          throws IllegalArgumentException,
                                                 BadItemTypeException,
                                                 BadDataPathCardinalityException

Description copied from interface: ModifiableDataHolder

Retrieves the composite at the given path

Specified by:

getComposite in interface ModifiableDataHolder

Specified by:

getComposite in interface ModifiableModelLessDataHolder

Parameters:

compositePath - path of the composite to retrieve

createNew - true to create the composite if it does not exist, false otherwise

Returns:

the composite

Throws:

IllegalArgumentException - if the given composite path is null or empty

BadItemTypeException - if the value stored in the repository at the given path is not a composite

BadDataPathCardinalityException - if the value of a part of the data path is multiple. Only the last part can be multiple

getRepeater

public ModifiableModelLessRepeater getRepeater(String repeaterPath,
                                               boolean createNew)
                                        throws IllegalArgumentException,
                                               BadItemTypeException

Description copied from interface: ModifiableDataHolder

Retrieves the repeater at the given path

Specified by:

getRepeater in interface ModifiableDataHolder

Specified by:

getRepeater in interface ModifiableModelLessDataHolder

Parameters:

repeaterPath - path of the repeater to retrieve

createNew - true to create the repeater if it does not exist, false otherwise

Returns:

the repeater

Throws:

IllegalArgumentException - if the given repeater path is null or empty

BadItemTypeException - if the value stored in the repository at the given path is not a repeater

setValue

public void setValue(String dataPath,
                     Object value)
              throws IllegalArgumentException,
                     UnknownTypeException,
                     NotUniqueTypeException,
                     UnknownDataException,
                     BadDataPathCardinalityException

Description copied from interface: ModifiableModelLessDataHolder

Sets the value of the data at the given path

Specified by:

setValue in interface ModifiableModelLessDataHolder

Parameters:

dataPath - path of the data

value - the value to set

Throws:

IllegalArgumentException - if the given data path is null or empty

UnknownTypeException - if there is no available type compatible with the given value for this data holder's type extension point

NotUniqueTypeException - if there is more than one available types compatibles with the given value for this data holder's type extension point

UnknownDataException - if given the data path is composed of an inexisting group

BadDataPathCardinalityException - if the value of a part of the data path is multiple. Only the last part can be multiple

setValue

public void setValue(String dataPath,
                     Object value,
                     String dataTypeId)
              throws IllegalArgumentException,
                     UnknownTypeException,
                     BadItemTypeException,
                     UnknownDataException,
                     BadDataPathCardinalityException

Description copied from interface: ModifiableModelLessDataHolder

Sets the value of the data at the given path

Specified by:

setValue in interface ModifiableModelLessDataHolder

Parameters:

dataPath - path of the data

value - the value to set

dataTypeId - type identifier of the data

Throws:

IllegalArgumentException - if the given data path is null or empty

UnknownTypeException - if the given type is not available for this data holder's type extension point

BadItemTypeException - if the given type doesn't match the given value to set

UnknownDataException - if the given data path is composed of an inexisting group

BadDataPathCardinalityException - if the value of a part of the data path is multiple. Only the last part can be multiple

removeValue

public void removeValue(String dataPath)
                 throws IllegalArgumentException,
                        UnknownDataException,
                        BadDataPathCardinalityException

Description copied from interface: ModifiableDataHolder

Removes the value of the data stored in the repository at the given path

Specified by:

removeValue in interface ModifiableDataHolder

Specified by:

removeValue in interface ModifiableModelLessDataHolder

Parameters:

dataPath - path of the data

Throws:

IllegalArgumentException - if the given data path is null or empty

UnknownDataException - if the value at the given data path does not exist

BadDataPathCardinalityException - if the value of a part of the data path is multiple. Only the last part can be multiple

setPosition

public void setPosition(int position)
                 throws IllegalArgumentException

Description copied from interface: ModifiableRepeaterEntry

Sets the position of the entry in the repeater. The position starts at index 1. The position can be an integer between 1 and the repeater size to move an entry from the beginning Or the position can an integer between 0 and - the repeater size to move an entry from the end (0 means at the end, -1 means before the last one and so on)

Specified by:

setPosition in interface ModifiableRepeaterEntry

Parameters:

position - The new position of the entry

Throws:

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

getDefaultDataHolder

protected ModifiableModelLessDataHolder getDefaultDataHolder()

Description copied from class: AbstractComposite

Retrieves the default implementation of a DataHolder to use

Overrides:

getDefaultDataHolder in class ModelLessRepeaterEntry

Returns:

the DataHolder