org.fcrepo.kernel.modeshape

Class FedoraResourceImpl

java.lang.Object

org.modeshape.jcr.api.JcrTools

org.fcrepo.kernel.modeshape.FedoraResourceImpl

All Implemented Interfaces:

FedoraTypes, FedoraResource

Direct Known Subclasses:

ContainerImpl, FedoraBinaryImpl, NonRdfSourceDescriptionImpl, TombstoneImpl

public class FedoraResourceImpl
extends org.modeshape.jcr.api.JcrTools
implements FedoraTypes, 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.api.FedoraTypes

CONTENT_DIGEST, CONTENT_SIZE, DEFAULT_DIGEST_ALGORITHM, FCR_METADATA, FCR_VERSIONS, FEDORA_BINARY, FEDORA_CONTAINER, FEDORA_CREATED, FEDORA_CREATEDBY, FEDORA_LASTMODIFIED, FEDORA_LASTMODIFIEDBY, FEDORA_NON_RDF_SOURCE_DESCRIPTION, FEDORA_PAIRTREE, FEDORA_REPOSITORY_ROOT, FEDORA_RESOURCE, FEDORA_SKOLEM, FEDORA_TOMBSTONE, FILENAME, HAS_MIME_TYPE, LDP_BASIC_CONTAINER, LDP_CONTAINER, LDP_DIRECT_CONTAINER, LDP_HAS_MEMBER_RELATION, LDP_INDIRECT_CONTAINER, LDP_INSERTED_CONTENT_RELATION, LDP_IS_MEMBER_OF_RELATION, LDP_MEMBER_RESOURCE, LDP_NON_RDF_SOURCE, LDP_RDF_SOURCE

Constructor Summary

Constructors

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

Method Summary

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)
static Function<org.apache.jena.graph.Triple,org.apache.jena.graph.Triple>	fixDatesIfNecessary(FedoraResource r, com.google.common.base.Converter<javax.jcr.Node,org.apache.jena.rdf.model.Resource> translator) A method that takes a Triple and returns a Triple that is the correct representation of that triple for the given resource.
FedoraResource	getBaseVersion() Get the base version for the node
FedoraResource	getChild(String relPath) Get the child of this resource at the given path
Stream<FedoraResource>	getChildren(Boolean recursive) Get the children of this resource, possibly recursively
FedoraResource	getContainer() Get the container of this resource
Instant	getCreatedDate() Get the date this resource was created
FedoraResource	getDescribedResource() Get the resource described by this resource
FedoraResource	getDescription() Get the description for this resource
String	getEtagValue() Construct an ETag value for the resource.
Instant	getLastModifiedDate() This method gets the last modified date for this FedoraResource.
javax.jcr.Node	getNode() Return the underlying JCR Node for this resource
String	getPath() Get the path to the resource
protected javax.jcr.Property	getProperty(String relPath)
protected javax.jcr.Session	getSession()
RdfStream	getTriples(IdentifierConverter<org.apache.jena.rdf.model.Resource,FedoraResource> idTranslator, Set<? extends TripleCategory> contexts) Return the RDF properties of this object using the provided contexts
RdfStream	getTriples(IdentifierConverter<org.apache.jena.rdf.model.Resource,FedoraResource> idTranslator, TripleCategory context) Return the RDF properties of this object using the provided context
List<URI>	getTypes() Get the RDF:type values for this resource
FedoraResource	getUnfrozenResource() Get the unfrozen equivalent of a frozen versioned node
FedoraResource	getVersion(String label) Get a resource version for this object with the provided label.
FedoraResource	getVersionedAncestor() When this is a frozen node, get the ancestor that was explicitly versioned
String	getVersionLabelOfFrozenResource() This method returns the version label of this frozen resource.
protected javax.jcr.version.VersionManager	getVersionManager()
Stream<FedoraVersion>	getVersions() Get a stream of versions associated with this resource
int	hashCode()
boolean	hasProperty(String relPath) Does this resource have a property
boolean	hasType(String type) Check if this object uses a given RDF type
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<org.apache.jena.rdf.model.Resource,FedoraResource> idTranslator, org.apache.jena.rdf.model.Model inputModel, RdfStream originalTriples) Replace the properties of this object with the properties from the given model
String	toString()
void	touch(boolean includeMembershipResource, Calendar createdDate, String createdUser, Calendar modifiedDate, String modifyingUser) Touches a resource to ensure that the implicitly updated properties are updated if not explicitly set.
void	updateProperties(IdentifierConverter<org.apache.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

Methods inherited from interface org.fcrepo.kernel.api.models.FedoraResource

getChildren

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()

Return the underlying JCR Node for this resource

Returns:

the JCR Node

getPath

public String getPath()

Description copied from interface: FedoraResource

Get the path to the resource

Specified by:

getPath in interface FedoraResource

Returns:

path

getChildren

public Stream<FedoraResource> getChildren(Boolean recursive)

Description copied from interface: FedoraResource

Get the children of this resource, possibly recursively

Specified by:

getChildren in interface FedoraResource

Parameters:

recursive - whether to recursively fetch child resources

Returns:

a stream of Fedora resources

getDescription

public FedoraResource getDescription()

Description copied from interface: FedoraResource

Get the description for this resource

Specified by:

getDescription in interface FedoraResource

Returns:

the description for this resource

getDescribedResource

public FedoraResource getDescribedResource()

Description copied from interface: FedoraResource

Get the resource described by this resource

Specified by:

getDescribedResource in interface FedoraResource

Returns:

the resource being described

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

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 Instant getCreatedDate()

Description copied from interface: FedoraResource

Get the date this resource was created

Specified by:

getCreatedDate in interface FedoraResource

Returns:

created date

getLastModifiedDate

public Instant getLastModifiedDate()

This method gets the last modified date for this FedoraResource. Because the last modified date is managed by fcrepo (not ModeShape) while the created date *is* sometimes managed by ModeShape in the current implementation it's possible that the last modified date will be before the created date. Instead of making a second update to correct the modified date, in cases where the modified date is ealier than the created date, this class presents the created date instead. Any method that exposes the last modified date must maintain this illusion so that that external callers are presented with a sensible and consistent representation of this resource.

Specified by:

getLastModifiedDate in interface FedoraResource

Returns:

the last modified Instant (or the created Instant if it was after the last modified date)

hasType

public boolean hasType(String type)

Description copied from interface: FedoraResource

Check if this object uses a given RDF type

Note: the type parameter should be in prefixed short form, so ldp:Container or ex:Image are both acceptable types. This method does not assume any jcr to fedora prefix mappings are managed by the implementation, so hasType("jcr:frozenNode") is a valid use of this method.

Specified by:

hasType in interface FedoraResource

Parameters:

type - the given type

Returns:

whether the object has the given type

getTypes

public List<URI> getTypes()

Description copied from interface: FedoraResource

Get the RDF:type values for this resource

Specified by:

getTypes in interface FedoraResource

Returns:

a list of types for this resource

updateProperties

public void updateProperties(IdentifierConverter<org.apache.jena.rdf.model.Resource,FedoraResource> idTranslator,
                             String sparqlUpdateStatement,
                             RdfStream originalTriples)
                      throws MalformedRdfException,
                             AccessDeniedException

Description copied from interface: FedoraResource

Update the provided properties with a SPARQL Update query. The updated properties may be serialized to the persistence layer.

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

AccessDeniedException - if access denied in updating properties

getTriples

public RdfStream getTriples(IdentifierConverter<org.apache.jena.rdf.model.Resource,FedoraResource> idTranslator,
                            TripleCategory 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<org.apache.jena.rdf.model.Resource,FedoraResource> idTranslator,
                            Set<? extends TripleCategory> 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 FedoraResource getBaseVersion()

Description copied from interface: FedoraResource

Get the base version for the node

Specified by:

getBaseVersion in interface FedoraResource

Returns:

base version

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<org.apache.jena.rdf.model.Resource,FedoraResource> idTranslator,
                              org.apache.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

touch

public void touch(boolean includeMembershipResource,
                  Calendar createdDate,
                  String createdUser,
                  Calendar modifiedDate,
                  String modifyingUser)
           throws javax.jcr.RepositoryException

Touches a resource to ensure that the implicitly updated properties are updated if not explicitly set.

Parameters:

includeMembershipResource - true if this touch should propagate through to ldp membership resources

createdDate - the date to which the created date should be set or null to leave it unchanged

createdUser - the user to which the created by should be set or null to leave it unchanged

modifiedDate - the date to which the modified date should be set or null to use now

modifyingUser - the user making the modification or null to use the current user

Throws:

javax.jcr.RepositoryException - an error occurs while updating the repository

getEtagValue

public String getEtagValue()

Description copied from interface: FedoraResource

Construct an ETag value for the resource.

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

getVersion

public FedoraResource getVersion(String label)

Description copied from interface: FedoraResource

Get a resource version for this object with the provided label.

Specified by:

getVersion in interface FedoraResource

Parameters:

label - the label

Returns:

the node for this object at the version provided

getVersions

public Stream<FedoraVersion> getVersions()

Description copied from interface: FedoraResource

Get a stream of versions associated with this resource

Specified by:

getVersions in interface FedoraResource

Returns:

the versions associated with this resource

getVersionLabelOfFrozenResource

public String getVersionLabelOfFrozenResource()

Description copied from interface: FedoraResource

This method returns the version label of this frozen resource. If this resource is not frozen, null is returned.

Specified by:

getVersionLabelOfFrozenResource in interface FedoraResource

Returns:

version label

getVersionManager

protected javax.jcr.version.VersionManager getVersionManager()

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

getProperty

protected javax.jcr.Property getProperty(String relPath)

fixDatesIfNecessary

public static Function<org.apache.jena.graph.Triple,org.apache.jena.graph.Triple> fixDatesIfNecessary(FedoraResource r,
                                                                                                      com.google.common.base.Converter<javax.jcr.Node,org.apache.jena.rdf.model.Resource> translator)

A method that takes a Triple and returns a Triple that is the correct representation of that triple for the given resource. The current implementation of this method is used by PropertiesRdfContext to replace the reported RdfLexicon.LAST_MODIFIED_DATE with the one produced by getLastModifiedDate().

Parameters:

r - the Fedora resource

translator - a converter to get the external identifier from a jcr node

Returns:

a function to convert triples