org.teiid.query.processor.proc
Class ErrorInstruction

java.lang.Object
  extended by org.teiid.query.processor.proc.ProgramInstruction
      extended by org.teiid.query.processor.proc.ErrorInstruction
All Implemented Interfaces:
Cloneable

public class ErrorInstruction
extends ProgramInstruction

This instruction updates the current variable context with the Variable defined using the declare statement that is used in constructing this instruction.


Field Summary
static String ERROR_PREFIX
           
 
Constructor Summary
ErrorInstruction()
          Constructor for DeclareInstruction.
 
Method Summary
 ErrorInstruction clone()
          Override Object.clone() to make the method public.
 PlanNode getDescriptionProperties()
           
 void process(ProcedurePlan env)
          Allow this instruction to do whatever processing it needs, and to in turn manipulate the running program.
 void setExpression(Expression expression)
           
 String toString()
           
 
Methods inherited from class org.teiid.query.processor.proc.ProgramInstruction
getChildPlans
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ERROR_PREFIX

public static final String ERROR_PREFIX
See Also:
Constant Field Values
Constructor Detail

ErrorInstruction

public ErrorInstruction()
Constructor for DeclareInstruction.

Method Detail

setExpression

public void setExpression(Expression expression)

clone

public ErrorInstruction clone()
Description copied from class: ProgramInstruction
Override Object.clone() to make the method public. This method simply calls super.clone(), deferring to the default shallow cloning. Some ProcessorInstruction subclasses may need to override with custom safe or deep cloning.

Overrides:
clone in class ProgramInstruction
Returns:
shallow clone
See Also:
ProgramInstruction.clone()

toString

public String toString()
Overrides:
toString in class Object

getDescriptionProperties

public PlanNode getDescriptionProperties()
Specified by:
getDescriptionProperties in class ProgramInstruction

process

public void process(ProcedurePlan env)
             throws TeiidComponentException,
                    TeiidProcessingException
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
TeiidProcessingException


Copyright © 2012. All Rights Reserved.