net.cnri.repository.wrapper

Class DirectRepositoryWrapper

java.lang.Object

net.cnri.repository.wrapper.RepositoryWrapper

net.cnri.repository.wrapper.DirectRepositoryWrapper

All Implemented Interfaces:

DirectRepository, Repository

Direct Known Subclasses:

SyncingRepository

public class DirectRepositoryWrapper
extends RepositoryWrapper
implements DirectRepository

A wrapper class for wrapping a Repository as a DirectRepository. Can be used to convert any Repository into a DirectRepository, or to add functionality to an existing DirectRepository.

Constructor Summary

Constructors

Constructor and Description
DirectRepositoryWrapper(Repository repository)

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 class net.cnri.repository.wrapper.RepositoryWrapper

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

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, deleteDigitalObject, getDigitalObject, getHandle, getOrCreateDigitalObject, listHandles, listObjects, search, search, search, searchHandles, searchHandles, searchHandles, searchMapping, verifyDigitalObject

Constructor Detail

DirectRepositoryWrapper

public DirectRepositoryWrapper(Repository repository)

Method Detail

getAttributes

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

Description copied from interface: DirectRepository

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

Specified by:

getAttributes in interface DirectRepository

Returns:

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

Throws:

RepositoryException

listAttributes

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

Description copied from interface: DirectRepository

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

Specified by:

listAttributes in interface DirectRepository

Returns:

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

Throws:

RepositoryException

getAttribute

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

Description copied from interface: DirectRepository

Returns the value for a particular attribute

Specified by:

getAttribute in interface DirectRepository

name - the attribute name

Returns:

the attribute value

Throws:

RepositoryException

setAttributes

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

Description copied from interface: DirectRepository

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

Specified by:

setAttributes in interface DirectRepository

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

Throws:

RepositoryException

setAttribute

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

Description copied from interface: DirectRepository

Sets a particular attribute.

Specified by:

setAttribute in interface DirectRepository

name - the attribute name

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

Throws:

RepositoryException

deleteAttributes

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

Description copied from interface: DirectRepository

Deletes multiple attributes.

Specified by:

deleteAttributes in interface DirectRepository

names - the names of the attributes to delete

Throws:

RepositoryException

deleteAttribute

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

Description copied from interface: DirectRepository

Deletes a particular attribute.

Specified by:

deleteAttribute in interface DirectRepository

name - the name of the attribute to delete

Throws:

RepositoryException

verifyDataElement

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

Description copied from interface: DirectRepository

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

Specified by:

verifyDataElement in interface DirectRepository

name - an identifier for a data element

Returns:

whether that data element exists

Throws:

RepositoryException

createDataElement

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

Description copied from interface: DirectRepository

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

Specified by:

createDataElement in interface DirectRepository

name - the identifier for the new data element

Throws:

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

RepositoryException

deleteDataElement

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

Description copied from interface: DirectRepository

Deletes any data element of the given name.

Specified by:

deleteDataElement in interface DirectRepository

name - the identifier for the data element

Throws:

RepositoryException

listDataElementNames

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

Description copied from interface: DirectRepository

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

Specified by:

listDataElementNames in interface DirectRepository

Throws:

RepositoryException

read

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

Description copied from interface: DirectRepository

Provides access to the data as an InputStream.

Specified by:

read in interface DirectRepository

Returns:

an InputStream providing access to the data

Throws:

RepositoryException

write

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

Description copied from interface: DirectRepository

Writes new data into the data element.

Specified by:

write in interface DirectRepository

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

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

Description copied from interface: DirectRepository

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

Specified by:

getSize in interface DirectRepository

Returns:

the number of bytes of data in this data element

Throws:

RepositoryException

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

Returns:

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

Throws:

RepositoryException