Package io.deephaven.engine.util

Class GroovyDeephavenSession

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<GroovyDeephavenSession.GroovySnapshot>

io.deephaven.engine.util.GroovyDeephavenSession

All Implemented Interfaces:

LogOutputAppendable, LivenessManager, LivenessNode, LivenessReferent, ScriptSession, Serializable

public class GroovyDeephavenSession
extends AbstractScriptSession<GroovyDeephavenSession.GroovySnapshot>

Groovy ScriptSession. Not safe for concurrent use.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GroovyDeephavenSession.Base
static class	GroovyDeephavenSession.Calendars
static class	GroovyDeephavenSession.CountMetrics
static interface	GroovyDeephavenSession.GroovyImport	Represents an import that can be added to an ImportCustomizer, as a valid return from createImport(String).
protected static class	GroovyDeephavenSession.GroovySnapshot
static interface	GroovyDeephavenSession.InitScript
static class	GroovyDeephavenSession.RunScripts

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

Modifier and Type	Field	Description
static final String	SCRIPT_TYPE

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

classCacheDirectory, executionContext

Method Summary

Modifier and Type	Method	Description
void	addScriptImportClass(Class<?> c)
void	addScriptImportClass(String c)
void	addScriptImportStatic(Class<?> c)
void	addScriptImportStatic(String c)
protected ScriptSession.Changes	createDiff(GroovyDeephavenSession.GroovySnapshot from, GroovyDeephavenSession.GroovySnapshot to, RuntimeException e)
Optional<GroovyDeephavenSession.GroovyImport>	createImport(String importString)	Ensure that the given importString is valid.
protected GroovyDeephavenSession.GroovySnapshot	emptySnapshot()
protected void	evaluate(String command, String scriptName)	Evaluates command in the context of the current ScriptSession.
static InputStream	findScript(String relativePath)
protected <T> Map<String,T>	getAllValues(@Nullable Function<Object,T> valueMapper, QueryScope.ParamFilter<T> filter)	Returns a mutable map with all known variables and their values.
groovy.lang.Binding	getBinding()
groovy.lang.GroovyShell	getShell()
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.
boolean	hasExecutedScript(String scriptName)
protected boolean	hasVariable(String name)	Check if the scope has the given variable name.
static GroovyDeephavenSession	of(UpdateGraph updateGraph, OperationInitializer operationInitializer, ObjectTypeLookup objectTypeLookup, @Nullable ScriptSession.Listener changeListener, GroovyDeephavenSession.RunScripts runScripts)
static GroovyDeephavenSession	of(UpdateGraph updateGraph, OperationInitializer operationInitializer, ObjectTypeLookup objectTypeLookup, GroovyDeephavenSession.RunScripts runScripts)
static String	removeComments(String s)	Remove comments from an import statement.
void	runScript(String script)
void	runScriptOnce(String script)
Throwable	sanitizeThrowable(Throwable e)	If this script session can throw unserializable exceptions, this method is responsible for turning those exceptions into something suitable for sending back to a client.
String	scriptType()
protected Object	setVariable(String name, @Nullable Object newValue)	Inserts a value into the script's scope.
protected GroovyDeephavenSession.GroovySnapshot	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, 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, unwrapObject

Field Details

SCRIPT_TYPE

public static final String SCRIPT_TYPE

See Also:

• Constant Field Values

Method Details

of

public static GroovyDeephavenSession of(UpdateGraph updateGraph,
 OperationInitializer operationInitializer,
 ObjectTypeLookup objectTypeLookup,
 GroovyDeephavenSession.RunScripts runScripts)
                                 throws IOException

Throws:

IOException

of

public static GroovyDeephavenSession of(UpdateGraph updateGraph,
 OperationInitializer operationInitializer,
 ObjectTypeLookup objectTypeLookup,
 @Nullable
 @Nullable ScriptSession.Listener changeListener,
 GroovyDeephavenSession.RunScripts runScripts)
                                 throws IOException

Throws:

IOException

findScript

public static InputStream findScript(String relativePath)
                              throws IOException

Throws:

IOException

runScript

public void runScript(String script)
               throws IOException

Throws:

IOException

hasExecutedScript

public boolean hasExecutedScript(String scriptName)

runScriptOnce

public void runScriptOnce(String script)
                   throws IOException

Throws:

IOException

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<GroovyDeephavenSession.GroovySnapshot>

Parameters:

name - the name of the variable to retrieve

Returns:

the variable value

evaluate

protected void evaluate(String command,
 String scriptName)

Description copied from class: AbstractScriptSession

Evaluates command in the context of the current ScriptSession.

Specified by:

evaluate in class AbstractScriptSession<GroovyDeephavenSession.GroovySnapshot>

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

removeComments

@VisibleForTesting
public static String removeComments(String s)

Remove comments from an import statement. /* comments take precedence over eol (//) comments. This ignores escaping and quoting, as they are not valid in an import statement.

Parameters:

s - import statement string from which to remove comments

Returns:

the input string with comments removed, and whitespace trimmed

createImport

@VisibleForTesting
public Optional<GroovyDeephavenSession.GroovyImport> createImport(String importString)

Ensure that the given importString is valid. Return a canonical version of the import string if it is valid.

Parameters:

importString - the string to check. importString is "[import] [static] package.class[.innerclass...][.field|.method][.*][;]".

Returns:

null if importString is not valid, else a string of the form "import [static] package.class.part.part[.*];"

addScriptImportClass

public void addScriptImportClass(String c)

addScriptImportClass

public void addScriptImportClass(Class<?> c)

addScriptImportStatic

public void addScriptImportStatic(String c)

addScriptImportStatic

public void addScriptImportStatic(Class<?> c)

emptySnapshot

protected GroovyDeephavenSession.GroovySnapshot emptySnapshot()

Specified by:

emptySnapshot in class AbstractScriptSession<GroovyDeephavenSession.GroovySnapshot>

takeSnapshot

protected GroovyDeephavenSession.GroovySnapshot takeSnapshot()

Specified by:

takeSnapshot in class AbstractScriptSession<GroovyDeephavenSession.GroovySnapshot>

createDiff

protected ScriptSession.Changes createDiff(GroovyDeephavenSession.GroovySnapshot from,
 GroovyDeephavenSession.GroovySnapshot to,
 RuntimeException e)

Specified by:

createDiff in class AbstractScriptSession<GroovyDeephavenSession.GroovySnapshot>

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<GroovyDeephavenSession.GroovySnapshot>

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<GroovyDeephavenSession.GroovySnapshot>

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<GroovyDeephavenSession.GroovySnapshot>

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<GroovyDeephavenSession.GroovySnapshot>

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.

getBinding

public groovy.lang.Binding getBinding()

getShell

public groovy.lang.GroovyShell getShell()

scriptType

public String scriptType()

Returns:

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

sanitizeThrowable

public Throwable sanitizeThrowable(Throwable e)

Description copied from interface: ScriptSession

If this script session can throw unserializable exceptions, this method is responsible for turning those exceptions into something suitable for sending back to a client.

Parameters:

e - the exception to (possibly) sanitize

Returns:

the sanitized exception