com.tangosol.coherence.dslquery

Interface QueryPlus.Dependencies

All Known Implementing Classes:

QueryPlus.DefaultDependencies

Enclosing class:

QueryPlus

public static interface QueryPlus.Dependencies

The Dependencies for QueryPlus.

Method Summary

Modifier and Type	Method and Description
String	getApplicationName() Return the optional application name to use if loading a GAR file.
CoherenceQueryLanguage	getCoherenceQueryLanguage() Return an instance of CoherenceQueryLanguage to be used by the QueryPlus session.
String[]	getDomainPartitions() Return the optional array of domain partition names to use if loading a GAR file.
List<String>	getFiles() Return the list of statement script files that should be executed prior to the start of the CohQL session.
String	getGarFileName() Return the name of the optional GAR file to load before running QueryPlus.
PrintWriter	getOutputWriter() Return an instance of a PrintWriter that should be used to display query output.
BufferedReader	getReader() Return the BufferedReader to use to obtain user input.
StatementExecutor	getStatementExecutor() Return the StatementExecutor to use to parse and execute statements.
List<String>	getStatements() Return the list of statements that should be executed prior to the start of the CohQL session.
com.oracle.coherence.common.util.Duration	getTimeout() Return the initial value that will be set as the CohQL statement timeout.
String	getTitle() Return the String to use for title that heads each result.
boolean	isExitWhenProcessingComplete() Return whether the QueryPlus session should exit once all of the statements added to the statements list have been executed.
boolean	isExtendedLanguageEnabled() Return whether "Extended Language" features are enabled.
boolean	isSanityChecking() Return whether sanity checking should be enabled when executing statements.
boolean	isSilent() Return true if the current query session is running in silent mode.
boolean	isTraceEnabled() Return whether trace is enabled.

Method Detail

getCoherenceQueryLanguage

CoherenceQueryLanguage getCoherenceQueryLanguage()

Return an instance of CoherenceQueryLanguage to be used by the QueryPlus session.

Returns:

the instance of CoherenceQueryLanguage to be used by the QueryPlus session

getOutputWriter

PrintWriter getOutputWriter()

Return an instance of a PrintWriter that should be used to display query output.

Returns:

the current PrintWriter to be used to display output

isTraceEnabled

boolean isTraceEnabled()

Return whether trace is enabled. Enabling trace displays verbose output when executing statements.

Returns:

true if trace is enabled, otherwise returns false

isSanityChecking

boolean isSanityChecking()

Return whether sanity checking should be enabled when executing statements.

Returns:

whether sanity checking should be enabled when executing statements

isExtendedLanguageEnabled

boolean isExtendedLanguageEnabled()

Return whether "Extended Language" features are enabled.

Returns:

whether "Extended Language" features are enabled

isExitWhenProcessingComplete

boolean isExitWhenProcessingComplete()

Return whether the QueryPlus session should exit once all of the statements added to the statements list have been executed.

Returns:

whether the QueryPlus session should exit once all of the statements added to the statements list have been executed

getStatements

List<String> getStatements()

Return the list of statements that should be executed prior to the start of the CohQL session.

Returns:

the list of statements that should be executed prior to the start of the CohQL session

getFiles

List<String> getFiles()

Return the list of statement script files that should be executed prior to the start of the CohQL session.

Returns:

the list of statements that should be executed prior to the start of the CohQL session

isSilent

boolean isSilent()

Return true if the current query session is running in silent mode.

Returns:

true if the current session is running in silent mode

getTitle

String getTitle()

Return the String to use for title that heads each result.

Returns:

the String to use for title that heads each result

getReader

BufferedReader getReader()

Return the BufferedReader to use to obtain user input.

Returns:

the BufferedReader to use to obtain user input

getStatementExecutor

StatementExecutor getStatementExecutor()

Return the StatementExecutor to use to parse and execute statements.

Returns:

the StatementExecutor to use to parse and execute statements

getGarFileName

String getGarFileName()

Return the name of the optional GAR file to load before running QueryPlus.

Returns:

the name of the optional GAR file to load before running QueryPlus

getApplicationName

String getApplicationName()

Return the optional application name to use if loading a GAR file.

Returns:

the optional application name to use if loading a GAR file

getDomainPartitions

String[] getDomainPartitions()

Return the optional array of domain partition names to use if loading a GAR file.

Returns:

the optional array of domain partition names to use if loading a GAR file

getTimeout

com.oracle.coherence.common.util.Duration getTimeout()

Return the initial value that will be set as the CohQL statement timeout.

Returns:

the initial value that will be set as the CohQL statement timeout.