net.sf.farrago.fennel.rel
Class FennelTempIdxSearchRel

java.lang.Object
  org.eigenbase.rel.AbstractRelNode
      org.eigenbase.rel.SingleRel
          net.sf.farrago.fennel.rel.FennelSingleRel
              net.sf.farrago.fennel.rel.FennelTempIdxSearchRel

All Implemented Interfaces:

Cloneable, FennelRel, RelNode

 class FennelTempIdxSearchRel
extends FennelSingleRel

FennelTempIdxSearchRel searches a temporary index that is built during runtime using search keys read through dynamic parameters and search directives passed in through its input.

Version:

$Id: //open/dev/farrago/src/net/sf/farrago/fennel/rel/FennelTempIdxSearchRel.java#1 $

Author:

Zelaine Fong

Field Summary

(package private) Integer[]	indexKeys
(package private) Integer[]	inputDirectiveProj
(package private) Integer[]	inputKeyProj
(package private) Integer[]	keyOffsets
(package private) FennelRelParamId	rootPageIdParamId
(package private) FennelRelParamId[]	searchKeyParamIds
(package private) RelNode	sourceRel

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

FennelTempIdxSearchRel(RelNode sourceRel, Integer[] indexKeys, RelNode child, Integer[] inputKeyProj, Integer[] inputDirectiveProj, FennelRelParamId[] searchKeyParamIds, Integer[] keyOffsets, FennelRelParamId rootPageIdParamId)
Creates a new FennelTempIdxSearchRel object.

Method Summary

FennelTempIdxSearchRel	clone() Clones this RelNode.
RelOptCost	computeSelfCost(RelOptPlanner planner) Returns the cost of this plan (not including children).
RelDataType	deriveRowType()
void	explain(RelOptPlanWriter pw)
double	getRows() Returns an estimate of the number of rows this relational expression will return.
FemExecutionStreamDef	toStreamDef(FennelRelImplementor implementor) Converts this relational expression to FemExecutionStreamDef form.

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

getCollations, getFarragoTypeFactory, implementFennelChild

Methods inherited from class org.eigenbase.rel.SingleRel

childrenAccept, getChild, getInputs, 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, getRowType, getTable, getTraits, getVariablesStopped, isAccessTo, isDistinct, isValid, onRegister, recomputeDigest, registerCorrelVariable, replaceInput, setCorrelVariable

Field Detail

sourceRel

final RelNode sourceRel

indexKeys

final Integer[] indexKeys

inputKeyProj

final Integer[] inputKeyProj

inputDirectiveProj

final Integer[] inputDirectiveProj

searchKeyParamIds

final FennelRelParamId[] searchKeyParamIds

keyOffsets

final Integer[] keyOffsets

rootPageIdParamId

final FennelRelParamId rootPageIdParamId

Constructor Detail

FennelTempIdxSearchRel

public FennelTempIdxSearchRel(RelNode sourceRel,
                              Integer[] indexKeys,
                              RelNode child,
                              Integer[] inputKeyProj,
                              Integer[] inputDirectiveProj,
                              FennelRelParamId[] searchKeyParamIds,
                              Integer[] keyOffsets,
                              FennelRelParamId rootPageIdParamId)

Creates a new FennelTempIdxSearchRel object.

Parameters:

sourceRel - underlying RelNode that will be used to populate the temporary index to be searched

indexKeys - the projection from the sourceRel corresponding to the temporary index keys

child - input which produces the search directives and specifies the types of the search keys

inputKeyProj - the projection of input fields corresponding to the search keys

inputDirectiveProj - the projection of input fields specifying the search directives

searchKeyParamIds - dynamic parameter ids corresponding to the search keys

keyOffsets - offset within the search key that each dynamic parameter corresponds to

rootPageIdParamId - dynamic parameter id that will be used to pass along the rootPageId of the temporary index to be searched

Method Detail

getRows

public double getRows()

Description copied from interface: RelNode

Returns an estimate of the number of rows this relational expression will return.

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

Specified by:

getRows in interface RelNode

Overrides:

getRows in class SingleRel

clone

public FennelTempIdxSearchRel 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

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

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