Package org.eclipse.dirigible.repository.api

Interface IRepositoryReader

All Known Subinterfaces:

IMasterRepository, IRepository

public interface IRepositoryReader

This interface represents a READ ONLY Repository. It allows for navigating through collections and resources.

Method Summary

Modifier and Type	Method	Description
List<String>	getAllResourcePaths()	Returns a list of all the paths pointing to a resource.
ICollection	getCollection(String path)	Returns an ICollection instance representing the resource at the specified path.
IResource	getResource(String path)	Returns an instance of IResource which represents the resource located at the specified path.
ICollection	getRoot()	Returns an instance of ICollection which represents the root collection of the repository.
boolean	hasCollection(String path)	Returns whether a collection with the specified path exists in the repository.
boolean	hasResource(String path)	Returns whether a resource with the specified path exists in the repository.
void	initialize()	Performs initialization tasks.

Method Details

initialize

void initialize() throws RepositoryInitializationException

Performs initialization tasks.

Throws:

RepositoryInitializationException - in case of an error

getRoot

ICollection getRoot()

Returns an instance of ICollection which represents the root collection of the repository.

This method does not throw any exceptions for convenience but is not guaranteed to return a valid collection.

Returns:

an ICollection instance

getCollection

ICollection getCollection(String path)

Returns an ICollection instance representing the resource at the specified path.

The collection may not exist at the specified path.

Parameters:

path - the ICollection location

Returns:

an ICollection instance

hasCollection

boolean hasCollection(String path) throws RepositoryReadException

Returns whether a collection with the specified path exists in the repository.

Parameters:

path - the ICollection location

Returns:

whether the ICollection exists

Throws:

RepositoryReadException - in case the check cannot be performed

getResource

IResource getResource(String path)

Returns an instance of IResource which represents the resource located at the specified path.

The resource may not exist at the specified path.

Parameters:

path - the location of the IResource

Returns:

an IResource instance

hasResource

boolean hasResource(String path) throws RepositoryReadException

Returns whether a resource with the specified path exists in the repository.

Parameters:

path - the IResource location

Returns:

whether the IResource exists

Throws:

RepositoryReadException - in case the check cannot be performed

getAllResourcePaths

List<String> getAllResourcePaths() throws RepositoryReadException

Returns a list of all the paths pointing to a resource.

Returns:

a list of all the resources' paths

Throws:

RepositoryReadException - in case of error