Package org.ametys.plugins.repository.jcr

Class SimpleModelAwareAmetysObject<F extends SimpleModelAwareAmetysObjectFactory>

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

org.ametys.plugins.repository.jcr.SimpleAmetysObject<F>

org.ametys.plugins.repository.jcr.SimpleModelAwareAmetysObject<F>

Type Parameters:

F - the actual type of factory.

All Implemented Interfaces:

AmetysObject, ModelAwareAmetysObject, ModifiableModelAwareAmetysObject, DataHolder, ModelAwareDataHolder, ModifiableDataHolder, ModifiableModelAwareDataHolder, JCRAmetysObject, ModelAwareJCRAmetysObject, MetadataAwareAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableAmetysObject, RemovableAmetysObject

Direct Known Subclasses:

DefaultAmetysObject, SimpleIndexableAmetysObject

public class SimpleModelAwareAmetysObject<F extends SimpleModelAwareAmetysObjectFactory>
extends SimpleAmetysObject<F>
implements ModelAwareJCRAmetysObject

Model aware implementation of an AmetysObject, backed by a JCR node.

Field Summary

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

ALTERNATIVE_SUFFIX, STATUS_SUFFIX

Constructor Summary

Constructors

Constructor	Description
SimpleModelAwareAmetysObject(javax.jcr.Node node, String parentPath, F factory)	Creates an SimpleModelAwareAmetysObject.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	dataToJSON(DataContext context)	Convert the data contained in this DataHolder
Map<String,Object>	dataToJSON(ViewItemAccessor viewItemAccessor, DataContext context)	Convert the data in the given view of the current DataHolder
Map<String,Object>	dataToJSONForEdition(ViewItemAccessor viewItemAccessor, DataContext context)	Convert the data in the given view in edition mode in the current DataHolder
Map<String,Object>	dataToMap(ViewItemAccessor viewItemAccessor, DataContext context)	Retrieves data of this DataHolder as a typed-values Map.
void	dataToSAX(ContentHandler contentHandler, DataContext context)	Generates SAX events for data contained in this DataHolder
void	dataToSAX(ContentHandler contentHandler, ViewItemAccessor viewItemAccessor, DataContext context)	Generates SAX events for the data in the given view in the current DataHolder
void	dataToSAXForEdition(ContentHandler contentHandler, ViewItemAccessor viewItemAccessor, DataContext context)	Generates SAX events for the data in the given view in edition mode in the current DataHolder
ModifiableModelAwareComposite	getComposite(String compositePath)	Retrieves the composite at the given path
ModifiableModelAwareComposite	getComposite(String compositePath, boolean createNew)	Retrieves the composite at the given path
protected ModifiableModelAwareDataHolder	getDataHolder()	Returns the DataHolder of this AmetysObject.
ModelItem	getDefinition(String path)	Retrieves the definition of the data at the given path
Collection<ModelItem>	getDifferences(Map<String,Object> values)	Get the collection of model items where there are differences between the given values and the current ones
Collection<ModelItem>	getDifferences(Map<String,Object> values, SynchronizationContext context)	Get the collection of model items where there are differences between the given values and the current ones
Collection<ModelItem>	getDifferences(ViewItemAccessor viewItemAccessor, Map<String,Object> values)	Get the collection of model items where there are differences between the given values and the current ones
Collection<ModelItem>	getDifferences(ViewItemAccessor viewItemAccessor, Map<String,Object> values, SynchronizationContext context)	Get the collection of model items where there are differences between the given values and the current ones
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
<T> T	getExternalValue(String dataPath)	Retrieves the external value of the data 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
<T> T	getLocalValue(String dataPath)	Retrieves the local value of the data at the given path
Collection<? extends Model>	getModel()	Retrieves the data holder's model
ModelItemTypeExtensionPoint	getModelItemTypeExtensionPoint()	Provide the ModelItemTypeExtensionPoint linked with the DataHolder
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
ModifiableRepositoryData	getRepositoryData()	Retrieves the repository data used by this DataHolder
ModifiableModelAwareDataHolder	getRootDataHolder()	Retrieves the DataHolder that is the root of the current one
ExternalizableDataProvider.ExternalizableDataStatus	getStatus(String dataPath)	Retrieves the status of the externalizable data at the given path Warning: This method won't check that your data is externalizable.
<X extends ModelItemType> X	getType(String path)	Retrieves the type of the data at the given path
<T> T	getValueOfType(String dataPath, String dataTypeId)	Retrieves the value of the data at the given path
<T> T	getValueOfTypeOrDefault(String dataPath, String dataTypeId, T defaultValue)	Retrieves the value of the data at the given path if exists and is not empty, or the given default value
<T> T	getValueOrDefault(String dataPath)	Retrieves the value of the data at the given path if exists and is not empty, or the default value from the model
<T> T	getValueWithMultiValuedPathSegments(String dataPath)	Retrieves the value of the data at the given path, allowing multi-valued segments in the path (not necessarily at the last segment) if there is no indicated entry for a repeater, the values of all the entries are retrieved if there are multiple values, all data are retrieved in one array
boolean	hasDefinition(String path)	Checks if there is a definition at the given path
boolean	hasDifferences(Map<String,Object> values)	Check if there are differences between the given values and the current ones
boolean	hasDifferences(Map<String,Object> values, SynchronizationContext context)	Check if there are differences between the given values and the current ones
boolean	hasDifferences(ViewItemAccessor viewItemAccessor, Map<String,Object> values)	Check if there are differences between the given values and the current ones
boolean	hasDifferences(ViewItemAccessor viewItemAccessor, Map<String,Object> values, SynchronizationContext context)	Check if there are differences between the given values and the current ones
boolean	hasExternalValue(String dataPath)	Checks if there is a non empty external value for the data at the given path
boolean	hasExternalValueOrEmpty(String dataPath)	Checks if there is an external value for the data at the given path
boolean	hasLocalValue(String dataPath)	Checks if there is a non empty local value for the data at the given path
boolean	hasLocalValueOrEmpty(String dataPath)	Checks if there is a local value for the data at the given path
boolean	hasValue(String dataPath)	Checks if there is a non empty value for the data at the given path
boolean	hasValue(String dataPath, String dataTypeId)	Checks if there is a non empty value for the data at the given path
boolean	hasValueOrEmpty(String dataPath)	Checks if there is a value, even empty, for the data at the given path
boolean	isMultiple(String dataPath)	Checks if the value of the data at the given path is multiple
boolean	isMultiple(String dataPath, String dataTypeId)	Checks if the value of the data at the given path is multiple
void	removeExternalizableMetadataIfExists(String dataPath)	Removes the stored metadata (status and alternative value) for externalizable (or ex-externalizable) data
void	removeExternalValue(String dataPath)	Removes the external value of the data at the given path
void	removeLocalValue(String dataPath)	Removes the local value of the data at the given path
void	removeValue(String dataPath)	Removes the stored value of the data at the given path
void	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
void	setValue(String dataPath, Object value, String dataTypeId)	Sets the value of the data at the given path
<T extends SynchronizationResult> T	synchronizeValues(Map<String,Object> values)	Synchronizes the given values with the current ones
<T extends SynchronizationResult> T	synchronizeValues(Map<String,Object> values, SynchronizationContext context)	Synchronizes the given values with the current ones
<T extends SynchronizationResult> T	synchronizeValues(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

Methods inherited from class org.ametys.plugins.repository.jcr.SimpleAmetysObject

_getFactory, _invalidateName, _invalidateParentPath, getId, getMetadataHolder, getName, getNode, getParent, getParentPath, getPath, needsSave, remove, rename, revertChanges, saveChanges

Methods inherited from class org.ametys.plugins.repository.AbstractAmetysObject

dataToJSON, dataToSAX, equals, getDataNames, getValue, getValueOrDefault, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ametys.plugins.repository.AmetysObject

equals, getId, getName, getParent, getParentPath, getPath, hashCode

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

copyTo, copyTo, dataToJSON, dataToJSON, dataToSAX, dataToSAX, getValue, getValueOrDefault

Methods inherited from interface org.ametys.plugins.repository.jcr.JCRAmetysObject

getNode

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

dataToJSON, dataToJSON, dataToMap, dataToMap, dataToMap, dataToSAX, dataToSAX, getDataNames

Methods inherited from interface org.ametys.plugins.repository.ModifiableAmetysObject

needsSave, rename, revertChanges, saveChanges

Methods inherited from interface org.ametys.plugins.repository.metadata.ModifiableMetadataAwareAmetysObject

getMetadataHolder

Methods inherited from interface org.ametys.plugins.repository.RemovableAmetysObject

remove

Constructor Details

SimpleModelAwareAmetysObject

public SimpleModelAwareAmetysObject(javax.jcr.Node node,
 String parentPath,
 F factory)

Creates an SimpleModelAwareAmetysObject.

Parameters:

node - the node backing this AmetysObject

parentPath - the parentPath in the Ametys hierarchy

factory - the SimpleModelAwareAmetysObjectFactory which created the AmetysObject

Method Details

getDataHolder

protected ModifiableModelAwareDataHolder getDataHolder()

Description copied from class: AbstractAmetysObject

Returns the DataHolder of this AmetysObject.

Overrides:

getDataHolder in class SimpleAmetysObject<F extends SimpleModelAwareAmetysObjectFactory>

Returns:

the DataHolder of this AmetysObject

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 SimpleAmetysObject<F extends SimpleModelAwareAmetysObjectFactory>

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

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

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

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

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

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

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

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

Overrides:

getComposite in class SimpleAmetysObject<F extends SimpleModelAwareAmetysObjectFactory>

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

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

hasValue

public boolean hasValue(String dataPath)
                 throws IllegalArgumentException,
BadDataPathCardinalityException

Description copied from interface: DataHolder

Checks if there is a non empty value for the data at the given path

Specified by:

hasValue in interface DataHolder

Overrides:

hasValue in class AbstractAmetysObject

Parameters:

dataPath - path of the data

Returns:

true if there is a non empty value for the data. If the data holder has a model and the data at the given path is defined by the model and the type of this value matches the type of the definition. false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

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

hasValue

public boolean hasValue(String dataPath,
 String dataTypeId)
                 throws IllegalArgumentException,
BadDataPathCardinalityException

Description copied from interface: DataHolder

Checks if there is a non empty value for the data at the given path

Specified by:

hasValue in interface DataHolder

Specified by:

hasValue in interface ModelAwareDataHolder

Overrides:

hasValue in class AbstractAmetysObject

Parameters:

dataPath - path of the data

dataTypeId - type identifier of the data

Returns:

true if there is a non empty value for the data. If the data holder has a model and the data at the given path is defined by the model and the type of this value matches the type of the definition. false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

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

hasLocalValue

public boolean hasLocalValue(String dataPath)
                      throws IllegalArgumentException,
BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Checks if there is a non empty local value for the data at the given path

Specified by:

hasLocalValue in interface ModelAwareDataHolder

Parameters:

dataPath - path of the externalizable data

Returns:

true if the data at the given path is defined by the model, if there is a non empty local value for the data and if the type of this value matches the type of the definition. false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

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

hasExternalValue

public boolean hasExternalValue(String dataPath)
                         throws IllegalArgumentException,
BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Checks if there is a non empty external value for the data at the given path

Specified by:

hasExternalValue in interface ModelAwareDataHolder

Parameters:

dataPath - path of the externalizable data

Returns:

true if the data at the given path is defined by the model, if there is a non empty external value for the data and if the type of this value matches the type of the definition. false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

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

hasValueOrEmpty

public boolean hasValueOrEmpty(String dataPath)
                        throws IllegalArgumentException,
BadDataPathCardinalityException

Description copied from interface: DataHolder

Checks if there is a value, even empty, for the data at the given path

Specified by:

hasValueOrEmpty in interface DataHolder

Overrides:

hasValueOrEmpty in class AbstractAmetysObject

Parameters:

dataPath - path of the data

Returns:

true if there is value, even empty, for the data. If the data holder has a model and the data at the given path is defined by the model and the type of this value matches the type of the definition. false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

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

hasLocalValueOrEmpty

public boolean hasLocalValueOrEmpty(String dataPath)
                             throws IllegalArgumentException,
BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Checks if there is a local value for the data at the given path

Specified by:

hasLocalValueOrEmpty in interface ModelAwareDataHolder

Parameters:

dataPath - path of the externalizable data

Returns:

true if the data at the given path is defined by the model, if there is a local value for the data, even empty, and if the type of this value matches the type of the definition. false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

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

hasExternalValueOrEmpty

public boolean hasExternalValueOrEmpty(String dataPath)
                                throws IllegalArgumentException,
BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Checks if there is an external value for the data at the given path

Specified by:

hasExternalValueOrEmpty in interface ModelAwareDataHolder

Parameters:

dataPath - path of the externalizable data

Returns:

true if the data at the given path is defined by the model, if there is an external value for the data, even empty, and if the type of this value matches the type of the definition. false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

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

getLocalValue

public <T> T getLocalValue(String dataPath)
                    throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the local value of the data at the given path

Specified by:

getLocalValue in interface ModelAwareDataHolder

Type Parameters:

T - type of the value to retrieve. The type of the value is defined by the model.

Parameters:

dataPath - path of the externalizable data

Returns:

the local value of the data or null if not exists or is empty. A typed array is returned for multiple empty data, and an empty string is returned for single empty string data

Throws:

IllegalArgumentException - if the given data path is null or empty

BadItemTypeException - if the type defined by the model doesn't match the type of the stored value

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

getExternalValue

public <T> T getExternalValue(String dataPath)
                       throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the external value of the data at the given path

Specified by:

getExternalValue in interface ModelAwareDataHolder

Type Parameters:

T - type of the value to retrieve. The type of the value is defined by the model.

Parameters:

dataPath - path of the externalizable data

Returns:

the external value of the data or null if not exists or is empty. A typed array is returned for multiple empty data, and an empty string is returned for single empty string data

Throws:

IllegalArgumentException - if the given data path is null or empty

BadItemTypeException - if the type defined by the model doesn't match the type of the stored value

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

getValueOrDefault

public <T> T getValueOrDefault(String dataPath)
                        throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the value of the data at the given path if exists and is not empty, or the default value from the model

Specified by:

getValueOrDefault in interface ModelAwareDataHolder

Type Parameters:

T - type of the value to retrieve. The type of the value is defined by the model.

Parameters:

dataPath - path of the data

Returns:

the value of the data, or the default value from the model if the value does not exist or is empty

Throws:

IllegalArgumentException - if the given data path is null or empty

BadItemTypeException - if the type defined by the model doesn't match the type of the stored value

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

getValueOfType

public <T> T getValueOfType(String dataPath,
 String dataTypeId)
                     throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Description copied from interface: DataHolder

Retrieves the value of the data at the given path

Specified by:

getValueOfType in interface DataHolder

Specified by:

getValueOfType in interface ModelAwareDataHolder

Overrides:

getValueOfType in class AbstractAmetysObject

Type Parameters:

T - type of the value to retrieve. Should match the given data type

Parameters:

dataPath - path of the data

dataTypeId - type identifier of the data

Returns:

the value of the data or null if not exists or is empty. A typed array is returned for multiple empty data, and an empty string is returned for single empty string data

Throws:

IllegalArgumentException - if the given data path is null or empty

BadItemTypeException - if the given type doesn't match the type of the stored value at the given path

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

getValueOfTypeOrDefault

public <T> T getValueOfTypeOrDefault(String dataPath,
 String dataTypeId,
 T defaultValue)
                              throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Description copied from interface: DataHolder

Retrieves the value of the data at the given path if exists and is not empty, or the given default value

Specified by:

getValueOfTypeOrDefault in interface DataHolder

Specified by:

getValueOfTypeOrDefault in interface ModelAwareDataHolder

Overrides:

getValueOfTypeOrDefault in class AbstractAmetysObject

Type Parameters:

T - type of the value to retrieve. Should match the given data type

Parameters:

dataPath - path of the data

dataTypeId - type identifier of the data

defaultValue - default value

Returns:

the value of the data, or the given default value if the value does not exist or is empty

Throws:

IllegalArgumentException - if the given data path is null or empty

BadItemTypeException - if the given type doesn't match the type of the stored value at the given path

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

getValueWithMultiValuedPathSegments

public <T> T getValueWithMultiValuedPathSegments(String dataPath)
                                          throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the value of the data at the given path, allowing multi-valued segments in the path (not necessarily at the last segment) if there is no indicated entry for a repeater, the values of all the entries are retrieved if there are multiple values, all data are retrieved in one array

Specified by:

getValueWithMultiValuedPathSegments in interface ModelAwareDataHolder

Type Parameters:

T - type of the value to retrieve

Parameters:

dataPath - path of the data

Returns:

the value of the data

Throws:

IllegalArgumentException - if the given data path is null or empty

BadItemTypeException - if the type defined by the model doesn't match the type of the stored value

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

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

getStatus

public ExternalizableDataProvider.ExternalizableDataStatus getStatus(String dataPath)
                                                              throws IllegalArgumentException,
BadItemTypeException,
UndefinedItemPathException,
BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the status of the externalizable data at the given path Warning: This method won't check that your data is externalizable. But there is no sense to call it with a non externalizable data

Specified by:

getStatus in interface ModelAwareDataHolder

Parameters:

dataPath - path of the externalizable data

Returns:

the status of the externalizable data at the given path

Throws:

IllegalArgumentException - if the given data path is null or empty

BadItemTypeException - if the given data path is composed of an item with type defined by the model that doesn't match the type of the stored value

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

isMultiple

public boolean isMultiple(String dataPath)
                   throws IllegalArgumentException,
UndefinedItemPathException

Description copied from interface: DataHolder

Checks if the value of the data at the given path is multiple

Specified by:

isMultiple in interface DataHolder

Specified by:

isMultiple in interface ModelAwareDataHolder

Overrides:

isMultiple in class AbstractAmetysObject

Parameters:

dataPath - path of the data to check

Returns:

true if the value of the data is multiple, false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

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

isMultiple

public boolean isMultiple(String dataPath,
 String dataTypeId)
                   throws IllegalArgumentException,
UndefinedItemPathException

Description copied from interface: DataHolder

Checks if the value of the data at the given path is multiple

Specified by:

isMultiple in interface DataHolder

Specified by:

isMultiple in interface ModelAwareDataHolder

Overrides:

isMultiple in class AbstractAmetysObject

Parameters:

dataPath - path of the data to check

dataTypeId - type identifier of the data

Returns:

true if the value of the data is multiple, false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

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

getType

public <X extends ModelItemType> X getType(String path)
                                    throws IllegalArgumentException,
UndefinedItemPathException

Description copied from interface: DataHolder

Retrieves the type of the data at the given path

Specified by:

getType in interface DataHolder

Specified by:

getType in interface ModelAwareDataHolder

Overrides:

getType in class AbstractAmetysObject

Type Parameters:

X - type of the item type

Parameters:

path - path of the data

Returns:

the type of the data

Throws:

IllegalArgumentException - if the given data path is null or empty

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

getModelItemTypeExtensionPoint

public ModelItemTypeExtensionPoint getModelItemTypeExtensionPoint()

Description copied from interface: DataHolder

Provide the ModelItemTypeExtensionPoint linked with the DataHolder

Specified by:

getModelItemTypeExtensionPoint in interface DataHolder

Specified by:

getModelItemTypeExtensionPoint in interface ModelAwareDataHolder

Overrides:

getModelItemTypeExtensionPoint in class AbstractAmetysObject

Returns:

the extension point

getModel

public Collection<? extends Model> getModel()

Description copied from interface: ModelAwareDataHolder

Retrieves the data holder's model

Specified by:

getModel in interface ModelAwareAmetysObject

Specified by:

getModel in interface ModelAwareDataHolder

Returns:

the data holder's model

getDefinition

public ModelItem getDefinition(String path)
                        throws IllegalArgumentException,
UndefinedItemPathException

Description copied from interface: ModelAwareDataHolder

Retrieves the definition of the data at the given path

Specified by:

getDefinition in interface ModelAwareDataHolder

Parameters:

path - path of the data. No matter if it is a definition or data path (with repeater entry positions)

Returns:

the definition of the data

Throws:

IllegalArgumentException - if the given path is null or empty

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

hasDefinition

public boolean hasDefinition(String path)
                      throws IllegalArgumentException

Description copied from interface: ModelAwareDataHolder

Checks if there is a definition at the given path

Specified by:

hasDefinition in interface ModelAwareDataHolder

Parameters:

path - path of the data. No matter if it is a definition or data path (with repeater entry positions)

Returns:

true if there is definition at the given path, false otherwise

Throws:

IllegalArgumentException - if the given path is null or empty

dataToSAX

public void dataToSAX(ContentHandler contentHandler,
 DataContext context)
               throws SAXException,
BadItemTypeException

Description copied from interface: DataHolder

Generates SAX events for data contained in this DataHolder

Specified by:

dataToSAX in interface DataHolder

Specified by:

dataToSAX in interface ModelAwareDataHolder

Overrides:

dataToSAX in class AbstractAmetysObject

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

context - The context of the data to SAX

Throws:

SAXException - if an error occurs during the SAX events generation

BadItemTypeException - if the saxed value's type does not matches the stored data

dataToSAX

public void dataToSAX(ContentHandler contentHandler,
 ViewItemAccessor viewItemAccessor,
 DataContext context)
               throws SAXException,
BadItemTypeException

Description copied from interface: ModelAwareDataHolder

Generates SAX events for the data in the given view in the current DataHolder

Specified by:

dataToSAX in interface ModelAwareDataHolder

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

viewItemAccessor - the ViewItemAccessor referencing the items for which generate SAX events

context - The context of the data to SAX

Throws:

SAXException - if an error occurs during the SAX events generation

BadItemTypeException - if the saxed value's type does not matches the stored data

dataToSAXForEdition

public void dataToSAXForEdition(ContentHandler contentHandler,
 ViewItemAccessor viewItemAccessor,
 DataContext context)
                         throws SAXException,
BadItemTypeException

Description copied from interface: ModelAwareDataHolder

Generates SAX events for the data in the given view in edition mode in the current DataHolder

Specified by:

dataToSAXForEdition in interface ModelAwareDataHolder

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

viewItemAccessor - the ViewItemAccessor referencing the items for which generate SAX events

context - The context of the data to SAX

Throws:

SAXException - if an error occurs during the SAX events generation

BadItemTypeException - if the saxed value's type does not matches the stored data

dataToJSON

public Map<String,Object> dataToJSON(DataContext context)
                              throws BadItemTypeException

Description copied from interface: DataHolder

Convert the data contained in this DataHolder

Specified by:

dataToJSON in interface DataHolder

Specified by:

dataToJSON in interface ModelAwareDataHolder

Overrides:

dataToJSON in class AbstractAmetysObject

Parameters:

context - The context of the data to convert

Returns:

The data of the current DataHolder as JSON

Throws:

BadItemTypeException - if the value's type does not matches the stored data

dataToJSON

public Map<String,Object> dataToJSON(ViewItemAccessor viewItemAccessor,
 DataContext context)
                              throws BadItemTypeException

Description copied from interface: ModelAwareDataHolder

Convert the data in the given view of the current DataHolder

Specified by:

dataToJSON in interface ModelAwareDataHolder

Parameters:

viewItemAccessor - the ViewItemAccessor referencing the items to convert

context - The context of the data to convert

Returns:

The data of the given view as JSON

Throws:

BadItemTypeException - if the value's type does not matches the stored data

dataToJSONForEdition

public Map<String,Object> dataToJSONForEdition(ViewItemAccessor viewItemAccessor,
 DataContext context)
                                        throws BadItemTypeException

Description copied from interface: ModelAwareDataHolder

Convert the data in the given view in edition mode in the current DataHolder

Specified by:

dataToJSONForEdition in interface ModelAwareDataHolder

Parameters:

viewItemAccessor - the ViewItemAccessor referencing the items to convert

context - The context of the data to convert

Returns:

The data of the given view as JSON

Throws:

BadItemTypeException - if the value's type does not matches the stored data

dataToMap

public Map<String,Object> dataToMap(ViewItemAccessor viewItemAccessor,
 DataContext context)
                             throws BadItemTypeException

Description copied from interface: ModelAwareDataHolder

Retrieves data of this DataHolder as a typed-values Map.

Specified by:

dataToMap in interface ModelAwareDataHolder

Parameters:

viewItemAccessor - the ViewItemAccessor referencing the items to include in the resulting Map

context - The context of the data

Returns:

a Map containing all data.

Throws:

BadItemTypeException - if the value's type does not matches the stored data

hasDifferences

public boolean hasDifferences(Map<String,Object> values)
                       throws BadItemTypeException

Description copied from interface: DataHolder

Check if there are differences between the given values and the current ones

Specified by:

hasDifferences in interface DataHolder

Specified by:

hasDifferences in interface ModelAwareDataHolder

Overrides:

hasDifferences in class AbstractAmetysObject

Parameters:

values - the values to check

Returns:

true if there are differences, false otherwise

Throws:

BadItemTypeException - if value doesn't match the data at corresponding path

hasDifferences

public boolean hasDifferences(Map<String,Object> values,
 SynchronizationContext context)
                       throws BadItemTypeException

Description copied from interface: ModelAwareDataHolder

Check if there are differences between the given values and the current ones

Specified by:

hasDifferences in interface ModelAwareDataHolder

Parameters:

values - the values to check

context - the context of the synchronization

Returns:

true if there are differences, false otherwise

Throws:

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

hasDifferences

public boolean hasDifferences(ViewItemAccessor viewItemAccessor,
 Map<String,Object> values)
                       throws BadItemTypeException

Description copied from interface: ModelAwareDataHolder

Check if there are differences between the given values and the current ones

Specified by:

hasDifferences in interface ModelAwareDataHolder

Parameters:

viewItemAccessor - The ViewItemAccessor for all items to check

values - the values to check

Returns:

true if there are differences, false otherwise

Throws:

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

hasDifferences

public boolean hasDifferences(ViewItemAccessor viewItemAccessor,
 Map<String,Object> values,
 SynchronizationContext context)
                       throws BadItemTypeException

Description copied from interface: ModelAwareDataHolder

Check if there are differences between the given values and the current ones

Specified by:

hasDifferences in interface ModelAwareDataHolder

Parameters:

viewItemAccessor - The ViewItemAccessor for all items to check

values - the values to check

context - the context of the synchronization

Returns:

true if there are differences, false otherwise

Throws:

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

getDifferences

public Collection<ModelItem> getDifferences(Map<String,Object> values)
                                     throws BadItemTypeException

Description copied from interface: ModelAwareDataHolder

Get the collection of model items where there are differences between the given values and the current ones

Specified by:

getDifferences in interface ModelAwareDataHolder

Parameters:

values - the values to check

Returns:

a collection of model items with differences

Throws:

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

getDifferences

public Collection<ModelItem> getDifferences(Map<String,Object> values,
 SynchronizationContext context)
                                     throws BadItemTypeException

Description copied from interface: ModelAwareDataHolder

Get the collection of model items where there are differences between the given values and the current ones

Specified by:

getDifferences in interface ModelAwareDataHolder

Parameters:

values - the values to check

context - the context of the synchronization

Returns:

a collection of model items with differences

Throws:

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

getDifferences

public Collection<ModelItem> getDifferences(ViewItemAccessor viewItemAccessor,
 Map<String,Object> values)
                                     throws BadItemTypeException

Description copied from interface: ModelAwareDataHolder

Get the collection of model items where there are differences between the given values and the current ones

Specified by:

getDifferences in interface ModelAwareDataHolder

Parameters:

viewItemAccessor - The ViewItemAccessor for all items to check

values - the values to check

Returns:

a collection of model items with differences

Throws:

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

getDifferences

public Collection<ModelItem> getDifferences(ViewItemAccessor viewItemAccessor,
 Map<String,Object> values,
 SynchronizationContext context)
                                     throws BadItemTypeException

Description copied from interface: ModelAwareDataHolder

Get the collection of model items where there are differences between the given values and the current ones

Specified by:

getDifferences in interface ModelAwareDataHolder

Parameters:

viewItemAccessor - The ViewItemAccessor for all items to check

values - the values to check

context - the context of the synchronization

Returns:

a collection of model items with differences

Throws:

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

synchronizeValues

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

Description copied from interface: ModifiableDataHolder

Synchronizes the given values with the current ones

Specified by:

synchronizeValues in interface ModifiableDataHolder

Overrides:

synchronizeValues in class SimpleAmetysObject<F extends SimpleModelAwareAmetysObjectFactory>

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

setValue

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

Description copied from interface: ModifiableDataHolder

Sets the value of the data at the given path

Specified by:

setValue in interface ModifiableDataHolder

Specified by:

setValue in interface ModifiableModelAwareDataHolder

Overrides:

setValue in class SimpleAmetysObject<F extends SimpleModelAwareAmetysObjectFactory>

Parameters:

dataPath - path of the data

value - the value to set. To empty a value, use ModifiableDataHolder.setValue(String, Object, String) with a null 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

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

setValue

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

Description copied from interface: ModifiableDataHolder

Sets the value of the data at the given path

Specified by:

setValue in interface ModifiableDataHolder

Specified by:

setValue in interface ModifiableModelAwareDataHolder

Overrides:

setValue in class SimpleAmetysObject<F extends SimpleModelAwareAmetysObjectFactory>

Parameters:

dataPath - path of the data

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

dataTypeId - type identifier of the data

Throws:

IllegalArgumentException - if the given data path is null or empty

BadItemTypeException - if the given type 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

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

Overrides:

removeValue in class SimpleAmetysObject<F extends SimpleModelAwareAmetysObjectFactory>

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

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

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 SimpleAmetysObject<F extends SimpleModelAwareAmetysObjectFactory>

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 SimpleAmetysObject<F extends SimpleModelAwareAmetysObjectFactory>

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 SimpleAmetysObject<F extends SimpleModelAwareAmetysObjectFactory>

Returns:

the root DataHolder