Package com.tangosol.coherence.dslquery.statement

Class AbstractStatement

java.lang.Object

com.tangosol.util.Base

com.tangosol.coherence.dslquery.statement.AbstractStatement

All Implemented Interfaces:

Statement

Direct Known Subclasses:

AbstractSnapshotStatement, BackupStatementBuilder.BackupStatement, CreateCacheStatementBuilder.CreateCacheStatement, CreateIndexStatementBuilder.CreateIndexStatement, DeleteStatementBuilder.DeleteStatement, DropCacheStatementBuilder.DropCacheStatement, DropIndexStatementBuilder.DropIndexStatement, ForceRecoveryStatementBuilder.ForceRecoveryStatement, InsertStatementBuilder.InsertStatement, ListArchiverStatementBuilder.ListArchiverStatement, ListServicesStatementBuilder.ListServicesStatement, ListSnapshotsStatementBuilder.ListSnapshotsStatement, QueryRecorderStatementBuilder.QueryRecorderStatement, RestoreStatementBuilder.RestoreStatement, ResumeServiceStatementBuilder.ResumeServiceStatement, SelectStatementBuilder.SelectStatement, SourceStatementBuilder.SourceStatement, SuspendServiceStatementBuilder.SuspendServiceStatement, TruncateCacheStatementBuilder.TruncateCacheStatement, UpdateStatementBuilder.UpdateStatement, ValidateSnapshotStatementBuilder.ValidateSnapshotStatement

public abstract class AbstractStatement
extends Base
implements Statement

A base class for Statement implementations.

Since:

Coherence 12.2.1

Author:

jk 2013.12.10

Nested Class Summary

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

Base.LoggingWriter

Field Summary

Fields inherited from class com.tangosol.util.Base

LOG_ALWAYS, LOG_CONFIG, 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	Description
AbstractStatement()

Method Summary

Modifier and Type	Method	Description
protected void	assertCacheName(String sName, ExecutionContext ctx)	Test to see whether the given String is a known cache name.
String	getExecutionConfirmation(ExecutionContext ctx)	Return a string that will be used as a question to confirm execution of a statement.
void	sanityCheck(ExecutionContext ctx)	Perform sanity checks on the statement that will be executed.

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, getStackTrace, getThreadFactory, getTimeZone, getUpTimeMillis, hashCode, hexValue, indentString, indentString, isDecimal, isHex, isLogEcho, isOctal, log, log, log, log, log, makeInteger, makeLong, makeThread, mergeArray, mergeBooleanArray, mergeByteArray, mergeCharArray, mergeDoubleArray, mergeFloatArray, mergeIntArray, mergeLongArray, 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

Methods inherited from interface com.tangosol.coherence.dslquery.Statement

execute, executeAsync, isManagingTimeout, showPlan

Constructor Detail

AbstractStatement

public AbstractStatement()

Method Detail

sanityCheck

public void sanityCheck(ExecutionContext ctx)

Description copied from interface: Statement

Perform sanity checks on the statement that will be executed.

Implementations can fail sanity checking by throwing an unchecked exception (RuntimeException).

Specified by:

sanityCheck in interface Statement

Parameters:

ctx - the context to use

getExecutionConfirmation

public String getExecutionConfirmation(ExecutionContext ctx)

Description copied from interface: Statement

Return a string that will be used as a question to confirm execution of a statement. If null is returned then no confirmation is required.

Specified by:

getExecutionConfirmation in interface Statement

Parameters:

ctx - the context to use

Returns:

a String that will be used to confirm execution of a statement

assertCacheName

protected void assertCacheName(String sName,
                               ExecutionContext ctx)

Test to see whether the given String is a known cache name.

Parameters:

sName - the cache name

ctx - the execution context of the CohQL query

Throws:

AssertionError - if a cache with the given name does not exist.