org.fcrepo.kernel

Class Datastream

java.lang.Object

org.modeshape.jcr.api.JcrTools

org.fcrepo.kernel.FedoraResource

org.fcrepo.kernel.Datastream

All Implemented Interfaces:

FedoraJcrTypes

public class Datastream
extends FedoraResource
implements FedoraJcrTypes

Abstraction for a Fedora datastream backed by a JCR node.

Author:

ajs6f

Nested Class Summary

Nested classes/interfaces inherited from class org.modeshape.jcr.api.JcrTools

org.modeshape.jcr.api.JcrTools.BasicOperation, org.modeshape.jcr.api.JcrTools.BrowseContent, org.modeshape.jcr.api.JcrTools.CountNodes, org.modeshape.jcr.api.JcrTools.NodeOperation, org.modeshape.jcr.api.JcrTools.Operation, org.modeshape.jcr.api.JcrTools.PrintNodes, org.modeshape.jcr.api.JcrTools.Variable

Field Summary

Fields inherited from class org.fcrepo.kernel.FedoraResource

node

Fields inherited from interface org.fcrepo.jcr.FedoraJcrTypes

CONTENT_DIGEST, CONTENT_SIZE, FCR_CONTENT, FEDORA_BINARY, FEDORA_DATASTREAM, FEDORA_OBJECT, FEDORA_RESOURCE, FROZEN_MIXIN_TYPES, FROZEN_NODE, JCR_CREATED, JCR_CREATEDBY, JCR_LASTMODIFIED, PREMIS_FILE_NAME, ROOT

Constructor Summary

Constructors

Constructor and Description
Datastream(javax.jcr.Node n) The JCR node for this datastream
Datastream(javax.jcr.Session session, String path) Create or find a FedoraDatastream at the given path
Datastream(javax.jcr.Session session, String path, String nodeType) Create or find a FedoraDatastream at the given path

Method Summary

Methods

Modifier and Type	Method and Description
InputStream	getContent()
URI	getContentDigest() Get the pre-calculated content digest for the binary payload
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
static boolean	hasMixin(javax.jcr.Node node) Check if the node has a fedora:datastream mixin
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 class org.fcrepo.kernel.FedoraResource

addVersionLabel, getCreatedDate, getEtagValue, getHierarchyTriples, getLastModifiedDate, getModels, getNode, getPath, getPropertiesDataset, getPropertiesDataset, getTriples, getVersionTriples, hasContent, isFrozen, isNew, replaceProperties, updatePropertiesDataset

Methods inherited from class org.modeshape.jcr.api.JcrTools

findOrCreateChild, findOrCreateChild, findOrCreateNode, findOrCreateNode, findOrCreateNode, findOrCreateNode, getNode, getReadable, getStringValue, importContent, importContent, importContent, importContent, importContent, importContent, importContent, isDebug, onEachNode, onEachNodeBelow, print, printNode, printQuery, printQuery, printQuery, printQuery, printSubgraph, printSubgraph, printSubgraph, registerNodeTypes, removeAllChildren, removeAllChildren, repeatedlyWithSession, resourceUrl, uploadFile, uploadFile, uploadFile, uploadFileAndBlock, uploadFileAndBlock, uploadFileAndBlock, uploadFilesAndBlock, var, vars, withSession

Methods inherited from class java.lang.Object

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

Constructor Detail

Datastream

public Datastream(javax.jcr.Node n)

The JCR node for this datastream

Parameters:

n - an existing Node

Datastream

public Datastream(javax.jcr.Session session,
          String path,
          String nodeType)
           throws javax.jcr.RepositoryException

Create or find a FedoraDatastream at the given path

Parameters:

session - the JCR session to use to retrieve the object

path - the absolute path to the object

nodeType - primary type to assign to node

Throws:

javax.jcr.RepositoryException

Datastream

public Datastream(javax.jcr.Session session,
          String path)
           throws javax.jcr.RepositoryException

Create or find a FedoraDatastream at the given path

Parameters:

session - the JCR session to use to retrieve the object

path - the absolute path to the object

Throws:

javax.jcr.RepositoryException

Method Detail

getContent

public InputStream getContent()
                       throws javax.jcr.RepositoryException

Returns:

The InputStream of content associated with this datastream.

Throws:

javax.jcr.RepositoryException

setContent

public 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

public 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

public long getContentSize()

Returns:

The size in bytes of content associated with this datastream.

getContentDigest

public 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

public 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

public FedoraObject getObject()
                       throws javax.jcr.RepositoryException

Returns:

the FedoraObject to which this datastream belongs.

Throws:

javax.jcr.RepositoryException

getMimeType

public String getMimeType()
                   throws javax.jcr.RepositoryException

Returns:

The MimeType of content associated with this datastream.

Throws:

javax.jcr.RepositoryException

getSize

public long getSize()
             throws javax.jcr.RepositoryException

Return the calculated size of the DS node

Overrides:

getSize in class FedoraResource

Returns:

combined size of the properties and binary content

Throws:

javax.jcr.RepositoryException

getFilename

public 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

hasMixin

public static boolean hasMixin(javax.jcr.Node node)
                        throws javax.jcr.RepositoryException

Check if the node has a fedora:datastream mixin

Parameters:

node - node to check

Throws:

javax.jcr.RepositoryException