net.cnri.repository.memory

Class MemoryRepository

java.lang.Object

net.cnri.repository.AbstractRepository

net.cnri.repository.AbstractDirectRepository

net.cnri.repository.memory.MemoryRepository

All Implemented Interfaces:

DirectRepository, Repository

public class MemoryRepository
extends AbstractDirectRepository

A local Digital Object repository entirely in system memory. High performance, no persistence.

Constructor Summary

Constructors

Constructor and Description
MemoryRepository()

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.io.File	getFile(java.lang.String handle, java.lang.String elementName) Returns a file for the data of the data element.
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<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.
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 net.cnri.repository.AbstractDirectRepository

createDataElement, deleteAttribute, deleteAttributes, deleteDataElement, getAttribute, getAttributes, getSize, listAttributes, listDataElementNames, read, setAttribute, setAttributes, verifyDataElement, write

Methods inherited from class net.cnri.repository.AbstractRepository

getHandle, search, search, searchHandles, searchHandles, searchMapping

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.cnri.repository.Repository

getHandle, search, search, searchHandles, searchHandles, searchMapping

Constructor Detail

MemoryRepository

public MemoryRepository()

Method Detail

verifyDigitalObject

public boolean verifyDigitalObject(java.lang.String handle)

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

Overrides:

verifyDigitalObject in class AbstractRepository

Parameters:

handle - an identifier for a digital object

Returns:

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

createDigitalObject

public DigitalObject createDigitalObject(java.lang.String handle)
                                  throws CreationException

Description copied from interface: Repository

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

getDigitalObject

public DigitalObject getDigitalObject(java.lang.String handle)

Description copied from interface: Repository

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

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

Overrides:

getOrCreateDigitalObject in class AbstractRepository

Parameters:

handle - the identifier for the digital object

Returns:

the digital object

Throws:

RepositoryException

deleteDigitalObject

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

Description copied from interface: Repository

Deletes a digital object from the repository.

Specified by:

deleteDigitalObject in interface Repository

Overrides:

deleteDigitalObject in class AbstractRepository

Parameters:

handle - the identifier for the digital object

Throws:

NoSuchDigitalObjectException

listHandles

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

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

Overrides:

listHandles in class AbstractRepository

listObjects

public CloseableIterator<DigitalObject> listObjects()

Description copied from interface: Repository

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

Specified by:

listObjects in interface Repository

Overrides:

listObjects in class AbstractRepository

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

Overrides:

search in class AbstractRepository

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

Overrides:

searchHandles in class AbstractRepository

Parameters:

query - the query to perform

Returns:

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

Throws:

RepositoryException

close

public void close()

Description copied from interface: Repository

Close the repository and release all resources.

getFile

public java.io.File getFile(java.lang.String handle,
                   java.lang.String elementName)
                     throws RepositoryException

Description copied from interface: DirectRepository

Returns a file for the data of the data element. Reading or writing the file corresponds to reading and writing the data element. If the repository does not support files for data elements, returns null.

Specified by:

getFile in interface DirectRepository

Overrides:

getFile in class AbstractDirectRepository

Returns:

A file for the data of the data element, or null if the repository does not support files for data elements.

Throws:

RepositoryException