com.metamatrix.query.processor.xml
Class JoinedWhileInstruction

java.lang.Object
  com.metamatrix.query.processor.xml.ProcessorInstruction
      com.metamatrix.query.processor.xml.WhileInstruction
          com.metamatrix.query.processor.xml.JoinedWhileInstruction

All Implemented Interfaces:

Describable

public class JoinedWhileInstruction
extends WhileInstruction

Loop instruction on the result set execute before this instruction.

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

JoinedWhileInstruction(java.lang.String rsName, java.lang.Integer mappingClassNumber, ElementSymbol mappingClassSymbol, java.lang.String originalResultSet)
Constructor for WhileInstruction.

Method Summary

java.util.Map	getDescriptionProperties() Get a description as a set of properties of primitive types such as String, Integer, etc.
com.metamatrix.query.processor.xml.XMLContext	process(XMLProcessorEnvironment env, com.metamatrix.query.processor.xml.XMLContext context) Allow this ProcessorInstruction to do whatever processing it needs, and to in turn manipulate the running program, (via the ProcessorEnvironment getProgramStack method.) 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.)
java.lang.String	toString()

Methods inherited from class com.metamatrix.query.processor.xml.WhileInstruction

getBlockProgram, getResultSetName, pushProgram, setBlockProgram

Methods inherited from class java.lang.Object

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

Constructor Detail

JoinedWhileInstruction

public JoinedWhileInstruction(java.lang.String rsName,
                              java.lang.Integer mappingClassNumber,
                              ElementSymbol mappingClassSymbol,
                              java.lang.String originalResultSet)

Constructor for WhileInstruction.

Method Detail

process

public com.metamatrix.query.processor.xml.XMLContext process(XMLProcessorEnvironment env,
                                                             com.metamatrix.query.processor.xml.XMLContext context)
                                                      throws BlockedException,
                                                             MetaMatrixComponentException,
                                                             MetaMatrixProcessingException

Description copied from class: ProcessorInstruction

Allow this ProcessorInstruction to do whatever processing it needs, and to in turn manipulate the running program, (via the ProcessorEnvironment getProgramStack method.) 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.)

Overrides:

process in class WhileInstruction

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

MetaMatrixComponentException - for non-business exception

MetaMatrixProcessingException - for business exception due to user input or model

See Also:

ProcessorInstruction#process(ProcessorEnvironment)

toString

public java.lang.String toString()

Overrides:

toString in class WhileInstruction

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

Overrides:

getDescriptionProperties in class WhileInstruction

Returns:

Map of properties