Package org.ametys.cms.data

Class ContentValue

java.lang.Object

org.ametys.cms.data.ContentValue

All Implemented Interfaces:

DataHolder, ModelAwareDataHolder, ModifiableDataHolder, ModifiableModelAwareDataHolder

public class ContentValue
extends Object
implements ModifiableModelAwareDataHolder

Content wrapper used by attributes of type content

See Also:

AbstractContentElementType

Field Summary

Fields

Modifier and Type	Field	Description
private ModifiableContent	_content
private String	_contentId
private AmetysObjectResolver	_resolver
private Session	_session

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

ALTERNATIVE_SUFFIX, COMMENTS_SUFFIX, STATUS_SUFFIX

Constructor Summary

Constructors

Constructor	Description
ContentValue(ModifiableContent content)	Constructor of the content wrapper
ContentValue(AmetysObjectResolver resolver, String contentId)	Constructor of the content wrapper
ContentValue(AmetysObjectResolver resolver, String contentId, Session session)	Constructor of the content wrapper

Method Summary

Modifier and Type	Method	Description
void	dataToSAX(ContentHandler contentHandler, String dataPath, DataContext context)	Generates SAX events for the data at the given data path in the current DataHolder Do not generate any event if there is no values at the given path
boolean	equals(Object obj)
List<DataComment>	getComments(String dataName)	Retrieve the comments of the data with the given name
ModifiableModelAwareComposite	getComposite(String compositePath)	Retrieves the composite at the given path
ModifiableModelAwareComposite	getComposite(String compositePath, boolean createNew)	Retrieves the composite at the given path
ModifiableContent	getContent()	Retrieves the content
String	getContentId()	Retrieves the content's identifier
Optional<ModifiableContent>	getContentIfExists()	Retrieves an Optional describing the content, or an empty Optional if the content does not exist
Collection<String>	getDataNames()	Retrieves the names of data contained by this data holder Retrieves only the data at first level, does not check composite data
ModelItem	getDefinition(String path)	Retrieves the definition of the data 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
<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
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
<T> T	getLocalValue(String dataPath)	Retrieves the local value of the data at the given path
Collection<? extends ModelItemContainer>	getModel()	Retrieves the data holder's model
Optional<? extends ModifiableModelAwareDataHolder>	getParentDataHolder()	Retrieves the optional parent of the current DataHolder There can be no parent if the current DataHolder is the root
ModifiableModelAwareRepeater	getRepeater(String repeaterPath)	Retrieves the repeater at the given path
ModifiableModelAwareRepeater	getRepeater(String repeaterPath, boolean createNew)	Retrieves the repeater at the given path
ModifiableRepositoryData	getRepositoryData()	Retrieves the repository data used by this DataHolder
ModifiableModelAwareDataHolder	getRootDataHolder()	Retrieves the DataHolder that is the root of the current one
ExternalizableDataProvider.ExternalizableDataStatus	getStatus(String dataPath)	Retrieves the status of the externalizable data at the given path
<T> T	getValue(String dataPath)	Retrieves the value of the data at the given path
<T> T	getValue(String dataPath, boolean allowMultiValuedPathSegments)	Retrieves the value of the data at the given path
<T> T	getValue(String dataPath, boolean useDefaultFromModel, T defaultValue)	Retrieves the value of the data at the given path, or the default value The returned value is one of those ones, in the order: The value of the data if exists and is not empty The default value from the model if useDefaultFromModel is true and there is a default value defined by the model The given default value
boolean	hasComments(String dataName)	Checks if there is are comments on the data with the given name
boolean	hasDefinition(String path)	Checks if there is a definition at the given path
boolean	hasExternalValue(String dataPath)	Checks if there is an external value for the data at the given path
int	hashCode()
boolean	hasLocalValue(String dataPath)	Checks if there is a local value for the data at the given path
boolean	hasNonEmptyExternalValue(String dataPath)	Checks if there is a non empty external value for the data at the given path
boolean	hasNonEmptyLocalValue(String dataPath)	Checks if there is a non empty local value for the data at the given path
boolean	hasNonEmptyValue(String dataPath)	Checks if there is a non empty value for the data at the given path
boolean	hasValue(String dataPath)	Checks if there is a value for the data at the given path
void	removeExternalValue(String dataPath)	Removes the external value of the data at the given path
void	removeLocalValue(String dataPath)	Removes the local value of the data at the given path
void	removeValue(String dataPath)	Removes the stored value of the data at the given path
void	setComments(String dataName, List<DataComment> comments)	Set the comments of the data with the given name
void	setExternalValue(String dataPath, Object externalValue)	Sets the external value of the data at the given path
void	setLocalValue(String dataPath, Object localValue)	Sets the local value of the data at the given path
void	setStatus(String dataPath, ExternalizableDataProvider.ExternalizableDataStatus status)	Set the status of the data at the given path
void	setValue(String dataPath, Object value)	Sets the value of the data at the given path
<T extends SynchronizationResult> T	synchronizeValues(Map<String,Object> values)	Synchronizes the given values with the current ones
<T extends SynchronizationResult> T	synchronizeValues(Map<String,Object> values, SynchronizationContext context)	Synchronizes the given values with the current ones
<T extends SynchronizationResult> T	synchronizeValues(ViewItemContainer viewItemContainer, Map<String,Object> values)	Synchronizes the given values with the current ones
<T extends SynchronizationResult> T	synchronizeValues(ViewItemContainer viewItemContainer, Map<String,Object> values, SynchronizationContext context)	Synchronizes the given values with the current ModifiableModelAwareDataHolder's ones

Methods inherited from class java.lang.Object

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

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

copyTo, dataToSAX

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

commentsToSAX, dataToMap, dataToMap, dataToMap, dataToMap, dataToSAX, dataToSAX, dataToSAX, dataToSAX, dataToSAXForEdition, getType, isMultiple

Field Detail

_resolver

private AmetysObjectResolver _resolver

_contentId

private String _contentId

_content

private ModifiableContent _content

_session

private Session _session

Constructor Detail

ContentValue

public ContentValue(ModifiableContent content)

Constructor of the content wrapper

Parameters:

content - the existing content

ContentValue

public ContentValue(AmetysObjectResolver resolver,
                    String contentId)

Constructor of the content wrapper

Parameters:

resolver - resolver used to get the content from its identifier

contentId - content identifier

ContentValue

public ContentValue(AmetysObjectResolver resolver,
                    String contentId,
                    Session session)

Constructor of the content wrapper

Parameters:

resolver - resolver used to get the content from its identifier

contentId - content identifier

session - the current session. If null, a new session will be used to retrieve the content

Method Detail

getContentId

public String getContentId()

Retrieves the content's identifier

Returns:

the content's identifier

getContent

public ModifiableContent getContent()
                             throws AmetysRepositoryException,
                                    UnknownAmetysObjectException

Retrieves the content

Returns:

the content

Throws:

AmetysRepositoryException - if an error occurs.

UnknownAmetysObjectException - if no content exists for the identifier

getContentIfExists

public Optional<ModifiableContent> getContentIfExists()

Retrieves an Optional describing the content, or an empty Optional if the content does not exist

Returns:

an Optional describing the content

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hasValue

public boolean hasValue(String dataPath)
                 throws IllegalArgumentException,
                        BadDataPathCardinalityException

Description copied from interface: DataHolder

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

Specified by:

hasValue in interface DataHolder

Specified by:

hasValue in interface ModelAwareDataHolder

Parameters:

dataPath - path of the data

Returns:

true if there is value (even empty) for the data, 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

hasLocalValue

public boolean hasLocalValue(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:

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

hasExternalValue

public boolean hasExternalValue(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:

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

hasNonEmptyValue

public boolean hasNonEmptyValue(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:

hasNonEmptyValue in interface DataHolder

Specified by:

hasNonEmptyValue in interface ModelAwareDataHolder

Parameters:

dataPath - path of the data

Returns:

true if there is a non empty value for the data, 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

hasNonEmptyLocalValue

public boolean hasNonEmptyLocalValue(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:

hasNonEmptyLocalValue 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

hasNonEmptyExternalValue

public boolean hasNonEmptyExternalValue(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:

hasNonEmptyExternalValue 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

hasComments

public boolean hasComments(String dataName)
                    throws IllegalArgumentException,
                           UndefinedItemPathException

Description copied from interface: ModelAwareDataHolder

Checks if there is are comments on the data with the given name

Specified by:

hasComments in interface ModelAwareDataHolder

Parameters:

dataName - name of the data

Returns:

true if there are comments on the data, false otherwise

Throws:

IllegalArgumentException - if the given data name is null or empty

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

getDataNames

public Collection<String> getDataNames()

Description copied from interface: DataHolder

Retrieves the names of data contained by this data holder Retrieves only the data at first level, does not check composite data

Specified by:

getDataNames in interface DataHolder

Specified by:

getDataNames in interface ModelAwareDataHolder

Returns:

the names of all data contained by this data holder

getValue

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

Description copied from interface: ModelAwareDataHolder

Retrieves the value of the data at the given path

Specified by:

getValue in interface ModelAwareDataHolder

Type Parameters:

T - type of the value to retrieve

Parameters:

dataPath - path of the data

Returns:

the value of the data or null if not exists or is empty. The object returned may be of a generic class defined by the storage (if the model is unknown). For example, an url may be returned as a String.

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 type of the stored value

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

getValue

public <T> T getValue(String dataPath,
                      boolean allowMultiValuedPathSegments)
               throws IllegalArgumentException,
                      UndefinedItemPathException,
                      BadItemTypeException,
                      BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the value of the data at the given path

Specified by:

getValue in interface ModelAwareDataHolder

Type Parameters:

T - type of the value to retrieve

Parameters:

dataPath - path of the data

allowMultiValuedPathSegments - true to allow multi-valued segments in the path (not necessarily at the last segment), false otherwise. If true, if there is no indicated entry for a repeater, the values of all the entries are retrieved If true and if there are multiple values, all data are retrieved in one array

Returns:

the value of the data or null if allowMultiValuedPathSegments is false and there is no non empty value. The object returned may be of a generic class defined by the storage (if the model is unknown). For example, an url may be returned as a String.

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 type of the stored value

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

getValue

public <T> T getValue(String dataPath,
                      boolean useDefaultFromModel,
                      T defaultValue)
               throws IllegalArgumentException,
                      UndefinedItemPathException,
                      BadItemTypeException,
                      BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the value of the data at the given path, or the default value The returned value is one of those ones, in the order:

1. The value of the data if exists and is not empty
2. The default value from the model if useDefaultFromModel is true and there is a default value defined by the model
3. The given default value

Specified by:

getValue in interface ModelAwareDataHolder

Type Parameters:

T - type of the value to retrieve

Parameters:

dataPath - path of the data

useDefaultFromModel - true to use the default value from the model, false to use the given default value

defaultValue - default value used if value is null and useDefaultFromModel is false, or if there is no default value on model

Returns:

the value of the data at the given path

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 type of the stored value

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

Parameters:

dataPath - path of the externalizable data

Returns:

the local value of the data or null if not exists or is empty. The object returned may be of a generic class defined by the storage (if the model is unknown). For example, an url may be returned as a String.

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 type of the stored value

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

Parameters:

dataPath - path of the externalizable data

Returns:

the external value of the data or null if not exists or is empty. The object returned may be of a generic class defined by the storage (if the model is unknown). For example, an url may be returned as a String.

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 type of the stored value

BadDataPathCardinalityException - if 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,
                                                                     UndefinedItemPathException,
                                                                     BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the status of the externalizable data at the given path

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

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

getComments

public List<DataComment> getComments(String dataName)
                              throws IllegalArgumentException,
                                     UndefinedItemPathException

Description copied from interface: ModelAwareDataHolder

Retrieve the comments of the data with the given name

Specified by:

getComments in interface ModelAwareDataHolder

Parameters:

dataName - name of the data

Returns:

the comments of the data

Throws:

IllegalArgumentException - if the given data name is null or empty

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

getModel

public Collection<? extends ModelItemContainer> getModel()

Description copied from interface: ModelAwareDataHolder

Retrieves the data holder's model

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

getComposite

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

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

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

Parameters:

compositePath - path of the externalizable composite to retrieve

Returns:

the composite or null if not exists or is empty

Throws:

IllegalArgumentException - if the given composite path is null or empty

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

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

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

getRepeater

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

Description copied from interface: ModelAwareDataHolder

Retrieves the repeater at the given path

Specified by:

getRepeater in interface ModelAwareDataHolder

Specified by:

getRepeater in interface ModifiableModelAwareDataHolder

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

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

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

dataToSAX

public void dataToSAX(ContentHandler contentHandler,
                      String dataPath,
                      DataContext context)
               throws SAXException,
                      IOException

Description copied from interface: DataHolder

Generates SAX events for the data at the given data path in the current DataHolder Do not generate any event if there is no values at the given path

Specified by:

dataToSAX in interface DataHolder

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

dataPath - the path of the data to SAX

context - The context of the data to SAX

Throws:

SAXException - if an error occurs during the SAX events generation

IOException - if an error occurs while reading a value using the I/O API

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

getRepeater

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

Description copied from interface: ModifiableModelAwareDataHolder

Retrieves the repeater at the given path

Specified by:

getRepeater in interface ModifiableModelAwareDataHolder

Parameters:

repeaterPath - path of the repeater to retrieve

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

Returns:

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

Throws:

IllegalArgumentException - if the given repeater path is null or empty

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

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

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

getLocalRepeater

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

Description copied from interface: ModifiableModelAwareDataHolder

Retrieves the local repeater at the given path

Specified by:

getLocalRepeater in interface ModifiableModelAwareDataHolder

Parameters:

repeaterPath - path of the externalizable repeater to retrieve

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

Returns:

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

Throws:

IllegalArgumentException - if the given repeater path is null or empty

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

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

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

getExternalRepeater

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

Description copied from interface: ModifiableModelAwareDataHolder

Retrieves the external repeater at the given path

Specified by:

getExternalRepeater in interface ModifiableModelAwareDataHolder

Parameters:

repeaterPath - path of the externalizable repeater to retrieve

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

Returns:

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

Throws:

IllegalArgumentException - if the given repeater path is null or empty

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

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

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

synchronizeValues

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

Description copied from interface: ModifiableModelAwareDataHolder

Synchronizes the given values with the current ones

Specified by:

synchronizeValues in interface ModifiableModelAwareDataHolder

Type Parameters:

T - the type of the SynchronizationResult

Parameters:

values - the values to synchronize

Returns:

the SynchronizationResult

Throws:

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

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

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

synchronizeValues

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

Description copied from interface: ModifiableModelAwareDataHolder

Synchronizes the given values with the current ones

Specified by:

synchronizeValues in interface ModifiableModelAwareDataHolder

Type Parameters:

T - the type of the SynchronizationResult

Parameters:

values - the values to synchronize

context - the context of the synchronization

Returns:

the SynchronizationResult

Throws:

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

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

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

synchronizeValues

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

Description copied from interface: ModifiableModelAwareDataHolder

Synchronizes the given values with the current ones

Specified by:

synchronizeValues in interface ModifiableModelAwareDataHolder

Type Parameters:

T - the type of the SynchronizationResult

Parameters:

viewItemContainer - The ViewItemContainer containing all items to synchronize

values - the values to synchronize

Returns:

the SynchronizationResult

Throws:

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

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

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

synchronizeValues

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

Description copied from interface: ModifiableModelAwareDataHolder

Synchronizes the given values with the current ModifiableModelAwareDataHolder's ones

Specified by:

synchronizeValues in interface ModifiableModelAwareDataHolder

Type Parameters:

T - the type of the SynchronizationResult

Parameters:

viewItemContainer - The ViewItemContainer containing all items to synchronize

values - the values to synchronize

context - the context of the synchronization

Returns:

the SynchronizationResult

Throws:

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

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

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

setValue

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

Description copied from interface: ModifiableModelAwareDataHolder

Sets the value of the data at the given path

Specified by:

setValue in interface ModifiableModelAwareDataHolder

Parameters:

dataPath - path of the data

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

Throws:

IllegalArgumentException - if the given data path is null or empty

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

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

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

setLocalValue

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

Description copied from interface: ModifiableModelAwareDataHolder

Sets the local value of the data at the given path

Specified by:

setLocalValue in interface ModifiableModelAwareDataHolder

Parameters:

dataPath - path of the externalizable data

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

Throws:

IllegalArgumentException - if the given data path is null or empty

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

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

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

setExternalValue

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

Description copied from interface: ModifiableModelAwareDataHolder

Sets the external value of the data at the given path

Specified by:

setExternalValue in interface ModifiableModelAwareDataHolder

Parameters:

dataPath - path of the externalizable data

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

Throws:

IllegalArgumentException - if the given data path is null or empty

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

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

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

setStatus

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

Description copied from interface: ModifiableModelAwareDataHolder

Set the status of the data at the given path

Specified by:

setStatus in interface ModifiableModelAwareDataHolder

Parameters:

dataPath - path of the externalizable data

status - the new status

Throws:

IllegalArgumentException - if the given data path is null or empty

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

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

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

setComments

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

Description copied from interface: ModifiableModelAwareDataHolder

Set the comments of the data with the given name

Specified by:

setComments in interface ModifiableModelAwareDataHolder

Parameters:

dataName - name of the data

comments - the comments to set

Throws:

IllegalArgumentException - if the given data name is null or empty

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

removeValue

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

Description copied from interface: 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

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

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

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

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

Returns:

the root DataHolder