net.sf.farrago.namespace.ftrs
Class FtrsIndexBuilderRel

java.lang.Object
  org.eigenbase.rel.AbstractRelNode
      org.eigenbase.rel.SingleRel
          net.sf.farrago.fennel.rel.FennelSingleRel
              net.sf.farrago.namespace.ftrs.FtrsIndexBuilderRel

All Implemented Interfaces:

Cloneable, FennelRel, RelNode

 class FtrsIndexBuilderRel
extends FennelSingleRel

FtrsIndexBuilderRel is the relational expression corresponding to building a single unclustered index on an FTRS table. Currently it is implemented via a FemTableWriter; TODO: use a BTreeBuilder instead.

The input must be the coverage tuple of the index.

Version:

$Id: //open/dev/farrago/src/net/sf/farrago/namespace/ftrs/FtrsIndexBuilderRel.java#9 $

Author:

John V. Sichi

Field Summary

private FemLocalIndex

index Index to be built.

Fields inherited from class org.eigenbase.rel.AbstractRelNode

digest, id, rowType, traits

Fields inherited from interface net.sf.farrago.query.FennelRel

FENNEL_EXEC_CONVENTION

Fields inherited from interface org.eigenbase.rel.RelNode

emptyArray

Constructor Summary

FtrsIndexBuilderRel(RelOptCluster cluster, RelNode child, FemLocalIndex index)

Method Summary

FtrsIndexBuilderRel	clone() Clones this RelNode.
RelOptCost	computeSelfCost(RelOptPlanner planner) Returns the cost of this plan (not including children).
RelDataType	deriveRowType()
void	explain(RelOptPlanWriter pw)
RelFieldCollation[]	getCollations() TODO: jhyde, 2006/3/28: unify with RelNode.getCollationList()
FemExecutionStreamDef	toStreamDef(FennelRelImplementor implementor) Converts this relational expression to FemExecutionStreamDef form.

Methods inherited from class net.sf.farrago.fennel.rel.FennelSingleRel

getFarragoTypeFactory, implementFennelChild

Methods inherited from class org.eigenbase.rel.SingleRel

childrenAccept, getChild, getInputs, getRows, replaceInput

Methods inherited from class org.eigenbase.rel.AbstractRelNode

cloneTraits, collectVariablesSet, collectVariablesUsed, computeDigest, getChildExps, getCluster, getCollationList, getConvention, getCorrelVariable, getDescription, getDigest, getExpectedInputRowType, getId, getInput, getOrCreateCorrelVariable, getQuery, getRelTypeName, getRowType, getTable, getTraits, getVariablesStopped, inheritTraitsFrom, isAccessTo, isDistinct, isValid, onRegister, recomputeDigest, register, registerCorrelVariable, setCorrelVariable, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eigenbase.rel.RelNode

childrenAccept, collectVariablesSet, collectVariablesUsed, getChildExps, getCluster, getCollationList, getConvention, getCorrelVariable, getDescription, getDigest, getExpectedInputRowType, getId, getInput, getInputs, getOrCreateCorrelVariable, getQuery, getRelTypeName, getRows, getRowType, getTable, getTraits, getVariablesStopped, isAccessTo, isDistinct, isValid, onRegister, recomputeDigest, registerCorrelVariable, replaceInput, setCorrelVariable

Field Detail

index

private final FemLocalIndex index

Index to be built.

Constructor Detail

FtrsIndexBuilderRel

FtrsIndexBuilderRel(RelOptCluster cluster,
                    RelNode child,
                    FemLocalIndex index)

Method Detail

clone

public FtrsIndexBuilderRel clone()

Description copied from interface: RelNode

Clones this RelNode.

Traits of the RelNode must be explicitly cloned, using AbstractRelNode.inheritTraitsFrom(AbstractRelNode), as the RelNode may have traits of which it has no knowledge. Example implementation:

     public MyRelNode clone()
     {
         MyRelNode clone = new MyRelNode(...);
         clone.inheritTraitsFrom(this);
         return clone;
     }
 

N.B.: This method must be overridden whenever an existing, concrete RelNode is extended. Otherwise, calling clone() will produce a differently typed RelNode, resulting in invalid or incorrect query plans.

Specified by:

clone in interface RelNode

Specified by:

clone in class AbstractRelNode

Returns:

a clone of this RelNode

computeSelfCost

public RelOptCost computeSelfCost(RelOptPlanner planner)

Description copied from interface: RelNode

Returns the cost of this plan (not including children). The base implementation throws an error; derived classes should override.

NOTE jvs 29-Mar-2006: Don't call this method directly. Instead, use RelMetadataQuery.getNonCumulativeCost(org.eigenbase.rel.RelNode), which gives plugins a chance to override the rel's default ideas about cost.

Specified by:

computeSelfCost in interface RelNode

Overrides:

computeSelfCost in class AbstractRelNode

toStreamDef

public FemExecutionStreamDef toStreamDef(FennelRelImplementor implementor)

Description copied from interface: FennelRel

Converts this relational expression to FemExecutionStreamDef form. In the process, the relational expression will almost certainly call FennelRelImplementor.visitFennelChild(net.sf.farrago.query.FennelRel, int) on each of its children.

Parameters:

implementor - for generating Java code

Returns:

generated FemExecutionStreamDef

deriveRowType

public RelDataType deriveRowType()

Overrides:

deriveRowType in class SingleRel

explain

public void explain(RelOptPlanWriter pw)

Specified by:

explain in interface RelNode

Overrides:

explain in class SingleRel

getCollations

public RelFieldCollation[] getCollations()

Description copied from interface: FennelRel

TODO: jhyde, 2006/3/28: unify with RelNode.getCollationList()

Specified by:

getCollations in interface FennelRel

Overrides:

getCollations in class FennelSingleRel

Returns:

the sort order produced by this FennelRel, or an empty array if the output is not guaranteed to be in any particular order.