net.cnri.repository.networked

Class NetworkedSearchResultDigitalObject

java.lang.Object

net.cnri.repository.AbstractDigitalObject

net.cnri.repository.networked.NetworkedSearchResultDigitalObject

All Implemented Interfaces:

DigitalObject

public class NetworkedSearchResultDigitalObject
extends AbstractDigitalObject
implements DigitalObject

Wraps a searchResult allowing it to be treated as if it were a real DigitalObject. This provides a considerable speed improvement as you can interact the the search result locally without having to make additional network calls unless they are necessary. Any reads that can be made without a network call will be made from the local search result. Any writes will be made to the remote object. Once a modification is made all further reads will be made from the remote object. These objects are created transparently to the user after they call NetworkedRepository.search() and iterates over the results.

Constructor Summary

Constructors

Constructor and Description
NetworkedSearchResultDigitalObject(NetworkedRepository repo, HeaderSet searchResult)

Method Summary

Methods

Modifier and Type	Method and Description
DataElement	createDataElement(java.lang.String elementID) 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 elname) Deletes any data element of the given name.
java.lang.String	getAttribute(java.lang.String attname) 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 elementID) Returns the data element with the given name.
java.lang.String	getHandle() Returns the identifier for this digital object.
Repository	getRepository() Returns the repository through which this digital object is being accessed.
java.lang.String	getSearchScore()
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 attname, java.lang.String attvalue) 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 elementID) 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, getOrCreateDataElement, 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, getOrCreateDataElement

Constructor Detail

NetworkedSearchResultDigitalObject

public NetworkedSearchResultDigitalObject(NetworkedRepository repo,
                                  HeaderSet searchResult)

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

Overrides:

delete in class AbstractDigitalObject

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

Overrides:

getAttributes in class AbstractDigitalObject

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

Overrides:

listAttributes in class AbstractDigitalObject

Returns:

a CloseableIterator view of the attributes of the digital object.

Throws:

RepositoryException

getAttribute

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

Description copied from interface: DigitalObject

Returns the value for a particular attribute

Specified by:

getAttribute in interface DigitalObject

Overrides:

getAttribute in class AbstractDigitalObject

Parameters:

attname - the attribute name

Returns:

the attribute value

Throws:

RepositoryException

getSearchScore

public java.lang.String getSearchScore()

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 attname,
                java.lang.String attvalue)
                  throws RepositoryException

Description copied from interface: DigitalObject

Sets a particular attribute.

Specified by:

setAttribute in interface DigitalObject

Parameters:

attname - the attribute name

attvalue - 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.

Specified by:

deleteAttribute in interface DigitalObject

Parameters:

name - the name of the attribute to delete

Throws:

RepositoryException

verifyDataElement

public boolean verifyDataElement(java.lang.String elementID)
                          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

Overrides:

verifyDataElement in class AbstractDigitalObject

Parameters:

elementID - an identifier for a data element

Returns:

whether that data element exists

Throws:

RepositoryException

createDataElement

public DataElement createDataElement(java.lang.String elementID)
                              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:

elementID - 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 elementID)
                           throws RepositoryException

Description copied from interface: DigitalObject

Returns the data element with the given name.

Specified by:

getDataElement in interface DigitalObject

Parameters:

elementID - the identifier for the data element

Returns:

the data element, or null if no such element exists

Throws:

RepositoryException

deleteDataElement

public void deleteDataElement(java.lang.String elname)
                       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:

elname - the identifier for the data element

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

Overrides:

listDataElementNames in class AbstractDigitalObject

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

Overrides:

listDataElements in class AbstractDigitalObject

Throws:

RepositoryException