com.tangosol.coherence.dslquery

Class ExecutionContext

java.lang.Object

com.tangosol.coherence.dslquery.ExecutionContext

public class ExecutionContext
extends Object

Instances of this context are passed to Statements to allow commands to discern execution conditions, altering their behavior / result as needed. In addition, commands may wish to alter the execution conditions or hold state across executions; the latter is possible via getResourceRegistry().

Since:

Coherence 12.2.1

Author:

jk 2014.07.10

Field Summary

Fields

Modifier and Type	Field and Description
protected ResourceRegistry	f_resourceRegistry The ResourceRegistry used to store various resources used by queries managed by this context.
protected ConfigurableCacheFactory	m_cacheFactory The ConfigurableCacheFactory to use to access caches.
protected Cluster	m_cluster The Cluster to use to access services.
protected StatementExecutor	m_executor The StatementExecutor to use to execute statements.
protected boolean	m_fExtendedLanguage Flag that controls whether we except Map, and List as literals.
protected boolean	m_fSanity A flag that enables sanity checking.
protected boolean	m_fSilent A flag indicating whether the query session is running in silent mode.
protected boolean	m_fStopOnError A flag indicating when true that CohQL should stop processing multiple statements if an error occurs (for example when processing a file), or when false that errors will be logged and statement processing will continue.
protected boolean	m_fTrace Flag that indicates tracing mode.
protected CoherenceQueryLanguage	m_language The CoherenceQueryLanguage to use.
protected BufferedReader	m_reader The reader to use to get user input.
protected String	m_sTitle String to use for Title that heads each result displayed.
protected com.oracle.coherence.common.util.Duration	m_timeout The number of milli-seconds to wait for a Statement to execute before timing out.
protected PrintWriter	m_writer The PrintWriter that can be used by commands to display output.

Constructor Summary

Constructors

Constructor and Description
ExecutionContext() Construct an ExecutionContext.

Method Summary

Modifier and Type	Method and Description
ConfigurableCacheFactory	getCacheFactory() Return the current ConfigurableCacheFactory to be used by commands executed under this context.
Cluster	getCluster() Return the current Cluster to be used by commands executed under this context.
CoherenceQueryLanguage	getCoherenceQueryLanguage() Return an instance of CoherenceQueryLanguage to be used by commands.
BufferedReader	getReader() Return the BufferedReader that can be used to obtain user input, typically from System.in.
ResourceRegistry	getResourceRegistry() Return the ResourceRegistry that may be used to register ad-hoc resources with this context as a way to maintain state between different command executions.
StatementExecutor	getStatementExecutor() Return the StatementExecutor to use to parse and execute statements.
com.oracle.coherence.common.util.Duration	getTimeout() Obtain the number of mill-seconds to wait for a Statement to execute before timing out.
String	getTitle() Return the String to use for title that heads each result.
PrintWriter	getWriter() Return the PrintWriter that can be used by commands to display output.
OPParser	instantiateParser(Reader reader) Instantiate an instance of an OPParser to parse the CohQL statements provided by the specified Reader.
boolean	isExtendedLanguageEnabled() Return whether "Extended Language" features are enabled.
boolean	isSanityChecking() Return whether sanity checking should be enabled when executing commands.
boolean	isSilent() Return true if the current query session is running in silent mode.
boolean	isStopOnError() Return the flag indicating whether CohQL should stop processing multiple statements if an error occurs (for example when processing a file), or whether errors should be logged and statement processing continue.
boolean	isTraceEnabled() Return whether trace to display output when executing commands.
void	setCacheFactory(ConfigurableCacheFactory ccf) Set the current ConfigurableCacheFactory to be used by commands executed under this context.
void	setCluster(Cluster cluster) Set the current Cluster to be used by commands executed under this context.
void	setCoherenceQueryLanguage(CoherenceQueryLanguage language) Set the CoherenceQueryLanguage that will be used by commands.
void	setExtendedLanguage(boolean fExtendedLanguage) Set whether "Extended Language" features are enabled.
void	setReader(BufferedReader reader) Set the BufferedReader that should be used to obtain user input.
void	setSanityCheckingEnabled(boolean fSanity) Set whether sanity checking is enabled when executing commands.
void	setSilentMode(boolean fSilent) Set the flag indicating that the QueryPlus session is running in silent mode.
void	setStatementExecutor(StatementExecutor executor) Set the StatementExecutor to use to parse and execute statements.
void	setStopOnError(boolean fStopOnError) Set the flag indicating whether CohQL should stop processing multiple statements if an error occurs (for example when processing a file), or whether errors should be logged and statement processing continue.
void	setTimeout(com.oracle.coherence.common.util.Duration timeout) Set the Duration to wait for a Statement to execute before timing out.
void	setTitle(String sTitle) Set the title that will be displayed as the results heading.
void	setTraceEnabled(boolean fTrace) Set whether to display trace output when executing commands.
void	setWriter(PrintWriter writer) Set the PrintWriter that can be used by commands to display output.

Methods inherited from class java.lang.Object

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

Field Detail

f_resourceRegistry

protected final ResourceRegistry f_resourceRegistry

The ResourceRegistry used to store various resources used by queries managed by this context.

m_cacheFactory

protected ConfigurableCacheFactory m_cacheFactory

The ConfigurableCacheFactory to use to access caches.

m_cluster

protected Cluster m_cluster

The Cluster to use to access services.

m_fTrace

protected boolean m_fTrace

Flag that indicates tracing mode.

m_fSanity

protected boolean m_fSanity

A flag that enables sanity checking.

m_fExtendedLanguage

protected boolean m_fExtendedLanguage

Flag that controls whether we except Map, and List as literals. This gives a json like feel to the language.

m_language

protected CoherenceQueryLanguage m_language

The CoherenceQueryLanguage to use.

m_writer

protected PrintWriter m_writer

The PrintWriter that can be used by commands to display output.

m_fStopOnError

protected boolean m_fStopOnError

A flag indicating when true that CohQL should stop processing multiple statements if an error occurs (for example when processing a file), or when false that errors will be logged and statement processing will continue.

m_sTitle

protected String m_sTitle

String to use for Title that heads each result displayed.

m_executor

protected StatementExecutor m_executor

The StatementExecutor to use to execute statements.

m_fSilent

protected boolean m_fSilent

A flag indicating whether the query session is running in silent mode.

m_reader

protected BufferedReader m_reader

The reader to use to get user input.

m_timeout

protected com.oracle.coherence.common.util.Duration m_timeout

The number of milli-seconds to wait for a Statement to execute before timing out.

Constructor Detail

ExecutionContext

public ExecutionContext()

Construct an ExecutionContext.

Method Detail

getResourceRegistry

public ResourceRegistry getResourceRegistry()

Return the ResourceRegistry that may be used to register ad-hoc resources with this context as a way to maintain state between different command executions.

Returns:

the ResourceRegistry that may be used to register ad-hoc resources

setCacheFactory

public void setCacheFactory(ConfigurableCacheFactory ccf)

Set the current ConfigurableCacheFactory to be used by commands executed under this context.

Parameters:

ccf - the ConfigurableCacheFactory to be used by commands executed with this context

getCacheFactory

public ConfigurableCacheFactory getCacheFactory()

Return the current ConfigurableCacheFactory to be used by commands executed under this context.

Returns:

the current ConfigurableCacheFactory

setCluster

public void setCluster(Cluster cluster)

Set the current Cluster to be used by commands executed under this context.

Parameters:

cluster - the Cluster to be used by commands executed with this context

getCluster

public Cluster getCluster()

Return the current Cluster to be used by commands executed under this context.

Returns:

the current Cluster

setCoherenceQueryLanguage

public void setCoherenceQueryLanguage(CoherenceQueryLanguage language)

Set the CoherenceQueryLanguage that will be used by commands.

Parameters:

language - the CoherenceQueryLanguage to be used by commands

getCoherenceQueryLanguage

public CoherenceQueryLanguage getCoherenceQueryLanguage()

Return an instance of CoherenceQueryLanguage to be used by commands.

Returns:

the instance of CoherenceQueryLanguage to be used by commands

setTraceEnabled

public void setTraceEnabled(boolean fTrace)

Set whether to display trace output when executing commands.

Parameters:

fTrace - whether to display trace output when executing commands

isTraceEnabled

public boolean isTraceEnabled()

Return whether trace to display output when executing commands.

Returns:

true if trace is enabled, otherwise returns false

setSanityCheckingEnabled

public void setSanityCheckingEnabled(boolean fSanity)

Set whether sanity checking is enabled when executing commands.

Parameters:

fSanity - whether sanity checking is enabled when executing commands

isSanityChecking

public boolean isSanityChecking()

Return whether sanity checking should be enabled when executing commands.

Returns:

whether sanity checking should be enabled when executing commands

setExtendedLanguage

public void setExtendedLanguage(boolean fExtendedLanguage)

Set whether "Extended Language" features are enabled.

Parameters:

fExtendedLanguage - whether "Extended Language" features are enabled

isExtendedLanguageEnabled

public boolean isExtendedLanguageEnabled()

Return whether "Extended Language" features are enabled.

Returns:

whether "Extended Language" features are enabled

setWriter

public void setWriter(PrintWriter writer)

Set the PrintWriter that can be used by commands to display output.

Parameters:

writer - the PrintWriter that can be used by commands to display output

getWriter

public PrintWriter getWriter()

Return the PrintWriter that can be used by commands to display output.

Returns:

the PrintWriter that can be used by commands to display output

isStopOnError

public boolean isStopOnError()

Return the flag indicating whether CohQL should stop processing multiple statements if an error occurs (for example when processing a file), or whether errors should be logged and statement processing continue.

Returns:

true if statement processing should stop when errors occur.

setStopOnError

public void setStopOnError(boolean fStopOnError)

Set the flag indicating whether CohQL should stop processing multiple statements if an error occurs (for example when processing a file), or whether errors should be logged and statement processing continue.

Parameters:

fStopOnError - true if statement processing should stop when errors occur

setTitle

public void setTitle(String sTitle)

Set the title that will be displayed as the results heading.

Parameters:

sTitle - the title that will be displayed as the results heading

getTitle

public String getTitle()

Return the String to use for title that heads each result.

Returns:

the String to use for title that heads each result

setStatementExecutor

public void setStatementExecutor(StatementExecutor executor)

Set the StatementExecutor to use to parse and execute statements.

Parameters:

executor - the StatementExecutor to use

getStatementExecutor

public StatementExecutor getStatementExecutor()

Return the StatementExecutor to use to parse and execute statements.

Returns:

the StatementExecutor to use to parse and execute statements

instantiateParser

public OPParser instantiateParser(Reader reader)

Instantiate an instance of an OPParser to parse the CohQL statements provided by the specified Reader.

Parameters:

reader - the Reader containing the statements to execute

Returns:

an instance of an OPParser to parse the CohQL statements

isSilent

public boolean isSilent()

Return true if the current query session is running in silent mode.

Returns:

true if the current session is running in silent mode

setSilentMode

public void setSilentMode(boolean fSilent)

Set the flag indicating that the QueryPlus session is running in silent mode.

Parameters:

fSilent - true to indicate that the QueryPlus session is running in silent mode.

getReader

public BufferedReader getReader()

Return the BufferedReader that can be used to obtain user input, typically from System.in.

Returns:

Return the BufferedReader that can be used to obtain user input

setReader

public void setReader(BufferedReader reader)

Set the BufferedReader that should be used to obtain user input.

Parameters:

reader - the BufferedReader to use to obtain user input

getTimeout

public com.oracle.coherence.common.util.Duration getTimeout()

Obtain the number of mill-seconds to wait for a Statement to execute before timing out.

Returns:

the number of mill-seconds to wait for a Statement to execute before timing out

setTimeout

public void setTimeout(com.oracle.coherence.common.util.Duration timeout)

Set the Duration to wait for a Statement to execute before timing out.

Parameters:

timeout - the timeout duration

Throws:

IllegalArgumentException - if the timeout value is null