com.metamatrix.query.processor
Class BaseProcessorPlan

java.lang.Object
  com.metamatrix.query.processor.BaseProcessorPlan

All Implemented Interfaces:

Describable, ProcessorPlan, java.lang.Cloneable

Direct Known Subclasses:

BatchedUpdatePlan, ProcedurePlan, RelationalPlan, XMLPlan, XQueryPlan

public abstract class BaseProcessorPlan
extends java.lang.Object
implements ProcessorPlan

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

BaseProcessorPlan()
Constructor for BaseProcessorPlan.

Method Summary

protected void	addWarning(MetaMatrixException warning)
abstract java.lang.Object	clone() Return a safe clone of the ProcessorPlan.
java.util.List	getAndClearWarnings() Get all warnings found while processing this plan.
CommandContext	getContext() Get the processor context, which can be modified.
void	reset() Reset a plan so that it can be processed again.
void	setContext(CommandContext context)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.metamatrix.query.processor.ProcessorPlan

close, getChildPlans, getOutputElements, initialize, nextBatch, open

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

getDescriptionProperties

Constructor Detail

BaseProcessorPlan

public BaseProcessorPlan()

Constructor for BaseProcessorPlan.

Method Detail

getAndClearWarnings

public java.util.List getAndClearWarnings()

Description copied from interface: ProcessorPlan

Get all warnings found while processing this plan. These warnings may be detected throughout the plan lifetime, which means new ones may arrive at any time. This method returns all current warnings and clears the current warnings list. The warnings are in order they were detected.

Specified by:

getAndClearWarnings in interface ProcessorPlan

Returns:

Current list of warnings, never null

See Also:

ProcessorPlan.getAndClearWarnings()

addWarning

protected void addWarning(MetaMatrixException warning)

getContext

public CommandContext getContext()

Description copied from interface: ProcessorPlan

Get the processor context, which can be modified.

Specified by:

getContext in interface ProcessorPlan

Returns:

setContext

public void setContext(CommandContext context)

Parameters:

context -

reset

public void reset()

Description copied from interface: ProcessorPlan

Reset a plan so that it can be processed again.

Specified by:

reset in interface ProcessorPlan

clone

public abstract java.lang.Object clone()

Description copied from interface: ProcessorPlan

Return a safe clone of the ProcessorPlan. A ProcessorPlan may only be safely cloned in between processings. That is, it is only safe to clone a plan before it is opened or after it is closed.

Specified by:

clone in interface ProcessorPlan

Overrides:

clone in class java.lang.Object

Returns:

safe clone of this ProcessorPlan, as long as it is not open for processing