Package org.ametys.plugins.explorer.cmis

Class CMISResource

java.lang.Object

org.ametys.plugins.explorer.cmis.CMISResource

All Implemented Interfaces:

Resource, AmetysObject, DataHolder, DublinCoreAwareAmetysObject

public class CMISResource
extends Object
implements Resource

Implementation of an Resource, backed by a server CMIS.

Constructor Summary

Constructors

Constructor	Description
CMISResource(Document document, CMISRootResourcesCollection root, AmetysObject parent)	Creates a CMISResource

Method Summary

Modifier and Type	Method	Description
void	copyTo(ModifiableDataHolder dataHolder)	Copies the current DataHolder to the given ModifiableDataHolder.
void	copyTo(ModifiableDataHolder dataHolder, DataContext context)	Copies the current DataHolder to the given ModifiableDataHolder.
Object	dataToJSON(String dataPath, DataContext context)	Convert the data at the given path into a JSON object
Map<String,Object>	dataToJSON(DataContext context)	Convert the data contained in this DataHolder
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
void	dataToSAX(ContentHandler contentHandler, DataContext context)	Generates SAX events for data contained in this DataHolder
Document	getCmisDocument()	Retrieves the Folder
CMISRootResourcesCollection	getCmisRoot()	Retrieves the CMISRootResourcesCollection
Composite	getComposite(String compositePath)	Retrieves the composite at the given path
Date	getCreationDate()	Retrieves the creation date.
UserIdentity	getCreator()	Returns the last contributor of this resource.
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
String	getDCContributor()	Get the Dublin Core contributor.
String	getDCCoverage()	Get the Dublin Core coverage.
String	getDCCreator()	Get the Dublin Core creator.
Date	getDCDate()	Get the Dublin Core date.
String	getDCDescription()	Get the Dublin Core description.
String	getDCFormat()	Get the Dublin Core format.
String	getDCIdentifier()	Get the Dublin Core identifier.
String	getDCLanguage()	Get the Dublin Core language.
String	getDCPublisher()	Get the Dublin Core publisher.
String	getDCRelation()	Get the Dublin Core relation.
String	getDCRights()	Get the Dublin Core rights.
String	getDCSource()	Get the Dublin Core source.
String[]	getDCSubject()	Get the Dublin Core subject.
String	getDCTitle()	Get the Dublin Core title.
String	getDCType()	Get the Dublin Core type.
String	getId()	Retrieves the unique identifier of this AmetysObject. It must be unique in the whole repository and must never be null. It must conform to the URI syntax: <protocol>://<protocol-specific-part>
InputStream	getInputStream()	Returns the data stream.
String[]	getKeywords()	Returns the keywords of this resource, as a String array.
String	getKeywordsAsString()	Returns the keywords of this resource, as a comme-separated String.
UserIdentity	getLastContributor()	Retrieves the login of the last contributor.
Date	getLastModified()	Returns the last modification date.
long	getLength()	Returns the length of the data stream.
String	getMimeType()	Returns the data mime-type.
ModelItemTypeExtensionPoint	getModelItemTypeExtensionPoint()	Provide the ModelItemTypeExtensionPoint linked with the DataHolder
String	getName()	Retrieves the name of the current object.
AmetysObject	getParent()	Returns the parent object in the Ametys hierarchy.
Optional<? extends DataHolder>	getParentDataHolder()	Retrieves the optional parent of the current DataHolder There can be no parent if the current DataHolder is the root
String	getParentPath()	Returns the path of the parent object in the Ametys hierarchy.
String	getPath()	Retrieves the path of the current object.
RepositoryData	getRepositoryData()	Retrieves the repository data used by this DataHolder
String	getResourcePath()	Returns the path of this resource in its hierarchy (which is a subset of the whole repository).
DataHolder	getRootDataHolder()	Retrieves the DataHolder that is the root of the current one
<X extends ModelItemType> X	getType(String dataPath)	Retrieves the type of the data at the given path
<T> T	getValue(String dataPath)	Retrieves the value 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, T defaultValue)	Retrieves the value of the data at the given path if exists and is not empty, or the given default value
boolean	hasDifferences(Map<String,Object> values)	Check if there are differences between the given values and the current ones
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

Methods inherited from class java.lang.Object

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

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

equals, hashCode

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

dataToJSON, dataToJSON, dataToSAX, dataToSAX

Constructor Details

CMISResource

public CMISResource(Document document,
 CMISRootResourcesCollection root,
 AmetysObject parent)

Creates a CMISResource

Parameters:

document - The CMIS document

root - The root of the virtual tree

parent - the parent AmetysObject if known

Method Details

getCmisRoot

public CMISRootResourcesCollection getCmisRoot()

Retrieves the CMISRootResourcesCollection

Returns:

the CMISRootResourcesCollection

getCmisDocument

public Document getCmisDocument()

Retrieves the Folder

Returns:

the Folder

getId

public String getId()
             throws AmetysRepositoryException

Description copied from interface: AmetysObject

Retrieves the unique identifier of this AmetysObject.
It must be unique in the whole repository and must never be null.
It must conform to the URI syntax:
<protocol>://<protocol-specific-part>

Specified by:

getId in interface AmetysObject

Returns:

the unique identifier of this AmetysObject

Throws:

AmetysRepositoryException - if an error occurs.

getName

public String getName()

Description copied from interface: AmetysObject

Retrieves the name of the current object.

Specified by:

getName in interface AmetysObject

Returns:

the name.

getParent

public AmetysObject getParent()
                       throws AmetysRepositoryException

Description copied from interface: AmetysObject

Returns the parent object in the Ametys hierarchy.

Specified by:

getParent in interface AmetysObject

Returns:

the parent object or null if current object is the root.

Throws:

AmetysRepositoryException - if an error occurs.

getParentPath

public String getParentPath()
                     throws AmetysRepositoryException

Description copied from interface: AmetysObject

Returns the path of the parent object in the Ametys hierarchy.

Specified by:

getParentPath in interface AmetysObject

Returns:

the path of the parent object.

Throws:

AmetysRepositoryException - if an error occurs.

getPath

public String getPath()
               throws AmetysRepositoryException

Description copied from interface: AmetysObject

Retrieves the path of the current object.

Specified by:

getPath in interface AmetysObject

Returns:

the path.

Throws:

AmetysRepositoryException - if an error occurs.

getCreator

public UserIdentity getCreator()

Description copied from interface: Resource

Returns the last contributor of this resource.

Specified by:

getCreator in interface Resource

Returns:

the last contributor of this resource.

getInputStream

public InputStream getInputStream()
                           throws AmetysRepositoryException

Description copied from interface: Resource

Returns the data stream.

Specified by:

getInputStream in interface Resource

Returns:

the data stream.

Throws:

AmetysRepositoryException - if an error occurs.

getLastModified

public Date getLastModified()

Description copied from interface: Resource

Returns the last modification date.

Specified by:

getLastModified in interface Resource

Returns:

the last modification date.

getLength

public long getLength()

Description copied from interface: Resource

Returns the length of the data stream.

Specified by:

getLength in interface Resource

Returns:

the length of the data stream.

getMimeType

public String getMimeType()
                   throws AmetysRepositoryException

Description copied from interface: Resource

Returns the data mime-type.

Specified by:

getMimeType in interface Resource

Returns:

the data mime-type.

Throws:

AmetysRepositoryException - if an error occurs.

getKeywords

public String[] getKeywords()
                     throws AmetysRepositoryException

Description copied from interface: Resource

Returns the keywords of this resource, as a String array.

Specified by:

getKeywords in interface Resource

Returns:

the keywords of this resource.

Throws:

AmetysRepositoryException - if an error occurs.

getKeywordsAsString

public String getKeywordsAsString()
                           throws AmetysRepositoryException

Description copied from interface: Resource

Returns the keywords of this resource, as a comme-separated String.

Specified by:

getKeywordsAsString in interface Resource

Returns:

the keywords of this resource.

Throws:

AmetysRepositoryException - if an error occurs.

getResourcePath

public String getResourcePath()
                       throws AmetysRepositoryException

Description copied from interface: Resource

Returns the path of this resource in its hierarchy (which is a subset of the whole repository).

Specified by:

getResourcePath in interface Resource

Returns:

the path of this resource in its hierarchy.

Throws:

AmetysRepositoryException - if an error occurs.

getDCTitle

public String getDCTitle()
                  throws AmetysRepositoryException

Description copied from interface: DublinCoreAwareAmetysObject

Get the Dublin Core title.

Specified by:

getDCTitle in interface DublinCoreAwareAmetysObject

Returns:

the Dublin Core title. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getDCCreator

public String getDCCreator()
                    throws AmetysRepositoryException

Description copied from interface: DublinCoreAwareAmetysObject

Get the Dublin Core creator.

Specified by:

getDCCreator in interface DublinCoreAwareAmetysObject

Returns:

the Dublin Core creator. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getDCSubject

public String[] getDCSubject()
                      throws AmetysRepositoryException

Description copied from interface: DublinCoreAwareAmetysObject

Get the Dublin Core subject.

Specified by:

getDCSubject in interface DublinCoreAwareAmetysObject

Returns:

the Dublin Core subject. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getDCDescription

public String getDCDescription()
                        throws AmetysRepositoryException

Description copied from interface: DublinCoreAwareAmetysObject

Get the Dublin Core description.

Specified by:

getDCDescription in interface DublinCoreAwareAmetysObject

Returns:

the Dublin Core description. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getDCPublisher

public String getDCPublisher()
                      throws AmetysRepositoryException

Description copied from interface: DublinCoreAwareAmetysObject

Get the Dublin Core publisher.

Specified by:

getDCPublisher in interface DublinCoreAwareAmetysObject

Returns:

the Dublin Core publisher. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getDCContributor

public String getDCContributor()
                        throws AmetysRepositoryException

Description copied from interface: DublinCoreAwareAmetysObject

Get the Dublin Core contributor.

Specified by:

getDCContributor in interface DublinCoreAwareAmetysObject

Returns:

the Dublin Core contributor. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getDCDate

public Date getDCDate()
               throws AmetysRepositoryException

Description copied from interface: DublinCoreAwareAmetysObject

Get the Dublin Core date.

Specified by:

getDCDate in interface DublinCoreAwareAmetysObject

Returns:

the Dublin Core date. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getDCType

public String getDCType()
                 throws AmetysRepositoryException

Description copied from interface: DublinCoreAwareAmetysObject

Get the Dublin Core type.

Specified by:

getDCType in interface DublinCoreAwareAmetysObject

Returns:

the Dublin Core type. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getDCFormat

public String getDCFormat()
                   throws AmetysRepositoryException

Description copied from interface: DublinCoreAwareAmetysObject

Get the Dublin Core format.

Specified by:

getDCFormat in interface DublinCoreAwareAmetysObject

Returns:

the Dublin Core format. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getDCIdentifier

public String getDCIdentifier()
                       throws AmetysRepositoryException

Description copied from interface: DublinCoreAwareAmetysObject

Get the Dublin Core identifier.

Specified by:

getDCIdentifier in interface DublinCoreAwareAmetysObject

Returns:

the Dublin Core identifier. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getDCSource

public String getDCSource()
                   throws AmetysRepositoryException

Description copied from interface: DublinCoreAwareAmetysObject

Get the Dublin Core source.

Specified by:

getDCSource in interface DublinCoreAwareAmetysObject

Returns:

the Dublin Core source. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getDCLanguage

public String getDCLanguage()
                     throws AmetysRepositoryException

Description copied from interface: DublinCoreAwareAmetysObject

Get the Dublin Core language.

Specified by:

getDCLanguage in interface DublinCoreAwareAmetysObject

Returns:

the Dublin Core language. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getDCRelation

public String getDCRelation()
                     throws AmetysRepositoryException

Description copied from interface: DublinCoreAwareAmetysObject

Get the Dublin Core relation.

Specified by:

getDCRelation in interface DublinCoreAwareAmetysObject

Returns:

the Dublin Core relation. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getDCCoverage

public String getDCCoverage()
                     throws AmetysRepositoryException

Description copied from interface: DublinCoreAwareAmetysObject

Get the Dublin Core coverage.

Specified by:

getDCCoverage in interface DublinCoreAwareAmetysObject

Returns:

the Dublin Core coverage. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getDCRights

public String getDCRights()
                   throws AmetysRepositoryException

Description copied from interface: DublinCoreAwareAmetysObject

Get the Dublin Core rights.

Specified by:

getDCRights in interface DublinCoreAwareAmetysObject

Returns:

the Dublin Core rights. Can be null.

Throws:

AmetysRepositoryException - if an error occurs.

getCreationDate

public Date getCreationDate()
                     throws AmetysRepositoryException

Description copied from interface: Resource

Retrieves the creation date.

Specified by:

getCreationDate in interface Resource

Returns:

the creation date.

Throws:

AmetysRepositoryException - if an error occurs.

getLastContributor

public UserIdentity getLastContributor()
                                throws AmetysRepositoryException

Description copied from interface: Resource

Retrieves the login of the last contributor.

Specified by:

getLastContributor in interface Resource

Returns:

the login of the last contributor.

Throws:

AmetysRepositoryException - if an error occurs.

getComposite

public Composite getComposite(String compositePath)
                       throws IllegalArgumentException,
UnknownTypeException,
BadItemTypeException

Description copied from interface: DataHolder

Retrieves the composite at the given path

Specified by:

getComposite in interface DataHolder

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

UnknownTypeException - if the type composite is not available for this data holder

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

hasValue

public boolean hasValue(String dataPath)
                 throws IllegalArgumentException

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

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

hasValue

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

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

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

hasValueOrEmpty

public boolean hasValueOrEmpty(String dataPath)
                        throws IllegalArgumentException

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

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

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

Returns:

the names of all data contained by this data holder

getValue

public <T> T getValue(String dataPath)
               throws IllegalArgumentException,
UnknownTypeException,
NotUniqueTypeException,
BadItemTypeException

Description copied from interface: DataHolder

Retrieves the value of the data at the given path

Specified by:

getValue in interface DataHolder

Type Parameters:

T - type of the value to retrieve. If the data holder has a model, the type of the value is defined by this model. Otherwise, the type of the value will be deduced from the stored data. In some cases, the type can be wrong. For example, it is impossible to know if a stored date is a date or a date time

Parameters:

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

UnknownTypeException - if there is no compatible type with the data at the given data path

NotUniqueTypeException - if there are many compatible types (there is no way to determine which type is the good one)

BadItemTypeException - if the data holder has a model and the type defined by the model doesn't match the type of the stored value, or if value at the sub data path of the given one is not a composite

getValueOrDefault

public <T> T getValueOrDefault(String dataPath,
 T defaultValue)
                        throws IllegalArgumentException,
UnknownTypeException,
NotUniqueTypeException,
BadItemTypeException

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:

getValueOrDefault in interface DataHolder

Type Parameters:

T - type of the value to retrieve. If the data holder has a model, the type of the value is defined by this model. Otherwise, the type of the value will be deduced from the stored data. In some cases, the type can be wrong. For example, it is impossible to know if a stored date is a date or a date time

Parameters:

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

UnknownTypeException - if there is no compatible type with the data at the given data path

NotUniqueTypeException - if there are many compatible types (there is no way to determine which type is the good one)

BadItemTypeException - if value at the sub data path of the given one is not a composite

getValueOfType

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

Description copied from interface: DataHolder

Retrieves the value of the data at the given path

Specified by:

getValueOfType in interface DataHolder

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

UnknownTypeException - if the given type isn't available for this data holder's type extension point

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

getValueOfTypeOrDefault

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

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

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

UnknownTypeException - if the given type isn't available for this data holder's type extension point

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

isMultiple

public boolean isMultiple(String dataPath)
                   throws IllegalArgumentException,
UnknownDataException,
UnknownTypeException,
NotUniqueTypeException,
BadItemTypeException

Description copied from interface: DataHolder

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

Specified by:

isMultiple in interface DataHolder

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

UnknownDataException - the data at the given path does not exist

UnknownTypeException - if there is no compatible type with the data at the given data path

NotUniqueTypeException - if there are many compatible types (there is no way to determine which type is the good one)

BadItemTypeException - if value at the sub data path of the given one is not a composite

isMultiple

public boolean isMultiple(String dataPath,
 String dataTypeId)
                   throws IllegalArgumentException,
UnknownDataException,
UnknownTypeException,
BadItemTypeException

Description copied from interface: DataHolder

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

Specified by:

isMultiple in interface DataHolder

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

UnknownDataException - the data at the given path does not exist

UnknownTypeException - if there is no compatible type with the data at the given data path

BadItemTypeException - if value at the sub data path of the given one is not a composite

getType

public <X extends ModelItemType> X getType(String dataPath)
                                    throws IllegalArgumentException,
UnknownDataException,
UnknownTypeException,
NotUniqueTypeException

Description copied from interface: DataHolder

Retrieves the type of the data at the given path

Specified by:

getType in interface DataHolder

Type Parameters:

X - type of the item type

Parameters:

dataPath - path of the data

Returns:

the type of the data

Throws:

IllegalArgumentException - if the given data path is null or empty

UnknownDataException - if there is no data stored at the given path

UnknownTypeException - if there is no compatible type with the data at the given data path or if the data is a repeater entry but the composite type is not available

NotUniqueTypeException - if there are many compatible types (there is no way to determine which type is the good one)

getModelItemTypeExtensionPoint

public ModelItemTypeExtensionPoint getModelItemTypeExtensionPoint()

Description copied from interface: DataHolder

Provide the ModelItemTypeExtensionPoint linked with the DataHolder

Specified by:

getModelItemTypeExtensionPoint in interface DataHolder

Returns:

the extension point

copyTo

public void copyTo(ModifiableDataHolder dataHolder)
            throws UnknownTypeException,
NotUniqueTypeException,
BadItemTypeException

Description copied from interface: DataHolder

Copies the current DataHolder to the given ModifiableDataHolder.

Specified by:

copyTo in interface DataHolder

Parameters:

dataHolder - The destination dataHolder. Can not be null.

Throws:

UnknownTypeException - if there is no available type compatible with the copied value for the type extension point of the destination ModifiableDataHolder

NotUniqueTypeException - if there is more than one available types compatibles with the copied value for the type extension point of the destination ModifiableDataHolder

BadItemTypeException - if type of a data to copy doesn't match the data with same path in the destination ModifiableDataHolder

copyTo

public void copyTo(ModifiableDataHolder dataHolder,
 DataContext context)
            throws UnknownTypeException,
NotUniqueTypeException,
BadItemTypeException

Description copied from interface: DataHolder

Copies the current DataHolder to the given ModifiableDataHolder.

Specified by:

copyTo in interface DataHolder

Parameters:

dataHolder - The destination dataHolder. Can not be null.

context - The context of the data to copy

Throws:

UnknownTypeException - if there is no available type compatible with the copied value for the type extension point of the destination ModifiableDataHolder

NotUniqueTypeException - if there is more than one available types compatibles with the copied value for the type extension point of the destination ModifiableDataHolder

BadItemTypeException - if type of a data to copy doesn't match the data with same path in the destination ModifiableDataHolder

dataToSAX

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

Description copied from interface: DataHolder

Generates SAX events for data contained in this DataHolder

Specified by:

dataToSAX in interface DataHolder

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

UnknownTypeException - if there is no compatible type with the saxed value

NotUniqueTypeException - if there are many compatible types (there is no way to determine which type is the good one) with the saxed value

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

dataToSAX

public void dataToSAX(ContentHandler contentHandler,
 String dataPath,
 DataContext context)
               throws SAXException,
UnknownTypeException,
NotUniqueTypeException,
BadItemTypeException

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

UnknownTypeException - if there is no compatible type with the saxed value

NotUniqueTypeException - if there are many compatible types (there is no way to determine which type is the good one) with the saxed value

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

dataToJSON

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

Description copied from interface: DataHolder

Convert the data contained in this DataHolder

Specified by:

dataToJSON in interface DataHolder

Parameters:

context - The context of the data to convert

Returns:

The data of the current DataHolder as JSON

Throws:

UnknownTypeException - if there is no compatible type with the value to convert

NotUniqueTypeException - if there are many compatible types (there is no way to determine which type is the good one) with the value to convert

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

dataToJSON

public Object dataToJSON(String dataPath,
 DataContext context)
                  throws UnknownTypeException,
NotUniqueTypeException,
BadItemTypeException

Description copied from interface: DataHolder

Convert the data at the given path into a JSON object

Specified by:

dataToJSON in interface DataHolder

Parameters:

dataPath - the path of the data to convert

context - The context of the data to convert

Returns:

The value as JSON

Throws:

UnknownTypeException - if there is no compatible type with the value to convert

NotUniqueTypeException - if there are many compatible types (there is no way to determine which type is the good one) with the value to convert

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

hasDifferences

public boolean hasDifferences(Map<String,Object> values)
                       throws UnknownTypeException,
NotUniqueTypeException,
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

Parameters:

values - the values to check

Returns:

true if there are differences, false otherwise

Throws:

UnknownTypeException - if there is no available type compatible with a given value for this data holder's type extension point

NotUniqueTypeException - if there is more than one available types compatibles with the a value for this data holder's type extension point

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

getRepositoryData

public RepositoryData getRepositoryData()

Description copied from interface: DataHolder

Retrieves the repository data used by this DataHolder

Specified by:

getRepositoryData in interface DataHolder

Returns:

the repository data used by this DataHolder

getParentDataHolder

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

Returns:

the parent of the current DataHolder

getRootDataHolder

public DataHolder getRootDataHolder()

Description copied from interface: DataHolder

Retrieves the DataHolder that is the root of the current one

Specified by:

getRootDataHolder in interface DataHolder

Returns:

the root DataHolder