org.teiid.query.sql.lang

Class ExplainCommand

java.lang.Object

org.teiid.query.sql.lang.Command

org.teiid.query.sql.lang.ExplainCommand

All Implemented Interfaces:

Cloneable, LanguageObject

public class ExplainCommand
extends Command

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExplainCommand.Format

Nested classes/interfaces inherited from interface org.teiid.query.sql.LanguageObject

LanguageObject.Util

Field Summary

Fields inherited from class org.teiid.query.sql.lang.Command

tempGroupIDs, TYPE_ALTER_PROC, TYPE_ALTER_TRIGGER, TYPE_ALTER_VIEW, TYPE_BATCHED_UPDATE, TYPE_CREATE, TYPE_DELETE, TYPE_DROP, TYPE_DYNAMIC, TYPE_EXPLAIN, TYPE_INSERT, TYPE_QUERY, TYPE_SOURCE_EVENT, TYPE_STORED_PROCEDURE, TYPE_TRIGGER_ACTION, TYPE_UNKNOWN, TYPE_UPDATE, TYPE_UPDATE_PROCEDURE

Constructor Summary

Constructors

Constructor and Description
ExplainCommand()

Method Summary

Modifier and Type	Method and Description
void	acceptVisitor(LanguageVisitor visitor) Method for accepting a visitor.
boolean	areResultsCachable() Whether the results are cachable.
ExplainCommand	clone() Implement clone to make objects cloneable.
boolean	equals(Object obj)
Command	getActualCommand() For a statement such as explain, obtain the actual command
Boolean	getAnalyze()
Command	getCommand()
ExplainCommand.Format	getFormat()
List<Expression>	getProjectedSymbols() Get the ordered list of all elements returned by this query.
int	getType() Return type of command to make it easier to build switch statements by command type.
int	hashCode()
boolean	isNoExec()
boolean	returnsResultSet()
void	setAnalyze(Boolean analyze)
void	setCommand(Command command)
void	setFormat(ExplainCommand.Format format)

Methods inherited from class org.teiid.query.sql.lang.Command

addExternalGroupToContext, copyMetadataState, getAllExternalGroups, getCacheHint, getCommandToken, getCorrelatedReferences, getExternalGroupContexts, getOption, getProcessorPlan, getResultSetColumns, getSourceHint, getTemporaryMetadata, getUpdateCommandSymbol, printCommandTree, printCommandTree, pushNewResolvingContext, sameOptionAndHint, setCacheHint, setCorrelatedReferences, setExternalGroupContexts, setOption, setProcessorPlan, setSourceHint, setTemporaryMetadata, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExplainCommand

public ExplainCommand()

Method Detail

acceptVisitor

public void acceptVisitor(LanguageVisitor visitor)

Description copied from interface: LanguageObject

Method for accepting a visitor. It is the responsibility of the language object to call back on the visitor.

Parameters:

visitor - Visitor being used

getType

public int getType()

Description copied from class: Command

Return type of command to make it easier to build switch statements by command type.

Specified by:

getType in class Command

Returns:

Type from TYPE constants

clone

public ExplainCommand clone()

Description copied from interface: LanguageObject

Implement clone to make objects cloneable.

Specified by:

clone in interface LanguageObject

Specified by:

clone in class Command

Returns:

Deep clone of this object

getProjectedSymbols

public List<Expression> getProjectedSymbols()

Description copied from class: Command

Get the ordered list of all elements returned by this query. These elements may be ElementSymbols or ExpressionSymbols but in all cases each represents a single column.

Specified by:

getProjectedSymbols in class Command

Returns:

Ordered list of SingleElementSymbol

areResultsCachable

public boolean areResultsCachable()

Description copied from class: Command

Whether the results are cachable.

Specified by:

areResultsCachable in class Command

Returns:

True if the results are cachable; false otherwise.

getFormat

public ExplainCommand.Format getFormat()

setFormat

public void setFormat(ExplainCommand.Format format)

isNoExec

public boolean isNoExec()

getAnalyze

public Boolean getAnalyze()

setAnalyze

public void setAnalyze(Boolean analyze)

getCommand

public Command getCommand()

setCommand

public void setCommand(Command command)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getActualCommand

public Command getActualCommand()

Description copied from class: Command

For a statement such as explain, obtain the actual command

Overrides:

getActualCommand in class Command

Returns:

returnsResultSet

public boolean returnsResultSet()

Overrides:

returnsResultSet in class Command