Package org.ametys.plugins.explorer.cmis

Class CMISResourcesCollection

java.lang.Object

org.ametys.plugins.explorer.cmis.CMISResourcesCollection

All Implemented Interfaces:

ExplorerNode, ResourceCollection, AmetysObject, DataHolder, TraversableAmetysObject

public class CMISResourcesCollection
extends Object
implements ResourceCollection

Implementation of an ExplorerNode, backed by a CMIS server.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APPLICATION_ID	Application id for resources collections.

Constructor Summary

Constructors

Constructor	Description
CMISResourcesCollection(Folder folder, CMISRootResourcesCollection root, AmetysObject parent)	Creates a CMISResourcesCollection

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
String	getApplicationId()	Returns the application id corresponding to this Node.
AmetysObject	getChild(String path)	Retrieves a given child from its relative path.
CollectionIterable<AmetysObject>	getChildren()	Retrieves children of the current object.
Folder	getCmisFolder()	Retrieves the Folder
CMISRootResourcesCollection	getCmisRoot()	Retrieves the CMISRootResourcesCollection
Composite	getComposite(String compositePath)	Retrieves the composite at the given path
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	getDescription()	Get the description of the application
String	getExplorerPath()	Returns the path of this explorer node in the explorer hierarchy (which is a subset of the whole repository). If this collection is the root explorer node, "" is returned.
String	getIconCls()	Returns the icon css class for this Node.
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>
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 collection in its hierarchy (which is a subset of the whole repository). If this collection is the root collection, "" is returned.
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	hasChild(String name)	Tests if this Object has at least one child with the given name.
boolean	hasChildExplorerNodes()	Returns true if this explorer node contains child explorer nodes.
boolean	hasChildResources()	Returns true if this explorer node contains resources.
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

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

getChildAt, getChildPosition

Field Details

APPLICATION_ID

public static final String APPLICATION_ID

Application id for resources collections.

See Also:

• Constant Field Values

Constructor Details

CMISResourcesCollection

public CMISResourcesCollection(Folder folder,
 CMISRootResourcesCollection root,
 AmetysObject parent)

Creates a CMISResourcesCollection

Parameters:

folder - The CMIS folder

root - The root of the virtual tree

parent - the parent AmetysObject if known

Method Details

getApplicationId

public String getApplicationId()

Description copied from interface: ExplorerNode

Returns the application id corresponding to this Node.

Specified by:

getApplicationId in interface ExplorerNode

Returns:

the application id corresponding to this Node.

getIconCls

public String getIconCls()

Description copied from interface: ExplorerNode

Returns the icon css class for this Node.

Specified by:

getIconCls in interface ExplorerNode

Returns:

the icon css class for this Node for rendering in the tree.

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()
               throws AmetysRepositoryException

Description copied from interface: AmetysObject

Retrieves the name of the current object.

Specified by:

getName in interface AmetysObject

Returns:

the name.

Throws:

AmetysRepositoryException - if an error occurs.

getCmisRoot

public CMISRootResourcesCollection getCmisRoot()

Retrieves the CMISRootResourcesCollection

Returns:

the CMISRootResourcesCollection

getCmisFolder

public Folder getCmisFolder()

Retrieves the Folder

Returns:

the Folder

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.

getChild

public AmetysObject getChild(String path)
                      throws AmetysRepositoryException,
UnknownAmetysObjectException

Description copied from interface: TraversableAmetysObject

Retrieves a given child from its relative path. The path cannot be null, empty nor begin with a '/'.

Specified by:

getChild in interface TraversableAmetysObject

Parameters:

path - the path of the child which can contains a position with. [n] if same name sibling is allowed.

Returns:

the child found.

Throws:

AmetysRepositoryException - if an error occurs.

UnknownAmetysObjectException - if the object does not exist.

getChildren

public CollectionIterable<AmetysObject> getChildren()
                                             throws AmetysRepositoryException

Description copied from interface: TraversableAmetysObject

Retrieves children of the current object.

Specified by:

getChildren in interface TraversableAmetysObject

Returns:

the children or an empty AmetysObjectIterable.

Throws:

AmetysRepositoryException - if an error occurs.

hasChild

public boolean hasChild(String name)
                 throws AmetysRepositoryException

Description copied from interface: TraversableAmetysObject

Tests if this Object has at least one child with the given name.

Specified by:

hasChild in interface TraversableAmetysObject

Parameters:

name - the name to test. Cannot be null nor empty nor begin with a '/' and it cannot contain '/'.

Returns:

true if the named child exists, false otherwise.

Throws:

AmetysRepositoryException - if an error occurs.

hasChildResources

public boolean hasChildResources()
                          throws AmetysRepositoryException

Description copied from interface: ResourceCollection

Returns true if this explorer node contains resources.

Specified by:

hasChildResources in interface ResourceCollection

Returns:

true if this explorer node contains resources.

Throws:

AmetysRepositoryException - if an error occurs.

hasChildExplorerNodes

public boolean hasChildExplorerNodes()
                              throws AmetysRepositoryException

Description copied from interface: ExplorerNode

Returns true if this explorer node contains child explorer nodes.

Specified by:

hasChildExplorerNodes in interface ExplorerNode

Returns:

true if this explorer node contains child explorer nodes.

Throws:

AmetysRepositoryException - if an error occurs.

getExplorerPath

public String getExplorerPath()

Description copied from interface: ExplorerNode

Returns the path of this explorer node in the explorer hierarchy (which is a subset of the whole repository).
If this collection is the root explorer node, "" is returned.

Specified by:

getExplorerPath in interface ExplorerNode

Returns:

the path of this node in its hierarchy.

getResourcePath

public String getResourcePath()
                       throws AmetysRepositoryException

Description copied from interface: ResourceCollection

Returns the path of this resource collection in its hierarchy (which is a subset of the whole repository).
If this collection is the root collection, "" is returned.

Specified by:

getResourcePath in interface ResourceCollection

Returns:

the path of this collection in its hierarchy.

Throws:

AmetysRepositoryException - if an error occurs.

getDescription

public String getDescription()

Description copied from interface: ExplorerNode

Get the description of the application

Specified by:

getDescription in interface ExplorerNode

Returns:

the description

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