org.apache.flink.table.runtime.operators.window.assigners

Class CumulativeWindowAssigner

java.lang.Object

org.apache.flink.table.runtime.operators.window.assigners.WindowAssigner<W>

org.apache.flink.table.runtime.operators.window.assigners.PanedWindowAssigner<TimeWindow>

org.apache.flink.table.runtime.operators.window.assigners.CumulativeWindowAssigner

All Implemented Interfaces:

Serializable, InternalTimeWindowAssigner

public class CumulativeWindowAssigner
extends PanedWindowAssigner<TimeWindow>
implements InternalTimeWindowAssigner

A WindowAssigner that windows elements into cumulative windows based on the timestamp of the elements. Windows are overlap.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CumulativeWindowAssigner(long maxSize, long step, long offset, boolean isEventTime)

Method Summary

Modifier and Type	Method and Description
TimeWindow	assignPane(Object element, long timestamp) Given the timestamp and element, returns the pane into which it should be placed.
Collection<TimeWindow>	assignWindows(RowData element, long timestamp) Given the timestamp and element, returns the set of windows into which it should be placed.
TimeWindow	getLastWindow(TimeWindow pane) Gets the last window which the pane belongs to.
TypeSerializer<TimeWindow>	getWindowSerializer(ExecutionConfig executionConfig) Returns a TypeSerializer for serializing windows that are assigned by this WindowAssigner.
boolean	isEventTime() Returns true if elements are assigned to windows based on event time, false otherwise.
static CumulativeWindowAssigner	of(java.time.Duration maxSize, java.time.Duration step) Creates a new CumulativeWindowAssigner that assigns elements to cumulative time windows based on the element timestamp.
Iterable<TimeWindow>	splitIntoPanes(TimeWindow window) Splits the given window into panes collection.
String	toString()
CumulativeWindowAssigner	withEventTime()
CumulativeWindowAssigner	withOffset(java.time.Duration offset)
CumulativeWindowAssigner	withProcessingTime()

Methods inherited from class org.apache.flink.table.runtime.operators.window.assigners.WindowAssigner

open

Methods inherited from class java.lang.Object

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

Constructor Detail

CumulativeWindowAssigner

protected CumulativeWindowAssigner(long maxSize,
                                   long step,
                                   long offset,
                                   boolean isEventTime)

Method Detail

assignWindows

public Collection<TimeWindow> assignWindows(RowData element,
                                            long timestamp)

Description copied from class: WindowAssigner

Given the timestamp and element, returns the set of windows into which it should be placed.

Specified by:

assignWindows in class WindowAssigner<TimeWindow>

Parameters:

element - The element to which windows should be assigned.

timestamp - The timestamp of the element when WindowAssigner.isEventTime() returns true, or the current system time when WindowAssigner.isEventTime() returns false. The timestamp value is mapping to UTC milliseconds for splitting windows simply.

assignPane

public TimeWindow assignPane(Object element,
                             long timestamp)

Description copied from class: PanedWindowAssigner

Given the timestamp and element, returns the pane into which it should be placed.

Specified by:

assignPane in class PanedWindowAssigner<TimeWindow>

Parameters:

element - The element to which windows should be assigned.

timestamp - The timestamp of the element when WindowAssigner.isEventTime() returns true, or the current system time when WindowAssigner.isEventTime() returns false.

splitIntoPanes

public Iterable<TimeWindow> splitIntoPanes(TimeWindow window)

Description copied from class: PanedWindowAssigner

Splits the given window into panes collection.

Specified by:

splitIntoPanes in class PanedWindowAssigner<TimeWindow>

Parameters:

window - the window to be split.

Returns:

the panes iterable

getLastWindow

public TimeWindow getLastWindow(TimeWindow pane)

Description copied from class: PanedWindowAssigner

Gets the last window which the pane belongs to.

Specified by:

getLastWindow in class PanedWindowAssigner<TimeWindow>

getWindowSerializer

public TypeSerializer<TimeWindow> getWindowSerializer(ExecutionConfig executionConfig)

Description copied from class: WindowAssigner

Returns a TypeSerializer for serializing windows that are assigned by this WindowAssigner.

Specified by:

getWindowSerializer in class WindowAssigner<TimeWindow>

isEventTime

public boolean isEventTime()

Description copied from class: WindowAssigner

Returns true if elements are assigned to windows based on event time, false otherwise.

Specified by:

isEventTime in class WindowAssigner<TimeWindow>

toString

public String toString()

Specified by:

toString in class WindowAssigner<TimeWindow>

of

public static CumulativeWindowAssigner of(java.time.Duration maxSize,
                                          java.time.Duration step)

Creates a new CumulativeWindowAssigner that assigns elements to cumulative time windows based on the element timestamp.

Parameters:

maxSize - The max size of the generated windows.

step - The step interval for window size to increase of the generated windows.

Returns:

The time policy.

withOffset

public CumulativeWindowAssigner withOffset(java.time.Duration offset)

withEventTime

public CumulativeWindowAssigner withEventTime()

Specified by:

withEventTime in interface InternalTimeWindowAssigner

Returns:

an InternalTimeWindowAssigner which in event time mode.

withProcessingTime

public CumulativeWindowAssigner withProcessingTime()

Specified by:

withProcessingTime in interface InternalTimeWindowAssigner

Returns:

an InternalTimeWindowAssigner which in processing time mode.