net.cnri.repository

Class AbstractDigitalObject

java.lang.Object

net.cnri.repository.AbstractDigitalObject

All Implemented Interfaces:

DigitalObject

Direct Known Subclasses:

BdbjeDigitalObject, FilesystemDigitalObject, LayeredDigitalObject, MemoryDigitalObject, NetworkedDigitalObject, NetworkedSearchResultDigitalObject, RestDigitalObject, SQLiteDigitalObject

public abstract class AbstractDigitalObject
extends java.lang.Object
implements DigitalObject

Constructor Summary

Constructors

Constructor and Description
AbstractDigitalObject()

Method Summary

Methods

Modifier and Type	Method and Description
void	delete() Deletes this digital object from the repository through which it is being accessed.
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.
boolean	equals(java.lang.Object obj)
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.
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.
DataElement	getOrCreateDataElement(java.lang.String name) Returns the data element with the given name, creating it if it does not exist.
int	hashCode()
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	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

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.cnri.repository.DigitalObject

createDataElement, deleteAttribute, getDataElement, getHandle, getRepository, setAttribute

Constructor Detail

AbstractDigitalObject

public AbstractDigitalObject()

Method Detail

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

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

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

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

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object