net.cnri.repository

Class AbstractRepository

java.lang.Object

net.cnri.repository.AbstractRepository

All Implemented Interfaces:

Repository

Direct Known Subclasses:

AbstractDirectRepository, BdbjeRepository, EmbeddedRepository, FilesystemRepository, LayeredRepository, NetworkedRepository, RestRepository, SQLiteRepository

public abstract class AbstractRepository
extends java.lang.Object
implements Repository

Constructor Summary

Constructors

Constructor and Description
AbstractRepository()

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteDigitalObject(java.lang.String handle) Deletes a digital object from the 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.
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.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.cnri.repository.Repository

close, createDigitalObject, getDigitalObject

Constructor Detail

AbstractRepository

public AbstractRepository()

Method Detail

getHandle

public java.lang.String getHandle()

Description copied from interface: Repository

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

Specified by:

getHandle in interface Repository

Returns:

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

verifyDigitalObject

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

Description copied from interface: Repository

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

Specified by:

verifyDigitalObject in interface 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

getOrCreateDigitalObject

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

Description copied from interface: Repository

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

Specified by:

getOrCreateDigitalObject in interface Repository

Parameters:

handle - the identifier for the digital object

Returns:

the digital object

Throws:

RepositoryException

deleteDigitalObject

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

Description copied from interface: Repository

Deletes a digital object from the repository.

Specified by:

deleteDigitalObject in interface Repository

Parameters:

handle - the identifier for the digital object

Throws:

RepositoryException

listHandles

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

Description copied from interface: Repository

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

Specified by:

listHandles in interface Repository

Throws:

RepositoryException

listObjects

public CloseableIterator<DigitalObject> listObjects()
                                             throws RepositoryException

Description copied from interface: Repository

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

Specified by:

listObjects in interface Repository

Throws:

RepositoryException

search

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

Description copied from interface: Repository

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.

Specified by:

search in interface Repository

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

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

Description copied from interface: Repository

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.

Specified by:

searchHandles in interface Repository

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

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

Deprecated.

Specified by:

search in interface Repository

Throws:

RepositoryException

searchHandles

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

Deprecated.

Specified by:

searchHandles in interface Repository

Throws:

RepositoryException

search

public CloseableIterator<DigitalObject> search(Query query)
                                        throws RepositoryException

Description copied from interface: Repository

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

Specified by:

search in interface Repository

Parameters:

query - the query to perform

Returns:

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

Throws:

RepositoryException

searchHandles

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

Description copied from interface: Repository

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

Specified by:

searchHandles in interface Repository

Parameters:

query - the query to perform

Returns:

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

Throws:

RepositoryException

searchMapping

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

Deprecated.

Specified by:

searchMapping in interface Repository

Throws:

RepositoryException