org.teiid.query.processor.xml
Class XMLProcessorEnvironment

java.lang.Object
  extended by org.teiid.query.processor.xml.XMLProcessorEnvironment

public class XMLProcessorEnvironment
extends java.lang.Object


Field Summary
static java.lang.String STRING_RESULT
          XML result documents should be in String form
 
Constructor Summary
protected XMLProcessorEnvironment()
           
  XMLProcessorEnvironment(Program mainProgram)
           
 
Method Summary
 java.lang.Object clone()
           
protected  void copyIntoClone(XMLProcessorEnvironment clone)
          Utility method to copy cloned state into newly-instantiated (empty) clone.
 PlanExecutor createResultExecutor(java.lang.String resultSetName, ResultSetInfo info)
           
 BufferManager getBufferManager()
           
 ProcessorInstruction getCurrentInstruction()
           
 Program getCurrentProgram()
           
 ProcessorDataManager getDataManager()
           
 GroupSymbol getDocumentGroup()
           
 DocumentInProgress getDocumentInProgress()
           
 CommandContext getProcessorContext()
           
 int getProgramRecursionCount(Program program)
           
 java.lang.String getXMLFormat()
           
 void incrementCurrentProgramCounter()
           
 void initialize(CommandContext context, ProcessorDataManager dataMgr, BufferManager bufferMgr)
           
 boolean isRecursiveProgramInStack()
          Indicates if there is a recursive program anywhere in the current program stack (not just at the top).
 void pushProgram(Program program)
           
 void pushProgram(Program program, boolean isRecursive)
           
 void setDocumentGroup(GroupSymbol documentGroup)
           
 void setDocumentInProgress(DocumentInProgress documentInProgress)
           
 void setXMLFormat(java.lang.String xmlFormat)
           
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

STRING_RESULT

public static final java.lang.String STRING_RESULT
XML result documents should be in String form

See Also:
Constant Field Values
Constructor Detail

XMLProcessorEnvironment

protected XMLProcessorEnvironment()

XMLProcessorEnvironment

public XMLProcessorEnvironment(Program mainProgram)
Method Detail

initialize

public void initialize(CommandContext context,
                       ProcessorDataManager dataMgr,
                       BufferManager bufferMgr)
See Also:
ProcessorEnvironment#start()

getCurrentProgram

public Program getCurrentProgram()

isRecursiveProgramInStack

public boolean isRecursiveProgramInStack()
Indicates if there is a recursive program anywhere in the current program stack (not just at the top).

Returns:
whether there is a recursive program anywhere in the program stack

incrementCurrentProgramCounter

public void incrementCurrentProgramCounter()

pushProgram

public void pushProgram(Program program)

pushProgram

public void pushProgram(Program program,
                        boolean isRecursive)

getCurrentInstruction

public ProcessorInstruction getCurrentInstruction()

getProgramRecursionCount

public int getProgramRecursionCount(Program program)

createResultExecutor

public PlanExecutor createResultExecutor(java.lang.String resultSetName,
                                         ResultSetInfo info)
                                  throws TeiidComponentException
Throws:
TeiidComponentException

getDocumentInProgress

public DocumentInProgress getDocumentInProgress()

setDocumentInProgress

public void setDocumentInProgress(DocumentInProgress documentInProgress)

getXMLFormat

public java.lang.String getXMLFormat()

setXMLFormat

public void setXMLFormat(java.lang.String xmlFormat)

getDataManager

public ProcessorDataManager getDataManager()

getProcessorContext

public CommandContext getProcessorContext()

clone

public java.lang.Object clone()
Overrides:
clone in class java.lang.Object

copyIntoClone

protected void copyIntoClone(XMLProcessorEnvironment clone)
Utility method to copy cloned state into newly-instantiated (empty) clone. Clone will appear as if it were reset.

Parameters:
clone - new but empty

getDocumentGroup

public GroupSymbol getDocumentGroup()

setDocumentGroup

public void setDocumentGroup(GroupSymbol documentGroup)

getBufferManager

public BufferManager getBufferManager()


Copyright © 2010. All Rights Reserved.