net.cnri.repository

Interface DataElement

All Known Subinterfaces:

FileDataElement

All Known Implementing Classes:

AbstractDataElement, AbstractFileDataElement, BdbjeDataElement, DataElementWrapper, EmbeddedDataElement, FilesystemDataElement, LayeredDataElement, MemoryDataElement, NetworkedDataElement, NetworkedSearchResultDataElement, RestDataElement, SQLiteDataElement, SyncingDataElement

public interface DataElement

An object for accessing a Data Element within a Digital Object. Generally obtained from a DigitalObject via the createDataElement() or getDataElement() methods.

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.

Method Detail

getDigitalObject

DigitalObject getDigitalObject()

Returns the digital object of this data element.

Returns:

the digital object of this data element

getName

java.lang.String getName()

Returns the name of this data element.

Returns:

the name of this data element

delete

void delete()
            throws RepositoryException

Deletes the data element from its digital object.

Throws:

RepositoryException

getAttributes

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

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

Returns:

a Map view of the attributes of the data element.

Throws:

RepositoryException

listAttributes

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

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

Returns:

a CloseableIterator view of the attributes of the data element.

Throws:

RepositoryException

getAttribute

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

Returns the value for a particular attribute

Parameters:

name - the attribute name

Returns:

the attribute value

Throws:

RepositoryException

setAttributes

void setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)
                   throws RepositoryException

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

Parameters:

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

Throws:

RepositoryException

setAttribute

void setAttribute(java.lang.String name,
                java.lang.String value)
                  throws RepositoryException

Sets a particular attribute.

Parameters:

name - the attribute name

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

Throws:

RepositoryException

deleteAttributes

void deleteAttributes(java.util.List<java.lang.String> names)
                      throws RepositoryException

Deletes multiple attributes.

Parameters:

names - the names of the attributes to delete

Throws:

RepositoryException

deleteAttribute

void deleteAttribute(java.lang.String name)
                     throws RepositoryException

Deletes a particular attribute.

Parameters:

name - the name of the attribute to delete

Throws:

RepositoryException

getType

java.lang.String getType()
                         throws RepositoryException

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

Returns:

the MIME type of this data

Throws:

RepositoryException

setType

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

Sets the MIME type of the given data.

Parameters:

type - the new MIME type

Throws:

RepositoryException

read

java.io.InputStream read()
                         throws RepositoryException

Provides access to the data as an InputStream.

Returns:

an InputStream providing access to the data

Throws:

RepositoryException

read

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

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

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

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

Writes new data into the data element.

Parameters:

data - an InputStream streaming the new data

Returns:

the number of bytes of data written

Throws:

java.io.IOException

RepositoryException

write

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

Writes new data into the data element.

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

long getSize()
             throws RepositoryException

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

Returns:

the number of bytes of data in this data element

Throws:

RepositoryException