com.metamatrix.query.processor.xml
Class XMLProcessorEnvironment

java.lang.Object
  com.metamatrix.query.processor.xml.XMLProcessorEnvironment

public class XMLProcessorEnvironment
extends java.lang.Object

Field Summary

static java.lang.String	JDOM_DOCUMENT_RESULT XML result documents should be in JDOM document form
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)
java.util.Collection	getChildPlans()
ProcessorInstruction	getCurrentInstruction()
Program	getCurrentProgram()
ProcessorDataManager	getDataManager()
GroupSymbol	getDocumentGroup()
DocumentInProgress	getDocumentInProgress()
CommandContext	getProcessorContext()
int	getProgramRecursionCount(Program program)
java.lang.String	getXMLFormat()
java.lang.String	getXMLResultsForm()
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	setChildPlans(java.util.Collection childPlans)
void	setDocumentGroup(GroupSymbol documentGroup)
void	setDocumentInProgress(DocumentInProgress documentInProgress)
void	setXMLFormat(java.lang.String xmlFormat)
void	setXMLResultsForm(java.lang.String xmlResultsForm)

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

JDOM_DOCUMENT_RESULT

public static final java.lang.String JDOM_DOCUMENT_RESULT

XML result documents should be in JDOM document 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#initialize(XMLPlan)

getCurrentProgram

public Program getCurrentProgram()

See Also:

com.metamatrix.query.processor.xml.ProcessorEnvironment#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()

See Also:

com.metamatrix.query.processor.xml.ProcessorEnvironment#incrementCurrentProgramCounter()

pushProgram

public void pushProgram(Program program)

See Also:

com.metamatrix.query.processor.xml.ProcessorEnvironment#pushProgram(Program)

pushProgram

public void pushProgram(Program program,
                        boolean isRecursive)

getCurrentInstruction

public ProcessorInstruction getCurrentInstruction()

See Also:

com.metamatrix.query.processor.xml.ProcessorEnvironment#getCurrentInstruction()

getProgramRecursionCount

public int getProgramRecursionCount(Program program)

See Also:

com.metamatrix.query.processor.xml.ProcessorEnvironment#getProgramRecursionCount(Program)

createResultExecutor

public PlanExecutor createResultExecutor(java.lang.String resultSetName,
                                         ResultSetInfo info)
                                  throws MetaMatrixComponentException

Throws:

MetaMatrixComponentException

getDocumentInProgress

public DocumentInProgress getDocumentInProgress()

See Also:

com.metamatrix.query.processor.xml.ProcessorEnvironment#getDocumentInProgress()

setDocumentInProgress

public void setDocumentInProgress(DocumentInProgress documentInProgress)

See Also:

com.metamatrix.query.processor.xml.ProcessorEnvironment#setDocumentInProgress(DocumentInProgress)

getXMLFormat

public java.lang.String getXMLFormat()

See Also:

com.metamatrix.query.processor.xml.ProcessorEnvironment#getXMLFormat

setXMLFormat

public void setXMLFormat(java.lang.String xmlFormat)

See Also:

com.metamatrix.query.processor.xml.ProcessorEnvironment#setXMLFormat

getXMLResultsForm

public java.lang.String getXMLResultsForm()

See Also:

com.metamatrix.query.processor.xml.ProcessorEnvironment#getXMLResultsForm

setXMLResultsForm

public void setXMLResultsForm(java.lang.String xmlResultsForm)

getDataManager

public ProcessorDataManager getDataManager()

See Also:

com.metamatrix.query.processor.xml.ProcessorEnvironment#getDataManager()

getProcessorContext

public CommandContext getProcessorContext()

See Also:

com.metamatrix.query.processor.xml.ProcessorEnvironment#getProcessorContext()

getChildPlans

public java.util.Collection getChildPlans()

See Also:

com.metamatrix.query.processor.xml.ProcessorEnvironment#getChildPlans()

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

See Also:

com.metamatrix.query.processor.xml.ProcessorEnvironment#clone()

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)

setChildPlans

public void setChildPlans(java.util.Collection childPlans)