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

Class ModifiableModelAwareRepeaterEntry

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

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

All Implemented Interfaces:

DataHolder, Composite, ModifiableComposite, ModifiableRepeaterEntry, RepeaterEntry, ModelAwareDataHolder, ModifiableDataHolder, ModifiableModelAwareDataHolder

public class ModifiableModelAwareRepeaterEntry
extends ModelAwareRepeaterEntry
implements ModifiableRepeaterEntry, ModifiableModelAwareDataHolder

Class for modifiable model aware repeater entries

Field Summary

Fields

Modifier and Type	Field	Description
protected ModifiableModelAwareDataHolder	_modifiableDdefaultDataHolder	the default implementation of a ModifiableModelAwareDataHolder to use
protected ModifiableModelAwareRepeater	_modifiableRepeater	the repeater containing this entry

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

_defaultDataHolder, _definition, _repeater

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

Fields inherited from interface org.ametys.plugins.repository.data.holder.ModelAwareDataHolder

ALTERNATIVE_SUFFIX, COMMENTS_SUFFIX, STATUS_SUFFIX

Constructor Summary

Constructors

Constructor	Description
ModifiableModelAwareRepeaterEntry(ModifiableRepositoryData repositoryData, ModifiableModelAwareRepeater repeater, RepeaterDefinition definition)	Creates a modifiable model aware repeater entry

Method Summary

Modifier and Type	Method	Description
ModifiableModelAwareComposite	getComposite(String compositePath)	Retrieves the composite at the given path
ModifiableModelAwareComposite	getComposite(String compositePath, boolean createNew)	Retrieves the composite at the given path
protected ModifiableModelAwareDataHolder	getDefaultDataHolder()	Retrieves the default implementation of a DataHolder to use
ModifiableModelAwareComposite	getExternalComposite(String compositePath)	Retrieves the external composite at the given path
ModifiableModelAwareComposite	getExternalComposite(String compositePath, boolean createNew)	Retrieves the external composite at the given path
ModifiableModelAwareRepeater	getExternalRepeater(String repeaterPath)	Retrieves the external repeater at the given path
ModifiableModelAwareRepeater	getExternalRepeater(String repeaterPath, boolean createNew)	Retrieves the external repeater at the given path
ModifiableModelAwareComposite	getLocalComposite(String compositePath)	Retrieves the local composite at the given path
ModifiableModelAwareComposite	getLocalComposite(String compositePath, boolean createNew)	Retrieves the local composite at the given path
ModifiableModelAwareRepeater	getLocalRepeater(String repeaterPath)	Retrieves the local repeater at the given path
ModifiableModelAwareRepeater	getLocalRepeater(String repeaterPath, boolean createNew)	Retrieves the local repeater at the given path
Optional<? extends ModifiableModelAwareDataHolder>	getParentDataHolder()	Retrieves the optional parent of the current DataHolder There can be no parent if the current DataHolder is the root
ModifiableModelAwareRepeater	getRepeater(String repeaterPath)	Retrieves the repeater at the given path
ModifiableModelAwareRepeater	getRepeater(String repeaterPath, boolean createNew)	Retrieves the repeater at the given path
ModifiableRepositoryData	getRepositoryData()	Retrieves the repository data used by this DataHolder
ModifiableModelAwareDataHolder	getRootDataHolder()	Retrieves the DataHolder that is the root of the current one
void	removeExternalValue(String dataPath)	Removes the external value of the data at the given path
void	removeLocalValue(String dataPath)	Removes the local value of the data at the given path
void	removeValue(String dataPath)	Removes the stored value of the data at the given path
void	setComments(String dataName, List<DataComment> comments)	Set the comments of the data with the given name
void	setExternalValue(String dataPath, Object externalValue)	Sets the external value of the data at the given path
void	setLocalValue(String dataPath, Object localValue)	Sets the local value of the data at the given path
void	setPosition(int position)	Sets the position of the entry in the repeater.
void	setStatus(String dataPath, ExternalizableDataProvider.ExternalizableDataStatus status)	Set the status of the data at the given path
void	setValue(String dataPath, Object value)	Sets the value of the data at the given path
<T extends SynchronizationResult> T	synchronizeValues(Map<String,Object> values)	Synchronizes the given values with the current ones
<T extends SynchronizationResult> T	synchronizeValues(Map<String,Object> values, SynchronizationContext context)	Synchronizes the given values with the current ones
<T extends SynchronizationResult> T	synchronizeValues(ViewItemContainer viewItemContainer, Map<String,Object> values)	Synchronizes the given values with the current ones
<T extends SynchronizationResult> T	synchronizeValues(ViewItemContainer viewItemContainer, Map<String,Object> values, SynchronizationContext context)	Synchronizes the given values with the current ModifiableModelAwareDataHolder's ones

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

dataToSAX, getComments, getDefinition, getExternalValue, getLocalValue, getModel, getStatus, getValue, getValue, hasComments, hasDefinition, hasExternalValue, hasLocalValue, hasNonEmptyExternalValue, hasNonEmptyLocalValue

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

copyTo, dataToSAX, getDataNames, hasNonEmptyValue, 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.DataHolder

copyTo, dataToSAX, dataToSAX

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

commentsToSAX, dataToMap, dataToMap, dataToMap, dataToMap, dataToSAX, dataToSAX, dataToSAX, dataToSAX, dataToSAXForEdition, getComments, getDataNames, getDefinition, getExternalValue, getLocalValue, getModel, getStatus, getType, getValue, getValue, getValue, hasComments, hasDefinition, hasExternalValue, hasLocalValue, hasNonEmptyExternalValue, hasNonEmptyLocalValue, hasNonEmptyValue, hasValue, isMultiple

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

getPosition

Field Detail

_modifiableRepeater

protected ModifiableModelAwareRepeater _modifiableRepeater

the repeater containing this entry

_modifiableDdefaultDataHolder

protected ModifiableModelAwareDataHolder _modifiableDdefaultDataHolder

the default implementation of a ModifiableModelAwareDataHolder to use

Constructor Detail

ModifiableModelAwareRepeaterEntry

public ModifiableModelAwareRepeaterEntry(ModifiableRepositoryData repositoryData,
                                         ModifiableModelAwareRepeater repeater,
                                         RepeaterDefinition definition)

Creates a modifiable model aware repeater entry

Parameters:

repositoryData - the repository data of the repeater entry

repeater - the repeater containing this entry

definition - the definition of the repeater

Method Detail

getComposite

public ModifiableModelAwareComposite getComposite(String compositePath)
                                           throws IllegalArgumentException,
                                                  UndefinedItemPathException,
                                                  BadItemTypeException,
                                                  BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the composite at the given path

Specified by:

getComposite in interface DataHolder

Specified by:

getComposite in interface ModelAwareDataHolder

Specified by:

getComposite in interface ModifiableDataHolder

Specified by:

getComposite in interface ModifiableModelAwareDataHolder

Overrides:

getComposite in class ModelAwareRepeaterEntry

Parameters:

compositePath - path of the composite to retrieve

Returns:

the composite or null if not exists or is empty

Throws:

IllegalArgumentException - if the given composite path is null or empty

UndefinedItemPathException - if the given composite path is not defined by the model

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

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

getLocalComposite

public ModifiableModelAwareComposite getLocalComposite(String compositePath)
                                                throws IllegalArgumentException,
                                                       UndefinedItemPathException,
                                                       BadItemTypeException,
                                                       BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the local composite at the given path

Specified by:

getLocalComposite in interface ModelAwareDataHolder

Specified by:

getLocalComposite in interface ModifiableModelAwareDataHolder

Overrides:

getLocalComposite in class ModelAwareRepeaterEntry

Parameters:

compositePath - path of the externalizable composite to retrieve

Returns:

the composite or null if not exists or is empty

Throws:

IllegalArgumentException - if the given composite path is null or empty

UndefinedItemPathException - if the given composite path is not defined by the model

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

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

getExternalComposite

public ModifiableModelAwareComposite getExternalComposite(String compositePath)
                                                   throws IllegalArgumentException,
                                                          UndefinedItemPathException,
                                                          BadItemTypeException,
                                                          BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the external composite at the given path

Specified by:

getExternalComposite in interface ModelAwareDataHolder

Specified by:

getExternalComposite in interface ModifiableModelAwareDataHolder

Overrides:

getExternalComposite in class ModelAwareRepeaterEntry

Parameters:

compositePath - path of the externalizable composite to retrieve

Returns:

the composite or null if not exists or is empty

Throws:

IllegalArgumentException - if the given composite path is null or empty

UndefinedItemPathException - if the given composite path is not defined by the model

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

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

getRepeater

public ModifiableModelAwareRepeater getRepeater(String repeaterPath)
                                         throws IllegalArgumentException,
                                                UndefinedItemPathException,
                                                BadItemTypeException,
                                                BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the repeater at the given path

Specified by:

getRepeater in interface ModelAwareDataHolder

Specified by:

getRepeater in interface ModifiableModelAwareDataHolder

Overrides:

getRepeater in class ModelAwareRepeaterEntry

Parameters:

repeaterPath - path of the repeater to retrieve

Returns:

the repeater or null if not exists or is empty

Throws:

IllegalArgumentException - if the given repeater path is null or empty

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

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

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

getLocalRepeater

public ModifiableModelAwareRepeater getLocalRepeater(String repeaterPath)
                                              throws IllegalArgumentException,
                                                     UndefinedItemPathException,
                                                     BadItemTypeException,
                                                     BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the local repeater at the given path

Specified by:

getLocalRepeater in interface ModelAwareDataHolder

Specified by:

getLocalRepeater in interface ModifiableModelAwareDataHolder

Overrides:

getLocalRepeater in class ModelAwareRepeaterEntry

Parameters:

repeaterPath - path of the externalizable repeater to retrieve

Returns:

the repeater or null if not exists or is empty

Throws:

IllegalArgumentException - if the given repeater path is null or empty

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

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

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

getExternalRepeater

public ModifiableModelAwareRepeater getExternalRepeater(String repeaterPath)
                                                 throws IllegalArgumentException,
                                                        UndefinedItemPathException,
                                                        BadItemTypeException,
                                                        BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the external repeater at the given path

Specified by:

getExternalRepeater in interface ModelAwareDataHolder

Specified by:

getExternalRepeater in interface ModifiableModelAwareDataHolder

Overrides:

getExternalRepeater in class ModelAwareRepeaterEntry

Parameters:

repeaterPath - path of the externalizable repeater to retrieve

Returns:

the repeater or null if not exists or is empty

Throws:

IllegalArgumentException - if the given repeater path is null or empty

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

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

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

getComposite

public ModifiableModelAwareComposite getComposite(String compositePath,
                                                  boolean createNew)
                                           throws IllegalArgumentException,
                                                  UndefinedItemPathException,
                                                  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 ModifiableModelAwareDataHolder

Parameters:

compositePath - path of the composite to retrieve

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

Returns:

the composite or null if createNew is false and value not exists or is empty

Throws:

IllegalArgumentException - if the given composite path is null or empty

UndefinedItemPathException - if the given composite path is not defined by the model

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

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

getLocalComposite

public ModifiableModelAwareComposite getLocalComposite(String compositePath,
                                                       boolean createNew)
                                                throws IllegalArgumentException,
                                                       UndefinedItemPathException,
                                                       BadItemTypeException,
                                                       BadDataPathCardinalityException

Description copied from interface: ModifiableModelAwareDataHolder

Retrieves the local composite at the given path

Specified by:

getLocalComposite in interface ModifiableModelAwareDataHolder

Parameters:

compositePath - path of the externalizable composite to retrieve

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

Returns:

the composite or null if createNew is false and value not exists or is empty

Throws:

IllegalArgumentException - if the given composite path is null or empty

UndefinedItemPathException - if the given composite path is not defined by the model

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

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

getExternalComposite

public ModifiableModelAwareComposite getExternalComposite(String compositePath,
                                                          boolean createNew)
                                                   throws IllegalArgumentException,
                                                          UndefinedItemPathException,
                                                          BadItemTypeException,
                                                          BadDataPathCardinalityException

Description copied from interface: ModifiableModelAwareDataHolder

Retrieves the external composite at the given path

Specified by:

getExternalComposite in interface ModifiableModelAwareDataHolder

Parameters:

compositePath - path of the externalizable composite to retrieve

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

Returns:

the composite or null if createNew is false and value not exists or is empty

Throws:

IllegalArgumentException - if the given composite path is null or empty

UndefinedItemPathException - if the given composite path is not defined by the model

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

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

getRepeater

public ModifiableModelAwareRepeater getRepeater(String repeaterPath,
                                                boolean createNew)
                                         throws IllegalArgumentException,
                                                UndefinedItemPathException,
                                                BadItemTypeException,
                                                BadDataPathCardinalityException

Description copied from interface: ModifiableModelAwareDataHolder

Retrieves the repeater at the given path

Specified by:

getRepeater in interface ModifiableModelAwareDataHolder

Parameters:

repeaterPath - path of the repeater to retrieve

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

Returns:

the repeater or null if createNew is false and value not exists or is empty

Throws:

IllegalArgumentException - if the given repeater path is null or empty

UndefinedItemPathException - if the given composite path is not defined by the model

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

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

getLocalRepeater

public ModifiableModelAwareRepeater getLocalRepeater(String repeaterPath,
                                                     boolean createNew)
                                              throws IllegalArgumentException,
                                                     UndefinedItemPathException,
                                                     BadItemTypeException,
                                                     BadDataPathCardinalityException

Description copied from interface: ModifiableModelAwareDataHolder

Retrieves the local repeater at the given path

Specified by:

getLocalRepeater in interface ModifiableModelAwareDataHolder

Parameters:

repeaterPath - path of the externalizable repeater to retrieve

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

Returns:

the repeater or null if createNew is false and value not exists or is empty

Throws:

IllegalArgumentException - if the given repeater path is null or empty

UndefinedItemPathException - if the given composite path is not defined by the model

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

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

getExternalRepeater

public ModifiableModelAwareRepeater getExternalRepeater(String repeaterPath,
                                                        boolean createNew)
                                                 throws IllegalArgumentException,
                                                        UndefinedItemPathException,
                                                        BadItemTypeException,
                                                        BadDataPathCardinalityException

Description copied from interface: ModifiableModelAwareDataHolder

Retrieves the external repeater at the given path

Specified by:

getExternalRepeater in interface ModifiableModelAwareDataHolder

Parameters:

repeaterPath - path of the externalizable repeater to retrieve

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

Returns:

the repeater or null if createNew is false and value not exists or is empty

Throws:

IllegalArgumentException - if the given repeater path is null or empty

UndefinedItemPathException - if the given composite path is not defined by the model

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

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

synchronizeValues

public <T extends SynchronizationResult> T synchronizeValues(Map<String,Object> values)
                                                      throws UndefinedItemPathException,
                                                             BadItemTypeException,
                                                             IOException

Description copied from interface: ModifiableModelAwareDataHolder

Synchronizes the given values with the current ones

Specified by:

synchronizeValues in interface ModifiableModelAwareDataHolder

Type Parameters:

T - the type of the SynchronizationResult

Parameters:

values - the values to synchronize

Returns:

the SynchronizationResult

Throws:

UndefinedItemPathException - if a key in the given Map refers to a data that is not defined by the model

BadItemTypeException - if the type defined by the model of one of the Map'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(Map<String,Object> values,
                                                             SynchronizationContext context)
                                                      throws UndefinedItemPathException,
                                                             BadItemTypeException,
                                                             IOException

Description copied from interface: ModifiableModelAwareDataHolder

Synchronizes the given values with the current ones

Specified by:

synchronizeValues in interface ModifiableModelAwareDataHolder

Type Parameters:

T - the type of the SynchronizationResult

Parameters:

values - the values to synchronize

context - the context of the synchronization

Returns:

the SynchronizationResult

Throws:

UndefinedItemPathException - if a key in the given Map refers to a data that is not defined by the model

BadItemTypeException - if the type defined by the model of one of the Map'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,
                                                             Map<String,Object> values)
                                                      throws UndefinedItemPathException,
                                                             BadItemTypeException,
                                                             IOException

Description copied from interface: ModifiableModelAwareDataHolder

Synchronizes the given values with the current ones

Specified by:

synchronizeValues in interface ModifiableModelAwareDataHolder

Type Parameters:

T - the type of the SynchronizationResult

Parameters:

viewItemContainer - The ViewItemContainer containing all items to synchronize

values - the values to synchronize

Returns:

the SynchronizationResult

Throws:

UndefinedItemPathException - if a key in the given Map refers to a data that is not defined by the model

BadItemTypeException - if the type defined by the model of one of the Map'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,
                                                             Map<String,Object> values,
                                                             SynchronizationContext context)
                                                      throws UndefinedItemPathException,
                                                             BadItemTypeException,
                                                             IOException

Description copied from interface: ModifiableModelAwareDataHolder

Synchronizes the given values with the current ModifiableModelAwareDataHolder's ones

Specified by:

synchronizeValues in interface ModifiableModelAwareDataHolder

Type Parameters:

T - the type of the SynchronizationResult

Parameters:

viewItemContainer - The ViewItemContainer containing all items to synchronize

values - the values to synchronize

context - the context of the synchronization

Returns:

the SynchronizationResult

Throws:

UndefinedItemPathException - if a key in the given Map refers to a data that is not defined by the model

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

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

setValue

public void setValue(String dataPath,
                     Object value)
              throws IllegalArgumentException,
                     UndefinedItemPathException,
                     BadItemTypeException,
                     BadDataPathCardinalityException

Description copied from interface: ModifiableModelAwareDataHolder

Sets the value of the data at the given path

Specified by:

setValue in interface ModifiableModelAwareDataHolder

Parameters:

dataPath - path of the data

value - the value to set. Give null to empty the value.

Throws:

IllegalArgumentException - if the given data path is null or empty

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

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

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

setLocalValue

public void setLocalValue(String dataPath,
                          Object localValue)
                   throws IllegalArgumentException,
                          UndefinedItemPathException,
                          BadItemTypeException,
                          BadDataPathCardinalityException

Description copied from interface: ModifiableModelAwareDataHolder

Sets the local value of the data at the given path

Specified by:

setLocalValue in interface ModifiableModelAwareDataHolder

Parameters:

dataPath - path of the externalizable data

localValue - the local value to set. Give null to empty the value.

Throws:

IllegalArgumentException - if the given data path is null or empty

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

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

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

setExternalValue

public void setExternalValue(String dataPath,
                             Object externalValue)
                      throws IllegalArgumentException,
                             UndefinedItemPathException,
                             BadItemTypeException,
                             BadDataPathCardinalityException

Description copied from interface: ModifiableModelAwareDataHolder

Sets the external value of the data at the given path

Specified by:

setExternalValue in interface ModifiableModelAwareDataHolder

Parameters:

dataPath - path of the externalizable data

externalValue - the external value to set. Give null to empty the value.

Throws:

IllegalArgumentException - if the given data path is null or empty

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

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

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

setStatus

public void setStatus(String dataPath,
                      ExternalizableDataProvider.ExternalizableDataStatus status)
               throws IllegalArgumentException,
                      UndefinedItemPathException,
                      BadItemTypeException,
                      BadDataPathCardinalityException

Description copied from interface: ModifiableModelAwareDataHolder

Set the status of the data at the given path

Specified by:

setStatus in interface ModifiableModelAwareDataHolder

Parameters:

dataPath - path of the externalizable data

status - the new status

Throws:

IllegalArgumentException - if the given data path is null or empty

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

BadItemTypeException - if there is a type issue while getting the parent (part of the dataPath without the last segment)

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

setComments

public void setComments(String dataName,
                        List<DataComment> comments)
                 throws IllegalArgumentException,
                        UndefinedItemPathException

Description copied from interface: ModifiableModelAwareDataHolder

Set the comments of the data with the given name

Specified by:

setComments in interface ModifiableModelAwareDataHolder

Parameters:

dataName - name of the data

comments - the comments to set

Throws:

IllegalArgumentException - if the given data name is null or empty

UndefinedItemPathException - if the given data name is not defined by the model

removeValue

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

Description copied from interface: ModifiableDataHolder

Removes the stored value of the data at the given path

Specified by:

removeValue in interface ModifiableDataHolder

Specified by:

removeValue in interface ModifiableModelAwareDataHolder

Parameters:

dataPath - path of the data

Throws:

IllegalArgumentException - if the given data path is null or empty

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

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

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

removeLocalValue

public void removeLocalValue(String dataPath)
                      throws IllegalArgumentException,
                             UndefinedItemPathException,
                             BadItemTypeException,
                             UnknownDataException,
                             BadDataPathCardinalityException

Description copied from interface: ModifiableModelAwareDataHolder

Removes the local value of the data at the given path

Specified by:

removeLocalValue in interface ModifiableModelAwareDataHolder

Parameters:

dataPath - path of the externalizable data

Throws:

IllegalArgumentException - if the given data path is null or empty

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

BadItemTypeException - if the value of the parent of the given path is not an item container

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

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

removeExternalValue

public void removeExternalValue(String dataPath)
                         throws IllegalArgumentException,
                                UndefinedItemPathException,
                                BadItemTypeException,
                                UnknownDataException,
                                BadDataPathCardinalityException

Description copied from interface: ModifiableModelAwareDataHolder

Removes the external value of the data at the given path

Specified by:

removeExternalValue in interface ModifiableModelAwareDataHolder

Parameters:

dataPath - path of the externalizable data

Throws:

IllegalArgumentException - if the given data path is null or empty

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

BadItemTypeException - if the value of the parent of the given path is not an item container

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

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

getParentDataHolder

public Optional<? extends ModifiableModelAwareDataHolder> getParentDataHolder()

Description copied from interface: DataHolder

Retrieves the optional parent of the current DataHolder There can be no parent if the current DataHolder is the root

Specified by:

getParentDataHolder in interface DataHolder

Specified by:

getParentDataHolder in interface ModelAwareDataHolder

Specified by:

getParentDataHolder in interface ModifiableDataHolder

Specified by:

getParentDataHolder in interface ModifiableModelAwareDataHolder

Overrides:

getParentDataHolder in class ModelAwareRepeaterEntry

Returns:

the parent of the current DataHolder

getRootDataHolder

public ModifiableModelAwareDataHolder getRootDataHolder()

Description copied from interface: DataHolder

Retrieves the DataHolder that is the root of the current one

Specified by:

getRootDataHolder in interface DataHolder

Specified by:

getRootDataHolder in interface ModelAwareDataHolder

Specified by:

getRootDataHolder in interface ModifiableDataHolder

Specified by:

getRootDataHolder in interface ModifiableModelAwareDataHolder

Overrides:

getRootDataHolder in class ModelAwareRepeaterEntry

Returns:

the root DataHolder

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 ModifiableModelAwareDataHolder getDefaultDataHolder()

Description copied from class: AbstractComposite

Retrieves the default implementation of a DataHolder to use

Overrides:

getDefaultDataHolder in class ModelAwareRepeaterEntry

Returns:

the DataHolder

getRepositoryData

public ModifiableRepositoryData getRepositoryData()

Description copied from interface: DataHolder

Retrieves the repository data used by this DataHolder

Specified by:

getRepositoryData in interface DataHolder

Specified by:

getRepositoryData in interface ModifiableDataHolder

Overrides:

getRepositoryData in class AbstractComposite

Returns:

the repository data used by this DataHolder