Program (Teiid 12.2.0 API)

java.lang.Object
- org.teiid.query.processor.proc.Program

All Implemented Interfaces:

Cloneable, Statement.Labeled
```
public class Program
extends Object
implements Cloneable, Statement.Labeled
```
A program is a sequence of ProgramInstruction. Certain ProgramInstructions, such as IfInstruction and WhileInstruction may have pointers to sub programs.

Constructor Summary

Constructors
Constructor and Description

Program(boolean atomic)
Constructor for Program.

Constructors
Constructor and Description
`Program(boolean atomic)` Constructor for Program.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addInstruction(ProgramInstruction instruction)`
`void`	`addInstructions(Program instructions)`
`Program`	`clone()` Produces a deep clone.
`void`	`decrementProgramCounter()` Decrements the program counter, so that the next call to `getCurrentInstruction()` will return the previous instruction.
`ProgramInstruction`	`getCurrentInstruction()` Returns the next instruction to be executed, or null if there are none or no more instructions.
`PlanNode`	`getDescriptionProperties()`
`String`	`getExceptionGroup()`
`Program`	`getExceptionProgram()`
`ProgramInstruction`	`getInstructionAt(int instructionIndex)` Returns the instruction to be executed at the indicated index, or null if there is no instruction at that index.
`String`	`getLabel()`
`List<ProgramInstruction>`	`getProcessorInstructions()`
`TempTableStore`	`getTempTableStore()`
`void`	`incrementProgramCounter()` Increments the program counter, so that the next call to `getCurrentInstruction()` will return the following instruction.
`Boolean`	`instructionsRequireTransaction(boolean transactionalReads)`
`boolean`	`isAtomic()`
`boolean`	`isTrappingExceptions()`
`Boolean`	`requiresTransaction(boolean transactionalReads)`
`void`	`reset(String sessionId)` Resets this program, so it can be run through again.
`void`	`setExceptionGroup(String exceptionGroup)`
`void`	`setExceptionProgram(Program exceptionBlock)`
`void`	`setLabel(String label)`
`void`	`setStartedTxn(boolean startedTxn)`
`void`	`setTrappingExceptions(boolean trappingExceptions)`
`boolean`	`startedTxn()`
`String`	`toString()`

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

- Constructor Detail
  - Program
```
public Program(boolean atomic)
```
    Constructor for Program.
- Method Detail
  - setStartedTxn
```
public void setStartedTxn(boolean startedTxn)
```
  - startedTxn
```
public boolean startedTxn()
```
  - getLabel
```
public String getLabel()
```
    Specified by:
    
    getLabel in interface Statement.Labeled
  - setLabel
```
public void setLabel(String label)
```
    Specified by:
    
    setLabel in interface Statement.Labeled
  - isAtomic
```
public boolean isAtomic()
```
  - getTempTableStore
```
public TempTableStore getTempTableStore()
```
  - getCurrentInstruction
```
public ProgramInstruction getCurrentInstruction()
```
    Returns the next instruction to be executed, or null if there are none or no more instructions.
    
    Returns:
    
    ProgramInstruction to be executed next, or null if there are no more to execute (or if this Program is empty)
  - incrementProgramCounter
```
public void incrementProgramCounter()
```
    Increments the program counter, so that the next call to getCurrentInstruction() will return the following instruction. This method is intended to be used by a ProcessingInstruction itself, to control the flow of execution.
  - decrementProgramCounter
```
public void decrementProgramCounter()
```
    Decrements the program counter, so that the next call to getCurrentInstruction() will return the previous instruction. This method is intended to be used by a ProcessingInstruction itself, to control the flow of execution.
  - reset
```
public void reset(String sessionId)
```
    Resets this program, so it can be run through again.
  - getInstructionAt
```
public ProgramInstruction getInstructionAt(int instructionIndex)
```
    Returns the instruction to be executed at the indicated index, or null if there is no instruction at that index.
    
    Returns:
    
    instruction to be executed at the indicated index, or null if there is no instruction at that index.
  - addInstruction
```
public void addInstruction(ProgramInstruction instruction)
```
  - addInstructions
```
public void addInstructions(Program instructions)
```
  - clone
```
public Program clone()
```
    Produces a deep clone.
    
    Overrides:
    
    clone in class Object
  - getDescriptionProperties
```
public PlanNode getDescriptionProperties()
```
  - getProcessorInstructions
```
public List<ProgramInstruction> getProcessorInstructions()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - setExceptionGroup
```
public void setExceptionGroup(String exceptionGroup)
```
  - setExceptionProgram
```
public void setExceptionProgram(Program exceptionBlock)
```
  - getExceptionGroup
```
public String getExceptionGroup()
```
  - getExceptionProgram
```
public Program getExceptionProgram()
```
  - isTrappingExceptions
```
public boolean isTrappingExceptions()
```
  - setTrappingExceptions
```
public void setTrappingExceptions(boolean trappingExceptions)
```
  - requiresTransaction
```
public Boolean requiresTransaction(boolean transactionalReads)
```
  - instructionsRequireTransaction
```
public Boolean instructionsRequireTransaction(boolean transactionalReads)
```

Class Program

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Program

Method Detail

setStartedTxn

startedTxn

getLabel

setLabel

isAtomic

getTempTableStore

getCurrentInstruction

incrementProgramCounter

decrementProgramCounter

reset

getInstructionAt

addInstruction

addInstructions

clone

getDescriptionProperties

getProcessorInstructions

toString

setExceptionGroup

setExceptionProgram

getExceptionGroup

getExceptionProgram

isTrappingExceptions

setTrappingExceptions

requiresTransaction

instructionsRequireTransaction