org.fcrepo.kernel

Class FedoraResource

java.lang.Object

org.modeshape.jcr.api.JcrTools

org.fcrepo.kernel.FedoraResource

All Implemented Interfaces:

FedoraJcrTypes

Direct Known Subclasses:

Datastream, FedoraObject

public class FedoraResource
extends org.modeshape.jcr.api.JcrTools
implements FedoraJcrTypes

Common behaviors across FedoraObject and Datastream types; also used when the exact type of an object is irrelevant

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

Modifier and Type	Field and Description
protected javax.jcr.Node	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
FedoraResource() Construct a FedoraObject without a backing JCR Node
FedoraResource(javax.jcr.Node node) Construct a FedoraObject from an existing JCR Node
FedoraResource(javax.jcr.Session session, String path, String nodeType) Create or find a FedoraObject at the given path

Method Summary

Methods

Modifier and Type	Method and Description
void	addVersionLabel(String label) Tag the current version of the Node with a version label that can be retrieved by name later.
Date	getCreatedDate() Get the date this datastream was created
String	getEtagValue() Construct an ETag value from the last modified date and path.
RdfStream	getHierarchyTriples(GraphSubjects graphSubjects) Return the JCR properties of this object as an RdfStream
Date	getLastModifiedDate() Get the date this datastream was last modified
Collection<String>	getModels() Get the mixins this object uses
javax.jcr.Node	getNode()
String	getPath() Get the path to the JCR node
com.hp.hpl.jena.query.Dataset	getPropertiesDataset(GraphSubjects subjects) Return the JCR properties of this object as a Jena Dataset
com.hp.hpl.jena.query.Dataset	getPropertiesDataset(GraphSubjects graphSubjects, int offset, int limit) Return the JCR properties of this object as a Jena Dataset
long	getSize() Get the total size of this object and its datastreams
RdfStream	getTriples(GraphSubjects graphSubjects) Return the JCR properties of this object as an RdfStream
RdfStream	getVersionTriples(GraphSubjects graphSubjects) Serialize the JCR versions information as an RDF dataset
boolean	hasContent() Does the resource have a jcr:content child node?
static boolean	hasMixin(javax.jcr.Node node) Is the given node a Fedora resource (because it has a fedora:resource mixin)?
static boolean	isFrozen(javax.jcr.Node node) Is the given node a frozen node?
boolean	isNew() Check if a resource was created in this session
RdfStream	replaceProperties(GraphSubjects graphSubjects, com.hp.hpl.jena.rdf.model.Model inputModel) Replace the properties of this object with the properties from the given model
com.hp.hpl.jena.query.Dataset	updatePropertiesDataset(GraphSubjects subjects, String sparqlUpdateStatement) Update the properties Dataset with a SPARQL Update query.

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

Field Detail

node

protected javax.jcr.Node node

Constructor Detail

FedoraResource

public FedoraResource()

Construct a FedoraObject without a backing JCR Node

FedoraResource

public FedoraResource(javax.jcr.Node node)

Construct a FedoraObject from an existing JCR Node

Parameters:

node - an existing JCR node to treat as an fcrepo object

FedoraResource

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

Create or find a FedoraObject 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

isFrozen

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

Is the given node a frozen node?

Parameters:

node - Node to check

Returns:

Throws:

javax.jcr.RepositoryException

hasMixin

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

Is the given node a Fedora resource (because it has a fedora:resource mixin)?

Parameters:

node - Node to check

Returns:

Throws:

javax.jcr.RepositoryException

hasContent

public boolean hasContent()
                   throws javax.jcr.RepositoryException

Does the resource have a jcr:content child node?

Returns:

Throws:

javax.jcr.RepositoryException

getNode

public javax.jcr.Node getNode()

Returns:

The JCR node that backs this object.

getPath

public String getPath()
               throws javax.jcr.RepositoryException

Get the path to the JCR node

Returns:

Throws:

javax.jcr.RepositoryException

getCreatedDate

public Date getCreatedDate()
                    throws javax.jcr.RepositoryException

Get the date this datastream was created

Returns:

Throws:

javax.jcr.RepositoryException

getLastModifiedDate

public Date getLastModifiedDate()
                         throws javax.jcr.RepositoryException

Get the date this datastream was last modified

Returns:

Throws:

javax.jcr.RepositoryException

getSize

public long getSize()
             throws javax.jcr.RepositoryException

Get the total size of this object and its datastreams

Returns:

size in bytes

Throws:

javax.jcr.RepositoryException

getModels

public Collection<String> getModels()
                             throws javax.jcr.RepositoryException

Get the mixins this object uses

Returns:

a collection of mixin names

Throws:

javax.jcr.RepositoryException

updatePropertiesDataset

public com.hp.hpl.jena.query.Dataset updatePropertiesDataset(GraphSubjects subjects,
                                                    String sparqlUpdateStatement)
                                                      throws javax.jcr.RepositoryException

Update the properties Dataset with a SPARQL Update query. The updated properties may be serialized to the JCR store. After applying the statement, clients SHOULD check the result of #getDatasetProblems, which may include problems when attempting to serialize the data to JCR.

Parameters:

subjects -

sparqlUpdateStatement -

Throws:

javax.jcr.RepositoryException

getPropertiesDataset

public com.hp.hpl.jena.query.Dataset getPropertiesDataset(GraphSubjects graphSubjects,
                                                 int offset,
                                                 int limit)
                                                   throws javax.jcr.RepositoryException

Return the JCR properties of this object as a Jena Dataset

Parameters:

graphSubjects -

offset -

limit -

Returns:

Throws:

javax.jcr.RepositoryException

getPropertiesDataset

public com.hp.hpl.jena.query.Dataset getPropertiesDataset(GraphSubjects subjects)
                                                   throws javax.jcr.RepositoryException

Return the JCR properties of this object as a Jena Dataset

Parameters:

graphSubjects -

Returns:

Throws:

javax.jcr.RepositoryException

getTriples

public RdfStream getTriples(GraphSubjects graphSubjects)
                     throws javax.jcr.RepositoryException

Return the JCR properties of this object as an RdfStream

Parameters:

graphSubjects -

Returns:

Throws:

javax.jcr.RepositoryException

getHierarchyTriples

public RdfStream getHierarchyTriples(GraphSubjects graphSubjects)
                              throws javax.jcr.RepositoryException

Return the JCR properties of this object as an RdfStream

Parameters:

graphSubjects -

Returns:

Throws:

javax.jcr.RepositoryException

getVersionTriples

public RdfStream getVersionTriples(GraphSubjects graphSubjects)
                            throws javax.jcr.RepositoryException

Serialize the JCR versions information as an RDF dataset

Parameters:

subjects -

Returns:

Throws:

javax.jcr.RepositoryException

addVersionLabel

public void addVersionLabel(String label)
                     throws javax.jcr.RepositoryException

Tag the current version of the Node with a version label that can be retrieved by name later.

Parameters:

label -

Throws:

javax.jcr.RepositoryException

isNew

public boolean isNew()

Check if a resource was created in this session

Returns:

replaceProperties

public RdfStream replaceProperties(GraphSubjects graphSubjects,
                          com.hp.hpl.jena.rdf.model.Model inputModel)
                            throws javax.jcr.RepositoryException

Replace the properties of this object with the properties from the given model

Parameters:

graphSubjects -

inputModel -

Returns:

Throws:

javax.jcr.RepositoryException

getEtagValue

public String getEtagValue()
                    throws javax.jcr.RepositoryException

Construct an ETag value from the last modified date and path. JCR has a mix:etag type, but it only takes into account binary properties. We actually want whole-object etag data. TODO : construct and store an ETag value on object modify

Returns:

Throws:

javax.jcr.RepositoryException