com.tangosol.coherence.dslquery.queryplus

Class AbstractQueryPlusStatementBuilder.AbstractStatement

java.lang.Object

com.tangosol.coherence.dslquery.queryplus.AbstractQueryPlusStatementBuilder.AbstractStatement

All Implemented Interfaces:

Statement

Direct Known Subclasses:

CommandsStatementBuilder.CommandsQueryPlusStatement, ExtendedLanguageStatementBuilder.ExtendedLanguageQueryPlusStatement, HelpStatementBuilder.HelpQueryPlusStatement, SanityCheckStatementBuilder.SanityCheckQueryPlusStatement, ServicesStatementBuilder.ServicesQueryPlusStatement, SetTimeoutStatementBuilder.SetTimeoutStatement, TraceStatementBuilder.TraceQueryPlusStatement, WheneverStatementBuilder.WheneverQueryPlusStatement

Enclosing class:

AbstractQueryPlusStatementBuilder

public abstract class AbstractQueryPlusStatementBuilder.AbstractStatement
extends Object
implements Statement

An abstract base class that allows sub classes to implement the applicable methods on Statement.

Constructor Summary

Constructors

Constructor and Description
AbstractStatement()

Method Summary

Modifier and Type	Method and Description
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.
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.

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, isManagingTimeout

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

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.

Specified by:

showPlan in interface Statement

Parameters:

out - the PrintWriter to write the trace to

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