net.cnri.repository

Interface DirectRepository

All Superinterfaces:

Repository

All Known Implementing Classes:

AbstractDirectRepository, BdbjeRepository, DirectRepositoryWrapper, LayeredRepository, MemoryRepository, MigrationRepository, SQLiteRepository, SyncingRepository

public interface DirectRepository
extends Repository

An object for accessing a Digital Object Repository. This interface allows direct access to digital objects and data elements without having to go through the DigitalObject and DataElement classes.

Method Summary

Methods

Modifier and Type	Method and Description
void	createDataElement(java.lang.String handle, java.lang.String name) Creates a new data element with the given name in this digital object.
void	deleteAttribute(java.lang.String handle, java.lang.String elementName, java.lang.String name) Deletes a particular attribute.
void	deleteAttributes(java.lang.String handle, java.lang.String elementName, java.util.List<java.lang.String> names) Deletes multiple attributes.
void	deleteDataElement(java.lang.String handle, java.lang.String name) Deletes any data element of the given name.
java.lang.String	getAttribute(java.lang.String handle, java.lang.String elementName, java.lang.String name) Returns the value for a particular attribute
java.util.Map<java.lang.String,java.lang.String>	getAttributes(java.lang.String handle, java.lang.String elementName) Returns a Map view of the attributes of the digital object or data element.
java.io.File	getFile(java.lang.String handle, java.lang.String elementName) Returns a file for the data of the data element.
long	getSize(java.lang.String handle, java.lang.String elementName) Returns the number of bytes of data in this data element.
CloseableIterator<java.util.Map.Entry<java.lang.String,java.lang.String>>	listAttributes(java.lang.String handle, java.lang.String elementName) Returns a CloseableIterator view of the attributes of the digital object or data element.
CloseableIterator<java.lang.String>	listDataElementNames(java.lang.String handle) Provides a CloseableIterator view of the names of the data elements in this digital object.
java.io.InputStream	read(java.lang.String handle, java.lang.String elementName) Provides access to the data as an InputStream.
void	setAttribute(java.lang.String handle, java.lang.String elementName, java.lang.String name, java.lang.String value) Sets a particular attribute.
void	setAttributes(java.lang.String handle, java.lang.String elementName, java.util.Map<java.lang.String,java.lang.String> attributes) Sets the value of multiple attributes.
boolean	verifyDataElement(java.lang.String handle, java.lang.String name) Verifies whether a data element with the given name exists within this digital object
long	write(java.lang.String handle, java.lang.String elementName, java.io.InputStream data, boolean append) Writes new data into the data element.

Methods inherited from interface net.cnri.repository.Repository

close, createDigitalObject, deleteDigitalObject, getDigitalObject, getHandle, getOrCreateDigitalObject, listHandles, listObjects, search, search, search, searchHandles, searchHandles, searchHandles, searchMapping, verifyDigitalObject

Method Detail

getAttributes

java.util.Map<java.lang.String,java.lang.String> getAttributes(java.lang.String handle,
                                                             java.lang.String elementName)
                                                               throws RepositoryException

Returns a Map view of the attributes of the digital object or data element.

Returns:

a Map view of the attributes of the digital object or data element.

Throws:

RepositoryException

listAttributes

CloseableIterator<java.util.Map.Entry<java.lang.String,java.lang.String>> listAttributes(java.lang.String handle,
                                                                                       java.lang.String elementName)
                                                                                         throws RepositoryException

Returns a CloseableIterator view of the attributes of the digital object or data element.

Returns:

a CloseableIterator view of the attributes of the digital object or data element.

Throws:

RepositoryException

getAttribute

java.lang.String getAttribute(java.lang.String handle,
                            java.lang.String elementName,
                            java.lang.String name)
                              throws RepositoryException

Returns the value for a particular attribute

Parameters:

name - the attribute name

Returns:

the attribute value

Throws:

RepositoryException

setAttributes

void setAttributes(java.lang.String handle,
                 java.lang.String elementName,
                 java.util.Map<java.lang.String,java.lang.String> attributes)
                   throws RepositoryException

Sets the value of multiple attributes. Attributes mapped to null will be deleted.

Parameters:

attributes - the attributes to set, mapped to their new values

Throws:

RepositoryException

setAttribute

void setAttribute(java.lang.String handle,
                java.lang.String elementName,
                java.lang.String name,
                java.lang.String value)
                  throws RepositoryException

Sets a particular attribute.

Parameters:

name - the attribute name

value - the attribute value; if null, the attribute will be deleted.

Throws:

RepositoryException

deleteAttributes

void deleteAttributes(java.lang.String handle,
                    java.lang.String elementName,
                    java.util.List<java.lang.String> names)
                      throws RepositoryException

Deletes multiple attributes.

Parameters:

names - the names of the attributes to delete

Throws:

RepositoryException

deleteAttribute

void deleteAttribute(java.lang.String handle,
                   java.lang.String elementName,
                   java.lang.String name)
                     throws RepositoryException

Deletes a particular attribute.

Parameters:

name - the name of the attribute to delete

Throws:

RepositoryException

verifyDataElement

boolean verifyDataElement(java.lang.String handle,
                        java.lang.String name)
                          throws RepositoryException

Verifies whether a data element with the given name exists within this digital object

Parameters:

name - an identifier for a data element

Returns:

whether that data element exists

Throws:

RepositoryException

createDataElement

void createDataElement(java.lang.String handle,
                     java.lang.String name)
                       throws CreationException,
                              RepositoryException

Creates a new data element with the given name in this digital object.

Parameters:

name - the identifier for the new data element

Throws:

CreationException - if a data element with the given name already exists

RepositoryException

deleteDataElement

void deleteDataElement(java.lang.String handle,
                     java.lang.String name)
                       throws RepositoryException

Deletes any data element of the given name.

Parameters:

name - the identifier for the data element

Throws:

RepositoryException

listDataElementNames

CloseableIterator<java.lang.String> listDataElementNames(java.lang.String handle)
                                                         throws RepositoryException

Provides a CloseableIterator view of the names of the data elements in this digital object.

Throws:

RepositoryException

read

java.io.InputStream read(java.lang.String handle,
                       java.lang.String elementName)
                         throws RepositoryException

Provides access to the data as an InputStream.

Returns:

an InputStream providing access to the data

Throws:

RepositoryException

write

long write(java.lang.String handle,
         java.lang.String elementName,
         java.io.InputStream data,
         boolean append)
           throws java.io.IOException,
                  RepositoryException

Writes new data into the data element.

Parameters:

data - an InputStream streaming the new data

append - whether to append the new data to the existing data

Returns:

the number of bytes of data written

Throws:

java.io.IOException

RepositoryException

getSize

long getSize(java.lang.String handle,
           java.lang.String elementName)
             throws RepositoryException

Returns the number of bytes of data in this data element.

Returns:

the number of bytes of data in this data element

Throws:

RepositoryException

getFile

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

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.

Returns:

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

Throws:

RepositoryException