com.bigdata.blueprints

Class BigdataGraph

java.lang.Object

com.bigdata.blueprints.BigdataGraph

All Implemented Interfaces:

com.tinkerpop.blueprints.Graph

Direct Known Subclasses:

BigdataGraphBulkLoad, BigdataGraphClient, BigdataGraphEmbedded, BigdataGraphEmbedded.BigdataReadOnlyGraph, ImmortalGraph

public abstract class BigdataGraph
extends Object
implements com.tinkerpop.blueprints.Graph

A base class for a Blueprints wrapper around a bigdata back-end.

Author:

mikepersonick

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BigdataGraph.EdgeIterable Translate a collection of Bigdata statements into an iteration of Blueprints edges.
class	BigdataGraph.FusedIterable<T> Fuse two iterables together into one.
static interface	BigdataGraph.Options
class	BigdataGraph.VertexIterable Translate a collection of Bigdata statements into an iteration of Blueprints vertices.
class	BigdataGraph.WrappedResult<E>

Field Summary

Fields

Modifier and Type	Field and Description
protected org.openrdf.model.URI	EDGE URI used to represent a Edge.
protected BlueprintsValueFactory	factory Factory for round-tripping between Blueprints data and RDF data.
protected static com.tinkerpop.blueprints.Features	FEATURES
protected org.openrdf.model.URI	LABEL URI used for labeling edges.
protected boolean	laxProperties If true, use pure append mode (don't check old property values).
protected int	maxQueryTime Max Query Time used to globally set the query timeout.
static int	SPARQL_LOG_MAX Maximum number of chars to print through the SparqlLogger.
protected org.openrdf.model.URI	TYPE URI used for typing elements.
protected org.openrdf.model.URI	VERTEX URI used to represent a Vertex.

Constructor Summary

Constructors

Constructor and Description
BigdataGraph(BlueprintsValueFactory factory)
BigdataGraph(BlueprintsValueFactory factory, Properties props)

Method Summary

Methods

Modifier and Type	Method and Description
com.tinkerpop.blueprints.Edge	addEdge(Object key, com.tinkerpop.blueprints.Vertex from, com.tinkerpop.blueprints.Vertex to, boolean anonymous) Add an edge.
com.tinkerpop.blueprints.Edge	addEdge(Object key, com.tinkerpop.blueprints.Vertex from, com.tinkerpop.blueprints.Vertex to, String label) Add an edge.
com.tinkerpop.blueprints.Edge	addEdge(Object key, com.tinkerpop.blueprints.Vertex from, com.tinkerpop.blueprints.Vertex to, String label, boolean anonymous) Add an edge.
com.tinkerpop.blueprints.Vertex	addVertex(Object key) Add a vertex.
boolean	ask(String queryStr) Select results using a SPARQL query.
boolean	ask(String queryStr, String externalQueryId) Select results using a SPARQL query.
abstract void	cancel(RunningQuery r) Kill a running query specified by the RunningQuery object.
abstract void	cancel(String uuid) Kill a running query specified by the UUID String.
abstract void	cancel(UUID queryId) Kill a running query specified by the UUID.
protected BigdataBindingSet	convert(org.openrdf.query.BindingSet bs) Convert SPARQL/RDF results into PG form.
abstract org.openrdf.repository.RepositoryConnection	cxn() Different implementations will return different types of connections depending on the mode (client/server, embedded, read-only, etc.)
protected void	finalizeQuery(UUID queryId) Wrapper method to clean up query and throw exception is interrupted.
<T> Iterable<T>	fuse(Iterable<T>... args) Fuse two iterables together into one.
com.tinkerpop.blueprints.Edge	getEdge(Object key) Lookup an edge.
Iterable<com.tinkerpop.blueprints.Edge>	getEdges() Iterate all edges.
Iterable<com.tinkerpop.blueprints.Edge>	getEdges(String prop, Object val) Find edges with the supplied property value.
protected org.openrdf.query.GraphQueryResult	getElements(org.openrdf.model.URI from, org.openrdf.model.URI to, String... labels) Translates the request to a high-performance SPARQL query: construct { ?from ?edge ?to .
com.tinkerpop.blueprints.Features	getFeatures()
Object	getProperty(org.openrdf.model.URI uri, String prop) Return a single-valued property for an edge or vertex.
Object	getProperty(org.openrdf.model.URI uri, org.openrdf.model.URI prop) Return a single-valued property for an edge or vertex.
protected Object	getProperty(org.openrdf.model.Value value)
Set<String>	getPropertyKeys(org.openrdf.model.URI uri) Return the property names for an edge or vertex.
abstract RunningQuery	getQueryByExternalId(String extQueryId) Return the RunningQuery for a currently executing SPARQL QUERY or UPDATE request.
abstract RunningQuery	getQueryById(UUID queryId2) Return the RunningQuery for a currently executing SPARQL QUERY or UPDATE request.
abstract Collection<RunningQuery>	getRunningQueries() Return a Collection of running queries
BlueprintsValueFactory	getValueFactory() Return the factory used to round-trip between Blueprints values and RDF values.
com.tinkerpop.blueprints.Vertex	getVertex(Object key) Lookup a vertex.
Iterable<com.tinkerpop.blueprints.Vertex>	getVertices() Iterate all vertices.
Iterable<com.tinkerpop.blueprints.Vertex>	getVertices(String prop, Object val) Find vertices with the supplied property value.
ICloseableIterator<BigdataGraphEdit>	history(List<org.openrdf.model.URI> ids) If history is enabled, return an iterator of historical graph edits related to any of the supplied ids.
ICloseableIterator<BigdataGraphEdit>	history(List<org.openrdf.model.URI> ids, String extQueryId)
protected abstract boolean	isQueryCancelled(UUID queryId) Helper method to determine if a query was cancelled.
abstract boolean	isReadOnly() Is this a read-only view of the graph?
void	loadGraphML(String file) Post a GraphML file to the remote server.
ICloseableIterator<BigdataGraphAtom>	project(String queryStr) Project a subgraph using a SPARQL query.
ICloseableIterator<BigdataGraphAtom>	project(String queryStr, String externalQueryId) Project a subgraph using a SPARQL query.
com.tinkerpop.blueprints.GraphQuery	query() Providing an override implementation for our GraphQuery to avoid the low-performance scan and filter paradigm.
void	removeEdge(com.tinkerpop.blueprints.Edge edge) Remove an edge and its properties.
Object	removeProperty(org.openrdf.model.URI uri, String prop) Remove all values for a particular property on an edge or vertex.
Object	removeProperty(org.openrdf.model.URI uri, org.openrdf.model.URI prop) Remove all values for a particular property on an edge or vertex.
void	removeVertex(com.tinkerpop.blueprints.Vertex vertex) Remove a vertex and its edges and properties.
ICloseableIterator<BigdataBindingSet>	select(String queryStr) Select results using a SPARQL query.
ICloseableIterator<BigdataBindingSet>	select(String queryStr, String externalQueryId) Select results using a SPARQL query.
protected void	setMaxQueryTime(org.openrdf.query.Query query) Utility function to set the Query timeout to the global setting if it is configured.
void	setProperty(org.openrdf.model.URI s, String prop, Object val) Set a single-value property on an edge or vertex (remove the old value first).
void	setProperty(org.openrdf.model.URI uri, org.openrdf.model.URI prop, Collection<org.openrdf.model.Literal> vals) Set a multi-value property on an edge or vertex (remove the old values first).
protected abstract UUID	setupQuery(BigdataSailRepositoryConnection cxn, ASTContainer astContainer, QueryType queryType, String extQueryId) Embedded clients can override this to access query management capabilities.
protected abstract void	tearDownQuery(UUID queryId) Embedded clients can override this to access query management capabilities.
protected BigdataGraphAtom	toGraphAtom(org.openrdf.model.Statement stmt) Convert a unit of RDF data to an atomic unit of PG data.
protected BigdataGraphAtom	toGraphAtom(org.openrdf.model.URI s, org.openrdf.model.URI p, org.openrdf.model.Value o) Convert a unit of RDF data to an atomic unit of PG data.
protected Collection<org.openrdf.model.Literal>	toLiterals(Object val)
String	toString() For some reason this is part of the specification (i.e.
void	update(String queryStr) Update graph using SPARQL Update.
void	update(String queryStr, String extQueryId) Update graph using SPARQL Update.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tinkerpop.blueprints.Graph

shutdown

Field Detail

SPARQL_LOG_MAX

public static final int SPARQL_LOG_MAX

Maximum number of chars to print through the SparqlLogger.

See Also:

Constant Field Values

maxQueryTime

protected final int maxQueryTime

Max Query Time used to globally set the query timeout. Default is 0 (unlimited)

TYPE

protected final org.openrdf.model.URI TYPE

URI used for typing elements.

VERTEX

protected final org.openrdf.model.URI VERTEX

URI used to represent a Vertex.

EDGE

protected final org.openrdf.model.URI EDGE

URI used to represent a Edge.

LABEL

protected final org.openrdf.model.URI LABEL

URI used for labeling edges.

factory

protected final BlueprintsValueFactory factory

Factory for round-tripping between Blueprints data and RDF data.

laxProperties

protected final boolean laxProperties

If true, use pure append mode (don't check old property values).

FEATURES

protected static final com.tinkerpop.blueprints.Features FEATURES

Constructor Detail

BigdataGraph

public BigdataGraph(BlueprintsValueFactory factory)

BigdataGraph

public BigdataGraph(BlueprintsValueFactory factory,
            Properties props)

Method Detail

toString

public String toString()

For some reason this is part of the specification (i.e. part of the Blueprints test suite).

Overrides:

toString in class Object

getValueFactory

public BlueprintsValueFactory getValueFactory()

Return the factory used to round-trip between Blueprints values and RDF values.

cxn

public abstract org.openrdf.repository.RepositoryConnection cxn()
                                                         throws Exception

Different implementations will return different types of connections depending on the mode (client/server, embedded, read-only, etc.)

Throws:

Exception

getProperty

public Object getProperty(org.openrdf.model.URI uri,
                 String prop)

Return a single-valued property for an edge or vertex.

See Also:

BigdataElement}

getProperty

public Object getProperty(org.openrdf.model.URI uri,
                 org.openrdf.model.URI prop)

Return a single-valued property for an edge or vertex.

See Also:

BigdataElement}

getProperty

protected Object getProperty(org.openrdf.model.Value value)

getPropertyKeys

public Set<String> getPropertyKeys(org.openrdf.model.URI uri)

Return the property names for an edge or vertex.

See Also:

BigdataElement}

removeProperty

public Object removeProperty(org.openrdf.model.URI uri,
                    String prop)

Remove all values for a particular property on an edge or vertex.

See Also:

BigdataElement}

removeProperty

public Object removeProperty(org.openrdf.model.URI uri,
                    org.openrdf.model.URI prop)

Remove all values for a particular property on an edge or vertex.

See Also:

BigdataElement}

setProperty

public void setProperty(org.openrdf.model.URI s,
               String prop,
               Object val)

Set a single-value property on an edge or vertex (remove the old value first).

See Also:

BigdataElement}

toLiterals

protected Collection<org.openrdf.model.Literal> toLiterals(Object val)

setProperty

public void setProperty(org.openrdf.model.URI uri,
               org.openrdf.model.URI prop,
               Collection<org.openrdf.model.Literal> vals)

Set a multi-value property on an edge or vertex (remove the old values first).

See Also:

BigdataElement}

loadGraphML

public void loadGraphML(String file)
                 throws Exception

Post a GraphML file to the remote server. (Bulk-upload operation.)

Throws:

Exception

addEdge

public com.tinkerpop.blueprints.Edge addEdge(Object key,
                                    com.tinkerpop.blueprints.Vertex from,
                                    com.tinkerpop.blueprints.Vertex to,
                                    String label)

Add an edge.

Specified by:

addEdge in interface com.tinkerpop.blueprints.Graph

addEdge

public com.tinkerpop.blueprints.Edge addEdge(Object key,
                                    com.tinkerpop.blueprints.Vertex from,
                                    com.tinkerpop.blueprints.Vertex to,
                                    boolean anonymous)

Add an edge.

addEdge

public com.tinkerpop.blueprints.Edge addEdge(Object key,
                                    com.tinkerpop.blueprints.Vertex from,
                                    com.tinkerpop.blueprints.Vertex to,
                                    String label,
                                    boolean anonymous)

Add an edge.

addVertex

public com.tinkerpop.blueprints.Vertex addVertex(Object key)

Add a vertex.

Specified by:

addVertex in interface com.tinkerpop.blueprints.Graph

getEdge

public com.tinkerpop.blueprints.Edge getEdge(Object key)

Lookup an edge.

Specified by:

getEdge in interface com.tinkerpop.blueprints.Graph

getEdges

public Iterable<com.tinkerpop.blueprints.Edge> getEdges()

Iterate all edges.

Specified by:

getEdges in interface com.tinkerpop.blueprints.Graph

getElements

protected org.openrdf.query.GraphQueryResult getElements(org.openrdf.model.URI from,
                                             org.openrdf.model.URI to,
                                             String... labels)
                                                  throws Exception

Translates the request to a high-performance SPARQL query: construct { ?from ?edge ?to . } where { ?edge rdf:type . ?from ?edge ?to . # filter by edge label ?edge rdfs:label ?label . filter(?label in ("label1", "label2", ...)) . }

Throws:

Exception

getEdges

public Iterable<com.tinkerpop.blueprints.Edge> getEdges(String prop,
                                               Object val)

Find edges with the supplied property value. construct { ?from ?edge ?to . } where { ?edge . ?from ?edge ?to . }

Specified by:

getEdges in interface com.tinkerpop.blueprints.Graph

getVertex

public com.tinkerpop.blueprints.Vertex getVertex(Object key)

Lookup a vertex.

Specified by:

getVertex in interface com.tinkerpop.blueprints.Graph

getVertices

public Iterable<com.tinkerpop.blueprints.Vertex> getVertices()

Iterate all vertices.

Specified by:

getVertices in interface com.tinkerpop.blueprints.Graph

getVertices

public Iterable<com.tinkerpop.blueprints.Vertex> getVertices(String prop,
                                                    Object val)

Find vertices with the supplied property value.

Specified by:

getVertices in interface com.tinkerpop.blueprints.Graph

query

public com.tinkerpop.blueprints.GraphQuery query()

Providing an override implementation for our GraphQuery to avoid the low-performance scan and filter paradigm. See BigdataGraphQuery.

Specified by:

query in interface com.tinkerpop.blueprints.Graph

removeEdge

public void removeEdge(com.tinkerpop.blueprints.Edge edge)

Remove an edge and its properties.

Specified by:

removeEdge in interface com.tinkerpop.blueprints.Graph

removeVertex

public void removeVertex(com.tinkerpop.blueprints.Vertex vertex)

Remove a vertex and its edges and properties. TODO FIXME I am not fully removing dependent edges.

Specified by:

removeVertex in interface com.tinkerpop.blueprints.Graph

fuse

public final <T> Iterable<T> fuse(Iterable<T>... args)

Fuse two iterables together into one. Useful for combining IN and OUT edges for a vertex.

project

public ICloseableIterator<BigdataGraphAtom> project(String queryStr)
                                             throws Exception

Project a subgraph using a SPARQL query.

Warning: You MUST close this iterator when finished.

Throws:

Exception

project

public ICloseableIterator<BigdataGraphAtom> project(String queryStr,
                                           String externalQueryId)
                                             throws Exception

Project a subgraph using a SPARQL query. This version allows passing an external system ID to allow association between queries in the query engine when using an Embedded Client.

Warning: You MUST close this iterator when finished.

Throws:

Exception

toGraphAtom

protected BigdataGraphAtom toGraphAtom(org.openrdf.model.Statement stmt)

Convert a unit of RDF data to an atomic unit of PG data.

toGraphAtom

protected BigdataGraphAtom toGraphAtom(org.openrdf.model.URI s,
                           org.openrdf.model.URI p,
                           org.openrdf.model.Value o)

Convert a unit of RDF data to an atomic unit of PG data.

select

public ICloseableIterator<BigdataBindingSet> select(String queryStr)
                                             throws Exception

Select results using a SPARQL query.

Warning: You MUST close this iterator when finished.

Throws:

Exception

select

public ICloseableIterator<BigdataBindingSet> select(String queryStr,
                                           String externalQueryId)
                                             throws Exception

Select results using a SPARQL query.

Warning: You MUST close this iterator when finished.

Throws:

Exception

convert

protected BigdataBindingSet convert(org.openrdf.query.BindingSet bs)

Convert SPARQL/RDF results into PG form.

ask

public boolean ask(String queryStr)
            throws Exception

Select results using a SPARQL query.

Throws:

Exception

ask

public boolean ask(String queryStr,
          String externalQueryId)
            throws Exception

Select results using a SPARQL query.

Throws:

Exception

update

public void update(String queryStr)
            throws Exception

Update graph using SPARQL Update.

Throws:

Exception

update

public void update(String queryStr,
          String extQueryId)
            throws Exception

Update graph using SPARQL Update.

Throws:

Exception

history

public ICloseableIterator<BigdataGraphEdit> history(List<org.openrdf.model.URI> ids)
                                             throws Exception

If history is enabled, return an iterator of historical graph edits related to any of the supplied ids. To enable history, make sure the database is in statement identifiers mode and that the RDR History class is enabled.

Warning: You MUST close this iterator when finished.

Throws:

Exception

See Also:

AbstractTripleStore.Options#STATEMENT_IDENTIFIERS}, AbstractTripleStore.Options#RDR_HISTORY_CLASS}, RDRHistory}

history

public ICloseableIterator<BigdataGraphEdit> history(List<org.openrdf.model.URI> ids,
                                           String extQueryId)
                                             throws Exception

Throws:

Exception

getFeatures

public com.tinkerpop.blueprints.Features getFeatures()

Specified by:

getFeatures in interface com.tinkerpop.blueprints.Graph

setMaxQueryTime

protected void setMaxQueryTime(org.openrdf.query.Query query)

Utility function to set the Query timeout to the global setting if it is configured.

getRunningQueries

public abstract Collection<RunningQuery> getRunningQueries()

Return a Collection of running queries

Returns:

cancel

public abstract void cancel(UUID queryId)

Kill a running query specified by the UUID. Do nothing if the query has completed.

Parameters:

queryId -

cancel

public abstract void cancel(String uuid)

Kill a running query specified by the UUID String. Do nothing if the query has completed.

Parameters:

String - uuid

cancel

public abstract void cancel(RunningQuery r)

Kill a running query specified by the RunningQuery object. Do nothing if the query has completed.

Parameters:

r -

getQueryById

public abstract RunningQuery getQueryById(UUID queryId2)

Return the RunningQuery for a currently executing SPARQL QUERY or UPDATE request.

Parameters:

queryId2 - The UUID for the request.

Returns:

The RunningQuery iff it was found.

getQueryByExternalId

public abstract RunningQuery getQueryByExternalId(String extQueryId)

Return the RunningQuery for a currently executing SPARQL QUERY or UPDATE request.

Parameters:

queryId2 - The UUID for the request.

Returns:

The RunningQuery iff it was found.

setupQuery

protected abstract UUID setupQuery(BigdataSailRepositoryConnection cxn,
              ASTContainer astContainer,
              QueryType queryType,
              String extQueryId)

Embedded clients can override this to access query management capabilities.

Parameters:

cxn -

astContainer -

Returns:

finalizeQuery

protected void finalizeQuery(UUID queryId)
                      throws QueryCancelledException

Wrapper method to clean up query and throw exception is interrupted.

Parameters:

queryId -

Throws:

QueryCancelledException

tearDownQuery

protected abstract void tearDownQuery(UUID queryId)

Embedded clients can override this to access query management capabilities.

Parameters:

absQuery -

isQueryCancelled

protected abstract boolean isQueryCancelled(UUID queryId)

Helper method to determine if a query was cancelled.

Parameters:

queryId -

Returns:

isReadOnly

public abstract boolean isReadOnly()

Is this a read-only view of the graph?