net.cnri.repository.wrapper

Class DigitalObjectWrapper

java.lang.Object

net.cnri.repository.wrapper.DigitalObjectWrapper

All Implemented Interfaces:

DigitalObject, SupportsFastCopyForLayeredRepo

Direct Known Subclasses:

HighLevelDigitalObject, SyncingDigitalObject

public class DigitalObjectWrapper
extends java.lang.Object
implements DigitalObject, SupportsFastCopyForLayeredRepo

Constructor Summary

Constructors

Constructor and Description
DigitalObjectWrapper(RepositoryWrapper repositoryWrapper, DigitalObject originalDigitalObject)

Method Summary

Methods

Modifier and Type	Method and Description
void	copyTo(DigitalObject target) Copy this digital object (in the bottom repository of a LayeredRepository to another digital object (in the top repository).
DataElement	createDataElement(java.lang.String name) Creates a new data element with the given name in this digital object.
void	delete() Deletes this digital object from the repository through which it is being accessed.
void	deleteAttribute(java.lang.String name) Deletes a particular attribute.
void	deleteAttributes(java.util.List<java.lang.String> names) Deletes multiple attributes.
void	deleteDataElement(java.lang.String name) Deletes any data element of the given name.
java.lang.String	getAttribute(java.lang.String name) Returns the value for a particular attribute
java.util.Map<java.lang.String,java.lang.String>	getAttributes() Returns a Map view of the attributes of the digital object.
DataElement	getDataElement(java.lang.String name) Returns the data element with the given name.
java.util.List<java.lang.String>	getDataElementNames() Return a list of the names of the data elements in this digital object.
java.util.List<DataElement>	getDataElements() Returns a list of the data elements in this digital object.
java.lang.String	getHandle() Returns the identifier for this digital object.
DataElement	getOrCreateDataElement(java.lang.String name) Returns the data element with the given name, creating it if it does not exist.
Repository	getRepository() Returns the repository through which this digital object is being accessed.
CloseableIterator<java.util.Map.Entry<java.lang.String,java.lang.String>>	listAttributes() Returns a CloseableIterator view of the attributes of the digital object.
CloseableIterator<java.lang.String>	listDataElementNames() Provides a CloseableIterator view of the names of the data elements in this digital object.
CloseableIterator<DataElement>	listDataElements() Provides a CloseableIterator view of the data elements in this digital object.
void	setAttribute(java.lang.String name, java.lang.String value) Sets a particular attribute.
void	setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes) Sets the value of multiple attributes.
boolean	verifyDataElement(java.lang.String name) Verifies whether a data element with the given name exists within this digital object

Methods inherited from class java.lang.Object

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

Constructor Detail

DigitalObjectWrapper

public DigitalObjectWrapper(RepositoryWrapper repositoryWrapper,
                    DigitalObject originalDigitalObject)

Method Detail

getRepository

public Repository getRepository()

Description copied from interface: DigitalObject

Returns the repository through which this digital object is being accessed.

Specified by:

getRepository in interface DigitalObject

Returns:

the repository through which this digital object is being accessed

getHandle

public java.lang.String getHandle()

Description copied from interface: DigitalObject

Returns the identifier for this digital object.

Specified by:

getHandle in interface DigitalObject

Returns:

the identifier for this digital object

delete

public void delete()
            throws RepositoryException

Description copied from interface: DigitalObject

Deletes this digital object from the repository through which it is being accessed.

Specified by:

delete in interface DigitalObject

Throws:

RepositoryException

getAttributes

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

Description copied from interface: DigitalObject

Returns a Map view of the attributes of the digital object.

Specified by:

getAttributes in interface DigitalObject

Returns:

a Map view of the attributes of the digital object.

Throws:

RepositoryException

listAttributes

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

Description copied from interface: DigitalObject

Returns a CloseableIterator view of the attributes of the digital object.

Specified by:

listAttributes in interface DigitalObject

Returns:

a CloseableIterator view of the attributes of the digital object.

Throws:

RepositoryException

getAttribute

public java.lang.String getAttribute(java.lang.String name)
                              throws RepositoryException

Description copied from interface: DigitalObject

Returns the value for a particular attribute

Specified by:

getAttribute in interface DigitalObject

Parameters:

name - the attribute name

Returns:

the attribute value

Throws:

RepositoryException

setAttributes

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

Description copied from interface: DigitalObject

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

Specified by:

setAttributes in interface DigitalObject

Parameters:

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

Throws:

RepositoryException

setAttribute

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

Description copied from interface: DigitalObject

Sets a particular attribute.

Specified by:

setAttribute in interface DigitalObject

Parameters:

name - the attribute name

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

Throws:

RepositoryException

deleteAttributes

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

Description copied from interface: DigitalObject

Deletes multiple attributes.

Specified by:

deleteAttributes in interface DigitalObject

Parameters:

names - the names of the attributes to delete

Throws:

RepositoryException

deleteAttribute

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

Description copied from interface: DigitalObject

Deletes a particular attribute.

Specified by:

deleteAttribute in interface DigitalObject

Parameters:

name - the name of the attribute to delete

Throws:

RepositoryException

verifyDataElement

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

Description copied from interface: DigitalObject

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

Specified by:

verifyDataElement in interface DigitalObject

Parameters:

name - an identifier for a data element

Returns:

whether that data element exists

Throws:

RepositoryException

createDataElement

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

Description copied from interface: DigitalObject

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

Specified by:

createDataElement in interface DigitalObject

Parameters:

name - the identifier for the new data element

Returns:

the newly-created data element

Throws:

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

RepositoryException

getDataElement

public DataElement getDataElement(java.lang.String name)
                           throws RepositoryException

Description copied from interface: DigitalObject

Returns the data element with the given name.

Specified by:

getDataElement in interface DigitalObject

Parameters:

name - the identifier for the data element

Returns:

the data element, or null if no such element exists

Throws:

RepositoryException

getOrCreateDataElement

public DataElement getOrCreateDataElement(java.lang.String name)
                                   throws RepositoryException

Description copied from interface: DigitalObject

Returns the data element with the given name, creating it if it does not exist.

Specified by:

getOrCreateDataElement in interface DigitalObject

Parameters:

name - the identifier for the data element

Returns:

the data element

Throws:

RepositoryException

deleteDataElement

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

Description copied from interface: DigitalObject

Deletes any data element of the given name.

Specified by:

deleteDataElement in interface DigitalObject

Parameters:

name - the identifier for the data element

Throws:

RepositoryException

getDataElementNames

public java.util.List<java.lang.String> getDataElementNames()
                                                     throws RepositoryException

Description copied from interface: DigitalObject

Return a list of the names of the data elements in this digital object.

Specified by:

getDataElementNames in interface DigitalObject

Throws:

RepositoryException

getDataElements

public java.util.List<DataElement> getDataElements()
                                            throws RepositoryException

Description copied from interface: DigitalObject

Returns a list of the data elements in this digital object.

Specified by:

getDataElements in interface DigitalObject

Throws:

RepositoryException

listDataElementNames

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

Description copied from interface: DigitalObject

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

Specified by:

listDataElementNames in interface DigitalObject

Throws:

RepositoryException

listDataElements

public CloseableIterator<DataElement> listDataElements()
                                                throws RepositoryException

Description copied from interface: DigitalObject

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

Specified by:

listDataElements in interface DigitalObject

Throws:

RepositoryException

copyTo

public void copyTo(DigitalObject target)
            throws RepositoryException,
                   java.io.IOException

Description copied from interface: SupportsFastCopyForLayeredRepo

Copy this digital object (in the bottom repository of a LayeredRepository to another digital object (in the top repository). For implementations that can be faster than naive copying. In general this does not copy the data of data elements, but sets the attribute LayeredDataElement.ATTRIBUTE_DATA_ELEMENT_MISSING to 1 on each data element not copied.

Specified by:

copyTo in interface SupportsFastCopyForLayeredRepo

Parameters:

target - the digital object to copy into

Throws:

RepositoryException

java.io.IOException