Package io.deephaven.engine.util

Class AbstractScriptSession<S extends AbstractScriptSession.Snapshot>

java.lang.Object

io.deephaven.util.referencecounting.ReferenceCounted

io.deephaven.engine.liveness.ReferenceCountedLivenessReferent

io.deephaven.engine.liveness.ReferenceCountedLivenessNode

io.deephaven.engine.liveness.LivenessScope

io.deephaven.engine.util.AbstractScriptSession<S>

All Implemented Interfaces:

LogOutputAppendable, LivenessManager, LivenessNode, LivenessReferent, ReleasableLivenessManager, ScriptSession, VariableProvider, Serializable

Direct Known Subclasses:

GroovyDeephavenSession, NoLanguageDeephavenSession, PythonDeephavenSession

public abstract class AbstractScriptSession<S extends AbstractScriptSession.Snapshot>
extends LivenessScope
implements ScriptSession, VariableProvider

This class exists to make all script sessions to be liveness artifacts, and provide a default implementation for evaluateScript which handles liveness and diffs in a consistent way.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractScriptSession.ScriptSessionQueryScope
protected static interface	AbstractScriptSession.Snapshot
static class	AbstractScriptSession.SynchronizedScriptSessionQueryScope
static class	AbstractScriptSession.UnsynchronizedScriptSessionQueryScope

Nested classes/interfaces inherited from interface io.deephaven.engine.util.ScriptSession

ScriptSession.Changes, ScriptSession.Listener

Field Summary

Fields

Modifier and Type	Field	Description
protected final ExecutionContext	executionContext

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractScriptSession(UpdateGraph updateGraph, OperationInitializer operationInitializer, ObjectTypeLookup objectTypeLookup, @Nullable ScriptSession.Listener changeListener)

Method Summary

Modifier and Type	Method	Description
protected void	applyVariableChangeToDiff(ScriptSession.Changes diff, String name, @Nullable Object fromValue, @Nullable Object toValue)
protected abstract ScriptSession.Changes	createDiff(S from, S to, RuntimeException e)
static void	createScriptCache()
protected void	destroy()	Attempt to release (destructively when necessary) resources held by this object.
protected abstract S	emptySnapshot()
protected abstract void	evaluate(String command, @Nullable String scriptName)	Evaluates command in the context of the current ScriptSession.
final ScriptSession.Changes	evaluateScript(String script, @Nullable String scriptName)	Evaluates the script and manages liveness of objects that are exported to the user.
ScriptSession.Changes	evaluateScript(Path scriptPath)	Evaluates the script and manages liveness of objects that are exported to the user.
ExecutionContext	getExecutionContext()	Obtain an ExecutionContext instance for the current script session.
TableDefinition	getTableDefinition(String var)
VariableProvider	getVariableProvider()	A VariableProvider instance, for services like autocomplete which may want a limited "just the variables" view of our session state.
Class<?>	getVariableType(String var)
protected abstract QueryScope	newQueryScope()
void	observeScopeChanges()	Observe (and report via onScopeChanges) any changes to this ScriptSession's QueryScope that may have been made externally, rather than during script evaluation.
protected void	publishInitial()
protected abstract S	takeSnapshot()

Methods inherited from class io.deephaven.engine.liveness.LivenessScope

release, transferTo

Methods inherited from class io.deephaven.engine.liveness.ReferenceCountedLivenessNode

getWeakReference, initializeTransientFieldsForLiveness, onReferenceCountAtZero, tryManage, tryUnmanage, tryUnmanage

Methods inherited from class io.deephaven.engine.liveness.ReferenceCountedLivenessReferent

dropReference, tryRetainReference

Methods inherited from class io.deephaven.util.referencecounting.ReferenceCounted

append, decrementReferenceCount, forceReferenceCountToZero, getReferenceCountDebug, incrementReferenceCount, resetReferenceCount, toString, tryDecrementReferenceCount, tryIncrementReferenceCount

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.deephaven.engine.liveness.LivenessManager

manage, tryManage

Methods inherited from interface io.deephaven.engine.liveness.LivenessNode

tryUnmanage, tryUnmanage, unmanage, unmanage

Methods inherited from interface io.deephaven.engine.liveness.LivenessReferent

dropReference, getReferentDescription, getWeakReference, retainReference, tryRetainReference

Methods inherited from interface io.deephaven.engine.liveness.ReleasableLivenessManager

release

Methods inherited from interface io.deephaven.engine.util.ScriptSession

evaluateScript, getVariable, getVariable, getVariableNames, getVariables, hasVariableName, sanitizeThrowable, scriptType, setVariable, unwrapObject

Methods inherited from interface io.deephaven.engine.util.VariableProvider

getVariable, getVariableNames

Field Details

executionContext

protected final ExecutionContext executionContext

Constructor Details

AbstractScriptSession

protected AbstractScriptSession(UpdateGraph updateGraph,
 OperationInitializer operationInitializer,
 ObjectTypeLookup objectTypeLookup,
 @Nullable
 @Nullable ScriptSession.Listener changeListener)

Method Details

createScriptCache

public static void createScriptCache()

getExecutionContext

public ExecutionContext getExecutionContext()

Description copied from interface: ScriptSession

Obtain an ExecutionContext instance for the current script session. This is the execution context that is used when executing scripts.

Specified by:

getExecutionContext in interface ScriptSession

publishInitial

protected void publishInitial()

observeScopeChanges

public void observeScopeChanges()

Description copied from interface: ScriptSession

Observe (and report via onScopeChanges) any changes to this ScriptSession's QueryScope that may have been made externally, rather than during script evaluation.

Specified by:

observeScopeChanges in interface ScriptSession

emptySnapshot

protected abstract S emptySnapshot()

takeSnapshot

protected abstract S takeSnapshot()

createDiff

protected abstract ScriptSession.Changes createDiff(S from,
 S to,
 RuntimeException e)

evaluateScript

public final ScriptSession.Changes evaluateScript(String script,
 @Nullable
 @Nullable String scriptName)

Description copied from interface: ScriptSession

Evaluates the script and manages liveness of objects that are exported to the user. This method should be called from the serial executor as it manipulates static state.

Specified by:

evaluateScript in interface ScriptSession

Parameters:

script - the code to execute

scriptName - an optional script name, which may be ignored by the implementation, or used improve error messages or for other internal purposes

Returns:

the changes made to the exportable objects

applyVariableChangeToDiff

protected void applyVariableChangeToDiff(ScriptSession.Changes diff,
 String name,
 @Nullable
 @Nullable Object fromValue,
 @Nullable
 @Nullable Object toValue)

evaluateScript

public ScriptSession.Changes evaluateScript(Path scriptPath)

Description copied from interface: ScriptSession

Evaluates the script and manages liveness of objects that are exported to the user. This method should be called from the serial executor as it manipulates static state.

Specified by:

evaluateScript in interface ScriptSession

Parameters:

scriptPath - the path to the script to execute

Returns:

the changes made to the exportable objects

destroy

protected void destroy()

Description copied from class: ReferenceCountedLivenessReferent

Attempt to release (destructively when necessary) resources held by this object. This may render the object unusable for subsequent operations. Implementations should be sure to call super.destroy().

This is intended to only ever be used as a side effect of decreasing the reference count to 0.

Overrides:

destroy in class ReferenceCountedLivenessReferent

evaluate

protected abstract void evaluate(String command,
 @Nullable
 @Nullable String scriptName)

Evaluates command in the context of the current ScriptSession.

Parameters:

command - the command to evaluate

scriptName - an optional script name, which may be ignored by the implementation, or used improve error messages or for other internal purposes

newQueryScope

protected abstract QueryScope newQueryScope()

Returns:

a query scope for this session; only invoked during construction

getVariableType

public Class<?> getVariableType(String var)

Specified by:

getVariableType in interface VariableProvider

getTableDefinition

public TableDefinition getTableDefinition(String var)

Specified by:

getTableDefinition in interface VariableProvider

getVariableProvider

public VariableProvider getVariableProvider()

Description copied from interface: ScriptSession

A VariableProvider instance, for services like autocomplete which may want a limited "just the variables" view of our session state.

Specified by:

getVariableProvider in interface ScriptSession

Returns:

a VariableProvider instance backed by the global/binding context of this script session.