Package org.eclipse.dirigible.repository.api

Interface ICollection

All Superinterfaces:

IEntity

public interface ICollection
extends IEntity

The ICollection interface represents a collection in the repository.

Method Summary

Modifier and Type	Method	Description
ICollection	createCollection(String name)	Creates a new collection with the specified name in this collection.
IResource	createResource(String name, byte[] content)	Create resource under this collection by recognizing the content type and binary flag by its file extension.
IResource	createResource(String name, byte[] content, boolean isBinary, String contentType)	Create resource under this collection by specifying the binary flag.
List<IEntity>	getChildren()	List the children of this collection.
ICollection	getCollection(String name)	Returns the collection with the specified name contained in this collection.
List<ICollection>	getCollections()	Returns a list of all the child collections held by this collection.
List<String>	getCollectionsNames()	Returns a list containing the names of all the child collections directly contained within this collection.
IResource	getResource(String name)	Returns the resource with the specified name contained in this collection.
List<IResource>	getResources()	Returns a list of all the resources held by this collection.
List<String>	getResourcesNames()	Returns a list containing the names of all the resources directly contained in this collection.
void	removeCollection(String name)	Removes the collection with the specified name contained in this collection.
void	removeCollection(ICollection collection)	Removes the child collection represented by the parameter.
void	removeResource(String name)	Removes the resource with the specified name from this collection.
void	removeResource(IResource resource)	Removes the child resource represented by the parameter.

Methods inherited from interface org.eclipse.dirigible.repository.api.IEntity

copyTo, create, delete, exists, getInformation, getName, getParent, getPath, getRepository, isEmpty, moveTo, renameTo

Method Details

getCollections

List<ICollection> getCollections() throws RepositoryReadException

Returns a list of all the child collections held by this collection.

Returns:

a list of ICollection instances

Throws:

RepositoryReadException - in case the list of ICollection cannot be retrieved

getCollectionsNames

List<String> getCollectionsNames() throws RepositoryReadException

Returns a list containing the names of all the child collections directly contained within this collection.

Returns:

a list of ICollection instances names

Throws:

RepositoryReadException - in case the names cannot be retrieved

createCollection

ICollection createCollection(String name) throws RepositoryReadException

Creates a new collection with the specified name in this collection.

The name should not contain any slashes.

The change is persisted to the backend.

Parameters:

name - the ICollection name

Returns:

an ICollection instance

Throws:

RepositoryReadException - in the ICollection cannot be created

getCollection

ICollection getCollection(String name) throws RepositoryReadException

Returns the collection with the specified name contained in this collection.

The returned collection is just a representation. It may not exist on the backend.

Parameters:

name - the name of the collection

Returns:

an ICollection instance.

Throws:

RepositoryReadException - in case the ICollection cannot be retrieved

removeCollection

void removeCollection(String name) throws RepositoryWriteException

Removes the collection with the specified name contained in this collection.

The name should not contain any slashes.

The change is persisted to the backend.

Parameters:

name - the name of the ICollection to be removed

Throws:

RepositoryWriteException - in case the ICollectioncannot be removed

removeCollection

void removeCollection(ICollection collection) throws RepositoryWriteException

Removes the child collection represented by the parameter.

Parameters:

collection - the ICollection instance to be removed

Throws:

RepositoryWriteException - in case the ICollection cannot be removed

getResources

List<IResource> getResources() throws RepositoryReadException

Returns a list of all the resources held by this collection.

Returns:

a list of IResource instances

Throws:

RepositoryReadException - in case the list of IResource cannot be retrieved

getResourcesNames

List<String> getResourcesNames() throws RepositoryReadException

Returns a list containing the names of all the resources directly contained in this collection.

Returns:

a list of IResource instances names

Throws:

RepositoryReadException - in case the list of IResource names cannot be retrieved

getResource

IResource getResource(String name) throws RepositoryReadException

Returns the resource with the specified name contained in this collection.

The returned resource is just a representation. It may not exist on the backend.

Parameters:

name - the name of the IResource

Returns:

a IResource instance

Throws:

RepositoryReadException - in case the IResource cannot be retrieved

removeResource

void removeResource(String name) throws RepositoryWriteException

Removes the resource with the specified name from this collection.

Changes are persisted to the backend.

Parameters:

name - the name of the IResource instance to be removed

Throws:

RepositoryWriteException - in case the IResource cannot be removed

removeResource

void removeResource(IResource resource) throws RepositoryWriteException

Removes the child resource represented by the parameter.

Changes are persisted to the backend.

Parameters:

resource - the IResource to be removed

Throws:

RepositoryWriteException - in case the IResource cannot be removed

getChildren

List<IEntity> getChildren() throws RepositoryReadException

List the children of this collection.

Returns:

a list of IEntity instances

Throws:

RepositoryReadException - in case the list of the IEntity cannot be retrieved

createResource

IResource createResource(String name, byte[] content, boolean isBinary, String contentType) throws RepositoryWriteException

Create resource under this collection by specifying the binary flag.

Parameters:

name - the name of the IResource

content - the raw content

isBinary - whether it is binary

contentType - the type of the content

Returns:

an IResource instance

Throws:

RepositoryWriteException - in case the IResource cannot be created

createResource

IResource createResource(String name, byte[] content) throws RepositoryWriteException

Create resource under this collection by recognizing the content type and binary flag by its file extension.

Parameters:

name - the name of the IResource

content - the raw content

Returns:

an IResource instance

Throws:

RepositoryWriteException - in case the IResource cannot be created