org.apache.calcite.rel.core

Class Window

java.lang.Object

org.apache.calcite.rel.AbstractRelNode

org.apache.calcite.rel.SingleRel

org.apache.calcite.rel.core.Window

All Implemented Interfaces:

Cloneable, org.apache.calcite.plan.RelOptNode, org.apache.calcite.rel.hint.Hintable, org.apache.calcite.rel.RelNode

Direct Known Subclasses:

LogicalWindow

public abstract class Window
extends org.apache.calcite.rel.SingleRel
implements org.apache.calcite.rel.hint.Hintable

A relational expression representing a set of window aggregates.

Temporarily copy from calcite to cherry-pick [CALCITE-5107] and will be removed when upgrade the latest calcite.

A Window can handle several window aggregate functions, over several partitions, with pre- and post-expressions, and an optional post-filter. Each of the partitions is defined by a partition key (zero or more columns) and a range (logical or physical). The partitions expect the data to be sorted correctly on input to the relational expression.

Each Window.Group has a set of RexOver objects.

Created by ProjectToWindowRule.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Window.Group Group of windowed aggregate calls that have the same window specification.
static class	Window.RexWinAggCall A call to a windowed aggregate function.

Nested classes/interfaces inherited from interface org.apache.calcite.rel.RelNode

org.apache.calcite.rel.RelNode.Context

Field Summary

Fields

Modifier and Type	Field and Description
com.google.common.collect.ImmutableList<RexLiteral>	constants
com.google.common.collect.ImmutableList<Window.Group>	groups
protected com.google.common.collect.ImmutableList<org.apache.calcite.rel.hint.RelHint>	hints

Fields inherited from class org.apache.calcite.rel.SingleRel

input

Fields inherited from class org.apache.calcite.rel.AbstractRelNode

digest, id, rowType, traitSet

Constructor Summary

Constructors

Constructor and Description
Window(org.apache.calcite.plan.RelOptCluster cluster, org.apache.calcite.plan.RelTraitSet traitSet, List<org.apache.calcite.rel.hint.RelHint> hints, org.apache.calcite.rel.RelNode input, List<RexLiteral> constants, org.apache.calcite.rel.type.RelDataType rowType, List<Window.Group> groups) Creates a window relational expression.
Window(org.apache.calcite.plan.RelOptCluster cluster, org.apache.calcite.plan.RelTraitSet traitSet, org.apache.calcite.rel.RelNode input, List<RexLiteral> constants, org.apache.calcite.rel.type.RelDataType rowType, List<Window.Group> groups) Creates a window relational expression.

Method Summary

Modifier and Type	Method and Description
org.apache.calcite.plan.RelOptCost	computeSelfCost(org.apache.calcite.plan.RelOptPlanner planner, org.apache.calcite.rel.metadata.RelMetadataQuery mq)
org.apache.calcite.rel.RelWriter	explainTerms(org.apache.calcite.rel.RelWriter pw)
static org.apache.calcite.rel.RelCollation	getCollation(List<org.apache.calcite.rex.RexFieldCollation> collations)
List<RexLiteral>	getConstants() Returns constants that are additional inputs of current relation.
com.google.common.collect.ImmutableList<org.apache.calcite.rel.hint.RelHint>	getHints()
static org.apache.calcite.util.ImmutableIntList	getProjectOrdinals(List<org.apache.calcite.rex.RexNode> exprs)
boolean	isValid(org.apache.calcite.util.Litmus litmus, org.apache.calcite.rel.RelNode.Context context)

Methods inherited from class org.apache.calcite.rel.SingleRel

childrenAccept, deriveRowType, estimateRowCount, getInput, getInputs, replaceInput

Methods inherited from class org.apache.calcite.rel.AbstractRelNode

accept, accept, collectVariablesSet, collectVariablesUsed, copy, deepEquals, deepHashCode, equals, explain, getCluster, getConvention, getCorrelVariable, getDescription, getDigest, getExpectedInputRowType, getId, getInput, getRelDigest, getRelTypeName, getRowType, getTable, getTraitSet, getVariablesSet, hashCode, isEnforcer, metadata, onRegister, recomputeDigest, register, sole, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.calcite.rel.hint.Hintable

attachHints, withHints

Methods inherited from interface org.apache.calcite.rel.RelNode

explain

Field Detail

groups

public final com.google.common.collect.ImmutableList<Window.Group> groups

constants

public final com.google.common.collect.ImmutableList<RexLiteral> constants

hints

protected final com.google.common.collect.ImmutableList<org.apache.calcite.rel.hint.RelHint> hints

Constructor Detail

Window

public Window(org.apache.calcite.plan.RelOptCluster cluster,
              org.apache.calcite.plan.RelTraitSet traitSet,
              List<org.apache.calcite.rel.hint.RelHint> hints,
              org.apache.calcite.rel.RelNode input,
              List<RexLiteral> constants,
              org.apache.calcite.rel.type.RelDataType rowType,
              List<Window.Group> groups)

Creates a window relational expression.

Parameters:

cluster - Cluster

traitSet - Trait set

hints - Hints for this node

input - Input relational expression

constants - List of constants that are additional inputs

rowType - Output row type

groups - Windows

Window

public Window(org.apache.calcite.plan.RelOptCluster cluster,
              org.apache.calcite.plan.RelTraitSet traitSet,
              org.apache.calcite.rel.RelNode input,
              List<RexLiteral> constants,
              org.apache.calcite.rel.type.RelDataType rowType,
              List<Window.Group> groups)

Creates a window relational expression.

Parameters:

cluster - Cluster

traitSet - Trait set

input - Input relational expression

constants - List of constants that are additional inputs

rowType - Output row type

groups - Windows

Method Detail

isValid

public boolean isValid(org.apache.calcite.util.Litmus litmus,
                       org.apache.calcite.rel.RelNode.Context context)

Specified by:

isValid in interface org.apache.calcite.rel.RelNode

Overrides:

isValid in class org.apache.calcite.rel.AbstractRelNode

explainTerms

public org.apache.calcite.rel.RelWriter explainTerms(org.apache.calcite.rel.RelWriter pw)

Overrides:

explainTerms in class org.apache.calcite.rel.SingleRel

getProjectOrdinals

public static org.apache.calcite.util.ImmutableIntList getProjectOrdinals(List<org.apache.calcite.rex.RexNode> exprs)

getCollation

public static org.apache.calcite.rel.RelCollation getCollation(List<org.apache.calcite.rex.RexFieldCollation> collations)

getConstants

public List<RexLiteral> getConstants()

Returns constants that are additional inputs of current relation.

Returns:

constants that are additional inputs of current relation

computeSelfCost

public org.apache.calcite.plan.RelOptCost computeSelfCost(org.apache.calcite.plan.RelOptPlanner planner,
                                                          org.apache.calcite.rel.metadata.RelMetadataQuery mq)

Specified by:

computeSelfCost in interface org.apache.calcite.rel.RelNode

Overrides:

computeSelfCost in class org.apache.calcite.rel.AbstractRelNode

getHints

public com.google.common.collect.ImmutableList<org.apache.calcite.rel.hint.RelHint> getHints()

Specified by:

getHints in interface org.apache.calcite.rel.hint.Hintable