com.tangosol.coherence.dslquery

Class QueryPlus

java.lang.Object

com.tangosol.coherence.dslquery.QueryPlus

public class QueryPlus
extends Object

QueryPlus implements a simple command line processor for a sql like language.

Author:

djl 2009.08.31, jk 2014.01.02

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryPlus.DefaultDependencies A default implementation of QueryPlus.Dependencies.
static interface	QueryPlus.Dependencies The Dependencies for QueryPlus.
static class	QueryPlus.DependenciesHelper The DependenciesHelper provides helper method for constructing QueryPlus.Dependencies implementations for QueryPlus.

Field Summary

Fields

Modifier and Type	Field and Description
protected ExecutionContext	f_context The ExecutionContext that will be passed to Statements.
protected QueryPlus.Dependencies	f_dependencies The QueryPlus.Dependencies configuring this query session.
protected StatementExecutor	f_executor The StatementExecutor to use to execute statements.

Constructor Summary

Constructors

Constructor and Description
QueryPlus(QueryPlus.Dependencies dependencies) Create a QueryPlus instance that uses the specified QueryPlus.Dependencies.

Method Summary

Modifier and Type	Method and Description
protected void	addAlterSessionStatement() Add the QueryPlus ALTER SESSION statements
protected void	addStatement(AbstractQueryPlusStatementBuilder builder) Add a new QueryPlus statement.
protected void	ensureGarServer(String sGarFile) Ensure that a GarServer is running using the GAR file at the location specified in the QueryPlus.Dependencies.
protected boolean	evalLine(String sLine) Evaluate the given CohQL statement.
ExecutionContext	getExecutionContext() Return the current ExecutionContext passed to Statements.
static InputStream	getJlineInputStream(PrintWriter writer, InputStream input, boolean fSilent) Return an instance of jline.ConsoleReaderInputStream object if JLine is present.
protected void	initializeLanguage() Initialize the CoherenceQueryLanguage with any QueryPlus Statement extensions.
static void	main(String[] asArgs) The main application for CohQL statement processing.
protected boolean	processFile(String sFileName) Process the given file of CohQL statements.
protected Object	query(String sQuery) Process the specified query.
void	repl() Start a statement processing loop.
void	run() Run this instance of QueryPlus.
protected DefaultCacheServer.GarServer	startGarServer(File fileGar, String sAppName, String[] asDomainPartition) Start the cache server on a dedicated daemon thread using the given File reference to a GAR.

Methods inherited from class java.lang.Object

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

Field Detail

f_dependencies

protected final QueryPlus.Dependencies f_dependencies

The QueryPlus.Dependencies configuring this query session.

f_context

protected final ExecutionContext f_context

The ExecutionContext that will be passed to Statements.

f_executor

protected final StatementExecutor f_executor

The StatementExecutor to use to execute statements.

Constructor Detail

QueryPlus

public QueryPlus(QueryPlus.Dependencies dependencies)

Create a QueryPlus instance that uses the specified QueryPlus.Dependencies.

Parameters:

dependencies - the Dependencies that will control the QueryPlus session

Method Detail

run

public void run()

Run this instance of QueryPlus.

repl

public void repl()

Start a statement processing loop.

ensureGarServer

protected void ensureGarServer(String sGarFile)

Ensure that a GarServer is running using the GAR file at the location specified in the QueryPlus.Dependencies.

Parameters:

sGarFile - the location of the GAR file or exploded GAR directory

startGarServer

protected DefaultCacheServer.GarServer startGarServer(File fileGar,
                                                      String sAppName,
                                                      String[] asDomainPartition)

Start the cache server on a dedicated daemon thread using the given File reference to a GAR. This method just calls DefaultCacheServer.startServerDaemon(java.io.File, String, String[]) and is primarily here so that this method can be stubbed out for unit testing.

Parameters:

fileGar - file reference to either a GAR file or a directory containing the contents of the GAR

sAppName - name to be used for the application

asDomainPartition - (optional) Domain Partition names

Returns:

an instance of the DefaultCacheServer.GarServer started

See Also:

DefaultCacheServer.startServerDaemon(java.io.File, String)

getExecutionContext

public ExecutionContext getExecutionContext()

Return the current ExecutionContext passed to Statements.

Returns:

the current ExecutionContext passed to Statements

initializeLanguage

protected void initializeLanguage()

Initialize the CoherenceQueryLanguage with any QueryPlus Statement extensions.

addStatement

protected void addStatement(AbstractQueryPlusStatementBuilder builder)

Add a new QueryPlus statement.

Parameters:

builder - the statement builder to add

addAlterSessionStatement

protected void addAlterSessionStatement()

Add the QueryPlus ALTER SESSION statements

query

protected Object query(String sQuery)

Process the specified query.

Parameters:

sQuery - a String that represents the query

Returns:

the results of the query

processFile

protected boolean processFile(String sFileName)

Process the given file of CohQL statements.

Parameters:

sFileName - the name of the file CohQL containing the statements to execute

Returns:

true if all statements in the file were processed or false if an error occurred

evalLine

protected boolean evalLine(String sLine)

Evaluate the given CohQL statement.

Parameters:

sLine - the CohQL statement String to be evaluated

Returns:

a flag indicating whether to continue processing statements

getJlineInputStream

public static InputStream getJlineInputStream(PrintWriter writer,
                                              InputStream input,
                                              boolean fSilent)

Return an instance of jline.ConsoleReaderInputStream object if JLine is present.

Parameters:

writer - the PrintWriter to write to

input - the InputStream that will provide input

fSilent - if true no message will be displayed if JLine is unavailable.

Returns:

an instance of jline.ConsoleReader or null

main

public static void main(String[] asArgs)

The main application for CohQL statement processing.

Parameters:

asArgs - an array of Strings that represents arguments