Package com.tangosol.coherence.dslquery.queryplus

Class CommandsStatementBuilder

java.lang.Object

com.tangosol.coherence.dslquery.queryplus.AbstractQueryPlusStatementBuilder

com.tangosol.coherence.dslquery.queryplus.CommandsStatementBuilder

All Implemented Interfaces:

StatementBuilder<Statement>

public class CommandsStatementBuilder
extends AbstractQueryPlusStatementBuilder

A class that builds the QueryPlus "COMMANDS" command.

Since:

Coherence 12.2.1

Author:

jk 2014.01.06

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	CommandsStatementBuilder.CommandsOPToken	A CohQL OPToken representing the QueryPlus "commands" command.
class	CommandsStatementBuilder.CommandsQueryPlusStatement	The implementation of the QueryPlus "commands" command.

Nested classes/interfaces inherited from class com.tangosol.coherence.dslquery.queryplus.AbstractQueryPlusStatementBuilder

AbstractQueryPlusStatementBuilder.AbstractOPToken, AbstractQueryPlusStatementBuilder.AbstractStatement

Field Summary

Fields

Modifier and Type	Field	Description
protected final CommandsStatementBuilder.CommandsQueryPlusStatement	f_command	An instance of the CommandsStatementBuilder.CommandsQueryPlusStatement.

Constructor Summary

Constructors

Constructor	Description
CommandsStatementBuilder()	Construct a CommandsStatementBuilder that builds a CommandsStatementBuilder.CommandsQueryPlusStatement.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return a description of the CohQL command suitable for displaying as help text.
String	getSyntax()	Return the syntax of the CohQL command.
AbstractQueryPlusStatementBuilder.AbstractOPToken	instantiateOpToken()	Return the OPToken for this command.
CommandsStatementBuilder.CommandsQueryPlusStatement	realize(ExecutionContext ctx, NodeTerm term, List listBindVars, ParameterResolver namedBindVars)	Realizes an implementation of a Statement that can be executed to perform a specific CohQL command.

Methods inherited from class java.lang.Object

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

Field Details

f_command

protected final CommandsStatementBuilder.CommandsQueryPlusStatement f_command

An instance of the CommandsStatementBuilder.CommandsQueryPlusStatement.

Constructor Details

CommandsStatementBuilder

public CommandsStatementBuilder()

Construct a CommandsStatementBuilder that builds a CommandsStatementBuilder.CommandsQueryPlusStatement.

Method Details

realize

public CommandsStatementBuilder.CommandsQueryPlusStatement realize(ExecutionContext ctx,
 NodeTerm term,
 List listBindVars,
 ParameterResolver namedBindVars)

Description copied from interface: StatementBuilder

Realizes an implementation of a Statement that can be executed to perform a specific CohQL command.

Parameters:

ctx - the ExecutionContext to use to create commands

term - the parsed NodeTerm used to create the relevant Statement

listBindVars - the indexed bind variables

namedBindVars - the named bind variables

Returns:

an executable instance of a Statement

getSyntax

public String getSyntax()

Description copied from interface: StatementBuilder

Return the syntax of the CohQL command.

Returns:

the syntax of the CohQL command

getDescription

public String getDescription()

Description copied from interface: StatementBuilder

Return a description of the CohQL command suitable for displaying as help text.

Returns:

a description of the CohQL command suitable for displaying as help text

instantiateOpToken

public AbstractQueryPlusStatementBuilder.AbstractOPToken instantiateOpToken()

Description copied from class: AbstractQueryPlusStatementBuilder

Return the OPToken for this command.

Specified by:

instantiateOpToken in class AbstractQueryPlusStatementBuilder

Returns:

the OPToken for this command