com.metamatrix.query.optimizer.xquery
Class XQueryPlanner

java.lang.Object
  com.metamatrix.query.optimizer.xquery.XQueryPlanner

All Implemented Interfaces:

CommandPlanner

public class XQueryPlanner
extends java.lang.Object
implements CommandPlanner

Planner for XQuery execution plans

Constructor Summary

XQueryPlanner()

Method Summary

void	generateCanonical(CommandTreeNode node, QueryMetadataInterface metadata, AnalysisRecord analysisRecord, CommandContext context) Requests that the planner generate the canonical plan(s) for the Command object(s) represented by the CommandTreeNode tree parameter.
ProcessorPlan	optimize(CommandTreeNode node, IDGenerator idGenerator, QueryMetadataInterface metadata, CapabilitiesFinder capFinder, AnalysisRecord analysisRecord, CommandContext context) Allows the planner a chance to optimize the canonical plan(s) stored in the CommandTreeNode tree.

Methods inherited from class java.lang.Object

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

Constructor Detail

XQueryPlanner

public XQueryPlanner()

Method Detail

generateCanonical

public void generateCanonical(CommandTreeNode node,
                              QueryMetadataInterface metadata,
                              AnalysisRecord analysisRecord,
                              CommandContext context)
                       throws QueryPlannerException,
                              QueryMetadataException,
                              MetaMatrixComponentException

Description copied from interface: CommandPlanner

Requests that the planner generate the canonical plan(s) for the Command object(s) represented by the CommandTreeNode tree parameter. The canonical plan(s) should be added to the node(s) of the tree rooted at rootNode.

It may or may not make sense for a specific implementation of this Class to create a canonical plan. It may be that all planning can be done during the call to CommandPlanner.optimize(com.metamatrix.query.optimizer.CommandTreeNode, com.metamatrix.core.id.IDGenerator, com.metamatrix.query.metadata.QueryMetadataInterface, com.metamatrix.query.optimizer.capabilities.CapabilitiesFinder, com.metamatrix.query.analysis.AnalysisRecord, com.metamatrix.query.util.CommandContext)

Specified by:

generateCanonical in interface CommandPlanner

Parameters:

node - tree of CommandTreeNode object(s) rooted at rootNode

Throws:

QueryPlannerException - indicating a problem in planning

MetaMatrixComponentException - indicating an unexpected exception

QueryMetadataException

See Also:

CommandPlanner.generateCanonical(com.metamatrix.query.optimizer.CommandTreeNode, com.metamatrix.query.metadata.QueryMetadataInterface, com.metamatrix.query.analysis.AnalysisRecord, CommandContext)

optimize

public ProcessorPlan optimize(CommandTreeNode node,
                              IDGenerator idGenerator,
                              QueryMetadataInterface metadata,
                              CapabilitiesFinder capFinder,
                              AnalysisRecord analysisRecord,
                              CommandContext context)
                       throws QueryPlannerException,
                              QueryMetadataException,
                              MetaMatrixComponentException

Description copied from interface: CommandPlanner

Allows the planner a chance to optimize the canonical plan(s) stored in the CommandTreeNode tree. This method should be called in a bottom-up manner; from leaf nodes up to the root node.

Specified by:

optimize in interface CommandPlanner

Parameters:

node - root of a tree (or subtree) of CommandTreeNode objects, each of which should have its canonical plan

metadata - source of metadata

capFinder - Class usable to find the connector capabilities for a particular model

Returns:

ProcessorPlan implementation specific to the CommandPlanner

Throws:

QueryPlannerException - indicating a problem in planning

QueryMetadataException - indicating an exception in accessing the metadata

MetaMatrixComponentException - indicating an unexpected exception

See Also:

CommandPlanner.optimize(com.metamatrix.query.optimizer.CommandTreeNode, com.metamatrix.core.id.IDGenerator, com.metamatrix.query.metadata.QueryMetadataInterface, com.metamatrix.query.optimizer.capabilities.CapabilitiesFinder, com.metamatrix.query.analysis.AnalysisRecord, CommandContext)