net.cnri.repository.memory

Class MemoryDigitalObject

java.lang.Object

net.cnri.repository.AbstractDigitalObject

net.cnri.repository.memory.MemoryDigitalObject

All Implemented Interfaces:

DigitalObject

public class MemoryDigitalObject
extends AbstractDigitalObject
implements DigitalObject

Constructor Summary

Constructors

Constructor and Description
MemoryDigitalObject(MemoryRepository repo, java.lang.String handle)

Method Summary

Methods

Modifier and Type	Method and Description
DataElement	createDataElement(java.lang.String id) 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 id) Deletes a particular attribute.
void	deleteAttributes(java.util.List<java.lang.String> ids) Deletes multiple attributes.
void	deleteDataElement(java.lang.String id) 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.lang.String	getHandle() Returns the identifier for this digital object.
DataElement	getOrCreateDataElement(java.lang.String id) 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 id, java.lang.String value) Sets a particular attribute.
void	setAttributes(java.util.Map<java.lang.String,java.lang.String> givenAttributes) Sets the value of multiple attributes.
void	setCreatedAndModifiedAttribute()
void	setModifiedAttribute()
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, getDataElementNames, getDataElements, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.cnri.repository.DigitalObject

getDataElementNames, getDataElements

Constructor Detail

MemoryDigitalObject

public MemoryDigitalObject(MemoryRepository repo,
                   java.lang.String handle)

Method Detail

setCreatedAndModifiedAttribute

public void setCreatedAndModifiedAttribute()

setModifiedAttribute

public void setModifiedAttribute()

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

Overrides:

delete in class AbstractDigitalObject

Throws:

RepositoryException

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

setAttributes

public void setAttributes(java.util.Map<java.lang.String,java.lang.String> givenAttributes)

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:

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

setAttribute

public void setAttribute(java.lang.String id,
                java.lang.String value)

Description copied from interface: DigitalObject

Sets a particular attribute.

Specified by:

setAttribute in interface DigitalObject

Parameters:

id - the attribute name

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

deleteAttributes

public void deleteAttributes(java.util.List<java.lang.String> ids)

Description copied from interface: DigitalObject

Deletes multiple attributes.

Specified by:

deleteAttributes in interface DigitalObject

Overrides:

deleteAttributes in class AbstractDigitalObject

Parameters:

ids - the names of the attributes to delete

deleteAttribute

public void deleteAttribute(java.lang.String id)

Description copied from interface: DigitalObject

Deletes a particular attribute.

Specified by:

deleteAttribute in interface DigitalObject

Parameters:

id - the name of the attribute to delete

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

createDataElement

public DataElement createDataElement(java.lang.String id)
                              throws CreationException

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:

id - 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

getDataElement

public DataElement getDataElement(java.lang.String id)

Description copied from interface: DigitalObject

Returns the data element with the given name.

Specified by:

getDataElement in interface DigitalObject

Parameters:

id - the identifier for the data element

Returns:

the data element, or null if no such element exists

getOrCreateDataElement

public DataElement getOrCreateDataElement(java.lang.String id)
                                   throws CreationException

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

Overrides:

getOrCreateDataElement in class AbstractDigitalObject

Parameters:

id - the identifier for the data element

Returns:

the data element

Throws:

CreationException

deleteDataElement

public void deleteDataElement(java.lang.String id)

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:

id - the identifier for the data element

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