Package org.ametys.cms.data.holder.impl

Class DefaultModifiableModelAwareDataHolder

java.lang.Object

org.ametys.cms.data.holder.impl.DefaultModelAwareDataHolder

org.ametys.cms.data.holder.impl.DefaultModifiableModelAwareDataHolder

All Implemented Interfaces:

IndexableDataHolder, ModifiableIndexableDataHolder, DataHolder, ModelAwareDataHolder, ModifiableDataHolder, ModifiableModelAwareDataHolder

Direct Known Subclasses:

ModifiableContentDataHolder

public class DefaultModifiableModelAwareDataHolder
extends DefaultModelAwareDataHolder
implements ModifiableIndexableDataHolder

Default implementation for modifiable data holder with model

Field Summary

Fields

Modifier and Type	Field	Description
protected Optional<? extends ModifiableIndexableDataHolder>	_modifiableParent	Parent of the current DataHolder
protected ModifiableRepositoryData	_modifiableRepositoryData	Repository data to use to store data in the repository
protected ModifiableIndexableDataHolder	_modifiableRoot	Root DataHolder

Fields inherited from class org.ametys.cms.data.holder.impl.DefaultModelAwareDataHolder

_itemContainers, _parent, _repositoryData, _root

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

ALTERNATIVE_SUFFIX, COMMENTS_SUFFIX, STATUS_SUFFIX

Constructor Summary

Constructors

Constructor	Description
DefaultModifiableModelAwareDataHolder(ModifiableRepositoryData repositoryData, Collection<? extends ModelItemContainer> itemContainers)	Creates a modifiable default model aware data holder
DefaultModifiableModelAwareDataHolder(ModifiableRepositoryData repositoryData, Optional<? extends ModifiableIndexableDataHolder> parent, Optional<? extends ModifiableIndexableDataHolder> root, Collection<? extends ModelItemContainer> itemContainers)	Creates a modifiable default model aware data holder
DefaultModifiableModelAwareDataHolder(ModifiableRepositoryData repositoryData, Optional<? extends ModifiableIndexableDataHolder> parent, Optional<? extends ModifiableIndexableDataHolder> root, ModelItemContainer... itemContainers)	Creates a modifiable default model aware data holder
DefaultModifiableModelAwareDataHolder(ModifiableRepositoryData repositoryData, ModelItemContainer... itemContainers)	Creates a modifiable default model aware data holder

Method Summary

Modifier and Type	Method	Description
protected void	_checkModifiableDefinition(String dataPath, String errorMsg)	Check definition for data path, for modification methods
protected <T extends SynchronizationResult> T	_createSetValueResultInstance()	Creates an instance of SynchronizationResult
protected <T extends SynchronizationContext> T	_createSynchronizationContextInstance()	Creates an instance of SynchronizationContext
protected ModifiableIndexableComposite	_getComposite(String name, CompositeDefinition compositeDefinition)	Retrieves the composite with the given name
protected ModifiableIndexableComposite	_getComposite(String name, CompositeDefinition compositeDefinition, boolean createNew)	Retrieves the composite with the given name
protected Class	_getCompositeClass()	Retrieves the class of the managed composites
protected ModifiableIndexableRepeater	_getRepeater(String name, RepeaterDefinition repeaterDefinition)	Retrieves the repeater with the given name
protected ModifiableIndexableRepeater	_getRepeater(String name, RepeaterDefinition repeaterDefinition, boolean createNew)	Retrieves the repeater with the given name
protected Class	_getRepeaterClass()	Retrieves the class of the managed repeaters
protected Class	_getRepeaterEntryClass()	Retrieves the class of the managed repeater entries
protected void	_removeValue(String dataPath, ValueContext context)	Removes the stored value of the data at the given path
protected <T extends SynchronizationResult> T	_removeValueForSynchronize(String dataName, ValueContext context)	Removes the stored value of the data with the given name
protected void	_setValue(String dataPath, Object value, ValueContext context)	Sets the value of the data at the given path
protected <T extends SynchronizationResult> T	_setValueForSynchronize(String dataName, SynchronizableValue value, ValueContext context)	Sets the value of the data with the given name
protected boolean	_updateStatusForSynchronize(String dataName, SynchronizableValue value, ValueContext context, boolean forceStatus, boolean doValuesContainData)	Updates the status of the data with the given name
ModifiableIndexableComposite	getComposite(String compositePath)	Retrieves the composite at the given path
ModifiableIndexableComposite	getComposite(String compositePath, boolean createNew)	Retrieves the composite at the given path
ModifiableIndexableComposite	getExternalComposite(String compositePath)	Retrieves the external composite at the given path
ModifiableIndexableComposite	getExternalComposite(String compositePath, boolean createNew)	Retrieves the external composite at the given path
ModifiableIndexableRepeater	getExternalRepeater(String repeaterPath)	Retrieves the external repeater at the given path
ModifiableIndexableRepeater	getExternalRepeater(String repeaterPath, boolean createNew)	Retrieves the external repeater at the given path
ModifiableIndexableComposite	getLocalComposite(String compositePath)	Retrieves the local composite at the given path
ModifiableIndexableComposite	getLocalComposite(String compositePath, boolean createNew)	Retrieves the local composite at the given path
ModifiableIndexableRepeater	getLocalRepeater(String repeaterPath)	Retrieves the local repeater at the given path
ModifiableIndexableRepeater	getLocalRepeater(String repeaterPath, boolean createNew)	Retrieves the local repeater at the given path
Optional<? extends ModifiableIndexableDataHolder>	getParentDataHolder()	Retrieves the optional parent of the current DataHolder There can be no parent if the current DataHolder is the root
ModifiableIndexableRepeater	getRepeater(String repeaterPath)	Retrieves the repeater at the given path
ModifiableIndexableRepeater	getRepeater(String repeaterPath, boolean createNew)	Retrieves the repeater at the given path
ModifiableRepositoryData	getRepositoryData()	Retrieves the repository data used by this DataHolder
ModifiableIndexableDataHolder	getRootDataHolder()	Retrieves the DataHolder that is the root of the current one
void	removeExternalizableMetadataIfExists(String dataPath)	Removes the stored metadata (status and alternative value) for externalizable (or ex-externalizable) data
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	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.cms.data.holder.impl.DefaultModelAwareDataHolder

_checkDefinition, _checkDefinition, _getFinalDataName, _getPropertysAmetysObject, dataToJSON, dataToJSON, dataToJSONForEdition, dataToMap, dataToSAX, dataToSAX, dataToSAXForEdition, getComments, getDataNames, getDefinition, getExternalValue, getLocalValue, getModel, getStatus, getValue, getValue, hasComments, hasExternalValue, hasExternalValueOrEmpty, hasLocalValue, hasLocalValueOrEmpty, hasValue, hasValueOrEmpty

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, dataToJSON, dataToJSON, dataToSAX, dataToSAX

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

commentsToSAX, dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToJSONForEdition, dataToMap, dataToMap, dataToMap, dataToMap, dataToSAX, dataToSAX, dataToSAX, dataToSAX, dataToSAXForEdition, getComments, getDataNames, getDefinition, getExternalValue, getLocalValue, getModel, getStatus, getType, getValue, getValue, getValue, hasComments, hasDefinition, hasExternalValue, hasExternalValueOrEmpty, hasLocalValue, hasLocalValueOrEmpty, hasValue, hasValueOrEmpty, isMultiple

Field Details

_modifiableRepositoryData

protected ModifiableRepositoryData _modifiableRepositoryData

Repository data to use to store data in the repository

_modifiableParent

protected Optional<? extends ModifiableIndexableDataHolder> _modifiableParent

Parent of the current DataHolder

_modifiableRoot

protected ModifiableIndexableDataHolder _modifiableRoot

Root DataHolder

Constructor Details

DefaultModifiableModelAwareDataHolder

public DefaultModifiableModelAwareDataHolder(ModifiableRepositoryData repositoryData,
 ModelItemContainer... itemContainers)

Creates a modifiable default model aware data holder

Parameters:

repositoryData - the repository data to use

itemContainers - the model containers to use to get information about definitions. Must match the given repository data. A repository data can have several item containers. For example, a content can have several content types.

DefaultModifiableModelAwareDataHolder

public DefaultModifiableModelAwareDataHolder(ModifiableRepositoryData repositoryData,
 Collection<? extends ModelItemContainer> itemContainers)

Creates a modifiable default model aware data holder

Parameters:

repositoryData - the repository data to use

itemContainers - the model containers to use to get information about definitions. Must match the given repository data. A repository data can have several item containers. For example, a content can have several content types.

DefaultModifiableModelAwareDataHolder

public DefaultModifiableModelAwareDataHolder(ModifiableRepositoryData repositoryData,
 Optional<? extends ModifiableIndexableDataHolder> parent,
 Optional<? extends ModifiableIndexableDataHolder> root,
 ModelItemContainer... itemContainers)

Creates a modifiable default model aware data holder

Parameters:

repositoryData - the repository data to use

parent - the parent of the created DataHolder, empty if the created DataHolder is the root DataHolder

root - the root DataHolder

itemContainers - the model containers to use to get information about definitions. Must match the given repository data. A repository data can have several item containers. For example, a content can have several content types.

DefaultModifiableModelAwareDataHolder

public DefaultModifiableModelAwareDataHolder(ModifiableRepositoryData repositoryData,
 Optional<? extends ModifiableIndexableDataHolder> parent,
 Optional<? extends ModifiableIndexableDataHolder> root,
 Collection<? extends ModelItemContainer> itemContainers)

Creates a modifiable default model aware data holder

Parameters:

repositoryData - the repository data to use

parent - the parent of the created DataHolder, empty if the created DataHolder is the root DataHolder

root - the root DataHolder

itemContainers - the model containers to use to get information about definitions. Must match the given repository data. A repository data can have several item containers. For example, a content can have several content types.

Method Details

getComposite

public ModifiableIndexableComposite 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 IndexableDataHolder

Specified by:

getComposite in interface ModelAwareDataHolder

Specified by:

getComposite in interface ModifiableDataHolder

Specified by:

getComposite in interface ModifiableIndexableDataHolder

Specified by:

getComposite in interface ModifiableModelAwareDataHolder

Overrides:

getComposite in class DefaultModelAwareDataHolder

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 ModifiableIndexableComposite 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 IndexableDataHolder

Specified by:

getLocalComposite in interface ModelAwareDataHolder

Specified by:

getLocalComposite in interface ModifiableIndexableDataHolder

Specified by:

getLocalComposite in interface ModifiableModelAwareDataHolder

Overrides:

getLocalComposite in class DefaultModelAwareDataHolder

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 ModifiableIndexableComposite 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 IndexableDataHolder

Specified by:

getExternalComposite in interface ModelAwareDataHolder

Specified by:

getExternalComposite in interface ModifiableIndexableDataHolder

Specified by:

getExternalComposite in interface ModifiableModelAwareDataHolder

Overrides:

getExternalComposite in class DefaultModelAwareDataHolder

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

_getComposite

protected ModifiableIndexableComposite _getComposite(String name,
 CompositeDefinition compositeDefinition)
                                              throws BadItemTypeException

Description copied from class: DefaultModelAwareDataHolder

Retrieves the composite with the given name

Overrides:

_getComposite in class DefaultModelAwareDataHolder

Parameters:

name - name of the composite to retrieve

compositeDefinition - the definition of the composite to retrieve

Returns:

the composite

Throws:

BadItemTypeException - if the value stored in the repository with the given name is not a composite

getRepeater

public ModifiableIndexableRepeater 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 IndexableDataHolder

Specified by:

getRepeater in interface ModelAwareDataHolder

Specified by:

getRepeater in interface ModifiableIndexableDataHolder

Specified by:

getRepeater in interface ModifiableModelAwareDataHolder

Overrides:

getRepeater in class DefaultModelAwareDataHolder

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 ModifiableIndexableRepeater 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 IndexableDataHolder

Specified by:

getLocalRepeater in interface ModelAwareDataHolder

Specified by:

getLocalRepeater in interface ModifiableIndexableDataHolder

Specified by:

getLocalRepeater in interface ModifiableModelAwareDataHolder

Overrides:

getLocalRepeater in class DefaultModelAwareDataHolder

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 ModifiableIndexableRepeater 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 IndexableDataHolder

Specified by:

getExternalRepeater in interface ModelAwareDataHolder

Specified by:

getExternalRepeater in interface ModifiableIndexableDataHolder

Specified by:

getExternalRepeater in interface ModifiableModelAwareDataHolder

Overrides:

getExternalRepeater in class DefaultModelAwareDataHolder

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

_getRepeater

protected ModifiableIndexableRepeater _getRepeater(String name,
 RepeaterDefinition repeaterDefinition)
                                            throws BadItemTypeException

Description copied from class: DefaultModelAwareDataHolder

Retrieves the repeater with the given name

Overrides:

_getRepeater in class DefaultModelAwareDataHolder

Parameters:

name - name of the repeater to retrieve

repeaterDefinition - the definition of the repeater to retrieve

Returns:

the repeater

Throws:

BadItemTypeException - if the value stored in the repository with the given name is not a repeater

getComposite

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

Description copied from interface: ModifiableModelAwareDataHolder

Retrieves the composite at the given path

Specified by:

getComposite in interface ModifiableDataHolder

Specified by:

getComposite in interface ModifiableIndexableDataHolder

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 ModifiableIndexableComposite 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 ModifiableIndexableDataHolder

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 ModifiableIndexableComposite 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 ModifiableIndexableDataHolder

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

_getComposite

protected ModifiableIndexableComposite _getComposite(String name,
 CompositeDefinition compositeDefinition,
 boolean createNew)
                                              throws BadItemTypeException

Retrieves the composite with the given name

Parameters:

name - name of the composite to retrieve

compositeDefinition - the definition of the composite to retrieve

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

Returns:

the composite

Throws:

BadItemTypeException - if the value stored in the repository with the given name is not a composite

getRepeater

public ModifiableIndexableRepeater 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 ModifiableIndexableDataHolder

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 ModifiableIndexableRepeater 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 ModifiableIndexableDataHolder

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 ModifiableIndexableRepeater 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 ModifiableIndexableDataHolder

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

_getRepeater

protected ModifiableIndexableRepeater _getRepeater(String name,
 RepeaterDefinition repeaterDefinition,
 boolean createNew)
                                            throws BadItemTypeException

Retrieves the repeater with the given name

Parameters:

name - name of the repeater to retrieve

repeaterDefinition - the definition of the repeater to retrieve

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

Returns:

the repeater

Throws:

BadItemTypeException - if the value stored in the repository with the given name is not a repeater

_getRepeaterEntryClass

protected Class _getRepeaterEntryClass()

Description copied from class: DefaultModelAwareDataHolder

Retrieves the class of the managed repeater entries

Overrides:

_getRepeaterEntryClass in class DefaultModelAwareDataHolder

Returns:

the class of the managed repeater entries

_getRepeaterClass

protected Class _getRepeaterClass()

Description copied from class: DefaultModelAwareDataHolder

Retrieves the class of the managed repeaters

Overrides:

_getRepeaterClass in class DefaultModelAwareDataHolder

Returns:

the class of the managed repeaters

_getCompositeClass

protected Class _getCompositeClass()

Description copied from class: DefaultModelAwareDataHolder

Retrieves the class of the managed composites

Overrides:

_getCompositeClass in class DefaultModelAwareDataHolder

Returns:

the class of the managed composites

synchronizeValues

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

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

synchronizeValues

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

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

synchronizeValues

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

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

synchronizeValues

public <T extends SynchronizationResult> T synchronizeValues(ViewItemContainer viewItemContainer,
 Map<String,Object> values,
 SynchronizationContext context)
                                                      throws UndefinedItemPathException,
BadItemTypeException

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

_updateStatusForSynchronize

protected boolean _updateStatusForSynchronize(String dataName,
 SynchronizableValue value,
 ValueContext context,
 boolean forceStatus,
 boolean doValuesContainData)

Updates the status of the data with the given name

Parameters:

dataName - name of the data

value - the value

context - context of the data

forceStatus - true to force the status if it is not present, false otherwise

doValuesContainData - true if the values contain the data, false otherwise

Returns:

true if the status has changed, false otherwise

_setValueForSynchronize

protected <T extends SynchronizationResult> T _setValueForSynchronize(String dataName,
 SynchronizableValue value,
 ValueContext context)
                                                               throws IllegalArgumentException,
UndefinedItemPathException,
BadItemTypeException,
BadDataPathCardinalityException

Sets the value of the data with the given name

Type Parameters:

T - the type of the SynchronizationResult

Parameters:

dataName - name of the data

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

context - context of the data to set

Returns:

the SynchronizationResult

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

_removeValueForSynchronize

protected <T extends SynchronizationResult> T _removeValueForSynchronize(String dataName,
 ValueContext context)
                                                                  throws IllegalArgumentException,
UndefinedItemPathException,
BadItemTypeException,
UnknownDataException,
BadDataPathCardinalityException

Removes the stored value of the data with the given name

Type Parameters:

T - the type of the SynchronizationResult

Parameters:

dataName - name of the data

context - context of the data to remove

Returns:

the SynchronizationResult

Throws:

IllegalArgumentException - if the given data path is null or empty

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

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

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

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

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

_setValue

protected void _setValue(String dataPath,
 Object value,
 ValueContext context)
                  throws IllegalArgumentException,
UndefinedItemPathException,
BadItemTypeException,
BadDataPathCardinalityException

Sets the value of the data at the given path

Parameters:

dataPath - path of the data

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

context - context of the data to set

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,
BadItemTypeException,
BadDataPathCardinalityException

Description copied from interface: ModifiableModelAwareDataHolder

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

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

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,
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

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,
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

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

_removeValue

protected void _removeValue(String dataPath,
 ValueContext context)
                     throws IllegalArgumentException,
UndefinedItemPathException,
BadItemTypeException,
BadDataPathCardinalityException

Removes the stored value of the data at the given path

Parameters:

dataPath - path of the data

context - context of the data to remove

Throws:

IllegalArgumentException - if the given data path is null or empty

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

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

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

removeExternalizableMetadataIfExists

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

Description copied from interface: ModifiableModelAwareDataHolder

Removes the stored metadata (status and alternative value) for externalizable (or ex-externalizable) data

Specified by:

removeExternalizableMetadataIfExists in interface ModifiableModelAwareDataHolder

Parameters:

dataPath - path of the data

Throws:

IllegalArgumentException - if the given data path is null or empty

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

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

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

_createSynchronizationContextInstance

protected <T extends SynchronizationContext> T _createSynchronizationContextInstance()

Creates an instance of SynchronizationContext

Type Parameters:

T - the type of the SynchronizationContext

Returns:

the created SynchronizationContext

_createSetValueResultInstance

protected <T extends SynchronizationResult> T _createSetValueResultInstance()

Creates an instance of SynchronizationResult

Type Parameters:

T - the type of the SynchronizationResult

Returns:

the created instance of SynchronizationResult

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 DefaultModelAwareDataHolder

Returns:

the repository data used by this DataHolder

getParentDataHolder

public Optional<? extends ModifiableIndexableDataHolder> 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 IndexableDataHolder

Specified by:

getParentDataHolder in interface ModelAwareDataHolder

Specified by:

getParentDataHolder in interface ModifiableDataHolder

Specified by:

getParentDataHolder in interface ModifiableIndexableDataHolder

Specified by:

getParentDataHolder in interface ModifiableModelAwareDataHolder

Overrides:

getParentDataHolder in class DefaultModelAwareDataHolder

Returns:

the parent of the current DataHolder

getRootDataHolder

public ModifiableIndexableDataHolder 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 IndexableDataHolder

Specified by:

getRootDataHolder in interface ModelAwareDataHolder

Specified by:

getRootDataHolder in interface ModifiableDataHolder

Specified by:

getRootDataHolder in interface ModifiableIndexableDataHolder

Specified by:

getRootDataHolder in interface ModifiableModelAwareDataHolder

Overrides:

getRootDataHolder in class DefaultModelAwareDataHolder

Returns:

the root DataHolder

_checkModifiableDefinition

protected void _checkModifiableDefinition(String dataPath,
 String errorMsg)

Check definition for data path, for modification methods

Parameters:

dataPath - the data path

errorMsg - the error message to throw