com.metamatrix.query.processor.proc
Class CreateCursorResultSetInstruction

java.lang.Object
  com.metamatrix.query.processor.program.ProgramInstruction
      com.metamatrix.query.processor.proc.CreateCursorResultSetInstruction

All Implemented Interfaces:

Describable, java.lang.Cloneable

Direct Known Subclasses:

LoopInstruction

public class CreateCursorResultSetInstruction
extends ProgramInstruction

Field Summary

protected ProcessorPlan	plan
protected java.lang.String	rsName

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

CreateCursorResultSetInstruction(java.lang.String rsName, ProcessorPlan plan)

Method Summary

java.lang.Object	clone() Returns a deep clone
java.util.Collection	getChildPlans() Finds all nested plans and returns them.
java.lang.Object	getCommand()
java.util.Map	getDescriptionProperties() Get a description as a set of properties of primitive types such as String, Integer, etc.
void	process(ProcedurePlan procEnv) If the result set named rsName does not exist yet in the ProcessorEnvironment, then this instruction will define that result set.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

rsName

protected java.lang.String rsName

plan

protected ProcessorPlan plan

Constructor Detail

CreateCursorResultSetInstruction

public CreateCursorResultSetInstruction(java.lang.String rsName,
                                        ProcessorPlan plan)

Method Detail

process

public void process(ProcedurePlan procEnv)
             throws BlockedException,
                    MetaMatrixComponentException,
                    MetaMatrixProcessingException

If the result set named rsName does not exist yet in the ProcessorEnvironment, then this instruction will define that result set. It will then throw a BlockedException if this result set is selecting from other than temp groups (because those results will be delivered asynchronously). IF the result set named rsName does already exist, this instruction will just increment the program counter and do nothing else.

Specified by:

process in class ProgramInstruction

Throws:

BlockedException - if this result set is not selecting from only temp groups

MetaMatrixComponentException

MetaMatrixProcessingException

clone

public java.lang.Object clone()

Returns a deep clone

Overrides:

clone in class ProgramInstruction

Returns:

shallow clone

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

Overrides:

getDescriptionProperties in class ProgramInstruction

Returns:

Map of properties

getCommand

public java.lang.Object getCommand()

getChildPlans

public java.util.Collection getChildPlans()

Description copied from class: ProgramInstruction

Finds all nested plans and returns them.

Overrides:

getChildPlans in class ProgramInstruction

Returns:

List of ProcessorPlan

Since:

4.2

See Also:

ProgramInstruction.getChildPlans()