org.teiid.query.processor.xml
Class WhileInstruction

java.lang.Object
  org.teiid.query.processor.xml.ProcessorInstruction
      org.teiid.query.processor.xml.WhileInstruction

Direct Known Subclasses:

JoinedWhileInstruction

public class WhileInstruction
extends ProcessorInstruction

Loop instruction on the result set execute before this instruction.

Constructor Summary

WhileInstruction(java.lang.String rsName)
Constructor for WhileInstruction.

Method Summary

Program	getBlockProgram()
PlanNode	getDescriptionProperties()
java.lang.String	getResultSetName()
org.teiid.query.processor.xml.XMLContext	process(XMLProcessorEnvironment env, org.teiid.query.processor.xml.XMLContext context) Allow this ProcessorInstruction to do whatever processing it needs, and to in turn manipulate the running program.
protected void	pushProgram(XMLProcessorEnvironment env, org.teiid.query.processor.xml.XMLContext context, java.util.List row)
void	setBlockProgram(Program blockProgram)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

WhileInstruction

public WhileInstruction(java.lang.String rsName)

Constructor for WhileInstruction.

Method Detail

setBlockProgram

public void setBlockProgram(Program blockProgram)

getBlockProgram

public Program getBlockProgram()

process

public org.teiid.query.processor.xml.XMLContext process(XMLProcessorEnvironment env,
                                                        org.teiid.query.processor.xml.XMLContext context)
                                                 throws BlockedException,
                                                        TeiidComponentException,
                                                        TeiidProcessingException

Description copied from class: ProcessorInstruction

Allow this ProcessorInstruction 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 ProcessorInstruction

Parameters:

env - instance of ProcessorEnvironment which is being used for the processing of the XML document model query

Throws:

BlockedException - if data is not available now but may be at a later time

TeiidComponentException - for non-business exception

TeiidProcessingException - for business exception due to user input or model

See Also:

ProcessorInstruction#process(ProcessorEnvironment)

pushProgram

protected void pushProgram(XMLProcessorEnvironment env,
                           org.teiid.query.processor.xml.XMLContext context,
                           java.util.List row)
                    throws TeiidComponentException

Throws:

TeiidComponentException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getDescriptionProperties

public PlanNode getDescriptionProperties()

Specified by:

getDescriptionProperties in class ProcessorInstruction

getResultSetName

public java.lang.String getResultSetName()