com.illumon.iris.db.tables.select

Class QueryScope

java.lang.Object

com.illumon.iris.db.tables.select.QueryScope

All Implemented Interfaces:

com.fishlib.base.log.LogOutputAppendable

public abstract class QueryScope
extends Object
implements com.fishlib.base.log.LogOutputAppendable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryScope.MissingVariableException
static class	QueryScope.ScriptSessionImpl
static class	QueryScope.StandaloneImpl

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIENT_HOST_PARAM_NAME
static String	QUERY_NAME_PARAM_NAME

Constructor Summary

Constructors

Constructor and Description
QueryScope()

Method Summary

Modifier and Type	Method and Description
static void	addObjectFields(Object object)
static <T> void	addParam(String name, T value)
com.fishlib.base.log.LogOutput	append(com.fishlib.base.log.LogOutput logOutput)
protected abstract <T> Param<T>	createParam(String name) Get a Param by name.
String	getClientHost()
static QueryScope	getDefaultInstance()
abstract Map<String,Object>	getLocalValuesForRemoteParams() Get a snapshot of local values for remote parameters, for scopes that support this.
abstract Set<String>	getParamNames() Get all known scope variable names.
Param[]	getParams(Collection<String> names) Get an array of Params by name.
static <T> T	getParamValue(String name)
String	getQueryName()
abstract void	putObjectFields(Object object) Add an object's public members (referenced reflectively, not a shallow copy!) to this scope if supported.
abstract <T> void	putParam(String name, T value) Add a name + value pair to the scope.
abstract void	putRemoteParams(Map<String,Class> remoteParamMetadata) Add remote parameter metadata, for scopes that support this.
abstract <T> T	readParamValue(String name) Get the value of a given scope variable by name.
abstract <T> T	readParamValue(String name, T defaultValue) Get the value of a given scope variable by name.
void	setClientHost(String clientHost)
static void	setDefaultInstance(QueryScope queryScope)
void	setQueryName(String queryName)

Methods inherited from class java.lang.Object

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

Field Detail

CLIENT_HOST_PARAM_NAME

public static final String CLIENT_HOST_PARAM_NAME

See Also:

Constant Field Values

QUERY_NAME_PARAM_NAME

public static final String QUERY_NAME_PARAM_NAME

See Also:

Constant Field Values

Constructor Detail

QueryScope

public QueryScope()

Method Detail

setDefaultInstance

public static void setDefaultInstance(@NotNull
                                      QueryScope queryScope)

getDefaultInstance

public static QueryScope getDefaultInstance()

addParam

public static <T> void addParam(String name,
                                T value)

addObjectFields

public static void addObjectFields(Object object)

getParamValue

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

Throws:

QueryScope.MissingVariableException

getParams

public final Param[] getParams(Collection<String> names)
                        throws QueryScope.MissingVariableException

Get an array of Params by name. See createParam(name) implementations for details.

Parameters:

names -

Returns:

A newly-constructed array of newly-constructed Params.

Throws:

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

getParamNames

public abstract Set<String> getParamNames()

Get all known scope variable names.

Returns:

A collection of scope variable names.

createParam

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

Get a Param by name.

Parameters:

name -

Returns:

A newly-constructed Param (name + value-snapshot pair).

Throws:

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

readParamValue

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

Get the value of a given scope variable by name.

Parameters:

name -

Returns:

The value of the specified scope variable.

Throws:

QueryScope.MissingVariableException - If no such scope variable exists.

readParamValue

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

Get the value of a given scope variable by name.

Parameters:

name -

defaultValue -

Returns:

The value of the specified scope variable, or defaultValue if the scope has no such variable.

putParam

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

Add a name + value pair to the scope.

Parameters:

name -

value -

putRemoteParams

public abstract void putRemoteParams(Map<String,Class> remoteParamMetadata)

Add remote parameter metadata, for scopes that support this. Note: This is an optional method.

Parameters:

remoteParamMetadata -

getLocalValuesForRemoteParams

public abstract Map<String,Object> getLocalValuesForRemoteParams()

Get a snapshot of local values for remote parameters, for scopes that support this. Note: This is an optional method.

Returns:

A map from name to the current local value for all remote params.

putObjectFields

public abstract void putObjectFields(Object object)

Add an object's public members (referenced reflectively, not a shallow copy!) to this scope if supported. Note: This is an optional method.

getClientHost

public final String getClientHost()

setClientHost

public void setClientHost(String clientHost)

getQueryName

public String getQueryName()

setQueryName

public void setQueryName(String queryName)

append

public com.fishlib.base.log.LogOutput append(@NotNull
                                             com.fishlib.base.log.LogOutput logOutput)

Specified by:

append in interface com.fishlib.base.log.LogOutputAppendable