net.cnri.repository

Interface Repository

All Known Subinterfaces:

DirectRepository

All Known Implementing Classes:

AbstractDirectRepository, AbstractRepository, BdbjeRepository, ClientRepository, DirectRepositoryWrapper, EmbeddedRepository, FilesystemRepository, HighLevelRepository, InternalRepository, LayeredRepository, MemoryRepository, MigrationRepository, NetworkedRepository, ReferenceCountingRepositoryWrapper, RepositoryWrapper, RestRepository, ServletRepository, SQLiteRepository, SyncingRepository, UnionRepository

public interface Repository

An object for accessing a Digital Object Repository. The Repositories class provides factory methods.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the repository and release all resources.
DigitalObject	createDigitalObject(java.lang.String handle) Creates a new digital object with the given identifier in this repository.
void	deleteDigitalObject(java.lang.String handle) Deletes a digital object from the repository.
DigitalObject	getDigitalObject(java.lang.String handle) Returns the digital object with the given identifier from this repository.
java.lang.String	getHandle() Returns the handle of the repository.
DigitalObject	getOrCreateDigitalObject(java.lang.String handle) Returns the digital object with the given identifier from this repository, which is created if it does not exist.
CloseableIterator<java.lang.String>	listHandles() Provides a CloseableIterator view of the identifiers for digital objects accessible through this repository.
CloseableIterator<DigitalObject>	listObjects() Provides a CloseableIterator view of the digital objects accessible through this repository.
CloseableIterator<DigitalObject>	search(Query query) Provides a CloseableIterator view of the digital objects accessible through this repository under search bounds defined in the Query object with default parameters.
CloseableIterator<DigitalObject>	search(Query query, QueryParams queryParams) Provides a CloseableIterator view of the digital objects accessible through this repository under search bounds defined in the Query object and the parameters defined in the QueryParams object.
CloseableIterator<DigitalObject>	search(java.lang.String query) Deprecated. Use search(Query,QueryParams) with first argument a RawQuery and second argument null.
CloseableIterator<java.lang.String>	searchHandles(Query query) Provides a CloseableIterator view of the digital objects handles accessible through this repository under search bounds defined in the Query object with default parameters.
CloseableIterator<java.lang.String>	searchHandles(Query query, QueryParams queryParams) Provides a CloseableIterator view of the digital objects handles accessible through this repository under search bounds defined in the Query object and the parameters defined in the QueryParams object.
CloseableIterator<java.lang.String>	searchHandles(java.lang.String query) Deprecated. Use searchHandles(Query,QueryParams) with first argument a RawQuery and second argument null.
CloseableIterator<java.util.Map<java.lang.String,java.lang.String>>	searchMapping(java.lang.String query) Deprecated.
boolean	verifyDigitalObject(java.lang.String handle) Verifies whether a digital object with the given identifier can be accessed via this repository.

Method Detail

getHandle

java.lang.String getHandle()

Returns the handle of the repository. May return null for local repositories.

Returns:

the handle of the repository, or null if not available.

verifyDigitalObject

boolean verifyDigitalObject(java.lang.String handle)
                            throws RepositoryException

Verifies whether a digital object with the given identifier can be accessed via this repository.

Parameters:

handle - an identifier for a digital object

Returns:

whether a digital object with that identifier can be accessed via this repository

Throws:

RepositoryException

createDigitalObject

DigitalObject createDigitalObject(java.lang.String handle)
                                  throws CreationException,
                                         RepositoryException

Creates a new digital object with the given identifier in this repository. Passing null requests that the repository assign a new unique identifier; this method will throw UnsupportedOperationException if the given repository does not support that functionality.

Parameters:

handle - the identifier for the new digital object, or null to request that the repository assign a new unique identifier.

Returns:

the newly-created digital object

Throws:

CreationException - if an object with the given identifier already exists within the repository

RepositoryException

getDigitalObject

DigitalObject getDigitalObject(java.lang.String handle)
                               throws RepositoryException

Returns the digital object with the given identifier from this repository.

Parameters:

handle - the identifier for the digital object

Returns:

the digital object, or null if no such object can be accessed through this repository

Throws:

RepositoryException

getOrCreateDigitalObject

DigitalObject getOrCreateDigitalObject(java.lang.String handle)
                                       throws RepositoryException

Returns the digital object with the given identifier from this repository, which is created if it does not exist.

Parameters:

handle - the identifier for the digital object

Returns:

the digital object

Throws:

RepositoryException

deleteDigitalObject

void deleteDigitalObject(java.lang.String handle)
                         throws RepositoryException

Deletes a digital object from the repository.

Parameters:

handle - the identifier for the digital object

Throws:

RepositoryException

listHandles

CloseableIterator<java.lang.String> listHandles()
                                                throws RepositoryException

Provides a CloseableIterator view of the identifiers for digital objects accessible through this repository.

Throws:

RepositoryException

listObjects

CloseableIterator<DigitalObject> listObjects()
                                             throws RepositoryException

Provides a CloseableIterator view of the digital objects accessible through this repository.

Throws:

RepositoryException

search

CloseableIterator<DigitalObject> search(Query query,
                                      QueryParams queryParams)
                                        throws RepositoryException

Provides a CloseableIterator view of the digital objects accessible through this repository under search bounds defined in the Query object and the parameters defined in the QueryParams object.

Parameters:

query - the query to perform

queryParams - parameters for the query, or null for default parameters

Returns:

a CloseableIterator over the results. Some implementations may return QueryResults.

Throws:

RepositoryException

searchHandles

CloseableIterator<java.lang.String> searchHandles(Query query,
                                                QueryParams queryParams)
                                                  throws RepositoryException

Provides a CloseableIterator view of the digital objects handles accessible through this repository under search bounds defined in the Query object and the parameters defined in the QueryParams object.

Parameters:

query - the query to perform

queryParams - parameters for the query, or null for default parameters

Returns:

a CloseableIterator over the results. Some implementations may return QueryResults.

Throws:

RepositoryException

search

CloseableIterator<DigitalObject> search(Query query)
                                        throws RepositoryException

Provides a CloseableIterator view of the digital objects accessible through this repository under search bounds defined in the Query object with default parameters.

Parameters:

query - the query to perform

Returns:

a CloseableIterator over the results. Some implementations may return QueryResults.

Throws:

RepositoryException

searchHandles

CloseableIterator<java.lang.String> searchHandles(Query query)
                                                  throws RepositoryException

Provides a CloseableIterator view of the digital objects handles accessible through this repository under search bounds defined in the Query object with default parameters.

Parameters:

query - the query to perform

Returns:

a CloseableIterator over the results. Some implementations may return QueryResults.

Throws:

RepositoryException

search

@Deprecated
CloseableIterator<DigitalObject> search(java.lang.String query)
                                        throws RepositoryException

Deprecated. Use search(Query,QueryParams) with first argument a RawQuery and second argument null.

Throws:

RepositoryException

searchHandles

@Deprecated
CloseableIterator<java.lang.String> searchHandles(java.lang.String query)
                                                  throws RepositoryException

Deprecated. Use searchHandles(Query,QueryParams) with first argument a RawQuery and second argument null.

Throws:

RepositoryException

searchMapping

@Deprecated
CloseableIterator<java.util.Map<java.lang.String,java.lang.String>> searchMapping(java.lang.String query)
                                                                                  throws RepositoryException

Deprecated.

Throws:

RepositoryException

close

void close()

Close the repository and release all resources.