Package com.tangosol.coherence.dslquery

Interface StatementBuilder<T extends Statement>

All Known Implementing Classes:

AbstractQueryPlusStatementBuilder, AbstractStatementBuilder, ArchiveSnapshotStatementBuilder, BackupStatementBuilder, CommandsStatementBuilder, CreateCacheStatementBuilder, CreateIndexStatementBuilder, CreateSnapshotStatementBuilder, DeleteStatementBuilder, DropCacheStatementBuilder, DropIndexStatementBuilder, ExtendedLanguageStatementBuilder, ForceRecoveryStatementBuilder, HelpStatementBuilder, InsertStatementBuilder, ListArchiverStatementBuilder, ListServicesStatementBuilder, ListSnapshotsStatementBuilder, QueryRecorderStatementBuilder, RecoverSnapshotStatementBuilder, RemoveSnapshotStatementBuilder, RestoreStatementBuilder, ResumeServiceStatementBuilder, RetrieveSnapshotStatementBuilder, SanityCheckStatementBuilder, SelectStatementBuilder, ServicesStatementBuilder, SetTimeoutStatementBuilder, SourceStatementBuilder, SuspendServiceStatementBuilder, TraceStatementBuilder, TruncateCacheStatementBuilder, UpdateStatementBuilder, ValidateSnapshotStatementBuilder, WheneverStatementBuilder

public interface StatementBuilder<T extends Statement>

Classes implementing this interface build instances of Statement implementations.

Since:

Coherence 12.2.1

Author:

jk 2013.12.09

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.
T	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.

Method Detail

realize

T 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.

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

String getSyntax()

Return the syntax of the CohQL command.

Returns:

the syntax of the CohQL command

getDescription

String getDescription()

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