Package io.substrait.relation

Class ConsistentPartitionWindow.WindowRelFunctionInvocation

java.lang.Object
io.substrait.relation.ConsistentPartitionWindow.WindowRelFunctionInvocation
Direct Known Subclasses:
ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation
Enclosing class:
ConsistentPartitionWindow
@Immutable public abstract static class ConsistentPartitionWindow.WindowRelFunctionInvocation extends Object
A single window function invocation with its arguments, options, output type, phase/invocation, and window bounds.

  • Constructor Details

    • WindowRelFunctionInvocation

      public WindowRelFunctionInvocation()

  • Method Details

    • declaration

      public abstract SimpleExtension.WindowFunctionVariant declaration()
      Returns the window function variant declaration.
      Returns:
      the function variant declaration

    • arguments

      public abstract List<FunctionArg> arguments()
      Returns the ordered list of function arguments.
      Returns:
      list of function arguments

    • options

      public abstract List<FunctionOption> options()
      Returns the options applied to the function invocation.
      Returns:
      list of function options

    • outputType

      public abstract Type outputType()
      Returns the type produced by this invocation.
      Returns:
      output type of the window function

    • aggregationPhase

      public abstract Expression.AggregationPhase aggregationPhase()
      Returns the aggregation phase (e.g., initial, intermediate, final).
      Returns:
      aggregation phase

    • invocation

      public abstract Expression.AggregationInvocation invocation()
      Returns the aggregation invocation semantics (e.g., aggregate, merge).
      Returns:
      aggregation invocation

    • lowerBound

      public abstract WindowBound lowerBound()
      Returns the inclusive lower bound of the window frame.
      Returns:
      lower window bound

    • upperBound

      public abstract WindowBound upperBound()
      Returns the inclusive upper bound of the window frame.
      Returns:
      upper window bound

    • boundsType

      public abstract Expression.WindowBoundsType boundsType()
      Returns the bounds type (e.g., ROWS or RANGE).
      Returns:
      window bounds type

    • builder

      public static ImmutableConsistentPartitionWindow.WindowRelFunctionInvocation.Builder builder()
      Creates a builder for ConsistentPartitionWindow.WindowRelFunctionInvocation.
      Returns:
      a new immutable builder