org.teiid.query.processor.proc

Class ReturnInstruction

java.lang.Object

org.teiid.query.processor.proc.ProgramInstruction

org.teiid.query.processor.proc.ReturnInstruction

All Implemented Interfaces:

Cloneable

public class ReturnInstruction
extends ProgramInstruction

Constructor Summary

Constructors

Constructor and Description
ReturnInstruction()

Method Summary

Modifier and Type	Method and Description
PlanNode	getDescriptionProperties()
void	process(ProcedurePlan env) Allow this instruction to do whatever processing it needs, and to in turn manipulate the running program.
String	toString()

Methods inherited from class org.teiid.query.processor.proc.ProgramInstruction

clone, requiresTransaction

Methods inherited from class java.lang.Object

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

Constructor Detail

ReturnInstruction

public ReturnInstruction()

Method Detail

toString

public String toString()

Overrides:

toString in class Object

process

public void process(ProcedurePlan env)
             throws TeiidComponentException

Description copied from class: ProgramInstruction

Allow this instruction to do whatever processing it needs, and to in turn manipulate the running program. A typical instruction should simply increment the program counter of the current program, but specialized instructions may add sub programs to the stack or not increment the counter (so that they are executed again.)

Specified by:

process in class ProgramInstruction

Throws:

TeiidComponentException

getDescriptionProperties

public PlanNode getDescriptionProperties()

Specified by:

getDescriptionProperties in class ProgramInstruction