io.cdap.cdap.etl.api.aggregation

Class WindowAggregationDefinition.Builder

java.lang.Object

io.cdap.cdap.etl.api.aggregation.WindowAggregationDefinition.Builder

Enclosing class:

WindowAggregationDefinition

public static class WindowAggregationDefinition.Builder
extends Object

Builds a WindowAggregationDefinition using fields to partition and fields to select. The fields to select must be specified.

Method Summary

Modifier and Type	Method and Description
WindowAggregationDefinition	build() Builds a WindowAggregationDefinition.
WindowAggregationDefinition.Builder	following(String following) Sets the following if window frame type is row or range .
WindowAggregationDefinition.Builder	orderBy(Expression expression, WindowAggregationDefinition.OrderBy orderBy) Sets the list of expressions to perform order by to the specified expressions.
WindowAggregationDefinition.Builder	orderBy(List<WindowAggregationDefinition.OrderByExpression> orderByExpressions) Sets the list of expressions to perform order by to the specified list.
WindowAggregationDefinition.Builder	partition(Expression... partitionExpressions) Sets the list of expressions to perform partition to the specified expressions.
WindowAggregationDefinition.Builder	partition(List<Expression> partitionExpressions) Sets the list of expressions to perform partition to the specified list.
WindowAggregationDefinition.Builder	preceding(String preceding) Sets the preceding if window frame type is row or range .
WindowAggregationDefinition.Builder	select(Map<String,Expression> selectExpressions) Sets the list of expressions to select to the specified expressions.
WindowAggregationDefinition.Builder	unboundedFollowing(boolean unboundedFollowing) Sets unbounded Preceding if window frame type is row or range
WindowAggregationDefinition.Builder	unboundedPreceding(boolean unboundedPreceding) Sets unbounded Preceding if window frame type is row or range
WindowAggregationDefinition.Builder	windowFrameType(WindowAggregationDefinition.WindowFrameType windowFrameType) Any window frame type value is overwritten.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

unboundedPreceding

public WindowAggregationDefinition.Builder unboundedPreceding(@Nullable
                                                              boolean unboundedPreceding)

Sets unbounded Preceding if window frame type is row or range

Parameters:

unboundedPreceding - value

Returns:

a WindowAggregationDefinition.Builder with the currently built WindowAggregationDefinition.

unboundedFollowing

public WindowAggregationDefinition.Builder unboundedFollowing(@Nullable
                                                              boolean unboundedFollowing)

Sets unbounded Preceding if window frame type is row or range

Parameters:

unboundedFollowing - value

Returns:

a WindowAggregationDefinition.Builder with the currently built WindowAggregationDefinition.

preceding

public WindowAggregationDefinition.Builder preceding(@Nullable
                                                     String preceding)

Sets the preceding if window frame type is row or range .

Parameters:

preceding - value

Returns:

a WindowAggregationDefinition.Builder with the currently built WindowAggregationDefinition.

following

public WindowAggregationDefinition.Builder following(@Nullable
                                                     String following)

Sets the following if window frame type is row or range .

Parameters:

following - value

Returns:

a WindowAggregationDefinition.Builder with the currently built WindowAggregationDefinition.

partition

public WindowAggregationDefinition.Builder partition(List<Expression> partitionExpressions)

Sets the list of expressions to perform partition to the specified list.

Parameters:

partitionExpressions - list of Expressions.

Returns:

a WindowAggregationDefinition.Builder with the currently built WindowAggregationDefinition.

orderBy

public WindowAggregationDefinition.Builder orderBy(@Nullable
                                                   List<WindowAggregationDefinition.OrderByExpression> orderByExpressions)

Sets the list of expressions to perform order by to the specified list.

Parameters:

orderByExpressions - list of Expressions.

Returns:

a WindowAggregationDefinition.Builder with the currently built WindowAggregationDefinition.

partition

public WindowAggregationDefinition.Builder partition(Expression... partitionExpressions)

Sets the list of expressions to perform partition to the specified expressions. Any existing partition expression list is overwritten.

Parameters:

partitionExpressions - Expressions.

Returns:

a WindowAggregationDefinition.Builder with the currently built WindowAggregationDefinition.

windowFrameType

public WindowAggregationDefinition.Builder windowFrameType(WindowAggregationDefinition.WindowFrameType windowFrameType)

Any window frame type value is overwritten.

Returns:

a WindowAggregationDefinition.Builder with the currently built WindowAggregationDefinition.

orderBy

public WindowAggregationDefinition.Builder orderBy(Expression expression,
                                                   WindowAggregationDefinition.OrderBy orderBy)

Sets the list of expressions to perform order by to the specified expressions. Any existing order by expression list is overwritten.

Returns:

a WindowAggregationDefinition.Builder with the currently built WindowAggregationDefinition.

select

public WindowAggregationDefinition.Builder select(Map<String,Expression> selectExpressions)

Sets the list of expressions to select to the specified expressions. Any existing list of select expressions is overwritten.

Parameters:

selectExpressions - to use

Returns:

a WindowAggregationDefinition.Builder with the currently built WindowAggregationDefinition.

build

public WindowAggregationDefinition build()

Builds a WindowAggregationDefinition.

Returns:

A WindowAggregationDefinition object.

Throws:

IllegalStateException - in case the fields to select are not specified.