edu.cornell.mannlib.vitro.webapp.rdfservice.impl.sparql

Class RDFServiceSparql

java.lang.Object

edu.cornell.mannlib.vitro.webapp.rdfservice.impl.RDFServiceImpl

edu.cornell.mannlib.vitro.webapp.rdfservice.impl.sparql.RDFServiceSparql

All Implemented Interfaces:

RDFService

Direct Known Subclasses:

RDFServiceSparqlHttp, RDFServiceVirtuoso

public class RDFServiceSparql
extends RDFServiceImpl
implements RDFService

Nested Class Summary

Nested classes/interfaces inherited from interface edu.cornell.mannlib.vitro.webapp.rdfservice.RDFService

RDFService.ModelSerializationFormat, RDFService.ResultFormat, RDFService.SPARQLQueryType

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.http.client.HttpClient	httpClient
protected String	readEndpointURI
protected boolean	rebuildGraphURICache
protected String	updateEndpointURI

Fields inherited from class edu.cornell.mannlib.vitro.webapp.rdfservice.impl.RDFServiceImpl

BNODE_ROOT_QUERY, defaultWriteGraphURI, registeredJenaListeners, registeredListeners

Constructor Summary

Constructors

Constructor and Description
RDFServiceSparql(String endpointURI) Returns an RDFService for a remote repository
RDFServiceSparql(String readEndpointURI, String updateEndpointURI) Returns an RDFService for a remote repository
RDFServiceSparql(String readEndpointURI, String updateEndpointURI, String defaultWriteGraphURI) Returns an RDFService for a remote repository

Method Summary

Modifier and Type	Method and Description
boolean	changeSetUpdate(ChangeSet changeSet) Perform a series of additions to and or removals from specified graphs in the RDF store.
void	close() Frees any resources held by this RDFService object The implementation of this method should be idempotent so that multiple invocations do not cause an error.
protected void	executeUpdate(String updateString)
protected org.apache.http.protocol.HttpContext	getContext(org.apache.http.client.methods.HttpRequestBase request)
protected org.apache.http.auth.UsernamePasswordCredentials	getCredentials()
String	getDefaultWriteGraphURI() Get the URI of the default write graph
void	getGraphMetadata() To be determined.
List<String>	getGraphURIs() Get a list of all the graph URIs in the RDF store.
protected String	getReadEndpointURI()
protected String	getUpdateEndpointURI()
boolean	isEquivalentGraph(String graphURI, InputStream serializedGraph, RDFService.ModelSerializationFormat serializationFormat) The basic version.
boolean	isEquivalentGraph(String graphURI, org.apache.jena.rdf.model.Model graph) The basic version.
protected boolean	isPreconditionSatisfied(String query, RDFService.SPARQLQueryType queryType)
ChangeSet	manufactureChangeSet() Create a ChangeSet object
boolean	preferPreciseOptionals()
void	registerListener(ChangeListener changeListener) Register a listener to listen to changes in any graph in the RDF store.
void	serializeAll(OutputStream outputStream) Serializes the union of all named and unnamed graphs in the store to the supplied OutputStream, in N-Quads format.
void	serializeGraph(String graphURI, OutputStream outputStream) Serializes the contents of the named graph to the supplied OutputStream, in N-Triples format.
boolean	sparqlAskQuery(String queryStr) Performs a SPARQL ASK query against the knowledge base.
void	sparqlConstructQuery(String queryStr, org.apache.jena.rdf.model.Model model) Performs a SPARQL construct query against the knowledge base.
InputStream	sparqlConstructQuery(String queryStr, RDFService.ModelSerializationFormat resultFormat) Performs a SPARQL construct query against the knowledge base.
InputStream	sparqlDescribeQuery(String queryStr, RDFService.ModelSerializationFormat resultFormat) Performs a SPARQL describe query against the knowledge base.
InputStream	sparqlSelectQuery(String queryStr, RDFService.ResultFormat resultFormat) Performs a SPARQL select query against the knowledge base.
void	sparqlSelectQuery(String queryStr, ResultSetConsumer consumer) Performs a SPARQL select query against the knowledge base.
protected boolean	sparqlSelectQueryHasResults(String queryStr)
protected void	testConnection()
void	unregisterListener(ChangeListener changeListener) Unregister a listener from listening to changes in any graph in the RDF store.

Methods inherited from class edu.cornell.mannlib.vitro.webapp.rdfservice.impl.RDFServiceImpl

countTriples, createQuery, getRegisteredJenaModelChangedListeners, getRegisteredListeners, getSerializationFormatString, getTriples, getVitroRequest, newIndividual, newIndividual, notifyListeners, notifyListenersOfChanges, notifyListenersOfEvent, pyString, registerJenaModelChangedListener, separateStatementsWithBlankNodes, setVitroRequest, sparqlNode, sparqlNodeUpdate, sparqlTriple, toString, unregisterJenaModelChangedListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.cornell.mannlib.vitro.webapp.rdfservice.RDFService

countTriples, getTriples, getVitroRequest, newIndividual, newIndividual, registerJenaModelChangedListener, setVitroRequest, unregisterJenaModelChangedListener

Field Detail

readEndpointURI

protected String readEndpointURI

updateEndpointURI

protected String updateEndpointURI

httpClient

protected org.apache.http.client.HttpClient httpClient

rebuildGraphURICache

protected boolean rebuildGraphURICache

Constructor Detail

RDFServiceSparql

public RDFServiceSparql(String readEndpointURI,
                        String updateEndpointURI,
                        String defaultWriteGraphURI)

Returns an RDFService for a remote repository

Parameters:

readEndpointURI - - URI of the read SPARQL endpoint for the knowledge base

updateEndpointURI - - URI of the update SPARQL endpoint for the knowledge base

defaultWriteGraphURI - - URI of the default write graph within the knowledge base. this is the graph that will be written to when a graph is not explicitly specified. The default read graph is the union of all graphs in the knowledge base

RDFServiceSparql

public RDFServiceSparql(String readEndpointURI,
                        String updateEndpointURI)

Returns an RDFService for a remote repository

Parameters:

readEndpointURI - - URI of the read SPARQL endpoint for the knowledge base

updateEndpointURI - - URI of the update SPARQL endpoint for the knowledge base The default read graph is the union of all graphs in the knowledge base

RDFServiceSparql

public RDFServiceSparql(String endpointURI)

Returns an RDFService for a remote repository

Parameters:

endpointURI - - URI of the read and update SPARQL endpoint for the knowledge base The default read graph is the union of all graphs in the knowledge base

Method Detail

testConnection

protected void testConnection()

close

public void close()

Description copied from interface: RDFService

Frees any resources held by this RDFService object The implementation of this method should be idempotent so that multiple invocations do not cause an error.

Specified by:

close in interface RDFService

changeSetUpdate

public boolean changeSetUpdate(ChangeSet changeSet)
                        throws RDFServiceException

Perform a series of additions to and or removals from specified graphs in the RDF store. preConditionSparql will be executed against the union of all the graphs in the knowledge base before any updates are made. If the precondition query returns a non-empty result no updates will be made.

Specified by:

changeSetUpdate in interface RDFService

Parameters:

changeSet - - a set of changes to be performed on the RDF store.

Returns:

boolean - indicates whether the precondition was satisfied

Throws:

RDFServiceException

sparqlConstructQuery

public InputStream sparqlConstructQuery(String queryStr,
                                        RDFService.ModelSerializationFormat resultFormat)
                                 throws RDFServiceException

Performs a SPARQL construct query against the knowledge base. The query may have an embedded graph identifier.

Specified by:

sparqlConstructQuery in interface RDFService

Parameters:

queryStr - - the SPARQL query to be executed against the RDF store

resultFormat - - type of serialization for RDF result of the SPARQL query

Returns:

InputStream - the result of the query

Throws:

RDFServiceException

sparqlConstructQuery

public void sparqlConstructQuery(String queryStr,
                                 org.apache.jena.rdf.model.Model model)
                          throws RDFServiceException

Description copied from interface: RDFService

Performs a SPARQL construct query against the knowledge base. The query may have an embedded graph identifier. If the query does not contain a graph identifier the query is executed against the union of all named and unnamed graphs in the store.

Specified by:

sparqlConstructQuery in interface RDFService

Parameters:

queryStr - - the SPARQL query to be executed against the RDF store

model - - the Model to add the statements to

Throws:

RDFServiceException

sparqlDescribeQuery

public InputStream sparqlDescribeQuery(String queryStr,
                                       RDFService.ModelSerializationFormat resultFormat)
                                throws RDFServiceException

Performs a SPARQL describe query against the knowledge base. The query may have an embedded graph identifier.

Specified by:

sparqlDescribeQuery in interface RDFService

Parameters:

queryStr - - the SPARQL query to be executed against the RDF store

resultFormat - - type of serialization for RDF result of the SPARQL query

Returns:

InputStream - the result of the query

Throws:

RDFServiceException

sparqlSelectQuery

public InputStream sparqlSelectQuery(String queryStr,
                                     RDFService.ResultFormat resultFormat)
                              throws RDFServiceException

Performs a SPARQL select query against the knowledge base. The query may have an embedded graph identifier.

Specified by:

sparqlSelectQuery in interface RDFService

Parameters:

queryStr - - the SPARQL query to be executed against the RDF store

resultFormat - - format for the result of the Select query

Returns:

InputStream - the result of the query

Throws:

RDFServiceException

sparqlSelectQuery

public void sparqlSelectQuery(String queryStr,
                              ResultSetConsumer consumer)
                       throws RDFServiceException

Description copied from interface: RDFService

Performs a SPARQL select query against the knowledge base. The query may have an embedded graph identifier. If the query does not contain a graph identifier the query is executed against the union of all named and unnamed graphs in the store.

Specified by:

sparqlSelectQuery in interface RDFService

Parameters:

queryStr - - the SPARQL query to be executed against the RDF store

consumer - - the class to consume the results of the query

Throws:

RDFServiceException

sparqlAskQuery

public boolean sparqlAskQuery(String queryStr)
                       throws RDFServiceException

Performs a SPARQL ASK query against the knowledge base. The query may have an embedded graph identifier.

Specified by:

sparqlAskQuery in interface RDFService

Parameters:

queryStr - - the SPARQL query to be executed against the RDF store

Returns:

boolean - the result of the SPARQL query

Throws:

RDFServiceException

getGraphURIs

public List<String> getGraphURIs()
                          throws RDFServiceException

Get a list of all the graph URIs in the RDF store.

Specified by:

getGraphURIs in interface RDFService

Returns:

list of all the named graph URIs in the RDF store. Return an empty list of there no named graphs in the store.

Throws:

RDFServiceException

getGraphMetadata

public void getGraphMetadata()
                      throws RDFServiceException

Description copied from interface: RDFService

To be determined. This is a place holder and is not implemented in current implementations.

Specified by:

getGraphMetadata in interface RDFService

Throws:

RDFServiceException

getDefaultWriteGraphURI

public String getDefaultWriteGraphURI()
                               throws RDFServiceException

Get the URI of the default write graph

Specified by:

getDefaultWriteGraphURI in interface RDFService

Overrides:

getDefaultWriteGraphURI in class RDFServiceImpl

Returns:

String URI of default write graph

Throws:

RDFServiceException

registerListener

public void registerListener(ChangeListener changeListener)
                      throws RDFServiceException

Register a listener to listen to changes in any graph in the RDF store.

Specified by:

registerListener in interface RDFService

Overrides:

registerListener in class RDFServiceImpl

Parameters:

changeListener - - the change listener

Throws:

RDFServiceException

unregisterListener

public void unregisterListener(ChangeListener changeListener)
                        throws RDFServiceException

Unregister a listener from listening to changes in any graph in the RDF store.

Specified by:

unregisterListener in interface RDFService

Overrides:

unregisterListener in class RDFServiceImpl

Parameters:

changeListener - - the change listener

Throws:

RDFServiceException

manufactureChangeSet

public ChangeSet manufactureChangeSet()

Create a ChangeSet object

Specified by:

manufactureChangeSet in interface RDFService

Overrides:

manufactureChangeSet in class RDFServiceImpl

Returns:

a ChangeSet object

getReadEndpointURI

protected String getReadEndpointURI()

getUpdateEndpointURI

protected String getUpdateEndpointURI()

executeUpdate

protected void executeUpdate(String updateString)
                      throws RDFServiceException

Throws:

RDFServiceException

isPreconditionSatisfied

protected boolean isPreconditionSatisfied(String query,
                                          RDFService.SPARQLQueryType queryType)
                                   throws RDFServiceException

Overrides:

isPreconditionSatisfied in class RDFServiceImpl

Throws:

RDFServiceException

sparqlSelectQueryHasResults

protected boolean sparqlSelectQueryHasResults(String queryStr)
                                       throws RDFServiceException

Overrides:

sparqlSelectQueryHasResults in class RDFServiceImpl

Throws:

RDFServiceException

serializeAll

public void serializeAll(OutputStream outputStream)
                  throws RDFServiceException

Description copied from interface: RDFService

Serializes the union of all named and unnamed graphs in the store to the supplied OutputStream, in N-Quads format. This method is designed for exporting data from VIVO, so any filters should be bypassed. If possible, this should be done without buffering in memory, so arbitrarily large graphs can be exported.

Specified by:

serializeAll in interface RDFService

Parameters:

outputStream - - receives the serialized result.

Throws:

RDFServiceException

serializeGraph

public void serializeGraph(String graphURI,
                           OutputStream outputStream)
                    throws RDFServiceException

Description copied from interface: RDFService

Serializes the contents of the named graph to the supplied OutputStream, in N-Triples format. This method is designed for exporting data from VIVO, so any filters should be bypassed. If possible, this should be done without buffering in memory, so arbitrarily large graphs can be exported.

Specified by:

serializeGraph in interface RDFService

Parameters:

graphURI - - the URI of the desired graph. May not be null.

outputStream - - receives the serialized result.

Throws:

RDFServiceException

isEquivalentGraph

public boolean isEquivalentGraph(String graphURI,
                                 InputStream serializedGraph,
                                 RDFService.ModelSerializationFormat serializationFormat)
                          throws RDFServiceException

The basic version. Parse the model from the file, read the model from the tripleStore, and ask whether they are isomorphic.

Specified by:

isEquivalentGraph in interface RDFService

Parameters:

graphURI - - the URI of the graph to test against. May not be null.

serializedGraph - - the contents to be compared with the existing graph. May not be null.

serializationFormat - - May not be null.

Throws:

RDFServiceException

isEquivalentGraph

public boolean isEquivalentGraph(String graphURI,
                                 org.apache.jena.rdf.model.Model graph)
                          throws RDFServiceException

The basic version. Parse the model from the file, read the model from the tripleStore, and ask whether they are isomorphic.

Specified by:

isEquivalentGraph in interface RDFService

Parameters:

graphURI - - the URI of the graph to test against. May not be null.

graph - - the contents to be compared with the existing graph. May not be null.

Throws:

RDFServiceException

preferPreciseOptionals

public boolean preferPreciseOptionals()

Specified by:

preferPreciseOptionals in interface RDFService

getContext

protected org.apache.http.protocol.HttpContext getContext(org.apache.http.client.methods.HttpRequestBase request)

getCredentials

protected org.apache.http.auth.UsernamePasswordCredentials getCredentials()