com.tinkerpop.blueprints.impls.sail

Class SailGraph

java.lang.Object

com.tinkerpop.blueprints.impls.sail.SailGraph

All Implemented Interfaces:

Graph, MetaGraph<org.openrdf.sail.Sail>, TransactionalGraph

Direct Known Subclasses:

LinkedDataSailGraph, MemoryStoreSailGraph, NativeStoreSailGraph, SparqlRepositorySailGraph

public class SailGraph
extends Object
implements TransactionalGraph, MetaGraph<org.openrdf.sail.Sail>

A Blueprints implementation of the RDF-based Sail interfaces by Aduna (http://openrdf.org).

Author:

Marko A. Rodriguez (http://markorodriguez.com), Joshua Shinavier (http://fortytwo.net)

Nested Class Summary

Nested classes/interfaces inherited from interface com.tinkerpop.blueprints.TransactionalGraph

TransactionalGraph.Conclusion

Field Summary

Fields

Modifier and Type	Field and Description
static Map<String,org.openrdf.rio.RDFFormat>	formats
protected org.openrdf.sail.Sail	rawGraph
protected ThreadLocal<org.openrdf.sail.SailConnection>	sailConnection

Constructor Summary

Constructors

Constructor and Description
SailGraph(org.openrdf.sail.Sail sail) Construct a new SailGraph with an uninitialized Sail.

Method Summary

Methods

Modifier and Type	Method and Description
void	addDefaultNamespaces() Defines a few commonly-used namespace prefixes.
Edge	addEdge(Object id, Vertex outVertex, Vertex inVertex, String label)
void	addNamespace(String prefix, String namespace) Add a prefix-to-namespace mapping to the Sail connection of this graph.
Vertex	addVertex(Object id)
void	commit()
List<Map<String,Vertex>>	executeSparql(String sparqlQuery) Evaluate a SPARQL query against the SailGraph (http://www.w3.org/TR/rdf-sparql-query/).
String	expandPrefix(String uri) Given a URI, expand it to its full URI.
Edge	getEdge(Object id)
Iterable<Edge>	getEdges()
Iterable<Edge>	getEdges(String key, Object value)
Features	getFeatures()
static org.openrdf.rio.RDFFormat	getFormat(String format)
Map<String,String>	getNamespaces() Get all the prefix-to-namespace mappings of the graph.
org.openrdf.sail.Sail	getRawGraph()
ThreadLocal<org.openrdf.sail.SailConnection>	getSailConnection() Get the Sail connection currently being used by the graph.
Vertex	getVertex(Object id)
Iterable<Vertex>	getVertices()
Iterable<Vertex>	getVertices(String key, Object value)
void	loadRDF(InputStream input, String baseURI, String format, String baseGraph) Load RDF data into the SailGraph.
String	prefixNamespace(String uri) Given a URI, compress it to its prefixed URI.
GraphQuery	query()
void	removeEdge(Edge edge)
void	removeNamespace(String prefix) Remove a prefix-to-namespace mapping from the Sail connection of this graph.
void	removeVertex(Vertex vertex)
void	rollback()
void	saveRDF(OutputStream output, String format) Save RDF data from the SailGraph.
void	shutdown()
void	stopTransaction(TransactionalGraph.Conclusion conclusion)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

formats

public static final Map<String,org.openrdf.rio.RDFFormat> formats

rawGraph

protected final org.openrdf.sail.Sail rawGraph

sailConnection

protected final ThreadLocal<org.openrdf.sail.SailConnection> sailConnection

Constructor Detail

SailGraph

public SailGraph(org.openrdf.sail.Sail sail)

Construct a new SailGraph with an uninitialized Sail.

Parameters:

sail - a not-yet-initialized Sail instance

Method Detail

getFormat

public static org.openrdf.rio.RDFFormat getFormat(String format)

addDefaultNamespaces

public void addDefaultNamespaces()

Defines a few commonly-used namespace prefixes.

getRawGraph

public org.openrdf.sail.Sail getRawGraph()

Specified by:

getRawGraph in interface MetaGraph<org.openrdf.sail.Sail>

addVertex

public Vertex addVertex(Object id)

Specified by:

addVertex in interface Graph

getVertex

public Vertex getVertex(Object id)

Specified by:

getVertex in interface Graph

getEdge

public Edge getEdge(Object id)

Specified by:

getEdge in interface Graph

getVertices

public Iterable<Vertex> getVertices()

Specified by:

getVertices in interface Graph

getVertices

public Iterable<Vertex> getVertices(String key,
                           Object value)

Specified by:

getVertices in interface Graph

getEdges

public Iterable<Edge> getEdges()

Specified by:

getEdges in interface Graph

getEdges

public Iterable<Edge> getEdges(String key,
                      Object value)

Specified by:

getEdges in interface Graph

removeVertex

public void removeVertex(Vertex vertex)

Specified by:

removeVertex in interface Graph

addEdge

public Edge addEdge(Object id,
           Vertex outVertex,
           Vertex inVertex,
           String label)

Specified by:

addEdge in interface Graph

removeEdge

public void removeEdge(Edge edge)

Specified by:

removeEdge in interface Graph

getSailConnection

public ThreadLocal<org.openrdf.sail.SailConnection> getSailConnection()

Get the Sail connection currently being used by the graph.

Returns:

the Sail connection

addNamespace

public void addNamespace(String prefix,
                String namespace)

Add a prefix-to-namespace mapping to the Sail connection of this graph.

Parameters:

prefix - the prefix (e.g. tg)

namespace - the namespace (e.g. http://tinkerpop.com#)

removeNamespace

public void removeNamespace(String prefix)

Remove a prefix-to-namespace mapping from the Sail connection of this graph.

Parameters:

prefix - the prefix of the prefix-to-namespace mapping to remove

getNamespaces

public Map<String,String> getNamespaces()

Get all the prefix-to-namespace mappings of the graph.

Returns:

a map of the prefix-to-namespace mappings

loadRDF

public void loadRDF(InputStream input,
           String baseURI,
           String format,
           String baseGraph)

Load RDF data into the SailGraph. Supported formats include rdf-xml, n-triples, turtle, n3, trix, or trig. Before loading data, the current transaction is successfully committed.

Parameters:

input - the InputStream of RDF data

baseURI - the baseURI for RDF data

format - supported formats include rdf-xml, n-triples, turtle, n3, trix, or trig

baseGraph - the baseGraph to insert the data into

saveRDF

public void saveRDF(OutputStream output,
           String format)

Save RDF data from the SailGraph. Supported formats include rdf-xml, n-triples, turtle, n3, trix, or trig.

Parameters:

output - the OutputStream to which to write RDF data

format - supported formats include rdf-xml, n-triples, turtle, n3, trix, or trig

shutdown

public void shutdown()

Specified by:

shutdown in interface Graph

Specified by:

shutdown in interface TransactionalGraph

expandPrefix

public String expandPrefix(String uri)

Given a URI, expand it to its full URI.

Parameters:

uri - the compressed URI (e.g. tg:knows)

Returns:

the expanded URI (e.g. http://tinkerpop.com#knows)

prefixNamespace

public String prefixNamespace(String uri)

Given a URI, compress it to its prefixed URI.

Parameters:

uri - the expanded URI (e.g. http://tinkerpop.com#knows)

Returns:

the prefixed URI (e.g. tg:knows)

stopTransaction

public void stopTransaction(TransactionalGraph.Conclusion conclusion)

Specified by:

stopTransaction in interface TransactionalGraph

commit

public void commit()

Specified by:

commit in interface TransactionalGraph

rollback

public void rollback()

Specified by:

rollback in interface TransactionalGraph

toString

public String toString()

Overrides:

toString in class Object

getFeatures

public Features getFeatures()

Specified by:

getFeatures in interface Graph

query

public GraphQuery query()

Specified by:

query in interface Graph

executeSparql

public List<Map<String,Vertex>> executeSparql(String sparqlQuery)
                                       throws RuntimeException

Evaluate a SPARQL query against the SailGraph (http://www.w3.org/TR/rdf-sparql-query/). The result is a mapping between the ?-bindings and the bound URI, blank node, or literal represented as a Vertex.

Parameters:

sparqlQuery - the SPARQL query to evaluate

Returns:

the mapping between a ?-binding and the URI, blank node, or literal as a Vertex

Throws:

RuntimeException - if an error occurs in the SPARQL query engine