org.fcrepo.kernel

Interface FedoraResource

All Known Subinterfaces:

Datastream, FedoraObject

public interface FedoraResource

Since:

Jan 10, 2014

Author:

ajs6f

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.
javax.jcr.version.Version	getBaseVersion() Get the JCR Base version for the node
Date	getCreatedDate() Get the date this datastream was created
String	getEtagValue() Construct an ETag value from the last modified date and path.
RdfStream	getHierarchyTriples(IdentifierTranslator graphSubjects, HierarchyRdfContextOptions serializationOptions) 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(IdentifierTranslator subjects) Return the JCR properties of this object as a Jena Dataset
com.hp.hpl.jena.query.Dataset	getPropertiesDataset(IdentifierTranslator graphSubjects, int offset, int limit) Return the JCR properties of this object as a Jena Dataset
RdfStream	getReferencesTriples(IdentifierTranslator graphSubjects) Serialize inbound References to this object as an RdfStream
Long	getSize() Get the total size of this object and its datastreams
RdfStream	getTriples(IdentifierTranslator graphSubjects) Return the JCR properties of this object as an RdfStream
javax.jcr.version.VersionHistory	getVersionHistory() Get JCR VersionHistory for the node.
RdfStream	getVersionTriples(IdentifierTranslator graphSubjects) Serialize the JCR versions information as an RDF dataset
boolean	hasContent() Does the resource have a jcr:content child node?
Boolean	isNew() Check if a resource was created in this session
RdfStream	replaceProperties(IdentifierTranslator 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(IdentifierTranslator subjects, String sparqlUpdateStatement) Update the properties Dataset with a SPARQL Update query.

Method Detail

hasContent

boolean hasContent()
                   throws javax.jcr.RepositoryException

Does the resource have a jcr:content child node?

Returns:

has content

Throws:

javax.jcr.RepositoryException

getNode

javax.jcr.Node getNode()

Returns:

The JCR node that backs this object.

getPath

String getPath()
               throws javax.jcr.RepositoryException

Get the path to the JCR node

Returns:

path

Throws:

javax.jcr.RepositoryException

getCreatedDate

Date getCreatedDate()
                    throws javax.jcr.RepositoryException

Get the date this datastream was created

Returns:

created date

Throws:

javax.jcr.RepositoryException

getLastModifiedDate

Date getLastModifiedDate()
                         throws javax.jcr.RepositoryException

Get the date this datastream was last modified

Returns:

last modified date

Throws:

javax.jcr.RepositoryException

getSize

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

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

Get the mixins this object uses

Returns:

a collection of mixin names

Throws:

javax.jcr.RepositoryException

updatePropertiesDataset

com.hp.hpl.jena.query.Dataset updatePropertiesDataset(IdentifierTranslator 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

com.hp.hpl.jena.query.Dataset getPropertiesDataset(IdentifierTranslator 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:

properties

Throws:

javax.jcr.RepositoryException

getPropertiesDataset

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

Return the JCR properties of this object as a Jena Dataset

Parameters:

subjects -

Returns:

properties

Throws:

javax.jcr.RepositoryException

getTriples

RdfStream getTriples(IdentifierTranslator graphSubjects)
                     throws javax.jcr.RepositoryException

Return the JCR properties of this object as an RdfStream

Parameters:

graphSubjects -

Returns:

triples

Throws:

javax.jcr.RepositoryException

getHierarchyTriples

RdfStream getHierarchyTriples(IdentifierTranslator graphSubjects,
                            HierarchyRdfContextOptions serializationOptions)
                              throws javax.jcr.RepositoryException

Return the JCR properties of this object as an RdfStream

Parameters:

graphSubjects -

Returns:

triples

Throws:

javax.jcr.RepositoryException

getVersionTriples

RdfStream getVersionTriples(IdentifierTranslator graphSubjects)
                            throws javax.jcr.RepositoryException

Serialize the JCR versions information as an RDF dataset

Parameters:

graphSubjects -

Returns:

triples

Throws:

javax.jcr.RepositoryException

getReferencesTriples

RdfStream getReferencesTriples(IdentifierTranslator graphSubjects)
                               throws javax.jcr.RepositoryException

Serialize inbound References to this object as an RdfStream

Parameters:

graphSubjects -

Returns:

triples

Throws:

javax.jcr.RepositoryException

addVersionLabel

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

getBaseVersion

javax.jcr.version.Version getBaseVersion()
                                         throws javax.jcr.RepositoryException

Get the JCR Base version for the node

Returns:

base version

Throws:

javax.jcr.RepositoryException

getVersionHistory

javax.jcr.version.VersionHistory getVersionHistory()
                                                   throws javax.jcr.RepositoryException

Get JCR VersionHistory for the node.

Returns:

version history

Throws:

javax.jcr.RepositoryException

isNew

Boolean isNew()

Check if a resource was created in this session

Returns:

if resource created in this session

replaceProperties

RdfStream replaceProperties(IdentifierTranslator 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:

RDFStream

Throws:

javax.jcr.RepositoryException

getEtagValue

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:

constructed etag value

Throws:

javax.jcr.RepositoryException