net.sf.farrago.fennel.rel
Class FennelIdxWriteRel

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

All Implemented Interfaces:

Cloneable, FennelRel, RelNode

 class FennelIdxWriteRel
extends FennelSingleRel

FennelIdxWriteRel takes its input and writes the records into an index. Currently, this class only support writes to a temporary index.

Version:

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

Author:

Zelaine Fong

Field Summary

(package private) boolean	discardDuplicates
(package private) Integer[]	indexCols
(package private) boolean	monotonicInserts
(package private) FennelRelParamId	rootPageIdParamId

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

FennelIdxWriteRel(RelNode child, boolean discardDuplicates, boolean monotonicInserts, FennelRelParamId rootPageIdParamId, Integer[] indexCols)
Creates a new FennelIdxWriteRel object.

Method Summary

FennelIdxWriteRel	clone() Clones this RelNode.
RelOptCost	computeSelfCost(RelOptPlanner planner) Returns the cost of this plan (not including children).
void	explain(RelOptPlanWriter pw)
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, deriveRowType, 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

discardDuplicates

final boolean discardDuplicates

monotonicInserts

final boolean monotonicInserts

rootPageIdParamId

final FennelRelParamId rootPageIdParamId

indexCols

final Integer[] indexCols

Constructor Detail

FennelIdxWriteRel

public FennelIdxWriteRel(RelNode child,
                         boolean discardDuplicates,
                         boolean monotonicInserts,
                         FennelRelParamId rootPageIdParamId,
                         Integer[] indexCols)

Creates a new FennelIdxWriteRel object.

Parameters:

child - input the provides the records to be written to the index

discardDuplicates - whether duplicates should be discard during inserts

monotonicInserts - whether the records to be written are provided in increasing key order and therefore can be written to the index in monotonic mode

rootPageIdParamId - dynamic parameter id corresponding to the temporary index that will be written

indexCols - projection of the index columns

Method Detail

clone

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

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