Module org.apache.jena.arq

Package org.apache.jena.sparql.engine

Class ExecutionContext

java.lang.Object

org.apache.jena.sparql.engine.ExecutionContext

All Implemented Interfaces:

FunctionEnv

public final class ExecutionContext
extends Object
implements FunctionEnv

Method Summary

Modifier and Type	Method	Description
void	checkCancelSignal()	Deprecated, for removal: This API element is subject to removal in a future version. This rarely the right way to handle cancellation.
void	closedIterator(QueryIterator qIter)
static ExecutionContext	copyChangeActiveGraph(ExecutionContext other, org.apache.jena.graph.Graph activeGraph)	Clone and change active graph - shares tracking
static ExecutionContext	copyChangeExecutor(ExecutionContext other, OpExecutorFactory opExecutorFactory)	Clone and change OpExecutor - shares tracking
static ExecutionContext	create(DatasetGraph dataset)	ExecutionContext for normal execution over a dataset, with defaults for Context and OpExecutorFactory.
static ExecutionContext	create(DatasetGraph dataset, org.apache.jena.graph.Graph activeGraph)	ExecutionContext for normal execution over a dataset, with defaults for Context and OpExecutorFactory.
static ExecutionContext	create(DatasetGraph dataset, org.apache.jena.graph.Graph activeGraph, Context context)	ExecutionContext for normal execution over a dataset.
static ExecutionContext	create(DatasetGraph dataset, Context context)	ExecutionContext for normal execution over a dataset, with default for OpExecutorFactory.
static ExecutionContext	create(Context context)	ExecutionContext for execution without a dataset, with default for OpExecutorFactory.
static ExecutionContext	createForGraph(org.apache.jena.graph.Graph graph)	ExecutionContext for normal execution over a graph, with defaults for Context and OpExecutorFactory.
static ExecutionContext	createForGraph(org.apache.jena.graph.Graph graph, Context cxt)	ExecutionContext for normal execution over a graph.
static ExecutionContext	fromFunctionEnv(FunctionEnv functionEnv)	Create ExecutionContext from FunctionEnv
org.apache.jena.graph.Graph	getActiveGraph()	Return the active graph (the one matching is against at this point in the query.
AtomicBoolean	getCancelSignal()
Context	getContext()	Return the context for this function call
DatasetGraph	getDataset()	Return the dataset for the query execution.
OpExecutorFactory	getExecutor()
Iterator<QueryIterator>	listAllIterators()
Iterator<QueryIterator>	listOpenIterators()
void	openIterator(QueryIterator qIter)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

fromFunctionEnv

public static ExecutionContext fromFunctionEnv(FunctionEnv functionEnv)

Create ExecutionContext from FunctionEnv

copyChangeActiveGraph

public static ExecutionContext copyChangeActiveGraph(ExecutionContext other,
 org.apache.jena.graph.Graph activeGraph)

Clone and change active graph - shares tracking

copyChangeExecutor

public static ExecutionContext copyChangeExecutor(ExecutionContext other,
 OpExecutorFactory opExecutorFactory)

Clone and change OpExecutor - shares tracking

create

public static ExecutionContext create(DatasetGraph dataset)

ExecutionContext for normal execution over a dataset, with defaults for Context and OpExecutorFactory.

create

public static ExecutionContext create(DatasetGraph dataset,
 Context context)

ExecutionContext for normal execution over a dataset, with default for OpExecutorFactory.

create

public static ExecutionContext create(Context context)

ExecutionContext for execution without a dataset, with default for OpExecutorFactory.

create

public static ExecutionContext create(DatasetGraph dataset,
 org.apache.jena.graph.Graph activeGraph)

ExecutionContext for normal execution over a dataset, with defaults for Context and OpExecutorFactory.

create

public static ExecutionContext create(DatasetGraph dataset,
 org.apache.jena.graph.Graph activeGraph,
 Context context)

ExecutionContext for normal execution over a dataset.

createForGraph

public static ExecutionContext createForGraph(org.apache.jena.graph.Graph graph)

ExecutionContext for normal execution over a graph, with defaults for Context and OpExecutorFactory.

createForGraph

public static ExecutionContext createForGraph(org.apache.jena.graph.Graph graph,
 Context cxt)

ExecutionContext for normal execution over a graph.

getContext

public Context getContext()

Description copied from interface: FunctionEnv

Return the context for this function call

Specified by:

getContext in interface FunctionEnv

getCancelSignal

public AtomicBoolean getCancelSignal()

checkCancelSignal

@Deprecated(forRemoval=true)
public void checkCancelSignal()

Deprecated, for removal: This API element is subject to removal in a future version.

This rarely the right way to handle cancellation. Either getCancelSignal() check the flag, take action and throw QueryCancelledException or let the query iterator machinery in QueryIteratorBase deal with it when no additional action is required.

Check the cancel signal and throw QueryCancelledException} if it is true.

openIterator

public void openIterator(QueryIterator qIter)

closedIterator

public void closedIterator(QueryIterator qIter)

listOpenIterators

public Iterator<QueryIterator> listOpenIterators()

listAllIterators

public Iterator<QueryIterator> listAllIterators()

getExecutor

public OpExecutorFactory getExecutor()

getDataset

public DatasetGraph getDataset()

Return the dataset for the query execution.

Specified by:

getDataset in interface FunctionEnv

getActiveGraph

public org.apache.jena.graph.Graph getActiveGraph()

Return the active graph (the one matching is against at this point in the query. May be null if unknown or not applicable - for example, doing quad store access or when sorting.

Specified by:

getActiveGraph in interface FunctionEnv