com.tangosol.coherence.dslquery.statement

Class SourceStatementBuilder.SourceStatement

java.lang.Object

com.tangosol.util.Base

com.tangosol.coherence.dslquery.statement.AbstractStatement

com.tangosol.coherence.dslquery.statement.SourceStatementBuilder.SourceStatement

All Implemented Interfaces:

Statement

Enclosing class:

SourceStatementBuilder

public static class SourceStatementBuilder.SourceStatement
extends AbstractStatement

Implementation of the CohQL "source" command.

Nested Class Summary

Nested classes/interfaces inherited from class com.tangosol.util.Base

Base.LoggingWriter, Base.StackFrame

Field Summary

Fields

Modifier and Type	Field and Description
protected String	f_sFileName The file name to be used in the CohQL "source" command.

Fields inherited from class com.tangosol.util.Base

LOG_ALWAYS, LOG_DEBUG, LOG_ERR, LOG_INFO, LOG_MAX, LOG_MIN, LOG_QUIET, LOG_WARN, POWER_0, POWER_G, POWER_K, POWER_M, POWER_T, UNIT_D, UNIT_H, UNIT_M, UNIT_MS, UNIT_NS, UNIT_S, UNIT_US

Constructor Summary

Constructors

Constructor and Description
SourceStatement(String sFileName) Construct a SourceStatement that will execute commands from the specified file.

Method Summary

Modifier and Type	Method and Description
StatementResult	execute(ExecutionContext ctx) Execute a CohQL query or command and return the relevant result.
boolean	isManagingTimeout() Obtain a flag indicating whether this Statement will manage its own timeout handling.
void	showPlan(PrintWriter out) Output to the provided PrintWriter a human readable trace of the actions that will be taken by this statement if or when executed.
StatementResult	source(String sFileName, ExecutionContext ctx) Attempt to parse, build, and execute from the given file of statements tracing on the given PrintWriter if the given flag indicates the need to trace.
protected void	traceout(String sLine, PrintWriter writer, boolean fTrace) Write the given line on the give PrintWriter if the trace flag is true.

Methods inherited from class com.tangosol.coherence.dslquery.statement.AbstractStatement

assertCacheName, getExecutionConfirmation, sanityCheck

Methods inherited from class com.tangosol.util.Base

azzert, azzert, azzert, azzertFailed, breakLines, breakLines, capitalize, checkNotEmpty, checkNotNull, checkRange, computeSafeWaitTime, decimalValue, dup, dup, ensureBigDecimal, ensureClassLoader, ensureRuntimeException, ensureRuntimeException, equals, equalsDeep, err, err, err, err, err, escape, formatDateTime, getCallerStackFrame, getCommonMonitor, getCommonMonitor, getCommonMonitor, getContextClassLoader, getContextClassLoader, getDeepMessage, getErr, getLastSafeTimeMillis, getLog, getMaxDecDigits, getMaxHexDigits, getOriginalException, getOut, getProcessRandom, getRandom, getRandomBinary, getRandomBinary, getRandomString, getSafeTimeMillis, getStackFrame, getStackFrames, getStackTrace, getStackTrace, getThreadFactory, getTimeZone, getUpTimeMillis, hashCode, hexValue, indentString, indentString, isDecimal, isHex, isLogEcho, isOctal, log, log, log, log, log, makeInteger, makeLong, makeThread, mod, mod, octalValue, out, out, out, out, out, pad, parseBandwidth, parseBandwidth, parseDelimitedString, parseHex, parseHex, parseMemorySize, parseMemorySize, parsePercentage, parseTime, parseTime, parseTimeNanos, parseTimeNanos, printStackTrace, randomize, randomize, randomize, randomize, read, read, read, read, read, read, read, replace, setErr, setLog, setLogEcho, setOut, sleep, toBandwidthString, toBandwidthString, toCharEscape, toCrc, toCrc, toCrc, toCrc, toCrc, toDecString, toDelimitedString, toDelimitedString, toDelimitedString, toDelimitedString, toHex, toHex, toHexDump, toHexEscape, toHexEscape, toHexEscape, toHexEscape, toHexString, toMemorySizeString, toMemorySizeString, toQuotedCharEscape, toQuotedStringEscape, toSqlString, toString, toString, toStringEscape, toUnicodeEscape, trace, trace, trace, trace, trace, trace, trace, trace, trace, truncateString, truncateString, wait

Methods inherited from class java.lang.Object

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

Field Detail

f_sFileName

protected final String f_sFileName

The file name to be used in the CohQL "source" command.

Constructor Detail

SourceStatement

public SourceStatement(String sFileName)

Construct a SourceStatement that will execute commands from the specified file.

Parameters:

sFileName - the file of commands to execute

Method Detail

execute

public StatementResult execute(ExecutionContext ctx)

Description copied from interface: Statement

Execute a CohQL query or command and return the relevant result.

Parameters:

ctx - the context to use

Returns:

a StatementResult containing the results of executing the statement

showPlan

public void showPlan(PrintWriter out)

Description copied from interface: Statement

Output to the provided PrintWriter a human readable trace of the actions that will be taken by this statement if or when executed.

Parameters:

out - the PrintWriter to write the trace to

isManagingTimeout

public boolean isManagingTimeout()

Description copied from interface: Statement

Obtain a flag indicating whether this Statement will manage its own timeout handling.

Returns:

true if this Statement manages timeout handling or false if the StatementExecutor should manage timeouts.

source

public StatementResult source(String sFileName,
                              ExecutionContext ctx)

Attempt to parse, build, and execute from the given file of statements tracing on the given PrintWriter if the given flag indicates the need to trace.

Parameters:

sFileName - a String representing a filename to process

ctx - the ExecutionContext to use to execute statements

Returns:

the StatementResult resulting form the last statement to be processed in the set of statements from the file

traceout

protected void traceout(String sLine,
                        PrintWriter writer,
                        boolean fTrace)

Write the given line on the give PrintWriter if the trace flag is true.

Parameters:

sLine - a String to be displayed

writer - a PrintWriter to write upon

fTrace - a flag indicating whether to trace