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

public class DefaultModifiableModelAwareDataHolder
extends DefaultModelAwareDataHolder
implements ModifiableModelAwareDataHolder

Default implementation for modifiable data holder with model

Field Summary

Fields

Modifier and Type	Field	Description
private static String	__TEMP_SUFFIX
protected ModifiableRepositoryData	_modifiableRepositoryData	Repository data to use to store data in the repository

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

_itemContainers, _repositoryData

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)	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
private void	_fillViewItemContainerFromValues(Map<String,Object> values, ViewItemContainer viewItemContainer, Collection<? extends ModelItemContainer> modelItemContainers)
private void	_fillViewItemContainerFromValues(Map<String,Object> values, ViewItemContainer viewItemContainer, ModelItemContainer modelItemContainer)
private ModifiableModelAwareComposite	_getComposite(String compositePath, boolean createNew, Optional<ExternalizableDataProvider.ExternalizableDataStatus> 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
private ModifiableModelAwareRepeater	_getRepeater(String repeaterPath, boolean createNew, Optional<ExternalizableDataProvider.ExternalizableDataStatus> status)
protected ModifiableModelAwareRepeater	_getRepeater(String name, RepeaterDefinition repeaterDefinition)	Retrieves the repeater with the given name
protected ModifiableModelAwareRepeater	_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
private void	_removeExternalizableMetadataIfExists(String dataName)
private void	_removeValue(String dataPath, Optional<ExternalizableDataProvider.ExternalizableDataStatus> status)
private void	_removeValueForSynchronize(String dataName, boolean isDataExternalizable)
private void	_setElementValue(ElementDefinition defintion, String dataName, Object value)
private void	_setStatus(String dataPath, CompositeDefinition compositeDefinition)
private void	_setStatus(String dataPath, RepeaterDefinition repeaterDefinition)
private void	_setStatus(String dataPath, ElementDefinition elementDefinition)
private void	_setValue(String dataPath, Object value, Optional<ExternalizableDataProvider.ExternalizableDataStatus> status)
private void	_setValueForSynchronize(String dataName, Object value, boolean isDataExternalizable)
private boolean	_synchronizeElement(ViewElement viewElement, Map<String,Object> values, ExternalizableDataProviderExtensionPoint externalizableDataProviderEP, boolean useDefaultFromModel)
private boolean	_synchronizeGroup(ModelViewItemGroup modelViewItemGroup, Map<String,Object> values, ExternalizableDataProviderExtensionPoint externalizableDataProviderEP, boolean useDefaultFromModel)
private boolean	_synchronizeValue(String dataName, Object value, ElementType type, boolean isDataExternalizable)
ModifiableModelAwareComposite	getComposite(String compositePath)	Retrieves the composite at the given path
ModifiableModelAwareComposite	getComposite(String compositePath, boolean createNew)	Retrieves the composite at the given path
ModifiableModelAwareComposite	getExternalComposite(String compositePath)	Retrieves the external composite at the given path
ModifiableModelAwareComposite	getExternalComposite(String compositePath, boolean createNew)	Retrieves the external composite at the given path
ModifiableModelAwareRepeater	getExternalRepeater(String repeaterPath)	Retrieves the external repeater at the given path
ModifiableModelAwareRepeater	getExternalRepeater(String repeaterPath, boolean createNew)	Retrieves the external repeater at the given path
ModifiableModelAwareComposite	getLocalComposite(String compositePath)	Retrieves the local composite at the given path
ModifiableModelAwareComposite	getLocalComposite(String compositePath, boolean createNew)	Retrieves the local composite at the given path
ModifiableModelAwareRepeater	getLocalRepeater(String repeaterPath)	Retrieves the local repeater at the given path
ModifiableModelAwareRepeater	getLocalRepeater(String repeaterPath, boolean createNew)	Retrieves the local repeater at the given path
ModifiableModelAwareRepeater	getRepeater(String repeaterPath)	Retrieves the repeater at the given path
ModifiableModelAwareRepeater	getRepeater(String repeaterPath, boolean createNew)	Retrieves the repeater at the given path
ModifiableRepositoryData	getRepositoryData()	Retrieves the repository data used by this DataHolder
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	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
boolean	synchronizeValues(Map<String,Object> values, ExternalizableDataProviderExtensionPoint externalizableDataProviderEP, boolean useDefaultFromModel)	Synchronizes the given values with the current ModifiableModelAwareDataHolder's ones If the data is externalizable, the synchronized value is the external one
boolean	synchronizeValues(ViewItemContainer viewItemContainer, Map<String,Object> values, ExternalizableDataProviderExtensionPoint externalizableDataProviderEP, boolean useDefaultFromModel)	Synchronizes the given values with the current ModifiableModelAwareDataHolder's ones If the data is externalizable, the synchronized value is the external one

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

_hasNonEmptyValue, dataToSAX, dataToSAX, getDataNames, getDefinition, getExternalValue, getLocalValue, getModel, getStatus, getValue, getValue, hasDefinition, hasExternalValue, hasLocalValue, hasValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

copyTo, dataToSAX, dataToSAX

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

dataToSAX, dataToSAX, dataToSAX, dataToSAX, getDataNames, getDefinition, getExternalValue, getLocalValue, getModel, getStatus, getType, getValue, getValue, getValue, hasDefinition, hasExternalValue, hasLocalValue, hasValue, isMultiple

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

synchronizeValues, synchronizeValues, synchronizeValues, synchronizeValues, synchronizeValues, synchronizeValues

Field Detail

__TEMP_SUFFIX

private static final String __TEMP_SUFFIX

See Also:

Constant Field Values

_modifiableRepositoryData

protected ModifiableRepositoryData _modifiableRepositoryData

Repository data to use to store data in the repository

Constructor Detail

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.

Method Detail

getComposite

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

Description copied from interface: ModelAwareDataHolder

Retrieves the composite at the given path

Specified by:

getComposite in interface DataHolder

Specified by:

getComposite in interface ModelAwareDataHolder

Specified by:

getComposite in interface ModifiableDataHolder

Specified by:

getComposite in interface ModifiableModelAwareDataHolder

Overrides:

getComposite in class 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 ModifiableModelAwareComposite getLocalComposite(String compositePath)
                                                throws IllegalArgumentException,
                                                       UndefinedItemPathException,
                                                       BadItemTypeException,
                                                       BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the local composite at the given path

Specified by:

getLocalComposite in interface ModelAwareDataHolder

Specified by:

getLocalComposite in interface ModifiableModelAwareDataHolder

Overrides:

getLocalComposite in class 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 ModifiableModelAwareComposite getExternalComposite(String compositePath)
                                                   throws IllegalArgumentException,
                                                          UndefinedItemPathException,
                                                          BadItemTypeException,
                                                          BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the external composite at the given path

Specified by:

getExternalComposite in interface ModelAwareDataHolder

Specified by:

getExternalComposite in interface ModifiableModelAwareDataHolder

Overrides:

getExternalComposite in class 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 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 ModifiableModelAwareRepeater getRepeater(String repeaterPath)
                                         throws IllegalArgumentException,
                                                UndefinedItemPathException,
                                                BadItemTypeException,
                                                BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the repeater at the given path

Specified by:

getRepeater in interface ModelAwareDataHolder

Specified by:

getRepeater in interface ModifiableModelAwareDataHolder

Overrides:

getRepeater in class 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 ModifiableModelAwareRepeater getLocalRepeater(String repeaterPath)
                                              throws IllegalArgumentException,
                                                     UndefinedItemPathException,
                                                     BadItemTypeException,
                                                     BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the local repeater at the given path

Specified by:

getLocalRepeater in interface ModelAwareDataHolder

Specified by:

getLocalRepeater in interface ModifiableModelAwareDataHolder

Overrides:

getLocalRepeater in class 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 ModifiableModelAwareRepeater getExternalRepeater(String repeaterPath)
                                                 throws IllegalArgumentException,
                                                        UndefinedItemPathException,
                                                        BadItemTypeException,
                                                        BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the external repeater at the given path

Specified by:

getExternalRepeater in interface ModelAwareDataHolder

Specified by:

getExternalRepeater in interface ModifiableModelAwareDataHolder

Overrides:

getExternalRepeater in class 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 ModifiableModelAwareRepeater _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,
                                                  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 ModifiableModelAwareDataHolder

Parameters:

compositePath - path of the composite to retrieve

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

Returns:

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

Throws:

IllegalArgumentException - if the given composite path is null or empty

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

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

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

getLocalComposite

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

Description copied from interface: ModifiableModelAwareDataHolder

Retrieves the local composite at the given path

Specified by:

getLocalComposite in interface ModifiableModelAwareDataHolder

Parameters:

compositePath - path of the externalizable composite to retrieve

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

Returns:

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

Throws:

IllegalArgumentException - if the given composite path is null or empty

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

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

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

getExternalComposite

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

Description copied from interface: ModifiableModelAwareDataHolder

Retrieves the external composite at the given path

Specified by:

getExternalComposite in interface ModifiableModelAwareDataHolder

Parameters:

compositePath - path of the externalizable composite to retrieve

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

Returns:

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

Throws:

IllegalArgumentException - if the given composite path is null or empty

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

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

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

_getComposite

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

Throws:

IllegalArgumentException

UndefinedItemPathException

BadItemTypeException

BadDataPathCardinalityException

_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

getRepeater

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

Description copied from interface: ModifiableModelAwareDataHolder

Retrieves the repeater at the given path

Specified by:

getRepeater in interface ModifiableModelAwareDataHolder

Parameters:

repeaterPath - path of the repeater to retrieve

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

Returns:

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

Throws:

IllegalArgumentException - if the given repeater path is null or empty

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

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

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

getLocalRepeater

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

Description copied from interface: ModifiableModelAwareDataHolder

Retrieves the local repeater at the given path

Specified by:

getLocalRepeater in interface ModifiableModelAwareDataHolder

Parameters:

repeaterPath - path of the externalizable repeater to retrieve

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

Returns:

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

Throws:

IllegalArgumentException - if the given repeater path is null or empty

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

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

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

getExternalRepeater

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

Description copied from interface: ModifiableModelAwareDataHolder

Retrieves the external repeater at the given path

Specified by:

getExternalRepeater in interface ModifiableModelAwareDataHolder

Parameters:

repeaterPath - path of the externalizable repeater to retrieve

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

Returns:

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

Throws:

IllegalArgumentException - if the given repeater path is null or empty

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

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

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

_getRepeater

private ModifiableModelAwareRepeater _getRepeater(String repeaterPath,
                                                  boolean createNew,
                                                  Optional<ExternalizableDataProvider.ExternalizableDataStatus> status)
                                           throws IllegalArgumentException,
                                                  UndefinedItemPathException,
                                                  BadItemTypeException,
                                                  BadDataPathCardinalityException

Throws:

IllegalArgumentException

UndefinedItemPathException

BadItemTypeException

BadDataPathCardinalityException

_getRepeater

protected ModifiableModelAwareRepeater _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 boolean synchronizeValues(Map<String,Object> values,
                                 ExternalizableDataProviderExtensionPoint externalizableDataProviderEP,
                                 boolean useDefaultFromModel)
                          throws UndefinedItemPathException,
                                 BadItemTypeException,
                                 IOException

Description copied from interface: ModifiableModelAwareDataHolder

Synchronizes the given values with the current ModifiableModelAwareDataHolder's ones If the data is externalizable, the synchronized value is the external one

Specified by:

synchronizeValues in interface ModifiableModelAwareDataHolder

Parameters:

values - the values to synchronize

externalizableDataProviderEP - the extrernalizable data provider extension point

useDefaultFromModel - true to use default values from the model if there is no value in the Map for an item present in the view

Returns:

true if some values have changed, false otherwise

Throws:

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

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

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

_fillViewItemContainerFromValues

private void _fillViewItemContainerFromValues(Map<String,Object> values,
                                              ViewItemContainer viewItemContainer,
                                              ModelItemContainer modelItemContainer)

_fillViewItemContainerFromValues

private void _fillViewItemContainerFromValues(Map<String,Object> values,
                                              ViewItemContainer viewItemContainer,
                                              Collection<? extends ModelItemContainer> modelItemContainers)

synchronizeValues

public boolean synchronizeValues(ViewItemContainer viewItemContainer,
                                 Map<String,Object> values,
                                 ExternalizableDataProviderExtensionPoint externalizableDataProviderEP,
                                 boolean useDefaultFromModel)
                          throws UndefinedItemPathException,
                                 BadItemTypeException,
                                 IOException

Description copied from interface: ModifiableModelAwareDataHolder

Synchronizes the given values with the current ModifiableModelAwareDataHolder's ones If the data is externalizable, the synchronized value is the external one

Specified by:

synchronizeValues in interface ModifiableModelAwareDataHolder

Parameters:

viewItemContainer - The ViewItemContainer containing all items to synchronize

values - the values to synchronize

externalizableDataProviderEP - the extrernalizable data provider extension point

useDefaultFromModel - true to use default values from the model if there is no value in the Map for an item present in the view

Returns:

true if some values have changed, false otherwise

Throws:

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

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

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

_synchronizeGroup

private boolean _synchronizeGroup(ModelViewItemGroup modelViewItemGroup,
                                  Map<String,Object> values,
                                  ExternalizableDataProviderExtensionPoint externalizableDataProviderEP,
                                  boolean useDefaultFromModel)
                           throws IOException

Throws:

IOException

_synchronizeElement

private boolean _synchronizeElement(ViewElement viewElement,
                                    Map<String,Object> values,
                                    ExternalizableDataProviderExtensionPoint externalizableDataProviderEP,
                                    boolean useDefaultFromModel)
                             throws IOException

Throws:

IOException

_synchronizeValue

private boolean _synchronizeValue(String dataName,
                                  Object value,
                                  ElementType type,
                                  boolean isDataExternalizable)
                           throws IOException

Throws:

IOException

_setValueForSynchronize

private void _setValueForSynchronize(String dataName,
                                     Object value,
                                     boolean isDataExternalizable)

_removeValueForSynchronize

private void _removeValueForSynchronize(String dataName,
                                        boolean isDataExternalizable)

_removeExternalizableMetadataIfExists

private void _removeExternalizableMetadataIfExists(String dataName)

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

private void _setValue(String dataPath,
                       Object value,
                       Optional<ExternalizableDataProvider.ExternalizableDataStatus> status)
                throws IllegalArgumentException,
                       UndefinedItemPathException,
                       BadItemTypeException,
                       BadDataPathCardinalityException

Throws:

IllegalArgumentException

UndefinedItemPathException

BadItemTypeException

BadDataPathCardinalityException

_setElementValue

private void _setElementValue(ElementDefinition defintion,
                              String dataName,
                              Object value)

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

private void _setStatus(String dataPath,
                        CompositeDefinition compositeDefinition)

_setStatus

private void _setStatus(String dataPath,
                        RepeaterDefinition repeaterDefinition)

_setStatus

private void _setStatus(String dataPath,
                        ElementDefinition elementDefinition)

removeValue

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

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

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

removeLocalValue

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

Description copied from interface: ModifiableModelAwareDataHolder

Removes the local value of the data at the given path

Specified by:

removeLocalValue in interface ModifiableModelAwareDataHolder

Parameters:

dataPath - path of the externalizable data

Throws:

IllegalArgumentException - if the given data path is null or empty

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

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

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

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

removeExternalValue

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

Description copied from interface: ModifiableModelAwareDataHolder

Removes the external value of the data at the given path

Specified by:

removeExternalValue in interface ModifiableModelAwareDataHolder

Parameters:

dataPath - path of the externalizable data

Throws:

IllegalArgumentException - if the given data path is null or empty

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

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

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

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

_removeValue

private void _removeValue(String dataPath,
                          Optional<ExternalizableDataProvider.ExternalizableDataStatus> status)
                   throws IllegalArgumentException,
                          UndefinedItemPathException,
                          BadItemTypeException,
                          UnknownDataException,
                          BadDataPathCardinalityException

Throws:

IllegalArgumentException

UndefinedItemPathException

BadItemTypeException

UnknownDataException

BadDataPathCardinalityException

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