- All Implemented Interfaces:
AutoCloseable
,QueryExecution
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionvoid
abort()
Stop in mid execution.void
close()
Close the query execution and stop query evaluation as soon as convenient.static QueryExecution
compatibility
(QueryExecMod qExec, Dataset dataset, Query query, String queryString) boolean
execAsk()
Execute an ASK queryExecute a CONSTRUCT queryexecConstruct
(Model model) Execute a CONSTRUCT query, putting the statements into a graph.Execute a CONSTRUCT query, putting the statements into 'dataset'.execConstructDataset
(Dataset dataset) Execute a CONSTRUCT query, putting the statements into 'dataset'.Execute a CONSTRUCT query, returning the results as an iterator ofQuad
.Execute a CONSTRUCT query, returning the results as an iterator ofTriple
.Execute a DESCRIBE queryexecDescribe
(Model model) Execute a DESCRIBE query, putting the statements into a graph.Execute a DESCRIBE query, returning the results as an iterator ofTriple
.execJson()
Execute a JSON query and return a json arrayExecute a JSON query and return an iteratorExecute a SELECT queryThe properties associated with a query execution - implementation specific parameters This includes Java objects (so it is not an RDF graph).The dataset against which the query will execute.getQuery()
The query associated with a query execution.long
Return the first timeout (time to first result), in milliseconds: negative if unsetlong
Return the second timeout (overall query execution after first result), in milliseconds: negative if unsetboolean
isClosed()
Answer whether this QueryExecution object has been closed or not.void
setInitialBinding
(QuerySolution querySolution) Set the initial association of variables and values.void
setInitialBinding
(Binding binding) Set the initial association of variables and values.void
setTimeout
(long timeout) Set time, in millisecondsvoid
setTimeout
(long timeout1, long timeout2) Set time, in millisecondsvoid
setTimeout
(long timeout, TimeUnit timeoutUnits) Set a timeout on the query execution.void
setTimeout
(long timeout1, TimeUnit timeUnit1, long timeout2, TimeUnit timeUnit2) Set timeouts on the query execution; the first timeout refers to time to first result, the second refers to overall query execution after the first result.Methods inherited from class org.apache.jena.sparql.exec.QueryExecutionAdapter
adapt, getQueryString
-
Method Details
-
compatibility
public static QueryExecution compatibility(QueryExecMod qExec, Dataset dataset, Query query, String queryString) -
setInitialBinding
Description copied from class:QueryExecutionAdapter
Set the initial association of variables and values. May not be supported by all QueryExecution implementations.- Specified by:
setInitialBinding
in interfaceQueryExecution
- Overrides:
setInitialBinding
in classQueryExecutionAdapter
-
getDataset
Description copied from class:QueryExecutionAdapter
The dataset against which the query will execute. May be null, implying it is expected that the query itself has a dataset description.- Specified by:
getDataset
in interfaceQueryExecution
- Overrides:
getDataset
in classQueryExecutionAdapter
-
getContext
Description copied from class:QueryExecutionAdapter
The properties associated with a query execution - implementation specific parameters This includes Java objects (so it is not an RDF graph). Keys should be URIs as strings. May be null (this implementation does not provide any configuration).- Specified by:
getContext
in interfaceQueryExecution
- Overrides:
getContext
in classQueryExecutionAdapter
-
getQuery
Description copied from class:QueryExecutionAdapter
The query associated with a query execution. May be null (QueryExecution may have been created by other means)- Specified by:
getQuery
in interfaceQueryExecution
- Overrides:
getQuery
in classQueryExecutionAdapter
-
execSelect
Description copied from class:QueryExecutionAdapter
Execute a SELECT queryImportant: The name of this method is somewhat of a misnomer in that depending on the underlying implementation this typically does not execute the SELECT query but rather answers a wrapper over an internal data structure that can be used to answer the query. In essence calling this method only returns a plan for executing this query which only gets evaluated when you actually start iterating over the results.
- Specified by:
execSelect
in interfaceQueryExecution
- Overrides:
execSelect
in classQueryExecutionAdapter
-
execConstruct
Description copied from class:QueryExecutionAdapter
Execute a CONSTRUCT query- Specified by:
execConstruct
in interfaceQueryExecution
- Overrides:
execConstruct
in classQueryExecutionAdapter
-
execConstruct
Description copied from class:QueryExecutionAdapter
Execute a CONSTRUCT query, putting the statements into a graph.- Specified by:
execConstruct
in interfaceQueryExecution
- Overrides:
execConstruct
in classQueryExecutionAdapter
- Returns:
- Graph The model argument for cascaded code.
-
execConstructTriples
Description copied from class:QueryExecutionAdapter
Execute a CONSTRUCT query, returning the results as an iterator ofTriple
.Caution: This method may return duplicate Triples. This method may be useful if you only need the results for stream processing, as it can avoid having to place the results in a Model.
Important: The name of this method is somewhat of a misnomer in that depending on the underlying implementation this typically does not execute the CONSTRUCT query but rather answers a wrapper over an internal data structure that can be used to answer the query. In essence calling this method only returns a plan for executing this query which only gets evaluated when you actually start iterating over the results.
- Specified by:
execConstructTriples
in interfaceQueryExecution
- Overrides:
execConstructTriples
in classQueryExecutionAdapter
- Returns:
- An iterator of Triple objects (possibly containing duplicates) generated by applying the CONSTRUCT template of the query to the bindings in the WHERE clause.
-
execConstructQuads
Description copied from class:QueryExecutionAdapter
Execute a CONSTRUCT query, returning the results as an iterator ofQuad
.Caution: This method may return duplicate Quads. This method may be useful if you only need the results for stream processing, as it can avoid having to place the results in a Model.
An iterator of Quad objects (possibly containing duplicates) generated by applying the CONSTRUCT template of the query to the bindings in the WHERE clause.
See
QueryExecutionAdapter.execConstructTriples()
for usage and features.- Specified by:
execConstructQuads
in interfaceQueryExecution
- Overrides:
execConstructQuads
in classQueryExecutionAdapter
- Returns:
- An iterator of Quad objects (possibly containing duplicates) generated by applying the CONSTRUCT template of the query to the bindings in the WHERE clause.
-
execConstructDataset
Description copied from class:QueryExecutionAdapter
Execute a CONSTRUCT query, putting the statements into 'dataset'. This maybe an extended syntax query (if supported).- Specified by:
execConstructDataset
in interfaceQueryExecution
- Overrides:
execConstructDataset
in classQueryExecutionAdapter
-
execConstructDataset
Description copied from class:QueryExecutionAdapter
Execute a CONSTRUCT query, putting the statements into 'dataset'. This may be an extended syntax query (if supported).- Specified by:
execConstructDataset
in interfaceQueryExecution
- Overrides:
execConstructDataset
in classQueryExecutionAdapter
-
execDescribe
Description copied from class:QueryExecutionAdapter
Execute a DESCRIBE query- Specified by:
execDescribe
in interfaceQueryExecution
- Overrides:
execDescribe
in classQueryExecutionAdapter
-
execDescribe
Description copied from class:QueryExecutionAdapter
Execute a DESCRIBE query, putting the statements into a graph.- Specified by:
execDescribe
in interfaceQueryExecution
- Overrides:
execDescribe
in classQueryExecutionAdapter
- Returns:
- Graph The model argument for cascaded code.
-
execDescribeTriples
Description copied from class:QueryExecutionAdapter
Execute a DESCRIBE query, returning the results as an iterator ofTriple
.Caution: This method may return duplicate Triples. This method may be useful if you only need the results for stream processing, as it can avoid having to place the results in a Model.
Important: The name of this method is somewhat of a misnomer in that depending on the underlying implementation this typically does not execute the DESCRIBE query but rather answers a wrapper over an internal data structure that can be used to answer the query. In essence calling this method only returns a plan for executing this query which only gets evaluated when you actually start iterating over the results.
- Specified by:
execDescribeTriples
in interfaceQueryExecution
- Overrides:
execDescribeTriples
in classQueryExecutionAdapter
- Returns:
- An iterator of Triple objects (possibly containing duplicates) generated as the output of the DESCRIBE query.
-
execAsk
public boolean execAsk()Description copied from class:QueryExecutionAdapter
Execute an ASK query- Specified by:
execAsk
in interfaceQueryExecution
- Overrides:
execAsk
in classQueryExecutionAdapter
-
execJson
Description copied from class:QueryExecutionAdapter
Execute a JSON query and return a json array- Specified by:
execJson
in interfaceQueryExecution
- Overrides:
execJson
in classQueryExecutionAdapter
-
execJsonItems
Description copied from class:QueryExecutionAdapter
Execute a JSON query and return an iterator- Specified by:
execJsonItems
in interfaceQueryExecution
- Overrides:
execJsonItems
in classQueryExecutionAdapter
-
abort
public void abort()Description copied from class:QueryExecutionAdapter
Stop in mid execution. This method can be called in parallel with other methods on the QueryExecution object. There is no guarantee that the concrete implementation actual will stop or that it will do so immediately. No operations on the query execution or any associated result set are permitted after this call and may cause exceptions to be thrown.- Specified by:
abort
in interfaceQueryExecution
- Overrides:
abort
in classQueryExecutionAdapter
-
close
public void close()Description copied from class:QueryExecutionAdapter
Close the query execution and stop query evaluation as soon as convenient. QueryExecution objects, and aResultSet
fromQueryExecutionAdapter.execSelect()
, can not be used once the QueryExecution is closed. Model results fromQueryExecutionAdapter.execConstruct()
andQueryExecutionAdapter.execDescribe()
are still valid. It is important to close query execution objects in order to release resources such as working memory and to stop the query execution. Some storage subsystems require explicit ends of operations and this operation will cause those to be called where necessary. No operations on the query execution or any associated result set are permitted after this call.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceQueryExecution
- Overrides:
close
in classQueryExecutionAdapter
-
isClosed
public boolean isClosed()Description copied from class:QueryExecutionAdapter
Answer whether this QueryExecution object has been closed or not.- Specified by:
isClosed
in interfaceQueryExecution
- Overrides:
isClosed
in classQueryExecutionAdapter
- Returns:
- boolean
-
setTimeout
Description copied from class:QueryExecutionAdapter
Set a timeout on the query execution. Processing will be aborted after the timeout (which starts when the appropriate exec call is made). Not all query execution systems support timeouts. A timeout of less than zero means no timeout.- Specified by:
setTimeout
in interfaceQueryExecution
- Overrides:
setTimeout
in classQueryExecutionAdapter
- See Also:
-
setTimeout
public void setTimeout(long timeout) Description copied from class:QueryExecutionAdapter
Set time, in milliseconds- Specified by:
setTimeout
in interfaceQueryExecution
- Overrides:
setTimeout
in classQueryExecutionAdapter
- See Also:
-
setTimeout
Description copied from class:QueryExecutionAdapter
Set timeouts on the query execution; the first timeout refers to time to first result, the second refers to overall query execution after the first result. Processing will be aborted if a timeout expires. Not all query execution systems support timeouts. A timeout of less than zero means no timeout; this can be used for timeout1 or timeout2.- Specified by:
setTimeout
in interfaceQueryExecution
- Overrides:
setTimeout
in classQueryExecutionAdapter
-
setTimeout
public void setTimeout(long timeout1, long timeout2) Description copied from class:QueryExecutionAdapter
Set time, in milliseconds- Specified by:
setTimeout
in interfaceQueryExecution
- Overrides:
setTimeout
in classQueryExecutionAdapter
- See Also:
-
getTimeout1
public long getTimeout1()Description copied from class:QueryExecutionAdapter
Return the first timeout (time to first result), in milliseconds: negative if unset- Specified by:
getTimeout1
in interfaceQueryExecution
- Overrides:
getTimeout1
in classQueryExecutionAdapter
-
getTimeout2
public long getTimeout2()Description copied from class:QueryExecutionAdapter
Return the second timeout (overall query execution after first result), in milliseconds: negative if unset- Specified by:
getTimeout2
in interfaceQueryExecution
- Overrides:
getTimeout2
in classQueryExecutionAdapter
-
setInitialBinding
Description copied from interface:QueryExecution
Set the initial association of variables and values. May not be supported by all QueryExecution implementations.The preferred way is to use
QueryExecutionDatasetBuilder.substitution(QuerySolution)
which is supported uniformly for local and remote queries.- Specified by:
setInitialBinding
in interfaceQueryExecution
- Overrides:
setInitialBinding
in classQueryExecutionAdapter
-