Module org.apache.jena.rdfconnection

Package org.apache.jena.rdflink

Interface RDFLink

All Superinterfaces:

java.lang.AutoCloseable, LinkDatasetGraph, LinkDatasetGraphAccess, LinkSparqlQuery, LinkSparqlUpdate, Transactional

All Known Implementing Classes:

RDFLinkAdapter, RDFLinkDataset, RDFLinkFuseki, RDFLinkHTTP, RDFLinkModular

public interface RDFLink
extends LinkSparqlQuery, LinkSparqlUpdate, LinkDatasetGraph, Transactional, java.lang.AutoCloseable

Interface for SPARQL operations on a dataset, whether local or remote. Operations can be performed via this interface or via the various interfaces for a subset of the operations.

• query (LinkSparqlQuery)
• update (LinkSparqlUpdate)
• graph store protocol (LinkDatasetGraph and read-only LinkDatasetGraphAccess).

For remote operations, the SPARQL Protocol is used for query and updates and SPARQL Graph Store Protocol for the graph operations and in addition, there are analogous operations on datasets (fetch, load, put; but not delete). RDFLink provides transaction boundaries. If not in a transaction, an implicit transactional wrapper is applied ("autocommit"). Remote SPARQL operations are atomic but without additional capabilities from the remote server, multiple operations are not combined into a single transaction. Not all implementations may implement all operations. See the implementation notes for details.

See Also:

RDFConnection, RDFLinkFactory, RDFLinkDataset, RDFLinkHTTP, LinkSparqlQuery, LinkSparqlUpdate, LinkDatasetGraph

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.jena.sparql.core.Transactional

Transactional.Promote

Method Summary

Modifier and Type	Method	Description
void	clearDataset()	Clear the dataset - remove all named graphs, clear the default graph.
void	close()	Close this connection.
void	delete()	Remove all data from the default graph.
void	delete(Node graphName)	Delete a graph from the dataset.
Graph	get()	Fetch the default graph.
Graph	get(Node graphName)	Fetch a named graph.
boolean	isClosed()	Test whether this connection is closed or not
default boolean	isRemote()	Whether this RDFLink is to a remote server or not.
void	load(java.lang.String file)	Send file - this merges the file RDF into the default graph of a dataset.
void	load(Graph graph)	Load (add, append) RDF into the default graph of a dataset.
void	load(Node graphName, java.lang.String file)	Load (add, append) RDF into a named graph in a dataset.
void	load(Node graphName, Graph graph)	Load (add, append) RDF into a named graph in a dataset.
void	loadDataset(java.lang.String file)
void	loadDataset(DatasetGraph dataset)
QueryExecBuilder	newQuery()	Return a QueryExecBuilder that is initially configured for this link setup and type.
void	put(java.lang.String file)	Set the contents of the default graph of a dataset.
void	put(Graph graph)	Set the contents of the default graph of a dataset.
void	put(Node graphName, java.lang.String file)	Set the contents of a named graph of a dataset.
void	put(Node graphName, Graph graph)	Set the contents of a named graph of a dataset.
void	putDataset(java.lang.String file)
void	putDataset(DatasetGraph dataset)
default QueryExec	query(java.lang.String queryString)	Setup a SPARQL query execution.
QueryExec	query(Query query)	Setup a SPARQL query execution.
default boolean	queryAsk(java.lang.String queryString)	Execute a ASK query and return a boolean
default boolean	queryAsk(Query query)	Execute a ASK query and return a boolean
default Graph	queryConstruct(java.lang.String queryString)	Execute a CONSTRUCT query and return as a Graph
default Graph	queryConstruct(Query query)	Execute a CONSTRUCT query and return as a Graph
default DatasetGraph	queryConstructDataset(java.lang.String queryString)	Execute a CONSTRUCT query and return as a Graph
default DatasetGraph	queryConstructDataset(Query query)	Execute a CONSTRUCT query and return as a DatasetGraph
default Graph	queryDescribe(java.lang.String queryString)	Execute a DESCRIBE query and return as a Graph
default Graph	queryDescribe(Query query)	Execute a DESCRIBE query and return as a Graph
default void	queryRowSet(java.lang.String queryString, java.util.function.Consumer<RowSet> rowSetAction)	Execute a SELECT query and process the RowSet with the handler code.
default void	queryRowSet(Query query, java.util.function.Consumer<RowSet> rowSetAction)	Execute a SELECT query and process the RowSet with the handler code.
default void	querySelect(java.lang.String queryString, java.util.function.Consumer<Binding> rowAction)	Execute a SELECT query and process the rows of the results with the handler code.
default void	querySelect(Query query, java.util.function.Consumer<Binding> rowAction)	Execute a SELECT query and process the rows of the results with the handler code.
default void	update(java.lang.String updateString)	Execute a SPARQL Update.
default void	update(Update update)	Execute a SPARQL Update.
void	update(UpdateRequest update)	Execute a SPARQL Update.

Methods inherited from interface org.apache.jena.rdflink.LinkDatasetGraphAccess

getDataset

Methods inherited from interface org.apache.jena.sparql.core.Transactional

abort, begin, begin, begin, calc, calculate, calculateRead, calculateWrite, commit, end, exec, execute, executeRead, executeWrite, isInTransaction, promote, promote, transactionMode, transactionType

Method Detail

queryRowSet

default void queryRowSet(java.lang.String queryString,
                         java.util.function.Consumer<RowSet> rowSetAction)

Execute a SELECT query and process the RowSet with the handler code.

Specified by:

queryRowSet in interface LinkSparqlQuery

Parameters:

queryString -

rowSetAction -

queryRowSet

default void queryRowSet(Query query,
                         java.util.function.Consumer<RowSet> rowSetAction)

Execute a SELECT query and process the RowSet with the handler code.

Specified by:

queryRowSet in interface LinkSparqlQuery

Parameters:

query -

rowSetAction -

querySelect

default void querySelect(java.lang.String queryString,
                         java.util.function.Consumer<Binding> rowAction)

Execute a SELECT query and process the rows of the results with the handler code.

Specified by:

querySelect in interface LinkSparqlQuery

Parameters:

queryString -

rowAction -

querySelect

default void querySelect(Query query,
                         java.util.function.Consumer<Binding> rowAction)

Execute a SELECT query and process the rows of the results with the handler code.

Specified by:

querySelect in interface LinkSparqlQuery

Parameters:

query -

rowAction -

queryConstruct

default Graph queryConstruct(java.lang.String queryString)

Execute a CONSTRUCT query and return as a Graph

Specified by:

queryConstruct in interface LinkSparqlQuery

queryConstructDataset

default DatasetGraph queryConstructDataset(Query query)

Execute a CONSTRUCT query and return as a DatasetGraph

queryConstructDataset

default DatasetGraph queryConstructDataset(java.lang.String queryString)

Execute a CONSTRUCT query and return as a Graph

queryConstruct

default Graph queryConstruct(Query query)

Execute a CONSTRUCT query and return as a Graph

Specified by:

queryConstruct in interface LinkSparqlQuery

queryDescribe

default Graph queryDescribe(java.lang.String queryString)

Execute a DESCRIBE query and return as a Graph

Specified by:

queryDescribe in interface LinkSparqlQuery

queryDescribe

default Graph queryDescribe(Query query)

Execute a DESCRIBE query and return as a Graph

Specified by:

queryDescribe in interface LinkSparqlQuery

queryAsk

default boolean queryAsk(java.lang.String queryString)

Execute a ASK query and return a boolean

Specified by:

queryAsk in interface LinkSparqlQuery

queryAsk

default boolean queryAsk(Query query)

Execute a ASK query and return a boolean

Specified by:

queryAsk in interface LinkSparqlQuery

query

QueryExec query(Query query)

Setup a SPARQL query execution. See also querySelect(Query, Consumer), queryConstruct(Query), queryDescribe(Query), queryAsk(Query) for ways to execute queries for of a specific form.

Specified by:

query in interface LinkSparqlQuery

Parameters:

query -

Returns:

QueryExecution

query

default QueryExec query(java.lang.String queryString)

Setup a SPARQL query execution.

This is a low-level operation. Handling the QueryExecution should be done with try-resource. Some QueryExecutions, such as ones connecting to a remote server, need to be properly closed to release system resources.

See also querySelect(String, Consumer), queryConstruct(String), queryDescribe(String), queryAsk(String) for ways to execute queries of a specific form.

Specified by:

query in interface LinkSparqlQuery

Parameters:

queryString -

Returns:

QueryExecution

newQuery

QueryExecBuilder newQuery()

Return a QueryExecBuilder that is initially configured for this link setup and type. The query built will be set to go to the same dataset/remote endpoint as the other RDFLink operations.

Specified by:

newQuery in interface LinkSparqlQuery

Returns:

QueryExecBuilder

update

default void update(Update update)

Execute a SPARQL Update.

Specified by:

update in interface LinkSparqlUpdate

Parameters:

update -

update

void update(UpdateRequest update)

Execute a SPARQL Update.

Specified by:

update in interface LinkSparqlUpdate

Parameters:

update -

update

default void update(java.lang.String updateString)

Execute a SPARQL Update.

Specified by:

update in interface LinkSparqlUpdate

Parameters:

updateString -

get

Graph get()

Fetch the default graph. This is SPARQL Graph Store Protocol HTTP GET or equivalent.

Specified by:

get in interface LinkDatasetGraphAccess

Returns:

Graph

get

Graph get(Node graphName)

Fetch a named graph. This is SPARQL Graph Store Protocol HTTP GET or equivalent.

Specified by:

get in interface LinkDatasetGraphAccess

Parameters:

graphName - URI string for the graph name (null or Quad.defaultGraphIRI for the default graph)

Returns:

Graph

load

void load(java.lang.String file)

Send file - this merges the file RDF into the default graph of a dataset. This is SPARQL Graph Store Protocol HTTP POST or equivalent.

If this is a remote connection:

• The file is sent as-is and not parsed in the RDFLink
• The Content-Type is determined by the filename

Specified by:

load in interface LinkDatasetGraph

Parameters:

file - File of the data.

load

void load(Node graphName,
          java.lang.String file)

Load (add, append) RDF into a named graph in a dataset. This is SPARQL Graph Store Protocol HTTP POST or equivalent.

If this is a remote connection:

• The file is sent as-is and not parsed in the RDFLink
• The Content-Type is determined by the filename

Specified by:

load in interface LinkDatasetGraph

Parameters:

graphName - Graph name (null or Quad.defaultGraphIRI for the default graph)

file - File of the data.

load

void load(Graph graph)

Load (add, append) RDF into the default graph of a dataset. This is SPARQL Graph Store Protocol HTTP POST or equivalent.

Specified by:

load in interface LinkDatasetGraph

Parameters:

graph - Data.

load

void load(Node graphName,
          Graph graph)

Load (add, append) RDF into a named graph in a dataset. This is SPARQL Graph Store Protocol HTTP POST or equivalent.

Specified by:

load in interface LinkDatasetGraph

Parameters:

graphName - Graph name (null or Quad.defaultGraphIRI for the default graph)

graph - Data.

put

void put(java.lang.String file)

Set the contents of the default graph of a dataset. Any existing data is lost. This is SPARQL Graph Store Protocol HTTP PUT or equivalent.

If this is a remote connection:

• The file is sent as-is and not parsed in the RDFLink
• The Content-Type is determined by the filename

Specified by:

put in interface LinkDatasetGraph

Parameters:

file - File of the data.

put

void put(Node graphName,
         java.lang.String file)

Set the contents of a named graph of a dataset. Any existing data is lost. This is SPARQL Graph Store Protocol HTTP PUT or equivalent.

Specified by:

put in interface LinkDatasetGraph

Parameters:

graphName - Graph name (null or Quad.defaultGraphIRI for the default graph)

file - File of the data.

put

void put(Graph graph)

Set the contents of the default graph of a dataset. Any existing data is lost. This is SPARQL Graph Store Protocol HTTP PUT or equivalent.

If this is a remote connection:

• The file is sent as-is and not parsed in the RDFLink
• The Content-Type is determined by the filename

Specified by:

put in interface LinkDatasetGraph

Parameters:

graph - Data.

put

void put(Node graphName,
         Graph graph)

Set the contents of a named graph of a dataset. Any existing data is lost. This is SPARQL Graph Store Protocol HTTP PUT or equivalent.

Specified by:

put in interface LinkDatasetGraph

Parameters:

graphName - Graph name (null or Quad.defaultGraphIRI for the default graph)

graph - Data.

delete

void delete(Node graphName)

Delete a graph from the dataset. Null or Quad.defaultGraphIRI means the default graph, which is cleared, not removed.

Specified by:

delete in interface LinkDatasetGraph

Parameters:

graphName -

delete

void delete()

Remove all data from the default graph.

Specified by:

delete in interface LinkDatasetGraph

loadDataset

void loadDataset(java.lang.String file)

Specified by:

loadDataset in interface LinkDatasetGraph

loadDataset

void loadDataset(DatasetGraph dataset)

Specified by:

loadDataset in interface LinkDatasetGraph

putDataset

void putDataset(java.lang.String file)

Specified by:

putDataset in interface LinkDatasetGraph

putDataset

void putDataset(DatasetGraph dataset)

Specified by:

putDataset in interface LinkDatasetGraph

clearDataset

void clearDataset()

Clear the dataset - remove all named graphs, clear the default graph.

Specified by:

clearDataset in interface LinkDatasetGraph

isClosed

boolean isClosed()

Test whether this connection is closed or not

Specified by:

isClosed in interface LinkDatasetGraph

Specified by:

isClosed in interface LinkDatasetGraphAccess

isRemote

default boolean isRemote()

Whether this RDFLink is to a remote server or not.

close

void close()

Close this connection. Use with try-resource.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface LinkDatasetGraph

Specified by:

close in interface LinkDatasetGraphAccess

Specified by:

close in interface LinkSparqlQuery

Specified by:

close in interface LinkSparqlUpdate