Package io.deephaven.engine.util

Class AbstractScriptSession.SynchronizedScriptSessionQueryScope

java.lang.Object

io.deephaven.engine.context.QueryScope

io.deephaven.engine.util.AbstractScriptSession.ScriptSessionQueryScope

io.deephaven.engine.util.AbstractScriptSession.UnsynchronizedScriptSessionQueryScope

io.deephaven.engine.util.AbstractScriptSession.SynchronizedScriptSessionQueryScope

All Implemented Interfaces:

LogOutputAppendable

Enclosing class:

AbstractScriptSession<S extends AbstractScriptSession.Snapshot>

public static class AbstractScriptSession.SynchronizedScriptSessionQueryScope
extends AbstractScriptSession.UnsynchronizedScriptSessionQueryScope

Nested Class Summary

Nested classes/interfaces inherited from class io.deephaven.engine.context.QueryScope

QueryScope.MissingVariableException, QueryScope.StandaloneImpl

Constructor Summary

Constructors

Constructor	Description
SynchronizedScriptSessionQueryScope(@NotNull ScriptSession scriptSession)

Method Summary

Modifier and Type	Method	Description
protected <T> QueryScopeParam<T>	createParam(String name)	Get a QueryScopeParam by name.
Set<String>	getParamNames()	Get all known scope variable names.
boolean	hasParamName(String name)	Check if the scope has the given name.
<T> void	putParam(String name, T value)	Add a parameter to the scope.
<T> T	readParamValue(String name)	Get the value of a given scope parameter by name.
<T> T	readParamValue(String name, T defaultValue)	Get the value of a given scope parameter by name.

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

putObjectFields, scriptSession

Methods inherited from class io.deephaven.engine.context.QueryScope

addObjectFields, addParam, append, getParams, getParamValue

Methods inherited from class java.lang.Object

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

Constructor Details

SynchronizedScriptSessionQueryScope

public SynchronizedScriptSessionQueryScope(@NotNull
 @NotNull ScriptSession scriptSession)

Method Details

getParamNames

public Set<String> getParamNames()

Description copied from class: QueryScope

Get all known scope variable names.

Overrides:

getParamNames in class AbstractScriptSession.UnsynchronizedScriptSessionQueryScope

Returns:

A collection of scope variable names.

hasParamName

public boolean hasParamName(String name)

Description copied from class: QueryScope

Check if the scope has the given name.

Overrides:

hasParamName in class AbstractScriptSession.UnsynchronizedScriptSessionQueryScope

Parameters:

name - param name

Returns:

True iff the scope has the given param name

createParam

protected <T> QueryScopeParam<T> createParam(String name)
                                      throws QueryScope.MissingVariableException

Description copied from class: QueryScope

Get a QueryScopeParam by name.

Overrides:

createParam in class AbstractScriptSession.UnsynchronizedScriptSessionQueryScope

Parameters:

name - parameter name

Returns:

newly-constructed QueryScopeParam (name + value-snapshot pair).

Throws:

QueryScope.MissingVariableException - If any of the named scope variables does not exist.

readParamValue

public <T> T readParamValue(String name)
                     throws QueryScope.MissingVariableException

Description copied from class: QueryScope

Get the value of a given scope parameter by name.

Overrides:

readParamValue in class AbstractScriptSession.UnsynchronizedScriptSessionQueryScope

Parameters:

name - parameter name.

Returns:

parameter value.

Throws:

QueryScope.MissingVariableException - If no such scope parameter exists.

readParamValue

public <T> T readParamValue(String name,
 T defaultValue)

Description copied from class: QueryScope

Get the value of a given scope parameter by name.

Overrides:

readParamValue in class AbstractScriptSession.UnsynchronizedScriptSessionQueryScope

Parameters:

name - parameter name.

defaultValue - default parameter value.

Returns:

parameter value, or the default parameter value, if the value is not present.

putParam

public <T> void putParam(String name,
 T value)

Description copied from class: QueryScope

Add a parameter to the scope.

Overrides:

putParam in class AbstractScriptSession.UnsynchronizedScriptSessionQueryScope

Parameters:

name - parameter name.

value - parameter value.