org.apache.calcite.adapter.enumerable

Interface WinAggFrameResultContext

All Superinterfaces:

WinAggFrameContext

All Known Subinterfaces:

WinAggAddContext, WinAggResultContext

All Known Implementing Classes:

WinAggAddContextImpl, WinAggResultContextImpl

public interface WinAggFrameResultContext
extends WinAggFrameContext

Provides information on the current window when computing the result of the aggregation.

Method Summary

Modifier and Type	Method and Description
org.apache.calcite.linq4j.tree.Expression	compareRows(org.apache.calcite.linq4j.tree.Expression a, org.apache.calcite.linq4j.tree.Expression b) Compares two rows given by absolute positions according to the order collation of the current window.
org.apache.calcite.linq4j.tree.Expression	computeIndex(org.apache.calcite.linq4j.tree.Expression offset, WinAggImplementor.SeekType seekType) Converts absolute index position of the given relative position.
org.apache.calcite.linq4j.tree.Expression	rowInFrame(org.apache.calcite.linq4j.tree.Expression rowIndex) Returns boolean the expression that checks if the given index is in the frame bounds.
org.apache.calcite.linq4j.tree.Expression	rowInPartition(org.apache.calcite.linq4j.tree.Expression rowIndex) Returns boolean the expression that checks if the given index is in the partition bounds.
RexToLixTranslator	rowTranslator(org.apache.calcite.linq4j.tree.Expression rowIndex) Returns row translator for given absolute row position.

Methods inherited from interface org.apache.calcite.adapter.enumerable.WinAggFrameContext

endIndex, getFrameRowCount, getPartitionRowCount, hasRows, index, startIndex

Method Detail

computeIndex

org.apache.calcite.linq4j.tree.Expression computeIndex(org.apache.calcite.linq4j.tree.Expression offset,
                                                       WinAggImplementor.SeekType seekType)

Converts absolute index position of the given relative position.

Parameters:

offset - offset of the requested row

seekType - the type of offset (start of window, end of window, etc)

Returns:

absolute position of the requested row

rowInFrame

org.apache.calcite.linq4j.tree.Expression rowInFrame(org.apache.calcite.linq4j.tree.Expression rowIndex)

Returns boolean the expression that checks if the given index is in the frame bounds.

Parameters:

rowIndex - index if the row to check

Returns:

expression that validates frame bounds for the given index

rowInPartition

org.apache.calcite.linq4j.tree.Expression rowInPartition(org.apache.calcite.linq4j.tree.Expression rowIndex)

Returns boolean the expression that checks if the given index is in the partition bounds.

Parameters:

rowIndex - index if the row to check

Returns:

expression that validates partition bounds for the given index

rowTranslator

RexToLixTranslator rowTranslator(org.apache.calcite.linq4j.tree.Expression rowIndex)

Returns row translator for given absolute row position.

Parameters:

rowIndex - absolute index of the row.

Returns:

translator for the requested row

compareRows

org.apache.calcite.linq4j.tree.Expression compareRows(org.apache.calcite.linq4j.tree.Expression a,
                                                      org.apache.calcite.linq4j.tree.Expression b)

Compares two rows given by absolute positions according to the order collation of the current window.

Parameters:

a - absolute index of the first row

b - absolute index of the second row

Returns:

result of comparison as as in Comparable.compareTo(T)