net.cnri.repository.rest

Class RestDigitalObject

java.lang.Object

net.cnri.repository.AbstractDigitalObject

net.cnri.repository.rest.RestDigitalObject

All Implemented Interfaces:

DigitalObject

public class RestDigitalObject
extends AbstractDigitalObject

Constructor Summary

Constructors

Constructor and Description
RestDigitalObject(RestRepository repo, MemoryDigitalObject memDobj)

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 id) 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 id) 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.
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 id) Verifies whether a data element with the given name exists within this digital object

Methods inherited from class net.cnri.repository.AbstractDigitalObject

equals, getOrCreateDataElement, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

RestDigitalObject

public RestDigitalObject(RestRepository repo,
                 MemoryDigitalObject memDobj)

Method Detail

getAttributes

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

Description copied from interface: DigitalObject

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

Specified by:

getAttributes in interface DigitalObject

Overrides:

getAttributes in class AbstractDigitalObject

Returns:

a Map view of the attributes of the digital object.

listAttributes

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

Description copied from interface: DigitalObject

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

Specified by:

listAttributes in interface DigitalObject

Overrides:

listAttributes in class AbstractDigitalObject

Returns:

a CloseableIterator view of the attributes of the digital object.

getAttribute

public java.lang.String getAttribute(java.lang.String id)

Description copied from interface: DigitalObject

Returns the value for a particular attribute

Specified by:

getAttribute in interface DigitalObject

Overrides:

getAttribute in class AbstractDigitalObject

Parameters:

id - the attribute name

Returns:

the attribute value

verifyDataElement

public boolean verifyDataElement(java.lang.String id)

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

Overrides:

verifyDataElement in class AbstractDigitalObject

Parameters:

id - an identifier for a data element

Returns:

whether that data element exists

getDataElement

public DataElement getDataElement(java.lang.String id)

Description copied from interface: DigitalObject

Returns the data element with the given name.

Parameters:

id - the identifier for the data element

Returns:

the data element, or null if no such element exists

listDataElementNames

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

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

Overrides:

listDataElementNames in class AbstractDigitalObject

listDataElements

public CloseableIterator<DataElement> listDataElements()

Description copied from interface: DigitalObject

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

Specified by:

listDataElements in interface DigitalObject

Overrides:

listDataElements in class AbstractDigitalObject

getRepository

public Repository getRepository()

Description copied from interface: DigitalObject

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

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.

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

Overrides:

delete in class AbstractDigitalObject

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

Overrides:

setAttributes in class AbstractDigitalObject

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.

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

Overrides:

deleteAttributes in class AbstractDigitalObject

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.

Parameters:

name - the name of the attribute to delete

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.

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

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

Overrides:

deleteDataElement in class AbstractDigitalObject

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

Overrides:

getDataElementNames in class AbstractDigitalObject

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

Overrides:

getDataElements in class AbstractDigitalObject

Throws:

RepositoryException