com.metamatrix.query.processor.relational
Class RelationalPlan

java.lang.Object
  extended by com.metamatrix.query.processor.BaseProcessorPlan
      extended by com.metamatrix.query.processor.relational.RelationalPlan
All Implemented Interfaces:
Describable, ProcessorPlan, java.lang.Cloneable

public class RelationalPlan
extends BaseProcessorPlan


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
RelationalPlan(RelationalNode node)
          Constructor for RelationalPlan.
 
Method Summary
 java.lang.Object clone()
          Return a safe clone of the ProcessorPlan.
 void close()
          Close the plan after processing.
 java.util.Collection getChildPlans()
          Finds all nested plans and returns them.
 java.util.Map getDescriptionProperties()
          Get a description as a set of properties of primitive types such as String, Integer, etc.
 java.util.List getOutputElements()
          Get list of resolved elements describing output columns for this plan.
 RelationalNode getRootNode()
           
 void initialize(CommandContext context, ProcessorDataManager dataMgr, BufferManager bufferMgr)
          Initialize the plan with some required pieces of data for making queries.
 TupleBatch nextBatch()
          Get a batch of results or possibly an Exception.
 void open()
          Open the plan for processing.
 void reset()
          Reset a plan so that it can be processed again.
 void setOutputElements(java.util.List outputCols)
           
 void setRootNode(RelationalNode root)
           
 java.lang.String toString()
           
 
Methods inherited from class com.metamatrix.query.processor.BaseProcessorPlan
addWarning, getAndClearWarnings, getContext, setContext
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RelationalPlan

public RelationalPlan(RelationalNode node)
Constructor for RelationalPlan.

Method Detail

getRootNode

public RelationalNode getRootNode()

setRootNode

public void setRootNode(RelationalNode root)

initialize

public void initialize(CommandContext context,
                       ProcessorDataManager dataMgr,
                       BufferManager bufferMgr)
Description copied from interface: ProcessorPlan
Initialize the plan with some required pieces of data for making queries. The data manager is used to make queries and the processorID must be passed with the request so the data manager can find the processor again.

Parameters:
context - Process execution context
dataMgr - Data manager reference
bufferMgr - Buffer manager reference
See Also:
ProcessorPlan#connectDataManager(ProcessorDataManager)

getOutputElements

public java.util.List getOutputElements()
Get list of resolved elements describing output columns for this plan.

Returns:
List of SingleElementSymbol

open

public void open()
          throws MetaMatrixComponentException,
                 MetaMatrixProcessingException
Description copied from interface: ProcessorPlan
Open the plan for processing.

Throws:
MetaMatrixComponentException
MetaMatrixProcessingException

nextBatch

public TupleBatch nextBatch()
                     throws BlockedException,
                            MetaMatrixComponentException,
                            MetaMatrixProcessingException
Description copied from interface: ProcessorPlan
Get a batch of results or possibly an Exception.

Returns:
Batch of results
Throws:
BlockedException - indicating next batch is not available yet
MetaMatrixComponentException - for non-business rule exception
MetaMatrixProcessingException - for business rule exception, related to user input or modeling
See Also:
ProcessorPlan.nextBatch()

close

public void close()
           throws MetaMatrixComponentException
Description copied from interface: ProcessorPlan
Close the plan after processing.

Throws:
MetaMatrixComponentException

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
Overrides:
reset in class BaseProcessorPlan
See Also:
ProcessorPlan.reset()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

clone

public 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
Specified by:
clone in class BaseProcessorPlan
Returns:
safe clone of this ProcessorPlan, as long as it is not open for processing

getChildPlans

public java.util.Collection getChildPlans()
Description copied from interface: ProcessorPlan
Finds all nested plans and returns them.

Returns:
List of ProcessorPlan
Since:
4.2
See Also:
ProcessorPlan.getChildPlans()

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.

Returns:
Map of properties

setOutputElements

public void setOutputElements(java.util.List outputCols)
Parameters:
outputCols - The outputCols to set.


Copyright © 2009. All Rights Reserved.