net.cnri.repository

Interface DigitalObject

All Known Implementing Classes:

AbstractDigitalObject, BdbjeDigitalObject, DigitalObjectWrapper, EmbeddedDigitalObject, FilesystemDigitalObject, HighLevelDigitalObject, LayeredDigitalObject, MemoryDigitalObject, NetworkedDigitalObject, NetworkedSearchResultDigitalObject, RestDigitalObject, SQLiteDigitalObject, SyncingDigitalObject

public interface DigitalObject

An object for accessing a Digital Object within a Repository. Generally obtained from a Repository via the createDigitalObject() or getDigitalObject() methods.

Method Summary

Methods

Modifier and Type	Method and Description
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

Method Detail

getRepository

Repository getRepository()

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

Returns:

the repository through which this digital object is being accessed

getHandle

java.lang.String getHandle()

Returns the identifier for this digital object.

Returns:

the identifier for this digital object

delete

void delete()
            throws RepositoryException

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

Throws:

RepositoryException

getAttributes

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

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

Returns:

a Map view of the attributes of the digital object.

Throws:

RepositoryException

listAttributes

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

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

Returns:

a CloseableIterator view of the attributes of the digital object.

Throws:

RepositoryException

getAttribute

java.lang.String getAttribute(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.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 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.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 name)
                     throws RepositoryException

Deletes a particular attribute.

Parameters:

name - the name of the attribute to delete

Throws:

RepositoryException

verifyDataElement

boolean verifyDataElement(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

DataElement createDataElement(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

Returns:

the newly-created data element

Throws:

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

RepositoryException

getDataElement

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

Returns the data element with the given name.

Parameters:

name - the identifier for the data element

Returns:

the data element, or null if no such element exists

Throws:

RepositoryException

getOrCreateDataElement

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

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

Parameters:

name - the identifier for the data element

Returns:

the data element

Throws:

RepositoryException

deleteDataElement

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

Deletes any data element of the given name.

Parameters:

name - the identifier for the data element

Throws:

RepositoryException

getDataElementNames

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

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

Throws:

RepositoryException

getDataElements

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

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

Throws:

RepositoryException

listDataElementNames

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

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

Throws:

RepositoryException

listDataElements

CloseableIterator<DataElement> listDataElements()
                                                throws RepositoryException

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

Throws:

RepositoryException