org.fcrepo.kernel

Interface Datastream

All Superinterfaces:

FedoraResource

public interface Datastream
extends FedoraResource

Since:

Feb 18, 2014

Author:

bbpennel

Method Summary

Methods

Modifier and Type	Method and Description
javax.jcr.Binary	getBinaryContent()
InputStream	getContent()
URI	getContentDigest() Get the pre-calculated content digest for the binary payload
javax.jcr.Node	getContentNode()
long	getContentSize()
String	getDsId()
String	getFilename() Return the file name for the binary content
String	getMimeType()
FedoraObject	getObject()
Long	getSize() Return the calculated size of the DS node
boolean	hasContent() Check if the datastream has a content node
void	setContent(InputStream content) Set the content of this datastream
void	setContent(InputStream content, String contentType, URI checksum, String originalFileName, StoragePolicyDecisionPoint storagePolicyDecisionPoint) Sets the content of this Datastream.

Methods inherited from interface org.fcrepo.kernel.FedoraResource

addVersionLabel, getBaseVersion, getCreatedDate, getEtagValue, getHierarchyTriples, getLastModifiedDate, getModels, getNode, getPath, getPropertiesDataset, getPropertiesDataset, getReferencesTriples, getTriples, getVersionHistory, getVersionTriples, isNew, replaceProperties, updatePropertiesDataset

Method Detail

getContent

InputStream getContent()
                       throws javax.jcr.RepositoryException

Returns:

The InputStream of content associated with this datastream.

Throws:

javax.jcr.RepositoryException

getBinaryContent

javax.jcr.Binary getBinaryContent()
                                  throws javax.jcr.RepositoryException

Returns:

The Binary content associated with this datastream.

Throws:

javax.jcr.RepositoryException

getContentNode

javax.jcr.Node getContentNode()
                              throws javax.jcr.RepositoryException

Returns:

The Node of content associated with this datastream.

Throws:

javax.jcr.RepositoryException

hasContent

boolean hasContent()
                   throws javax.jcr.RepositoryException

Check if the datastream has a content node

Specified by:

hasContent in interface FedoraResource

Returns:

boolean

Throws:

javax.jcr.RepositoryException

setContent

void setContent(InputStream content,
              String contentType,
              URI checksum,
              String originalFileName,
              StoragePolicyDecisionPoint storagePolicyDecisionPoint)
                throws javax.jcr.RepositoryException,
                       InvalidChecksumException

Sets the content of this Datastream.

Parameters:

content - InputStream of binary content to be stored

contentType - MIME type of content (optional)

checksum - Checksum URI of the content (optional)

originalFileName - Original file name of the content (optional)

storagePolicyDecisionPoint - Policy decision point for storing the content (optional)

Throws:

javax.jcr.RepositoryException

InvalidChecksumException

setContent

void setContent(InputStream content)
                throws InvalidChecksumException,
                       javax.jcr.RepositoryException

Set the content of this datastream

Parameters:

content - Binary content to be stored

Throws:

InvalidChecksumException

javax.jcr.RepositoryException

getContentSize

long getContentSize()

Returns:

The size in bytes of content associated with this datastream.

getContentDigest

URI getContentDigest()
                     throws javax.jcr.RepositoryException

Get the pre-calculated content digest for the binary payload

Returns:

a URI with the format algorithm:value

Throws:

javax.jcr.RepositoryException

getDsId

String getDsId()
               throws javax.jcr.RepositoryException

Returns:

The ID of this datastream, unique within an object. Normally just the name of the backing JCR node.

Throws:

javax.jcr.RepositoryException

getObject

FedoraObject getObject()
                       throws javax.jcr.RepositoryException

Returns:

the FedoraObject to which this datastream belongs.

Throws:

javax.jcr.RepositoryException

getMimeType

String getMimeType()
                   throws javax.jcr.RepositoryException

Returns:

The MimeType of content associated with this datastream.

Throws:

javax.jcr.RepositoryException

getSize

Long getSize()
             throws javax.jcr.RepositoryException

Return the calculated size of the DS node

Specified by:

getSize in interface FedoraResource

Returns:

combined size of the properties and binary content

Throws:

javax.jcr.RepositoryException

getFilename

String getFilename()
                   throws javax.jcr.RepositoryException

Return the file name for the binary content

Returns:

original file name for the binary content, or the object's id.

Throws:

javax.jcr.RepositoryException