org.fcrepo.kernel.impl

Class FedoraResourceImpl

java.lang.Object

org.modeshape.jcr.api.JcrTools

org.fcrepo.kernel.impl.FedoraResourceImpl

All Implemented Interfaces:

FedoraJcrTypes, FedoraResource

Direct Known Subclasses:

ContainerImpl, FedoraBinaryImpl, NonRdfSourceDescriptionImpl, TombstoneImpl

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

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

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

Modifier and Type	Field and Description
protected javax.jcr.Node	node

Fields inherited from interface org.fcrepo.kernel.FedoraJcrTypes

CONTENT_DIGEST, CONTENT_SIZE, EXPOSED_PROTECTED_JCR_TYPES, FCR_METADATA, FCR_VERSIONS, FEDORA_BINARY, FEDORA_BLANKNODE, FEDORA_CONTAINER, FEDORA_NON_RDF_SOURCE_DESCRIPTION, FEDORA_PAIRTREE, FEDORA_RESOURCE, FEDORA_TOMBSTONE, FROZEN_MIXIN_TYPES, FROZEN_NODE, JCR_CREATED, JCR_CREATEDBY, JCR_FROZEN_NODE, JCR_LASTMODIFIED, JCR_MIXIN_TYPES, JCR_PRIMARY_TYPE, JCR_UUID, LDP_BASIC_CONTAINER, LDP_DIRECT_CONTAINER, LDP_HAS_MEMBER_RELATION, LDP_INDIRECT_CONTAINER, LDP_INSERTED_CONTENT_RELATION, LDP_IS_MEMBER_OF_RELATION, LDP_MEMBER_RESOURCE, PREMIS_FILE_NAME, ROOT, VERSIONABLE

Constructor Summary

Constructors

Constructor and Description
FedoraResourceImpl(javax.jcr.Node node) Construct a FedoraResource from an existing JCR Node

Method Summary

Methods

Modifier and Type	Method and Description
void	delete() Delete this resource, and any inbound references to it
void	disableVersioning() Disable versioning
void	enableVersioning() Enable versioning
boolean	equals(Object object)
javax.jcr.version.Version	getBaseVersion() Get the JCR Base version for the node
FedoraResource	getChild(String relPath) Get the child of this resource at the given path
Iterator<FedoraResource>	getChildren() Get the children of this resource
FedoraResource	getContainer() Get the container of this resource
Date	getCreatedDate() Get the date this datastream was created
String	getEtagValue() Construct an ETag value from the last modified date and path.
Date	getLastModifiedDate() Get the date this datastream was last modified
javax.jcr.Node	getNode()
javax.jcr.Node	getNodeVersion(String label) Get the node for this object at the version provided.
String	getPath() Get the path to the JCR node
javax.jcr.Property	getProperty(String relPath) Retrieve the given property value for this resource
protected javax.jcr.Session	getSession()
RdfStream	getTriples(IdentifierConverter<com.hp.hpl.jena.rdf.model.Resource,FedoraResource> idTranslator, Class<? extends RdfStream> context) Return the RDF properties of this object using the provided context
RdfStream	getTriples(IdentifierConverter<com.hp.hpl.jena.rdf.model.Resource,FedoraResource> idTranslator, Iterable<? extends Class<? extends RdfStream>> contexts) Return the RDF properties of this object using the provided contexts
FedoraResource	getUnfrozenResource() Get the unfrozen equivalent of a frozen versioned node
FedoraResource	getVersionedAncestor() When this is a frozen node, get the ancestor that was explicitly versioned
javax.jcr.version.VersionHistory	getVersionHistory() Get JCR VersionHistory for the node.
int	hashCode()
boolean	hasProperty(String relPath) Does this resource have a property
boolean	hasType(String type) Check if this object uses a given mixin
boolean	isFrozenResource() Check if a resource is frozen (a historic version).
Boolean	isNew() Check if a resource was created in this session
boolean	isVersioned() Check if a resource is versioned
void	replaceProperties(IdentifierConverter<com.hp.hpl.jena.rdf.model.Resource,FedoraResource> idTranslator, com.hp.hpl.jena.rdf.model.Model inputModel, RdfStream originalTriples) Replace the properties of this object with the properties from the given model
String	toString()
void	updateProperties(IdentifierConverter<com.hp.hpl.jena.rdf.model.Resource,FedoraResource> idTranslator, String sparqlUpdateStatement, RdfStream originalTriples) Update the provided properties 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, setDebug, uploadFile, uploadFile, uploadFile, uploadFileAndBlock, uploadFileAndBlock, uploadFileAndBlock, uploadFilesAndBlock, var, vars, withSession

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

node

protected javax.jcr.Node node

Constructor Detail

FedoraResourceImpl

public FedoraResourceImpl(javax.jcr.Node node)

Construct a FedoraResource from an existing JCR Node

Parameters:

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

Method Detail

getNode

public javax.jcr.Node getNode()

Specified by:

getNode in interface FedoraResource

Returns:

The JCR node that backs this object.

getPath

public String getPath()

Description copied from interface: FedoraResource

Get the path to the JCR node

Specified by:

getPath in interface FedoraResource

Returns:

path

getChildren

public Iterator<FedoraResource> getChildren()

Description copied from interface: FedoraResource

Get the children of this resource

Specified by:

getChildren in interface FedoraResource

Returns:

iterator

getContainer

public FedoraResource getContainer()

Description copied from interface: FedoraResource

Get the container of this resource

Specified by:

getContainer in interface FedoraResource

Returns:

the container of this resource

getChild

public FedoraResource getChild(String relPath)

Description copied from interface: FedoraResource

Get the child of this resource at the given path

Specified by:

getChild in interface FedoraResource

Parameters:

relPath - the given path

Returns:

the child of this resource

hasProperty

public boolean hasProperty(String relPath)

Description copied from interface: FedoraResource

Does this resource have a property

Specified by:

hasProperty in interface FedoraResource

Parameters:

relPath - the given path

Returns:

the boolean value whether the resource has a property

getProperty

public javax.jcr.Property getProperty(String relPath)

Description copied from interface: FedoraResource

Retrieve the given property value for this resource

Specified by:

getProperty in interface FedoraResource

Parameters:

relPath - the given path

Returns:

the property

delete

public void delete()

Description copied from interface: FedoraResource

Delete this resource, and any inbound references to it

Specified by:

delete in interface FedoraResource

getCreatedDate

public Date getCreatedDate()

Description copied from interface: FedoraResource

Get the date this datastream was created

Specified by:

getCreatedDate in interface FedoraResource

Returns:

created date

getLastModifiedDate

public Date getLastModifiedDate()

Description copied from interface: FedoraResource

Get the date this datastream was last modified

Specified by:

getLastModifiedDate in interface FedoraResource

Returns:

last modified date

hasType

public boolean hasType(String type)

Description copied from interface: FedoraResource

Check if this object uses a given mixin

Specified by:

hasType in interface FedoraResource

Parameters:

type - the given type

Returns:

a collection of mixin names

updateProperties

public void updateProperties(IdentifierConverter<com.hp.hpl.jena.rdf.model.Resource,FedoraResource> idTranslator,
                    String sparqlUpdateStatement,
                    RdfStream originalTriples)
                      throws MalformedRdfException,
                             javax.jcr.AccessDeniedException

Description copied from interface: FedoraResource

Update the provided properties 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.

Specified by:

updateProperties in interface FedoraResource

Parameters:

idTranslator - the property of idTranslator

sparqlUpdateStatement - sparql update statement

originalTriples - original triples

Throws:

MalformedRdfException - if malformed rdf exception occurred

javax.jcr.AccessDeniedException - if access denied in updating properties

getTriples

public RdfStream getTriples(IdentifierConverter<com.hp.hpl.jena.rdf.model.Resource,FedoraResource> idTranslator,
                   Class<? extends RdfStream> context)

Description copied from interface: FedoraResource

Return the RDF properties of this object using the provided context

Specified by:

getTriples in interface FedoraResource

Parameters:

idTranslator - the property of idTranslator

context - the context

Returns:

the rdf properties of this object using the provided context

getTriples

public RdfStream getTriples(IdentifierConverter<com.hp.hpl.jena.rdf.model.Resource,FedoraResource> idTranslator,
                   Iterable<? extends Class<? extends RdfStream>> contexts)

Description copied from interface: FedoraResource

Return the RDF properties of this object using the provided contexts

Specified by:

getTriples in interface FedoraResource

Parameters:

idTranslator - the property of idTranslator

contexts - the provided contexts

Returns:

the rdf properties of this object

getBaseVersion

public javax.jcr.version.Version getBaseVersion()

Description copied from interface: FedoraResource

Get the JCR Base version for the node

Specified by:

getBaseVersion in interface FedoraResource

Returns:

base version

getVersionHistory

public javax.jcr.version.VersionHistory getVersionHistory()

Description copied from interface: FedoraResource

Get JCR VersionHistory for the node.

Specified by:

getVersionHistory in interface FedoraResource

Returns:

version history

isNew

public Boolean isNew()

Description copied from interface: FedoraResource

Check if a resource was created in this session

Specified by:

isNew in interface FedoraResource

Returns:

if resource created in this session

replaceProperties

public void replaceProperties(IdentifierConverter<com.hp.hpl.jena.rdf.model.Resource,FedoraResource> idTranslator,
                     com.hp.hpl.jena.rdf.model.Model inputModel,
                     RdfStream originalTriples)
                       throws MalformedRdfException

Description copied from interface: FedoraResource

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

Specified by:

replaceProperties in interface FedoraResource

Parameters:

idTranslator - the given property of idTranslator

inputModel - the input model

originalTriples - the original triples

Throws:

MalformedRdfException - if malformed rdf exception occurred

getEtagValue

public String getEtagValue()

Description copied from interface: FedoraResource

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

Specified by:

getEtagValue in interface FedoraResource

Returns:

constructed etag value

enableVersioning

public void enableVersioning()

Description copied from interface: FedoraResource

Enable versioning

Specified by:

enableVersioning in interface FedoraResource

disableVersioning

public void disableVersioning()

Description copied from interface: FedoraResource

Disable versioning

Specified by:

disableVersioning in interface FedoraResource

isVersioned

public boolean isVersioned()

Description copied from interface: FedoraResource

Check if a resource is versioned

Specified by:

isVersioned in interface FedoraResource

Returns:

whether the resource is versioned

isFrozenResource

public boolean isFrozenResource()

Description copied from interface: FedoraResource

Check if a resource is frozen (a historic version).

Specified by:

isFrozenResource in interface FedoraResource

Returns:

whether the resource is frozen

getVersionedAncestor

public FedoraResource getVersionedAncestor()

Description copied from interface: FedoraResource

When this is a frozen node, get the ancestor that was explicitly versioned

Specified by:

getVersionedAncestor in interface FedoraResource

Returns:

the ancestor that was explicity versioned

getUnfrozenResource

public FedoraResource getUnfrozenResource()

Description copied from interface: FedoraResource

Get the unfrozen equivalent of a frozen versioned node

Specified by:

getUnfrozenResource in interface FedoraResource

Returns:

the unfrozen equivalent of a frozen versioned node

getNodeVersion

public javax.jcr.Node getNodeVersion(String label)

Description copied from interface: FedoraResource

Get the node for this object at the version provided.

Specified by:

getNodeVersion in interface FedoraResource

Parameters:

label - the label

Returns:

the node for this object at the version provided

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getSession

protected javax.jcr.Session getSession()

toString

public String toString()

Overrides:

toString in class Object