Package io.deephaven.engine.context

Class ExecutionContext.Builder

java.lang.Object

io.deephaven.engine.context.ExecutionContext.Builder

Enclosing class:

ExecutionContext

public static class ExecutionContext.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
ExecutionContext	build()
ExecutionContext.Builder	captureQueryCompiler()	Use the current ExecutionContext's QueryCompiler instance.
ExecutionContext.Builder	captureQueryLibrary()	Use the current ExecutionContext's QueryLibrary instance.
ExecutionContext.Builder	captureQueryScope()	Use the current ExecutionContext's QueryScope instance.
ExecutionContext.Builder	captureQueryScopeVars(String... vars)	Instantiate a new QueryScope and initialize with values from the current ExecutionContext.
ExecutionContext.Builder	captureUpdateGraph()	Deprecated, for removal: This API element is subject to removal in a future version. The update graph is automatically captured, this method should no longer be needed.
ExecutionContext.Builder	emptyQueryScope()	Use a query scope that is immutably empty.
ExecutionContext.Builder	markSystemic()	A systemic execution context is one that is supplied by the system and not the user.
ExecutionContext.Builder	newQueryLibrary()	Instantiate an empty query library.
ExecutionContext.Builder	newQueryLibrary(String libraryVersion)	Instantiate an empty query library using the provided libraryVersion.
ExecutionContext.Builder	newQueryScope()	Instantiate a new query scope.
ExecutionContext.Builder	setOperationInitializer(OperationInitializer operationInitializer)	Use the specified operation initializer instead of the captured instance.
ExecutionContext.Builder	setQueryCompiler(QueryCompiler queryCompiler)	Use the provided QueryCompiler
ExecutionContext.Builder	setQueryLibrary(QueryLibrary queryLibrary)	Use the provided QueryLibrary.
ExecutionContext.Builder	setQueryScope(QueryScope queryScope)	Use the provided QueryScope.
ExecutionContext.Builder	setUpdateGraph(UpdateGraph updateGraph)	Use the provided UpdateGraph.

Methods inherited from class java.lang.Object

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

Method Details

markSystemic

@ScriptApi
public ExecutionContext.Builder markSystemic()

A systemic execution context is one that is supplied by the system and not the user. A systemic context will not be recorded when work is deferred.

newQueryLibrary

@ScriptApi
public ExecutionContext.Builder newQueryLibrary()

Instantiate an empty query library.

newQueryLibrary

@ScriptApi
public ExecutionContext.Builder newQueryLibrary(String libraryVersion)

Instantiate an empty query library using the provided libraryVersion. This is useful for testing.

setQueryLibrary

@ScriptApi
public ExecutionContext.Builder setQueryLibrary(QueryLibrary queryLibrary)

Use the provided QueryLibrary.

captureQueryLibrary

@ScriptApi
public ExecutionContext.Builder captureQueryLibrary()

Use the current ExecutionContext's QueryLibrary instance.

setQueryCompiler

@ScriptApi
public ExecutionContext.Builder setQueryCompiler(QueryCompiler queryCompiler)

Use the provided QueryCompiler

captureQueryCompiler

@ScriptApi
public ExecutionContext.Builder captureQueryCompiler()

Use the current ExecutionContext's QueryCompiler instance.

emptyQueryScope

@ScriptApi
public ExecutionContext.Builder emptyQueryScope()

Use a query scope that is immutably empty.

newQueryScope

@ScriptApi
public ExecutionContext.Builder newQueryScope()

Instantiate a new query scope.

setQueryScope

@ScriptApi
public ExecutionContext.Builder setQueryScope(QueryScope queryScope)

Use the provided QueryScope.

captureQueryScope

@ScriptApi
public ExecutionContext.Builder captureQueryScope()

Use the current ExecutionContext's QueryScope instance.

ApiNote:

This captures a reference to the current, likely mutable, query scope state. Future changes to the query scope may cause deferred operations to fail. Additionally, there is risk of GC leakage should the query scope be otherwise unreachable.

captureQueryScopeVars

@ScriptApi
public ExecutionContext.Builder captureQueryScopeVars(String... vars)

Instantiate a new QueryScope and initialize with values from the current ExecutionContext.

Parameters:

vars - the variable names to copy from the current ExecutionContext's QueryScope

setUpdateGraph

@ScriptApi
public ExecutionContext.Builder setUpdateGraph(UpdateGraph updateGraph)

Use the provided UpdateGraph.

captureUpdateGraph

@ScriptApi
@Deprecated(forRemoval=true,
            since="0.31")
public ExecutionContext.Builder captureUpdateGraph()

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

The update graph is automatically captured, this method should no longer be needed.

Use the current ExecutionContext's UpdateGraph instance.

setOperationInitializer

@ScriptApi
public ExecutionContext.Builder setOperationInitializer(OperationInitializer operationInitializer)

Use the specified operation initializer instead of the captured instance.

build

@ScriptApi
public ExecutionContext build()

Returns:

the newly instantiated ExecutionContext