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

Class DefaultModifiableModelAwareDataHolder

java.lang.Object

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

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

All Implemented Interfaces:

DataHolder, ModelAwareDataHolder, ModifiableDataHolder, ModifiableModelAwareDataHolder

Direct Known Subclasses:

DefaultModifiableIndexableDataHolder

public class DefaultModifiableModelAwareDataHolder
extends DefaultModelAwareDataHolder
implements ModifiableModelAwareDataHolder

Default implementation for modifiable data holder with model

Field Summary

Fields

Modifier and Type	Field	Description
protected Optional<LockableAmetysObject>	_lockableAmetysObject	Ametys object that can be locked on data modification
protected Optional<? extends ModifiableModelAwareDataHolder>	_modifiableParent	Parent of the current DataHolder
protected ModifiableRepositoryData	_modifiableRepositoryData	Repository data to use to store data in the repository
protected ModifiableModelAwareDataHolder	_modifiableRoot	Root DataHolder

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

_itemContainers, _parent, _repositoryData, _root

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

ALTERNATIVE_SUFFIX, STATUS_SUFFIX

Constructor Summary

Constructors

Constructor	Description
DefaultModifiableModelAwareDataHolder(ModifiableRepositoryData repositoryData, Collection<? extends ModelItemContainer> itemContainers, Optional<LockableAmetysObject> lockableAmetysObject, Optional<? extends ModifiableModelAwareDataHolder> parent, Optional<? extends ModifiableModelAwareDataHolder> root)	Creates a modifiable default model aware data holder
DefaultModifiableModelAwareDataHolder(ModifiableRepositoryData repositoryData, ModelItemContainer itemContainer)	Creates a modifiable default model aware data holder
DefaultModifiableModelAwareDataHolder(ModifiableRepositoryData repositoryData, ModelItemContainer itemContainer, Optional<LockableAmetysObject> lockableAmetysObject)	Creates a modifiable default model aware data holder
DefaultModifiableModelAwareDataHolder(ModifiableRepositoryData repositoryData, ModelItemContainer itemContainer, Optional<LockableAmetysObject> lockableAmetysObject, Optional<? extends ModifiableModelAwareDataHolder> parent, Optional<? extends ModifiableModelAwareDataHolder> root)	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 ModifiableModelAwareComposite	createCompositeInstance(RepositoryData compositeRepositoryData, CompositeDefinition compositeDefinition)	Creates an instance of composite
protected ModifiableRepeater	createRepeaterInstance(RepositoryData repeaterRepositoryData, RepeaterDefinition repeaterDefinition)	Creates an instance of repeater
protected <T extends SynchronizationResult> T	createSetValueResultInstance()	Creates an instance of SynchronizationResult
protected void	doRemoveValue(String dataName, ValueContext context)	Removes the stored value of the simple data with the given name
protected <T extends SynchronizationResult> T	doSynchronizeValues(ViewItemAccessor viewItemAccessor, Map<String,Object> values, SynchronizationContext context)	Synchronizes the given values with the current ModifiableModelAwareDataHolder's ones
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 ModifiableModelAwareComposite	getComposite(String compositePath, boolean createNew, Optional<ExternalizableDataProvider.ExternalizableDataStatus> status)	Retrieves the composite at the given path, optionally creating it if it does not exist, filtered by the given externalizable status
protected ModifiableModelAwareComposite	getComposite(String name, CompositeDefinition compositeDefinition)	Retrieves the composite with the given name
protected ModifiableModelAwareComposite	getComposite(String name, CompositeDefinition compositeDefinition, boolean createNew)	Retrieves the composite with the given name
protected Class	getCompositeClass()	Retrieves the class of the managed composites
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
ModifiableRepeater	getExternalRepeater(String repeaterPath)	Retrieves the external repeater at the given path
ModifiableRepeater	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
ModifiableRepeater	getLocalRepeater(String repeaterPath)	Retrieves the local repeater at the given path
ModifiableRepeater	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
ModifiableRepeater	getRepeater(String repeaterPath)	Retrieves the repeater at the given path
ModifiableRepeater	getRepeater(String repeaterPath, boolean createNew)	Retrieves the repeater at the given path
protected ModifiableRepeater	getRepeater(String repeaterPath, boolean createNew, Optional<ExternalizableDataProvider.ExternalizableDataStatus> status)	Retrieves the repeater at the given path, optionally creating it if it does not exist, filtered by the given externalizable status
protected ModifiableRepeater	getRepeater(String name, RepeaterDefinition repeaterDefinition)	Retrieves the repeater with the given name
protected ModifiableRepeater	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
ModifiableRepositoryData	getRepositoryData()	Retrieves the repository data used by this DataHolder
ModifiableModelAwareDataHolder	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
protected void	removeExternalizableMetadataIfExists(ModifiableRepositoryData repositoryData, String dataName)	Removes the externalizable metadata (alternative value and status) for the given data name, if they exist in the given repository 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
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	setElementValue(ElementDefinition definition, String dataName, Object value)	Writes the value of the given element definition into the repository
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
protected void	setStatus(String dataPath, CompositeDefinition compositeDefinition)	Switches the current value and the alternative value of the composite at the given path to reflect the new externalizable status
protected void	setStatus(String dataPath, RepeaterDefinition repeaterDefinition)	Switches the current value and the alternative value of the repeater at the given path to reflect the new externalizable status
protected void	setStatus(String dataName, ElementDefinition elementDefinition)	Switches the current value and the alternative value of the element with the given name to reflect the new externalizable status
void	setValue(String dataPath, Object value)	Sets the value of the data at the given path
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 <T extends SynchronizationResult> T	synchronizeElement(ViewElement viewElement, Map<String,Object> values, SynchronizationContext synchronizationContext)	Synchronizes the given values with the given element's ones
protected <T extends SynchronizationResult> T	synchronizeGroup(ModelViewItemGroup modelViewItemGroup, Map<String,Object> values, SynchronizationContext synchronizationContext)	Synchronizes the given values with the given group's ones
<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(ViewItemAccessor viewItemAccessor, Map<String,Object> values)	Synchronizes the given values with the current ones
<T extends SynchronizationResult> T	synchronizeValues(ViewItemAccessor viewItemAccessor, Map<String,Object> values, SynchronizationContext context)	Synchronizes the given values with the current ModifiableModelAwareDataHolder's ones
protected boolean	updateStatusForSynchronize(String dataName, SynchronizableValue value, ValueContext context, boolean forceStatus, boolean doValuesContainData)	Updates the status of the data with the given name

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

checkDefinition, checkDefinition, checkElementDifferences, checkElementDifferencesInRemoveMode, checkStatusDifferences, createSynchronizationContextInstance, dataToJSON, dataToJSON, dataToJSON, dataToJSONForEdition, dataToMap, dataToSAX, dataToSAX, dataToSAX, dataToSAXForEdition, doesHaveDifferences, doGetDifferences, ensureNonNullItemContainers, getCompositeFromValue, getDataNames, getDifferences, getDifferences, getDifferencesInGroup, getElementValue, getExternalValue, getFinalDataName, getGroupValue, getLocalValue, getManagedClass, getModel, getMultipleValues, getRepeaterFromValue, getStatus, getValue, getValue, getValueOrDefault, getValueOrDefault, getValueWithMultiValuedPathSegments, hasDefaultValue, hasDifferences, hasDifferences, hasDifferencesInElement, hasDifferencesInGroup, hasExternalValue, hasExternalValueOrEmpty, hasLocalValue, hasLocalValueOrEmpty, hasValue, hasValue, hasValueForName, hasValueOrEmpty, hasValueOrEmpty, hasValueOrEmptyForName

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, copyTo, dataToJSON, dataToJSON, dataToSAX, dataToSAX, getValue, getValueOrDefault, hasValue, hasValueOrEmpty

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

dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToJSONForEdition, dataToMap, dataToMap, dataToMap, dataToMap, dataToSAX, dataToSAX, dataToSAX, dataToSAX, dataToSAXForEdition, getDataNames, getDefinition, getDifferences, getDifferences, getDifferences, getDifferences, getExternalValue, getLocalValue, getModel, getModelItemTypeExtensionPoint, getStatus, getType, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, getValueWithMultiValuedPathSegments, hasDefinition, hasDifferences, hasDifferences, hasDifferences, hasDifferences, hasExternalValue, hasExternalValueOrEmpty, hasLocalValue, hasLocalValueOrEmpty, hasValue, isMultiple, isMultiple

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

setValue

Field Details

_modifiableRepositoryData

protected ModifiableRepositoryData _modifiableRepositoryData

Repository data to use to store data in the repository

_lockableAmetysObject

protected Optional<LockableAmetysObject> _lockableAmetysObject

Ametys object that can be locked on data modification

_modifiableParent

protected Optional<? extends ModifiableModelAwareDataHolder> _modifiableParent

Parent of the current DataHolder

_modifiableRoot

protected ModifiableModelAwareDataHolder _modifiableRoot

Root DataHolder

Constructor Details

DefaultModifiableModelAwareDataHolder

public DefaultModifiableModelAwareDataHolder(ModifiableRepositoryData repositoryData,
 ModelItemContainer itemContainer)

Creates a modifiable default model aware data holder

Parameters:

repositoryData - the repository data to use

itemContainer - the model container 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,
 ModelItemContainer itemContainer,
 Optional<LockableAmetysObject> lockableAmetysObject)

Creates a modifiable default model aware data holder

Parameters:

repositoryData - the repository data to use

itemContainer - the model container 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.

lockableAmetysObject - the ametys object that can be locked on data modification

DefaultModifiableModelAwareDataHolder

public DefaultModifiableModelAwareDataHolder(ModifiableRepositoryData repositoryData,
 ModelItemContainer itemContainer,
 Optional<LockableAmetysObject> lockableAmetysObject,
 Optional<? extends ModifiableModelAwareDataHolder> parent,
 Optional<? extends ModifiableModelAwareDataHolder> root)

Creates a modifiable default model aware data holder

Parameters:

repositoryData - the repository data to use

itemContainer - the model container 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.

lockableAmetysObject - the ametys object that can be locked on data modification

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

root - the root DataHolder

DefaultModifiableModelAwareDataHolder

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

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.

lockableAmetysObject - the ametys object that can be locked on data modification

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

root - the root DataHolder

Method Details

getComposite

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

Description copied from interface: DataHolder

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

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

UndefinedItemPathException - if the data holder has a model and the given composite path is not defined by this model

BadDataPathCardinalityException - if the data holder has a model and 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,
BadItemTypeException,
UndefinedItemPathException,
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 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

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

UndefinedItemPathException - if the given composite 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

getExternalComposite

public ModifiableModelAwareComposite getExternalComposite(String compositePath)
                                                   throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
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 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

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

UndefinedItemPathException - if the given composite 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

getComposite

protected ModifiableModelAwareComposite 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 ModifiableRepeater getRepeater(String repeaterPath)
                               throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
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 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

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

UndefinedItemPathException - if the given repeater 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

getLocalRepeater

public ModifiableRepeater getLocalRepeater(String repeaterPath)
                                    throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
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 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

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

UndefinedItemPathException - if the given repeater 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

getExternalRepeater

public ModifiableRepeater getExternalRepeater(String repeaterPath)
                                       throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
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 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

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

UndefinedItemPathException - if the given repeater 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

getRepeater

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

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

UndefinedItemPathException - if the data holder has a model and the given composite path is not defined by this model

BadDataPathCardinalityException - if the data holder has a model and 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,
BadItemTypeException,
UndefinedItemPathException,
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

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

UndefinedItemPathException - if the given composite 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

getExternalComposite

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

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

UndefinedItemPathException - if the given composite 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

getComposite

protected ModifiableModelAwareComposite getComposite(String compositePath,
 boolean createNew,
 Optional<ExternalizableDataProvider.ExternalizableDataStatus> status)
                                              throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Retrieves the composite at the given path, optionally creating it if it does not exist, filtered by the given externalizable status

Parameters:

compositePath - the path of the composite to retrieve

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

status - the optional externalizable status to filter on, or empty to retrieve the current composite

Returns:

the composite, or null if it does not exist and createNew is false

Throws:

IllegalArgumentException - if the composite path is empty

BadItemTypeException - if the data at the given path is not a composite

UndefinedItemPathException - if the path does not match any definition

BadDataPathCardinalityException - if an intermediate segment of the path refers to a multiple data

getComposite

protected ModifiableModelAwareComposite 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

createCompositeInstance

protected ModifiableModelAwareComposite createCompositeInstance(RepositoryData compositeRepositoryData,
 CompositeDefinition compositeDefinition)

Description copied from class: DefaultModelAwareDataHolder

Creates an instance of composite

Overrides:

createCompositeInstance in class DefaultModelAwareDataHolder

Parameters:

compositeRepositoryData - the repository data of the composite to create

compositeDefinition - the definition of the composite to create

Returns:

the created composite instance

getRepeater

public ModifiableRepeater getRepeater(String repeaterPath,
 boolean createNew)
                               throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
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

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

UndefinedItemPathException - if the given composite 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

getLocalRepeater

public ModifiableRepeater getLocalRepeater(String repeaterPath,
 boolean createNew)
                                    throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
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

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

UndefinedItemPathException - if the given composite 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

getExternalRepeater

public ModifiableRepeater getExternalRepeater(String repeaterPath,
 boolean createNew)
                                       throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
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

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

UndefinedItemPathException - if the given composite 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

getRepeater

protected ModifiableRepeater getRepeater(String repeaterPath,
 boolean createNew,
 Optional<ExternalizableDataProvider.ExternalizableDataStatus> status)
                                  throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Retrieves the repeater at the given path, optionally creating it if it does not exist, filtered by the given externalizable status

Parameters:

repeaterPath - the path of the repeater to retrieve

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

status - the optional externalizable status to filter on, or empty to retrieve the current repeater

Returns:

the repeater, or null if it does not exist and createNew is false

Throws:

IllegalArgumentException - if the repeater path is empty

BadItemTypeException - if the data at the given path is not a repeater

UndefinedItemPathException - if the path does not match any definition

BadDataPathCardinalityException - if an intermediate segment of the path refers to a multiple data

getRepeater

protected ModifiableRepeater 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

createRepeaterInstance

protected ModifiableRepeater createRepeaterInstance(RepositoryData repeaterRepositoryData,
 RepeaterDefinition repeaterDefinition)

Description copied from class: DefaultModelAwareDataHolder

Creates an instance of repeater

Overrides:

createRepeaterInstance in class DefaultModelAwareDataHolder

Parameters:

repeaterRepositoryData - the repository data of the repeater to create

repeaterDefinition - the definition of the repeater to create

Returns:

the created repeater instance

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

Description copied from interface: ModifiableDataHolder

Synchronizes the given values with the current ones

Specified by:

synchronizeValues in interface ModifiableDataHolder

Type Parameters:

T - the type of the SynchronizationResult

Parameters:

values - the values to synchronize

Returns:

the SynchronizationResult

Throws:

BadItemTypeException - if type of the a data doesn't match the corresponding given value to set

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

synchronizeValues

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

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:

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

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

synchronizeValues

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

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:

viewItemAccessor - The ViewItemAccessor for all items to synchronize

values - the values to synchronize

Returns:

the SynchronizationResult

Throws:

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

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

synchronizeValues

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

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:

viewItemAccessor - The ViewItemAccessor for all items to synchronize

values - the values to synchronize

context - the context of the synchronization

Returns:

the SynchronizationResult

Throws:

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

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

doSynchronizeValues

protected <T extends SynchronizationResult> T doSynchronizeValues(ViewItemAccessor viewItemAccessor,
 Map<String,Object> values,
 SynchronizationContext context)
                                                           throws BadItemTypeException,
UndefinedItemPathException

Synchronizes the given values with the current ModifiableModelAwareDataHolder's ones

Type Parameters:

T - the type of the SynchronizationResult

Parameters:

viewItemAccessor - The ViewItemAccessor for all items to synchronize

values - the values to synchronize

context - the context of the synchronization

Returns:

the SynchronizationResult

Throws:

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

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

synchronizeGroup

protected <T extends SynchronizationResult> T synchronizeGroup(ModelViewItemGroup modelViewItemGroup,
 Map<String,Object> values,
 SynchronizationContext synchronizationContext)
                                                        throws BadItemTypeException,
UndefinedItemPathException

Synchronizes the given values with the given group's ones

Type Parameters:

T - the type of the SynchronizationResult

Parameters:

modelViewItemGroup - The group containing items to synchronize

values - the values to synchronize

synchronizationContext - the context of the synchronization

Returns:

the SynchronizationResult

Throws:

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

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

synchronizeElement

protected <T extends SynchronizationResult> T synchronizeElement(ViewElement viewElement,
 Map<String,Object> values,
 SynchronizationContext synchronizationContext)
                                                          throws BadItemTypeException,
UndefinedItemPathException

Synchronizes the given values with the given element's ones

Type Parameters:

T - the type of the SynchronizationResult

Parameters:

viewElement - The element item to synchronize

values - the values to synchronize

synchronizationContext - the context of the synchronization

Returns:

the SynchronizationResult

Throws:

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

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

updateStatusForSynchronize

protected boolean updateStatusForSynchronize(String dataName,
 SynchronizableValue value,
 ValueContext context,
 boolean forceStatus,
 boolean doValuesContainData)
                                      throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException

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

Throws:

IllegalArgumentException - if the given data name is null or empty

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

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

setValueForSynchronize

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

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 name is null or empty

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

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

removeValueForSynchronize

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

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 name is null or empty

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

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

setValue

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

Description copied from interface: ModifiableModelAwareDataHolder

Sets the value of the data at the given path

Specified by:

setValue in interface ModifiableDataHolder

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

BadItemTypeException - if type of the data at the given path doesn't match the given value to set

UndefinedItemPathException - if the data holder has a model and the given data path is not defined by the model

BadDataPathCardinalityException - if the data holder has a model and 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,
BadItemTypeException,
UndefinedItemPathException,
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

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

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

setExternalValue

public void setExternalValue(String dataPath,
 Object externalValue)
                      throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
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

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

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

protected void setValue(String dataPath,
 Object value,
 ValueContext context)
                 throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
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

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

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

setElementValue

protected void setElementValue(ElementDefinition definition,
 String dataName,
 Object value)

Writes the value of the given element definition into the repository

Parameters:

definition - the definition of the element

dataName - the final name (possibly altered with a status suffix) to use to write the repository data

value - the value to write. Can be null to write an empty value, single or array depending on the definition cardinality.

setStatus

public void setStatus(String dataPath,
 ExternalizableDataProvider.ExternalizableDataStatus status)
               throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
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

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

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

setStatus

protected void setStatus(String dataPath,
 CompositeDefinition compositeDefinition)

Switches the current value and the alternative value of the composite at the given path to reflect the new externalizable status

Parameters:

dataPath - the name of the composite data

compositeDefinition - the definition of the composite

setStatus

protected void setStatus(String dataPath,
 RepeaterDefinition repeaterDefinition)

Switches the current value and the alternative value of the repeater at the given path to reflect the new externalizable status

Parameters:

dataPath - the name of the repeater data

repeaterDefinition - the definition of the repeater

setStatus

protected void setStatus(String dataName,
 ElementDefinition elementDefinition)

Switches the current value and the alternative value of the element with the given name to reflect the new externalizable status

Parameters:

dataName - the name of the element data

elementDefinition - the definition of the element

removeValue

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

Description copied from interface: ModifiableDataHolder

Removes the stored value of the data at the given path

Specified by:

removeValue in interface ModifiableDataHolder

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 data holder has a model and the given data path is not defined by the model

BadDataPathCardinalityException - if the data holder has a model and 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,
BadItemTypeException,
UndefinedItemPathException,
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

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

removeExternalValue

public void removeExternalValue(String dataPath)
                         throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
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

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

removeValue

protected void removeValue(String dataPath,
 ValueContext context)
                    throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
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

doRemoveValue

protected void doRemoveValue(String dataName,
 ValueContext context)

Removes the stored value of the simple data with the given name

Parameters:

dataName - the simple name of the data (no path separator)

context - context of the data to remove, including the optional externalizable status

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

removeExternalizableMetadataIfExists

protected void removeExternalizableMetadataIfExists(ModifiableRepositoryData repositoryData,
 String dataName)

Removes the externalizable metadata (alternative value and status) for the given data name, if they exist in the given repository data

Parameters:

repositoryData - the repository data from which to remove the metadata

dataName - the name of the data whose externalizable metadata should be removed

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

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 DefaultModelAwareDataHolder

Returns:

the root DataHolder

checkModifiableDefinition

protected void checkModifiableDefinition(String dataPath,
 String errorMsg)
                                  throws UndefinedItemPathException

Check definition for data path, for modification methods

Parameters:

dataPath - the data path

errorMsg - the error message to throw

Throws:

UndefinedItemPathException - if the definition is not found for the given data path or if the definition is not modifiable