org.teiid.query.processor.xml
Class ProcessorInstruction

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

Direct Known Subclasses:

AbortProcessingInstruction, AddCommentInstruction, AddNodeInstruction, BlockInstruction, EndBlockInstruction, EndDocumentInstruction, ExecSqlInstruction, ExecStagingTableInstruction, IfInstruction, InitializeDocumentInstruction, MoveCursorInstruction, MoveDocInstruction, WhileInstruction

public abstract class ProcessorInstruction
extends java.lang.Object

Abstract superclass of all XML Processor Instructions.

Constructor Summary

ProcessorInstruction()

Method Summary

abstract PlanNode	getDescriptionProperties()
abstract 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessorInstruction

public ProcessorInstruction()

Method Detail

process

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

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.)

Parameters:

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

Throws:

TeiidComponentException - for non-business exception

TeiidProcessingException - for business exception due to user input or model

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

getDescriptionProperties

public abstract PlanNode getDescriptionProperties()