Command (Teiid 10.1.0 API)

java.lang.Object
- org.teiid.query.sql.lang.Command

All Implemented Interfaces:

Cloneable, LanguageObject

Direct Known Subclasses:

Alter, AlterTempTable, BatchedUpdateCommand, Create, CreateProcedureCommand, Drop, DynamicCommand, ProcedureContainer, QueryCommand, SourceTriggerActionPlanner.SourceEventCommand, TriggerAction
```
public abstract class Command
extends Object
implements LanguageObject
```
A Command is an interface for all the language objects that are at the root of a language object tree representing a SQL statement. For instance, a Query command represents a SQL select query, an Update command represents a SQL update statement, etc.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.teiid.query.sql.LanguageObject
  LanguageObject.Util

Field Summary

Fields
Modifier and Type	Field and Description
`protected TempMetadataStore`	`tempGroupIDs` All temporary group IDs discovered while resolving this command.
`static int`	`TYPE_ALTER_PROC`
`static int`	`TYPE_ALTER_TRIGGER`
`static int`	`TYPE_ALTER_VIEW`
`static int`	`TYPE_BATCHED_UPDATE` Represents a batched sequence of UPDATE statements
`static int`	`TYPE_CREATE`
`static int`	`TYPE_DELETE` Represents a SQL DELETE statement
`static int`	`TYPE_DROP`
`static int`	`TYPE_DYNAMIC`
`static int`	`TYPE_INSERT` Represents a SQL INSERT statement
`static int`	`TYPE_QUERY` Represents a SQL SELECT statement
`static int`	`TYPE_SOURCE_EVENT`
`static int`	`TYPE_STORED_PROCEDURE` Represents a stored procedure command
`static int`	`TYPE_TRIGGER_ACTION`
`static int`	`TYPE_UNKNOWN` Represents an unknown type of command
`static int`	`TYPE_UPDATE` Represents a SQL UPDATE statement
`static int`	`TYPE_UPDATE_PROCEDURE` Represents a update stored procedure command

Constructor Summary

Constructors
Constructor and Description

Command()

Constructors
Constructor and Description
`Command()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addExternalGroupToContext(GroupSymbol group)`
`abstract boolean`	`areResultsCachable()` Whether the results are cachable.
`abstract Object`	`clone()` Implement clone to make objects cloneable.
`protected void`	`copyMetadataState(Command copy)`
`List<GroupSymbol>`	`getAllExternalGroups()`
`CacheHint`	`getCacheHint()`
`static String`	`getCommandToken(int commandType)`
`SymbolMap`	`getCorrelatedReferences()` Get the correlated references to the containing scope only
`GroupContext`	`getExternalGroupContexts()`
`Option`	`getOption()` Get the option clause for the query.
`ProcessorPlan`	`getProcessorPlan()`
`abstract List<Expression>`	`getProjectedSymbols()` Get the ordered list of all elements returned by this query.
`List<? extends Expression>`	`getResultSetColumns()`
`SourceHint`	`getSourceHint()`
`TempMetadataStore`	`getTemporaryMetadata()`
`abstract int`	`getType()` Return type of command to make it easier to build switch statements by command type.
`static List<Expression>`	`getUpdateCommandSymbol()`
`boolean`	`isResolved()` Indicates whether this command has been resolved or not - attempting to resolve a command that has already been resolved has undefined results.
`String`	`printCommandTree()` Print the full tree of commands with indentation - useful for debugging
`protected void`	`printCommandTree(StringBuffer str, int tabLevel)` Helper method to print command tree at given tab level
`void`	`pushNewResolvingContext(Collection<GroupSymbol> groups)`
`boolean`	`returnsResultSet()`
`protected boolean`	`sameOptionAndHint(Command cmd)`
`void`	`setCacheHint(CacheHint cacheHint)`
`void`	`setCorrelatedReferences(SymbolMap correlatedReferences)`
`void`	`setExternalGroupContexts(GroupContext root)`
`void`	`setIsResolved(boolean isResolved)` This command is intended to only be used by the QueryResolver.
`void`	`setOption(Option option)` Set the option clause for the query.
`void`	`setProcessorPlan(ProcessorPlan plan)`
`void`	`setSourceHint(SourceHint sourceHint)`
`void`	`setTemporaryMetadata(TempMetadataStore metadata)`
`String`	`toString()` Returns a string representation of an instance of this class.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.teiid.query.sql.LanguageObject
acceptVisitor

- Field Detail
  - TYPE_UNKNOWN
```
public static final int TYPE_UNKNOWN
```
    Represents an unknown type of command
    
    See Also:
    
    Constant Field Values
  - TYPE_QUERY
```
public static final int TYPE_QUERY
```
    Represents a SQL SELECT statement
    
    See Also:
    
    Constant Field Values
  - TYPE_INSERT
```
public static final int TYPE_INSERT
```
    Represents a SQL INSERT statement
    
    See Also:
    
    Constant Field Values
  - TYPE_UPDATE
```
public static final int TYPE_UPDATE
```
    Represents a SQL UPDATE statement
    
    See Also:
    
    Constant Field Values
  - TYPE_DELETE
```
public static final int TYPE_DELETE
```
    Represents a SQL DELETE statement
    
    See Also:
    
    Constant Field Values
  - TYPE_STORED_PROCEDURE
```
public static final int TYPE_STORED_PROCEDURE
```
    Represents a stored procedure command
    
    See Also:
    
    Constant Field Values
  - TYPE_UPDATE_PROCEDURE
```
public static final int TYPE_UPDATE_PROCEDURE
```
    Represents a update stored procedure command
    
    See Also:
    
    Constant Field Values
  - TYPE_BATCHED_UPDATE
```
public static final int TYPE_BATCHED_UPDATE
```
    Represents a batched sequence of UPDATE statements
    
    See Also:
    
    Constant Field Values
  - TYPE_DYNAMIC
```
public static final int TYPE_DYNAMIC
```
    See Also:
    
    Constant Field Values
  - TYPE_CREATE
```
public static final int TYPE_CREATE
```
    See Also:
    
    Constant Field Values
  - TYPE_DROP
```
public static final int TYPE_DROP
```
    See Also:
    
    Constant Field Values
  - TYPE_TRIGGER_ACTION
```
public static final int TYPE_TRIGGER_ACTION
```
    See Also:
    
    Constant Field Values
  - TYPE_ALTER_VIEW
```
public static final int TYPE_ALTER_VIEW
```
    See Also:
    
    Constant Field Values
  - TYPE_ALTER_PROC
```
public static final int TYPE_ALTER_PROC
```
    See Also:
    
    Constant Field Values
  - TYPE_ALTER_TRIGGER
```
public static final int TYPE_ALTER_TRIGGER
```
    See Also:
    
    Constant Field Values
  - TYPE_SOURCE_EVENT
```
public static final int TYPE_SOURCE_EVENT
```
    See Also:
    
    Constant Field Values
  - tempGroupIDs
```
protected TempMetadataStore tempGroupIDs
```
    All temporary group IDs discovered while resolving this command. The key is a TempMetadataID and the value is an ordered List of TempMetadataID representing the elements.
- Constructor Detail
  - Command
```
public Command()
```
- Method Detail
  - getType
```
public abstract int getType()
```
    Return type of command to make it easier to build switch statements by command type.
    
    Returns:
    
    Type from TYPE constants
  - getCorrelatedReferences
```
public SymbolMap getCorrelatedReferences()
```
    Get the correlated references to the containing scope only
    
    Returns:
  - setCorrelatedReferences
```
public void setCorrelatedReferences(SymbolMap correlatedReferences)
```
  - setTemporaryMetadata
```
public void setTemporaryMetadata(TempMetadataStore metadata)
```
  - getTemporaryMetadata
```
public TempMetadataStore getTemporaryMetadata()
```
  - addExternalGroupToContext
```
public void addExternalGroupToContext(GroupSymbol group)
```
  - setExternalGroupContexts
```
public void setExternalGroupContexts(GroupContext root)
```
  - pushNewResolvingContext
```
public void pushNewResolvingContext(Collection<GroupSymbol> groups)
```
  - getExternalGroupContexts
```
public GroupContext getExternalGroupContexts()
```
  - getAllExternalGroups
```
public List<GroupSymbol> getAllExternalGroups()
```
  - isResolved
```
public boolean isResolved()
```
    Indicates whether this command has been resolved or not - attempting to resolve a command that has already been resolved has undefined results. Also, caution should be taken in modifying a command which has already been resolved, as it could result in adding unresolved components to a supposedly resolved command.
    
    Returns:
    
    whether this command is resolved or not.
  - setIsResolved
```
public void setIsResolved(boolean isResolved)
```
    This command is intended to only be used by the QueryResolver.
    
    Parameters:
    
    isResolved - whether this command is resolved or not
  - clone
```
public abstract Object clone()
```
    Description copied from interface: LanguageObject
    
    Implement clone to make objects cloneable.
    
    Specified by:
    
    clone in interface LanguageObject
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    Deep clone of this object
  - copyMetadataState
```
protected void copyMetadataState(Command copy)
```
  - printCommandTree
```
public String printCommandTree()
```
    Print the full tree of commands with indentation - useful for debugging
    
    Returns:
    
    String String representation of command tree
  - printCommandTree
```
protected void printCommandTree(StringBuffer str,
                                int tabLevel)
```
    Helper method to print command tree at given tab level
    
    Parameters:
    
    str - String buffer to add command sub tree to
    
    tabLevel - Number of tabs to print this command at
  - getOption
```
public Option getOption()
```
    Get the option clause for the query.
    
    Returns:
    
    option clause
  - setOption
```
public void setOption(Option option)
```
    Set the option clause for the query.
    
    Parameters:
    
    option - New option clause
  - getProjectedSymbols
```
public abstract List<Expression> getProjectedSymbols()
```
    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.
    
    Returns:
    
    Ordered list of SingleElementSymbol
  - areResultsCachable
```
public abstract boolean areResultsCachable()
```
    Whether the results are cachable.
    
    Returns:
    
    True if the results are cachable; false otherwise.
  - getUpdateCommandSymbol
```
public static List<Expression> getUpdateCommandSymbol()
```
  - getProcessorPlan
```
public ProcessorPlan getProcessorPlan()
```
  - setProcessorPlan
```
public void setProcessorPlan(ProcessorPlan plan)
```
  - getCacheHint
```
public CacheHint getCacheHint()
```
  - setCacheHint
```
public void setCacheHint(CacheHint cacheHint)
```
  - getSourceHint
```
public SourceHint getSourceHint()
```
  - setSourceHint
```
public void setSourceHint(SourceHint sourceHint)
```
  - toString
```
public String toString()
```
    Returns a string representation of an instance of this class.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of object
  - sameOptionAndHint
```
protected boolean sameOptionAndHint(Command cmd)
```
  - returnsResultSet
```
public boolean returnsResultSet()
```
  - getResultSetColumns
```
public List<? extends Expression> getResultSetColumns()
```
    Returns:
    
    null if unknown, empty if results are not returned, or the resultset columns
  - getCommandToken
```
public static String getCommandToken(int commandType)
```

Class Command

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.teiid.query.sql.LanguageObject

Field Detail

TYPE_UNKNOWN

TYPE_QUERY

TYPE_INSERT

TYPE_UPDATE

TYPE_DELETE

TYPE_STORED_PROCEDURE

TYPE_UPDATE_PROCEDURE

TYPE_BATCHED_UPDATE

TYPE_DYNAMIC

TYPE_CREATE

TYPE_DROP

TYPE_TRIGGER_ACTION

TYPE_ALTER_VIEW

TYPE_ALTER_PROC

TYPE_ALTER_TRIGGER

TYPE_SOURCE_EVENT

tempGroupIDs

Constructor Detail

Command

Method Detail

getType

getCorrelatedReferences

setCorrelatedReferences

setTemporaryMetadata

getTemporaryMetadata

addExternalGroupToContext

setExternalGroupContexts

pushNewResolvingContext

getExternalGroupContexts

getAllExternalGroups

isResolved

setIsResolved

clone

copyMetadataState

printCommandTree

printCommandTree

getOption

setOption

getProjectedSymbols

areResultsCachable

getUpdateCommandSymbol

getProcessorPlan

setProcessorPlan

getCacheHint

setCacheHint

getSourceHint

setSourceHint

toString

sameOptionAndHint

returnsResultSet

getResultSetColumns

getCommandToken