net.cnri.repository.wrapper

Class DataElementWrapper

java.lang.Object

net.cnri.repository.wrapper.DataElementWrapper

All Implemented Interfaces:

DataElement

Direct Known Subclasses:

SyncingDataElement

public class DataElementWrapper
extends java.lang.Object
implements DataElement

Constructor Summary

Constructors

Constructor and Description
DataElementWrapper(DigitalObject digitalObjectWrapper, DataElement originalDataElement)

Method Summary

Methods

Modifier and Type	Method and Description
void	delete() Deletes the data element from its digital object.
void	deleteAttribute(java.lang.String name) Deletes a particular attribute.
void	deleteAttributes(java.util.List<java.lang.String> names) Deletes multiple attributes.
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 data element.
DigitalObject	getDigitalObject() Returns the digital object of this data element.
java.lang.String	getName() Returns the name of this data element.
long	getSize() Returns the number of bytes of data in this data element.
java.lang.String	getType() Returns the MIME type of the given data.
CloseableIterator<java.util.Map.Entry<java.lang.String,java.lang.String>>	listAttributes() Returns a CloseableIterator view of the attributes of the data element.
java.io.InputStream	read() Provides access to the data as an InputStream.
java.io.InputStream	read(long start, long len) Provides access to a specified portion of the data as an InputStream.
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.
void	setType(java.lang.String type) Sets the MIME type of the given data.
long	write(java.io.InputStream data) Writes new data into the data element.
long	write(java.io.InputStream data, boolean append) Writes new data into the data element.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataElementWrapper

public DataElementWrapper(DigitalObject digitalObjectWrapper,
                  DataElement originalDataElement)

Method Detail

getDigitalObject

public DigitalObject getDigitalObject()

Description copied from interface: DataElement

Returns the digital object of this data element.

Specified by:

getDigitalObject in interface DataElement

Returns:

the digital object of this data element

getName

public java.lang.String getName()

Description copied from interface: DataElement

Returns the name of this data element.

Specified by:

getName in interface DataElement

Returns:

the name of this data element

delete

public void delete()
            throws RepositoryException

Description copied from interface: DataElement

Deletes the data element from its digital object.

Specified by:

delete in interface DataElement

Throws:

RepositoryException

getAttributes

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

Description copied from interface: DataElement

Returns a Map view of the attributes of the data element.

Specified by:

getAttributes in interface DataElement

Returns:

a Map view of the attributes of the data element.

Throws:

RepositoryException

listAttributes

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

Description copied from interface: DataElement

Returns a CloseableIterator view of the attributes of the data element.

Specified by:

listAttributes in interface DataElement

Returns:

a CloseableIterator view of the attributes of the data element.

Throws:

RepositoryException

getAttribute

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

Description copied from interface: DataElement

Returns the value for a particular attribute

Specified by:

getAttribute in interface DataElement

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: DataElement

Sets the value of multiple attributes. Attributes mapped to null will be deleted.

Specified by:

setAttributes in interface DataElement

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: DataElement

Sets a particular attribute.

Specified by:

setAttribute in interface DataElement

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: DataElement

Deletes multiple attributes.

Specified by:

deleteAttributes in interface DataElement

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: DataElement

Deletes a particular attribute.

Specified by:

deleteAttribute in interface DataElement

Parameters:

name - the name of the attribute to delete

Throws:

RepositoryException

getType

public java.lang.String getType()
                         throws RepositoryException

Description copied from interface: DataElement

Returns the MIME type of the given data. Needed to give access to this data to other applications in the Android system.

Specified by:

getType in interface DataElement

Returns:

the MIME type of this data

Throws:

RepositoryException

setType

public void setType(java.lang.String type)
             throws RepositoryException

Description copied from interface: DataElement

Sets the MIME type of the given data.

Specified by:

setType in interface DataElement

Parameters:

type - the new MIME type

Throws:

RepositoryException

read

public java.io.InputStream read()
                         throws RepositoryException

Description copied from interface: DataElement

Provides access to the data as an InputStream.

Specified by:

read in interface DataElement

Returns:

an InputStream providing access to the data

Throws:

RepositoryException

read

public java.io.InputStream read(long start,
                       long len)
                         throws RepositoryException

Description copied from interface: DataElement

Provides access to a specified portion of the data as an InputStream.

Specified by:

read in interface DataElement

Parameters:

start - the first byte of the data to send

len - the number of bytes to send

Returns:

an InputStream providing access to the data

Throws:

RepositoryException

write

public long write(java.io.InputStream data)
           throws java.io.IOException,
                  RepositoryException

Description copied from interface: DataElement

Writes new data into the data element.

Specified by:

write in interface DataElement

Parameters:

data - an InputStream streaming the new data

Returns:

the number of bytes of data written

Throws:

java.io.IOException

RepositoryException

write

public long write(java.io.InputStream data,
         boolean append)
           throws java.io.IOException,
                  RepositoryException

Description copied from interface: DataElement

Writes new data into the data element.

Specified by:

write in interface DataElement

Parameters:

data - an InputStream streaming the new data

append - whether to append the new data to the existing data

Returns:

the number of bytes of data written

Throws:

java.io.IOException

RepositoryException

getSize

public long getSize()
             throws RepositoryException

Description copied from interface: DataElement

Returns the number of bytes of data in this data element.

Specified by:

getSize in interface DataElement

Returns:

the number of bytes of data in this data element

Throws:

RepositoryException