org.fcrepo.kernel.rdf

Class JcrRdfTools

java.lang.Object

org.fcrepo.kernel.rdf.JcrRdfTools

public class JcrRdfTools
extends Object

A set of helpful tools for converting JCR properties to RDF

Author:

Chris Beer

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.base.Function<javax.jcr.Property,com.hp.hpl.jena.rdf.model.Property>	getPredicateForProperty Map a JCR property to an RDF property with the right namespace URI and local name
static com.google.common.collect.BiMap<String,String>	jcrNamespacesToRDFNamespaces A map of JCR namespaces to Fedora's RDF namespaces
static com.google.common.collect.BiMap<String,String>	rdfNamespacesToJcrNamespaces A map of Fedora's RDF namespaces to the JCR equivalent

Constructor Summary

Constructors

Constructor and Description
JcrRdfTools(org.fcrepo.kernel.rdf.IdentifierTranslator graphSubjects) Factory method to create a new JcrRdfTools utility with a graph subjects converter
JcrRdfTools(org.fcrepo.kernel.rdf.IdentifierTranslator graphSubjects, javax.jcr.Session session) Factory method to create a new JcrRdfTools utility with a graph subjects converter
JcrRdfTools(org.fcrepo.kernel.rdf.IdentifierTranslator graphSubjects, javax.jcr.Session session, LowLevelStorageService lls) Contructor with even more context.

Method Summary

Methods

Modifier and Type	Method and Description
javax.jcr.Value	createValue(javax.jcr.Node node, com.hp.hpl.jena.rdf.model.RDFNode data, int type) Create a JCR value from an RDFNode, either by using the given JCR PropertyType or by looking at the RDFNode Datatype
javax.jcr.Value	createValue(com.hp.hpl.jena.rdf.model.RDFNode data) Create a JCR value (with an undefined type) from a RDFNode
javax.jcr.Value	createValue(com.hp.hpl.jena.rdf.model.RDFNode data, int type) Create a JCR value from an RDFNode with the given JCR type
javax.jcr.Value	createValue(javax.jcr.ValueFactory valueFactory, com.hp.hpl.jena.rdf.model.RDFNode data, int type) Create a JCR value from an RDF node with the given JCR type
static String	getJcrNamespaceForRDFNamespace(String rdfNamespaceUri) Convert a Fedora RDF Namespace into its JCR equivalent
org.fcrepo.kernel.utils.iterators.RdfStream	getJcrPropertiesModel(Iterator<javax.jcr.Node> nodeIterator, com.hp.hpl.jena.rdf.model.Resource iteratorSubject) Get an RdfStream for the given JCR NodeIterator
org.fcrepo.kernel.utils.iterators.RdfStream	getJcrTriples(javax.jcr.Node node) Get an RdfStream for a node that includes all its own JCR properties, as well as the properties of its immediate children.
org.fcrepo.kernel.utils.iterators.RdfStream	getJcrTriples(javax.jcr.Node node, Iterable<org.fcrepo.kernel.utils.FixityResult> blobs) Serialize the JCR fixity information in an RdfStream
org.fcrepo.kernel.utils.iterators.RdfStream	getNamespaceTriples() Get an RdfStream of the registered JCR namespaces
static com.hp.hpl.jena.rdf.model.Model	getProblemsModel() Get a model in which to collect statements of RDF extraction problems
String	getPropertyNameFromPredicate(org.modeshape.jcr.api.NamespaceRegistry namespaceRegistry, com.hp.hpl.jena.rdf.model.Property predicate, Map<String,String> namespaceMapping) Get the JCR property name for an RDF predicate
String	getPropertyNameFromPredicate(javax.jcr.Node node, com.hp.hpl.jena.rdf.model.Property predicate) Given an RDF predicate value (namespace URI + local name), figure out what JCR property to use
String	getPropertyNameFromPredicate(javax.jcr.Node node, com.hp.hpl.jena.rdf.model.Property predicate, Map<String,String> namespaceMapping) Given an RDF predicate value (namespace URI + local name), figure out what JCR property to use
String	getPropertyNameFromPredicate(com.hp.hpl.jena.rdf.model.Property predicate) Get a property name for an RDF predicate
String	getPropertyNameFromPredicate(com.hp.hpl.jena.rdf.model.Property predicate, Map<String,String> namespaceMapping) Get the property name for an RDF predicate
int	getPropertyType(javax.jcr.nodetype.NodeType nodeType, String propertyName) Given a node type and a property name, figure out an appropraite jcr value type
int	getPropertyType(String nodeType, String propertyName) Given a node type and a property name, figure out an appropriate jcr value type
static String	getRDFNamespaceForJcrNamespace(String jcrNamespaceUri) Convert a JCR namespace into an RDF namespace fit for downstream consumption.
org.fcrepo.kernel.utils.iterators.RdfStream	getTreeTriples(javax.jcr.Node node) Add the properties of a Node's parent and immediate children using the default serialization options
org.fcrepo.kernel.utils.iterators.RdfStream	getTreeTriples(javax.jcr.Node node, org.fcrepo.kernel.rdf.HierarchyRdfContextOptions options) Add the properties of a Node's parent and immediate children (as well as the jcr:content of children) to the given RdfStream
org.fcrepo.kernel.utils.iterators.RdfStream	getVersionTriples(javax.jcr.Node node) Get an RdfStream for the JCR version history information for a node
org.fcrepo.kernel.utils.iterators.RdfStream	getWorkspaceTriples(org.fcrepo.kernel.rdf.IdentifierTranslator subjects) Get an RdfStream of the registered JCR workspaces
static boolean	isContainer(javax.jcr.Node node) Decides whether the RDF representation of this Node will receive LDP Container status.
boolean	isInternalProperty(javax.jcr.Node subjectNode, com.hp.hpl.jena.rdf.model.Resource predicate) Determine if a predicate is an internal property of a node (and should not be modified from external sources)
void	setLlstore(LowLevelStorageService lowLevelStorageService) Set the Low-level storage server implementation
static JcrRdfTools	withContext(org.fcrepo.kernel.rdf.IdentifierTranslator graphSubjects) Factory method to create a new JcrRdfTools instance
static JcrRdfTools	withContext(org.fcrepo.kernel.rdf.IdentifierTranslator idTranslator, javax.jcr.Session session) Factory method to create a new JcrRdfTools instance
static JcrRdfTools	withContext(org.fcrepo.kernel.rdf.IdentifierTranslator graphSubjects, javax.jcr.Session session, LowLevelStorageService lls) Factory method to create a new JcrRdfTools instance with full context.
JcrRdfTools	withSession(javax.jcr.Session session) Using the same graph subjects, create a new JcrRdfTools with the given session

Methods inherited from class java.lang.Object

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

Field Detail

jcrNamespacesToRDFNamespaces

public static com.google.common.collect.BiMap<String,String> jcrNamespacesToRDFNamespaces

A map of JCR namespaces to Fedora's RDF namespaces

rdfNamespacesToJcrNamespaces

public static com.google.common.collect.BiMap<String,String> rdfNamespacesToJcrNamespaces

A map of Fedora's RDF namespaces to the JCR equivalent

getPredicateForProperty

public static com.google.common.base.Function<javax.jcr.Property,com.hp.hpl.jena.rdf.model.Property> getPredicateForProperty

Map a JCR property to an RDF property with the right namespace URI and local name

Constructor Detail

JcrRdfTools

public JcrRdfTools(org.fcrepo.kernel.rdf.IdentifierTranslator graphSubjects)

Factory method to create a new JcrRdfTools utility with a graph subjects converter

Parameters:

graphSubjects -

JcrRdfTools

public JcrRdfTools(org.fcrepo.kernel.rdf.IdentifierTranslator graphSubjects,
           javax.jcr.Session session)

Factory method to create a new JcrRdfTools utility with a graph subjects converter

Parameters:

graphSubjects -

session -

JcrRdfTools

public JcrRdfTools(org.fcrepo.kernel.rdf.IdentifierTranslator graphSubjects,
           javax.jcr.Session session,
           LowLevelStorageService lls)

Contructor with even more context.

Parameters:

graphSubjects -

session -

lls -

Method Detail

withContext

public static JcrRdfTools withContext(org.fcrepo.kernel.rdf.IdentifierTranslator graphSubjects)

Factory method to create a new JcrRdfTools instance

Parameters:

graphSubjects -

Returns:

withContext

public static JcrRdfTools withContext(org.fcrepo.kernel.rdf.IdentifierTranslator idTranslator,
                      javax.jcr.Session session)

Factory method to create a new JcrRdfTools instance

Parameters:

graphSubjects -

session -

Returns:

withContext

public static JcrRdfTools withContext(org.fcrepo.kernel.rdf.IdentifierTranslator graphSubjects,
                      javax.jcr.Session session,
                      LowLevelStorageService lls)

Factory method to create a new JcrRdfTools instance with full context.

Parameters:

graphSubjects -

session -

lls -

Returns:

getJcrNamespaceForRDFNamespace

public static String getJcrNamespaceForRDFNamespace(String rdfNamespaceUri)

Convert a Fedora RDF Namespace into its JCR equivalent

Parameters:

rdfNamespaceUri - a namespace from an RDF document

Returns:

the JCR namespace, or the RDF namespace if no matching JCR namespace is found

getRDFNamespaceForJcrNamespace

public static String getRDFNamespaceForJcrNamespace(String jcrNamespaceUri)

Convert a JCR namespace into an RDF namespace fit for downstream consumption.

Parameters:

jcrNamespaceUri - a namespace from the JCR NamespaceRegistry

Returns:

an RDF namespace for downstream consumption.

getProblemsModel

public static com.hp.hpl.jena.rdf.model.Model getProblemsModel()

Get a model in which to collect statements of RDF extraction problems

Returns:

withSession

public JcrRdfTools withSession(javax.jcr.Session session)

Using the same graph subjects, create a new JcrRdfTools with the given session

Parameters:

session -

Returns:

getJcrPropertiesModel

public org.fcrepo.kernel.utils.iterators.RdfStream getJcrPropertiesModel(Iterator<javax.jcr.Node> nodeIterator,
                                                                com.hp.hpl.jena.rdf.model.Resource iteratorSubject)
                                                                  throws javax.jcr.RepositoryException

Get an RdfStream for the given JCR NodeIterator

Parameters:

nodeIterator -

iteratorSubject -

Returns:

Throws:

javax.jcr.RepositoryException

getJcrTriples

public org.fcrepo.kernel.utils.iterators.RdfStream getJcrTriples(javax.jcr.Node node)
                                                          throws javax.jcr.RepositoryException

Get an RdfStream for a node that includes all its own JCR properties, as well as the properties of its immediate children. TODO add triples for root node, ala addRepositoryMetricsToModel()

Parameters:

node -

Returns:

Throws:

javax.jcr.RepositoryException

getVersionTriples

public org.fcrepo.kernel.utils.iterators.RdfStream getVersionTriples(javax.jcr.Node node)
                                                              throws javax.jcr.RepositoryException

Get an RdfStream for the JCR version history information for a node

Parameters:

node -

Returns:

Throws:

javax.jcr.RepositoryException

getJcrTriples

public org.fcrepo.kernel.utils.iterators.RdfStream getJcrTriples(javax.jcr.Node node,
                                                        Iterable<org.fcrepo.kernel.utils.FixityResult> blobs)
                                                          throws javax.jcr.RepositoryException

Serialize the JCR fixity information in an RdfStream

Parameters:

node -

blobs -

Returns:

Throws:

javax.jcr.RepositoryException

getNamespaceTriples

public org.fcrepo.kernel.utils.iterators.RdfStream getNamespaceTriples()
                                                                throws javax.jcr.RepositoryException

Get an RdfStream of the registered JCR namespaces

Returns:

Throws:

javax.jcr.RepositoryException

getWorkspaceTriples

public org.fcrepo.kernel.utils.iterators.RdfStream getWorkspaceTriples(org.fcrepo.kernel.rdf.IdentifierTranslator subjects)
                                                                throws javax.jcr.RepositoryException

Get an RdfStream of the registered JCR workspaces

Returns:

Throws:

javax.jcr.RepositoryException

getTreeTriples

public org.fcrepo.kernel.utils.iterators.RdfStream getTreeTriples(javax.jcr.Node node,
                                                         org.fcrepo.kernel.rdf.HierarchyRdfContextOptions options)
                                                           throws javax.jcr.RepositoryException

Add the properties of a Node's parent and immediate children (as well as the jcr:content of children) to the given RdfStream

Parameters:

node -

Throws:

javax.jcr.RepositoryException

getTreeTriples

public org.fcrepo.kernel.utils.iterators.RdfStream getTreeTriples(javax.jcr.Node node)
                                                           throws javax.jcr.RepositoryException

Add the properties of a Node's parent and immediate children using the default serialization options

Parameters:

node -

Returns:

Throws:

javax.jcr.RepositoryException

isContainer

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

Decides whether the RDF representation of this Node will receive LDP Container status.

Parameters:

node -

Returns:

Throws:

javax.jcr.RepositoryException

isInternalProperty

public boolean isInternalProperty(javax.jcr.Node subjectNode,
                         com.hp.hpl.jena.rdf.model.Resource predicate)

Determine if a predicate is an internal property of a node (and should not be modified from external sources)

Parameters:

subjectNode -

predicate -

Returns:

createValue

public javax.jcr.Value createValue(javax.jcr.Node node,
                          com.hp.hpl.jena.rdf.model.RDFNode data,
                          int type)
                            throws javax.jcr.RepositoryException

Create a JCR value from an RDFNode, either by using the given JCR PropertyType or by looking at the RDFNode Datatype

Parameters:

data - an RDF Node (possibly with a DataType)

type - a JCR PropertyType value

Returns:

a JCR Value

Throws:

javax.jcr.RepositoryException

createValue

public javax.jcr.Value createValue(com.hp.hpl.jena.rdf.model.RDFNode data)
                            throws javax.jcr.RepositoryException

Create a JCR value (with an undefined type) from a RDFNode

Parameters:

data -

Returns:

Throws:

javax.jcr.RepositoryException

createValue

public javax.jcr.Value createValue(com.hp.hpl.jena.rdf.model.RDFNode data,
                          int type)
                            throws javax.jcr.RepositoryException

Create a JCR value from an RDFNode with the given JCR type

Parameters:

data -

type -

Returns:

Throws:

javax.jcr.RepositoryException

createValue

public javax.jcr.Value createValue(javax.jcr.ValueFactory valueFactory,
                          com.hp.hpl.jena.rdf.model.RDFNode data,
                          int type)
                            throws javax.jcr.RepositoryException

Create a JCR value from an RDF node with the given JCR type

Parameters:

valueFactory -

data -

type -

Returns:

Throws:

javax.jcr.RepositoryException

getPropertyNameFromPredicate

public String getPropertyNameFromPredicate(javax.jcr.Node node,
                                  com.hp.hpl.jena.rdf.model.Property predicate)
                                    throws javax.jcr.RepositoryException

Given an RDF predicate value (namespace URI + local name), figure out what JCR property to use

Parameters:

node - the JCR node we want a property for

predicate - the predicate to map to a property name

Returns:

Throws:

javax.jcr.RepositoryException

getPropertyNameFromPredicate

public String getPropertyNameFromPredicate(javax.jcr.Node node,
                                  com.hp.hpl.jena.rdf.model.Property predicate,
                                  Map<String,String> namespaceMapping)
                                    throws javax.jcr.RepositoryException

Given an RDF predicate value (namespace URI + local name), figure out what JCR property to use

Parameters:

node - the JCR node we want a property for

predicate - the predicate to map to a property name

namespaceMapping - prefix => uri namespace mapping

Returns:

the JCR property name

Throws:

javax.jcr.RepositoryException

getPropertyNameFromPredicate

public String getPropertyNameFromPredicate(com.hp.hpl.jena.rdf.model.Property predicate,
                                  Map<String,String> namespaceMapping)
                                    throws javax.jcr.RepositoryException

Get the property name for an RDF predicate

Parameters:

predicate -

namespaceMapping -

Returns:

Throws:

javax.jcr.RepositoryException

getPropertyNameFromPredicate

public String getPropertyNameFromPredicate(com.hp.hpl.jena.rdf.model.Property predicate)
                                    throws javax.jcr.RepositoryException

Get a property name for an RDF predicate

Parameters:

predicate -

Returns:

Throws:

javax.jcr.RepositoryException

getPropertyNameFromPredicate

public String getPropertyNameFromPredicate(org.modeshape.jcr.api.NamespaceRegistry namespaceRegistry,
                                  com.hp.hpl.jena.rdf.model.Property predicate,
                                  Map<String,String> namespaceMapping)
                                    throws javax.jcr.RepositoryException

Get the JCR property name for an RDF predicate

Parameters:

namespaceRegistry -

predicate -

namespaceMapping -

Returns:

Throws:

javax.jcr.RepositoryException

setLlstore

public void setLlstore(LowLevelStorageService lowLevelStorageService)

Set the Low-level storage server implementation

getPropertyType

public int getPropertyType(String nodeType,
                  String propertyName)
                    throws javax.jcr.RepositoryException

Given a node type and a property name, figure out an appropriate jcr value type

Parameters:

nodeType -

propertyName -

Returns:

Throws:

javax.jcr.RepositoryException

getPropertyType

public int getPropertyType(javax.jcr.nodetype.NodeType nodeType,
                  String propertyName)

Given a node type and a property name, figure out an appropraite jcr value type

Parameters:

nodeType -

propertyName -

Returns: