org.eigenbase.rel
Class TableFunctionRel

java.lang.Object
  org.eigenbase.rel.AbstractRelNode
      org.eigenbase.rel.TableFunctionRelBase
          org.eigenbase.rel.TableFunctionRel

All Implemented Interfaces:

Cloneable, RelNode

public class TableFunctionRel
extends TableFunctionRelBase

TableFunctionRel represents a call to a function which returns a result set. Currently, it can only appear as a leaf in a query tree, but eventually we will extend it to take relational inputs.

Version:

$Id: //open/dev/farrago/src/org/eigenbase/rel/TableFunctionRel.java#9 $

Author:

John V. Sichi

Field Summary

Fields inherited from class org.eigenbase.rel.TableFunctionRelBase

inputs

Fields inherited from class org.eigenbase.rel.AbstractRelNode

digest, id, nextId, traits

Fields inherited from interface org.eigenbase.rel.RelNode

emptyArray

Constructor Summary

TableFunctionRel(RelOptCluster cluster, RexNode rexCall, RelDataType rowType, RelNode[] inputs)
Creates a TableFunctionRel.

Method Summary

TableFunctionRel	clone() Clones this RelNode.
RelOptCost	computeSelfCost(RelOptPlanner planner) Returns the cost of this plan (not including children).

Methods inherited from class org.eigenbase.rel.TableFunctionRelBase

deriveRowType, explain, getCall, getChildExps, getColumnMappings, getInputs, getRows, replaceInput, setColumnMappings

Methods inherited from class org.eigenbase.rel.AbstractRelNode

childrenAccept, cloneTraits, collectVariablesSet, collectVariablesUsed, computeDigest, 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

Constructor Detail

TableFunctionRel

public TableFunctionRel(RelOptCluster cluster,
                        RexNode rexCall,
                        RelDataType rowType,
                        RelNode[] inputs)

Creates a TableFunctionRel.

Parameters:

cluster - RelOptCluster this relational expression belongs to

rexCall - function invocation expression

rowType - row type produced by function

inputs - 0 or more relational inputs

Method Detail

clone

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