com.metamatrix.query.processor.xml
Class Program

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

All Implemented Interfaces:

Describable

public class Program
extends java.lang.Object
implements Describable

A program is a sequence of ProcessorInstructions. Certain ProcessorInstructions, such as IfInstruction and WhileInstruction may have pointers to sub programs. XMLPlan will maintain a stack of programs during execution.

Field Summary

Fields inherited from interface com.metamatrix.query.processor.Describable

PROP_BINDINGS, PROP_CHILDREN, PROP_CONDITIONS, PROP_CRITERIA, PROP_DATA_COL, PROP_DEFAULT, PROP_DEFAULT_PROGRAM, PROP_ELSE, PROP_ENCODING, PROP_EXECUTION_PLAN, PROP_EXPRESSION, PROP_FORMATTED, PROP_GROUP, PROP_GROUP_COLS, PROP_IN_MEMORY, PROP_INTO_GROUP, PROP_IS_STAGING, PROP_JOIN_CRITERIA, PROP_JOIN_STRATEGY, PROP_JOIN_TYPE, PROP_MESSAGE, PROP_MODEL_NAME, PROP_NAMESPACE, PROP_NAMESPACE_DECL, PROP_NODE_COST_ESTIMATES, PROP_NODE_STATS_LIST, PROP_NODE_STATS_PROPS, PROP_OPTIONAL, PROP_OUTPUT_COLS, PROP_PROGRAM, PROP_PROGRAMS, PROP_RECURSE_DIR, PROP_REMOVE_DUPS, PROP_RESULT_SET, PROP_ROW_LIMIT, PROP_ROW_OFFSET, PROP_SELECT_COLS, PROP_SORT_COLS, PROP_SQL, PROP_TAG, PROP_THEN, PROP_TYPE, PROP_VARIABLE

Constructor Summary

Program()
Constructor for Program.

Method Summary

void	addInstruction(ProcessorInstruction instruction)
void	addInstructions(Program instructions)
java.util.Map	getDescriptionProperties() Get a description as a set of properties of primitive types such as String, Integer, etc.
ProcessorInstruction	getInstructionAt(int instructionIndex) Returns the instruction to be executed at the indicated index, or null if there is no instruction at that index.
void	removeInstructionAt(int instructionIndex) Removes the instruction to be executed at the indicated index, or do nothing if there is no instruction at that index.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Program

public Program()

Constructor for Program.

Method Detail

getInstructionAt

public ProcessorInstruction getInstructionAt(int instructionIndex)

Returns the instruction to be executed at the indicated index, or null if there is no instruction at that index.

Returns:

instruction to be executed at the indicated index, or null if there is no instruction at that index.

removeInstructionAt

public void removeInstructionAt(int instructionIndex)

Removes the instruction to be executed at the indicated index, or do nothing if there is no instruction at that index.

Parameters:

instructionIndex - index of instruction to be removed

addInstruction

public void addInstruction(ProcessorInstruction instruction)

addInstructions

public void addInstructions(Program instructions)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getDescriptionProperties

public java.util.Map getDescriptionProperties()

Description copied from interface: Describable

Get a description as a set of properties of primitive types such as String, Integer, etc.

Specified by:

getDescriptionProperties in interface Describable

Returns:

Map of properties