Package io.deephaven.engine.util

Class NoLanguageDeephavenSession

java.lang.Object

io.deephaven.util.referencecounting.ReferenceCounted

io.deephaven.engine.liveness.ReferenceCountedLivenessReferent

io.deephaven.engine.liveness.ReferenceCountedLivenessNode

io.deephaven.engine.liveness.LivenessArtifact

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

io.deephaven.engine.util.NoLanguageDeephavenSession

All Implemented Interfaces:

LogOutputAppendable, LivenessManager, LivenessNode, LivenessReferent, ScriptSession, Serializable

public class NoLanguageDeephavenSession
extends AbstractScriptSession<AbstractScriptSession.Snapshot>

ScriptSession implementation that simply allows variables to be exported. This is not intended for use in user scripts.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class io.deephaven.engine.util.AbstractScriptSession

AbstractScriptSession.ScriptSessionQueryScope, AbstractScriptSession.Snapshot

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

ScriptSession.Changes, ScriptSession.Listener

Field Summary

Fields inherited from class io.deephaven.engine.util.AbstractScriptSession

classCacheDirectory, executionContext

Constructor Summary

Constructors

Constructor	Description
NoLanguageDeephavenSession(UpdateGraph updateGraph, OperationInitializer operationInitializer)
NoLanguageDeephavenSession(UpdateGraph updateGraph, OperationInitializer operationInitializer, String scriptType)

Method Summary

Modifier and Type	Method	Description
protected ScriptSession.Changes	createDiff(AbstractScriptSession.Snapshot from, AbstractScriptSession.Snapshot to, RuntimeException e)
protected AbstractScriptSession.Snapshot	emptySnapshot()
protected void	evaluate(String command, @Nullable String scriptName)	Evaluates command in the context of the current ScriptSession.
protected <T> Map<String,T>	getAllValues(@Nullable Function<Object,T> valueMapper, @NotNull QueryScope.ParamFilter<T> filter)	Returns a mutable map with all known variables and their values.
protected <T> T	getVariable(String name)	Retrieve a variable from the script session's bindings.
protected Set<String>	getVariableNames()	Retrieves all variable names present in the session's scope.
protected boolean	hasVariable(String name)	Check if the scope has the given variable name.
String	scriptType()
protected Object	setVariable(String name, @Nullable Object newValue)	Inserts a value into the script's scope.
protected AbstractScriptSession.Snapshot	takeSnapshot()

Methods inherited from class io.deephaven.engine.util.AbstractScriptSession

applyVariableChangeToDiff, createScriptCache, destroy, evaluateScript, evaluateScript, getExecutionContext, getQueryScope, newClassCacheLocation, observeScopeChanges, publishInitial

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

manageWithCurrentScope

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.util.ScriptSession

evaluateScript, sanitizeThrowable, unwrapObject

Constructor Details

NoLanguageDeephavenSession

public NoLanguageDeephavenSession(UpdateGraph updateGraph,
 OperationInitializer operationInitializer)

NoLanguageDeephavenSession

public NoLanguageDeephavenSession(UpdateGraph updateGraph,
 OperationInitializer operationInitializer,
 String scriptType)

Method Details

getVariable

protected <T> T getVariable(String name)

Description copied from class: AbstractScriptSession

Retrieve a variable from the script session's bindings. Values may need to be unwrapped.

Specified by:

getVariable in class AbstractScriptSession<AbstractScriptSession.Snapshot>

Parameters:

name - the name of the variable to retrieve

Returns:

the variable value

emptySnapshot

protected AbstractScriptSession.Snapshot emptySnapshot()

Specified by:

emptySnapshot in class AbstractScriptSession<AbstractScriptSession.Snapshot>

takeSnapshot

protected AbstractScriptSession.Snapshot takeSnapshot()

Specified by:

takeSnapshot in class AbstractScriptSession<AbstractScriptSession.Snapshot>

createDiff

protected ScriptSession.Changes createDiff(AbstractScriptSession.Snapshot from,
 AbstractScriptSession.Snapshot to,
 RuntimeException e)

Specified by:

createDiff in class AbstractScriptSession<AbstractScriptSession.Snapshot>

evaluate

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

Description copied from class: AbstractScriptSession

Evaluates command in the context of the current ScriptSession.

Specified by:

evaluate in class AbstractScriptSession<AbstractScriptSession.Snapshot>

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

getVariableNames

protected Set<String> getVariableNames()

Description copied from class: AbstractScriptSession

Retrieves all variable names present in the session's scope.

Specified by:

getVariableNames in class AbstractScriptSession<AbstractScriptSession.Snapshot>

Returns:

a caller-owned mutable set of variable names

hasVariable

protected boolean hasVariable(String name)

Description copied from class: AbstractScriptSession

Check if the scope has the given variable name.

Specified by:

hasVariable in class AbstractScriptSession<AbstractScriptSession.Snapshot>

Parameters:

name - the variable name

Returns:

True iff the scope has the given variable name

setVariable

protected Object setVariable(String name,
 @Nullable
 @Nullable Object newValue)

Description copied from class: AbstractScriptSession

Inserts a value into the script's scope.

Specified by:

setVariable in class AbstractScriptSession<AbstractScriptSession.Snapshot>

Parameters:

name - the variable name to set

newValue - the new value of the variable

Returns:

the old value for this name, if any. As with AbstractScriptSession.getVariable(String), may need to be unwrapped.

getAllValues

protected <T> Map<String,T> getAllValues(@Nullable
 @Nullable Function<Object,T> valueMapper,
 @NotNull QueryScope.ParamFilter<T> filter)

Description copied from class: AbstractScriptSession

Returns a mutable map with all known variables and their values.

Callers may want to pass in a valueMapper of ScriptSession.unwrapObject(Object) which would unwrap values before filtering. The returned map is owned by the caller.

Specified by:

getAllValues in class AbstractScriptSession<AbstractScriptSession.Snapshot>

Type Parameters:

T - the type of the mapped values

Parameters:

valueMapper - a function to map the values

filter - a predicate to filter the map entries

Returns:

a caller-owned mutable map with all known variables and their mapped values. As with AbstractScriptSession.getVariable(String), values may need to be unwrapped.

scriptType

public String scriptType()

Returns:

a textual description of this script session's language for use in messages.