com.bigdata.rdf.sail.webapp.client

Class RemoteRepository

java.lang.Object

com.bigdata.rdf.sail.webapp.client.RemoteRepositoryDecls

com.bigdata.rdf.sail.webapp.client.RemoteRepositoryBase

com.bigdata.rdf.sail.webapp.client.RemoteRepository

public class RemoteRepository
extends RemoteRepositoryBase

Java API to the Nano Sparql Server.

Note: The RemoteRepository object SHOULD be reused for multiple operations against the same end point.

See Also:

NanoSparqlServer REST API , Create a bigdata-client jar for the NSS REST API

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RemoteRepository.AddOp Add by URI, statements, or file.
protected class	RemoteRepository.QueryOrUpdate A prepared query will hold metadata for a particular query instance.
static class	RemoteRepository.RemoveOp Remove by query, access path, statements, or file.

Field Summary

Fields inherited from class com.bigdata.rdf.sail.webapp.client.RemoteRepositoryDecls

BASE_URI, BD_NULL_GRAPH, BINDING_PREFIX, DEFAULT_GRAPH_URI, DEFAULT_MAX_REQUEST_URL_LENGTH, DEFAULT_NAMESPACE, DEFAULT_QUERY_METHOD, FORCE_INDEX_CREATE, HTTP_HEADER_BIGDATA_MAX_QUERY_MILLIS, INCLUDE_INFERRED, MAX_QUERY_TIME_MILLIS, MAX_REQUEST_URL_LENGTH, NAMED_GRAPH_URI, OPTION_CREATE_KB_NAMESPACE, QUERY_METHOD, QUERYID, USING_GRAPH_URI, USING_NAMED_GRAPH_URI, UTF8

Method Summary

Methods

Modifier and Type	Method and Description
long	add(RemoteRepository.AddOp add) Adds RDF data to the remote repository.
long	add(RemoteRepository.AddOp add, UUID uuid) Adds RDF data to the remote repository.
void	cancel(UUID queryId) Cancel a query running remotely on the server.
BigdataSailRemoteRepository	getBigdataSailRemoteRepository() Flyweight method returns a wrapper for the sparql end point associated with this instance.
Collection<org.openrdf.model.Resource>	getContexts() Return a list of contexts in use in a remote quads database.
RemoteRepositoryManager	getRemoteRepositoryManager() The RemoteRepositoryManager object use to manage all access to the service backing the sparqlEndpointURL.
org.openrdf.query.GraphQueryResult	getServiceDescription() Return the SPARQL 1.1 Service Description for the end point.
org.openrdf.query.GraphQueryResult	getServiceDescription(UUID uuid)
String	getSparqlEndPoint() Return the SPARQL end point.
org.openrdf.query.GraphQueryResult	getStatements(org.openrdf.model.Resource subj, org.openrdf.model.URI pred, org.openrdf.model.Value obj, boolean includeInferred, org.openrdf.model.Resource... contexts) Return all matching statements.
boolean	hasStatement(org.openrdf.model.Resource s, org.openrdf.model.URI p, org.openrdf.model.Value o, boolean includeInferred, org.openrdf.model.Resource... c) Method to line up with the Sesame interface.
long	postGraphML(String path) Post a GraphML file to the blueprints layer of the remote bigdata instance.
IPreparedBooleanQuery	prepareBooleanQuery(String query) Prepare a boolean (ask) query.
IPreparedBooleanQuery	prepareBooleanQuery(String query, UUID uuid) Prepare a boolean (ask) query.
IPreparedGraphQuery	prepareGraphQuery(String query) Prepare a graph query.
IPreparedGraphQuery	prepareGraphQuery(String query, UUID uuid) Prepare a graph query.
IPreparedTupleQuery	prepareTupleQuery(String query) Prepare a tuple (select) query.
IPreparedTupleQuery	prepareTupleQuery(String query, UUID uuid) Prepare a tuple (select) query.
IPreparedSparqlUpdate	prepareUpdate(String updateStr) Prepare a SPARQL UPDATE request.
IPreparedSparqlUpdate	prepareUpdate(String updateStr, UUID uuid) Prepare a SPARQL UPDATE request.
long	rangeCount(boolean exact, org.openrdf.model.Resource s, org.openrdf.model.URI p, org.openrdf.model.Value o, org.openrdf.model.Resource... c) Perform a range count on the statement indices for a given triple (quad) pattern.
long	rangeCount(org.openrdf.model.Resource s, org.openrdf.model.URI p, org.openrdf.model.Value o, org.openrdf.model.Resource... c) Perform a fast range count on the statement indices for a given triple (quad) pattern.
long	remove(RemoteRepository.RemoveOp remove) Removes RDF data from the remote repository.
long	remove(RemoteRepository.RemoveOp remove, UUID uuid) Removes RDF data from the remote repository.
long	size() Perform a fast range count on the statement indices.
String	toString()
long	update(RemoteRepository.RemoveOp remove, RemoteRepository.AddOp add) Perform an ACID update (delete+insert) per the semantics of the NanoSparqlServer.
long	update(RemoteRepository.RemoveOp remove, RemoteRepository.AddOp add, UUID uuid) Perform an ACID update

Methods inherited from class com.bigdata.rdf.sail.webapp.client.RemoteRepositoryBase

asGraph, booleanResults, checkResponseCode, contextsResults, getContextPath, mutationResults, rangeCountResults, serialize, toStrings

Methods inherited from class java.lang.Object

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

Method Detail

getSparqlEndPoint

public String getSparqlEndPoint()

Return the SPARQL end point.

toString

public String toString()

Overrides:

toString in class Object

getRemoteRepositoryManager

public RemoteRepositoryManager getRemoteRepositoryManager()

The RemoteRepositoryManager object use to manage all access to the service backing the sparqlEndpointURL.

getBigdataSailRemoteRepository

public BigdataSailRemoteRepository getBigdataSailRemoteRepository()

Flyweight method returns a wrapper for the sparql end point associated with this instance.

postGraphML

public long postGraphML(String path)
                 throws Exception

Post a GraphML file to the blueprints layer of the remote bigdata instance.

Throws:

Exception

getServiceDescription

public org.openrdf.query.GraphQueryResult getServiceDescription()
                                                         throws Exception

Return the SPARQL 1.1 Service Description for the end point.

Throws:

Exception

getServiceDescription

public org.openrdf.query.GraphQueryResult getServiceDescription(UUID uuid)
                                                         throws Exception

Throws:

Exception

prepareTupleQuery

public IPreparedTupleQuery prepareTupleQuery(String query)
                                      throws Exception

Prepare a tuple (select) query.

Parameters:

query - the query string

Returns:

The IPreparedTupleQuery.

Throws:

Exception

prepareTupleQuery

public IPreparedTupleQuery prepareTupleQuery(String query,
                                    UUID uuid)
                                      throws Exception

Prepare a tuple (select) query.

Parameters:

query - the query string

uuid - The UUID used to identify this query.

Returns:

The IPreparedTupleQuery.

Throws:

Exception

prepareGraphQuery

public IPreparedGraphQuery prepareGraphQuery(String query)
                                      throws Exception

Prepare a graph query.

Parameters:

query - the query string

Returns:

The IPreparedGraphQuery

Throws:

Exception

prepareGraphQuery

public IPreparedGraphQuery prepareGraphQuery(String query,
                                    UUID uuid)
                                      throws Exception

Prepare a graph query.

Parameters:

query - the query string

uuid - The UUID used to identify this query.

Returns:

The IPreparedGraphQuery

Throws:

Exception

prepareBooleanQuery

public IPreparedBooleanQuery prepareBooleanQuery(String query)
                                          throws Exception

Prepare a boolean (ask) query.

Parameters:

query - the query string

Returns:

the IPreparedBooleanQuery

Throws:

Exception

prepareBooleanQuery

public IPreparedBooleanQuery prepareBooleanQuery(String query,
                                        UUID uuid)
                                          throws Exception

Prepare a boolean (ask) query.

Parameters:

query - the query string

uuid - The UUID used to identify this query.

Returns:

the IPreparedBooleanQuery

Throws:

Exception

prepareUpdate

public IPreparedSparqlUpdate prepareUpdate(String updateStr)
                                    throws Exception

Prepare a SPARQL UPDATE request.

Parameters:

updateStr - The SPARQL UPDATE request.

Returns:

The SparqlUpdate operation.

Throws:

Exception

prepareUpdate

public IPreparedSparqlUpdate prepareUpdate(String updateStr,
                                  UUID uuid)
                                    throws Exception

Prepare a SPARQL UPDATE request.

Parameters:

updateStr - The SPARQL UPDATE request.

uuid - The UUID used to identify this query.

Returns:

The SparqlUpdate operation.

Throws:

Exception

getStatements

public org.openrdf.query.GraphQueryResult getStatements(org.openrdf.model.Resource subj,
                                               org.openrdf.model.URI pred,
                                               org.openrdf.model.Value obj,
                                               boolean includeInferred,
                                               org.openrdf.model.Resource... contexts)
                                                 throws Exception

Return all matching statements.

Parameters:

subj -

pred -

obj -

includeInferred -

contexts -

Returns:

Throws:

Exception

hasStatement

public boolean hasStatement(org.openrdf.model.Resource s,
                   org.openrdf.model.URI p,
                   org.openrdf.model.Value o,
                   boolean includeInferred,
                   org.openrdf.model.Resource... c)
                     throws Exception

Method to line up with the Sesame interface.

Parameters:

s - The subject (optional).

p - The predicate (optional).

o - The value (optional).

includeInferred - when true inferred statements will also be considered.

c - The contexts (optional, BUT may not be a null Resource[]).

Returns:

true iff a statement exists that matches the request.

Throws:

Exception

See Also:

hasStatements can overestimate and ignores includeInferred (REST API) , Resource... contexts not encoded/decoded according to openrdf semantics (REST API)

cancel

public void cancel(UUID queryId)
            throws Exception

Cancel a query running remotely on the server.

Parameters:

queryID - the UUID of the query to cancel

Throws:

Exception

rangeCount

public long rangeCount(org.openrdf.model.Resource s,
              org.openrdf.model.URI p,
              org.openrdf.model.Value o,
              org.openrdf.model.Resource... c)
                throws Exception

Perform a fast range count on the statement indices for a given triple (quad) pattern.

Parameters:

s - the subject (can be null)

p - the predicate (can be null)

o - the object (can be null)

c - the context (can be null)

Returns:

the range count

Throws:

Exception

See Also:

Add REST API method for exact range counts

rangeCount

public long rangeCount(boolean exact,
              org.openrdf.model.Resource s,
              org.openrdf.model.URI p,
              org.openrdf.model.Value o,
              org.openrdf.model.Resource... c)
                throws Exception

Perform a range count on the statement indices for a given triple (quad) pattern.

Note: fast range counts are *fast*. They require two key probes into the indices. Exact range counts are only fast when the indices do not support isolation or fused views. Isolation is used if the namespace supports full read/write transactions. Fused views are used in scale-out to model shards and are also used in full read/write transaction support.

Parameters:

exact - if true then an exact range count is requested, otherwise a fast range count is requested.

s - the subject (can be null)

p - the predicate (can be null)

o - the object (can be null)

c - the context (can be null)

Returns:

the range count

Throws:

Exception

See Also:

Add REST API method for exact range counts , Resource... contexts not encoded/decoded according to openrdf semantics (REST API)

size

public long size()
          throws Exception

Perform a fast range count on the statement indices. This reports an estimate of the number of statements in the namespace. That estimate is exact unless the namespace is provisioned for full read/write transactions or the endpoint is scale-out.

Returns:

the range count (#of statements in the database).

Throws:

Exception

getContexts

public Collection<org.openrdf.model.Resource> getContexts()
                                                   throws Exception

Return a list of contexts in use in a remote quads database. FIXME This should be a streaming response for scalability. That will require us to change the return type for the method. E.g., to something that implements Closeable. Callers will then have to invoke Closeable.close() to avoid leaking resources. (This change could be made when making the CONTEXTS an operation that can be given a UUID for cancellation by the client.)

Throws:

Exception

add

public long add(RemoteRepository.AddOp add)
         throws Exception

Adds RDF data to the remote repository.

Parameters:

add - The RDF data to be added.

Returns:

The mutation count.

Throws:

Exception

add

public long add(RemoteRepository.AddOp add,
       UUID uuid)
         throws Exception

Adds RDF data to the remote repository.

Parameters:

add - The RDF data to be added.

uuid - The UUID used to identify this query.

Returns:

The mutation count.

Throws:

Exception

See Also:

#1254 / BLZG-1259

remove

public long remove(RemoteRepository.RemoveOp remove)
            throws Exception

Removes RDF data from the remote repository.

Parameters:

remove - The RDF data to be removed.

Returns:

The mutation count.

Throws:

Exception

See Also:

Resource... contexts not encoded/decoded according to openrdf semantics (REST API)

remove

public long remove(RemoteRepository.RemoveOp remove,
          UUID uuid)
            throws Exception

Removes RDF data from the remote repository.

Parameters:

remove - The RDF data to be removed.

Returns:

The mutation count.

Throws:

Exception

See Also:

Resource... contexts not encoded/decoded according to openrdf semantics (REST API) , / BLZG-1259

update

public long update(RemoteRepository.RemoveOp remove,
          RemoteRepository.AddOp add)
            throws Exception

Perform an ACID update (delete+insert) per the semantics of the NanoSparqlServer.

Currently, the only combination supported is delete by query with add by post (Iterable and File). You can embed statements you want to delete inside a construct query without a where clause.

Parameters:

remove - The RDF data to be removed.

add - The RDF data to be added.

Returns:

The mutation count.

Throws:

Exception

update

public long update(RemoteRepository.RemoveOp remove,
          RemoteRepository.AddOp add,
          UUID uuid)
            throws Exception

Perform an ACID update

There are two different patterns which are supported:

UPDATE (DELETE statements selected by a QUERY plus INSERT statements from Request Body using PUT)

Where query is a CONSTRUCT or DESCRIBE query.
Note: The QUERY + DELETE operation is ACID.
Note: You MAY specify a CONSTRUCT query with an empty WHERE clause in order to specify a set of statements to be removed without reference to statements already existing in the database.

UPDATE (POST with Multi-Part Request Body)

You can specify two sets of serialized statements - one to be removed and one to be added..

Parameters:

remove - The RDF data to be removed (either a collection of statements or a CONSTRUCT or DESCRIBE QUERY identifying the data to be deleted).

add - The RDF data to be added (must be a collection of statements).

Returns:

The mutation count.

Throws:

Exception

See Also:

://wiki.blazegraph.com/wiki/index.php/NanoSparqlServer#UPDATE_.28D ELETE_.2B_INSERT.29