org.teiid.query.processor.xml
Class EndBlockInstruction

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

public class EndBlockInstruction
extends ProcessorInstruction

This instruction closes a result set, which closes and removes the TupleSource associated with it. This is needed to explicitly close temporary group result sets once processing moves out of their scope, otherwise they would not get cleaned up. But it can be used for other result sets besides temporary groups.

(This instruction does the same thing that a WhileInstruction does when the end of a result set is reached.)

Constructor Summary

EndBlockInstruction(java.lang.String resultSetName)
Constructor for CloseResultSetInstruction.

Method Summary

PlanNode	getDescriptionProperties()
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.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

EndBlockInstruction

public EndBlockInstruction(java.lang.String resultSetName)

Constructor for CloseResultSetInstruction.

Method Detail

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)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getDescriptionProperties

public PlanNode getDescriptionProperties()

Specified by:

getDescriptionProperties in class ProcessorInstruction