Package org.apache.flink.table.runtime.operators.window.groupwindow.internal

Class GeneralWindowProcessFunction<K,W extends Window>

java.lang.Object

org.apache.flink.table.runtime.operators.window.groupwindow.internal.InternalWindowProcessFunction<K,W>

org.apache.flink.table.runtime.operators.window.groupwindow.internal.GeneralWindowProcessFunction<K,W>

Type Parameters:

W - The type of Window that assigner assigns.

All Implemented Interfaces:

Serializable

public class GeneralWindowProcessFunction<K,W extends Window>
extends InternalWindowProcessFunction<K,W>

The general implementation of InternalWindowProcessFunction. The GroupWindowAssigner should be a regular assigner without implement PanedWindowAssigner or MergingWindowAssigner.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.table.runtime.operators.window.groupwindow.internal.InternalWindowProcessFunction

InternalWindowProcessFunction.Context<K,W extends Window>

Field Summary

Fields inherited from class org.apache.flink.table.runtime.operators.window.groupwindow.internal.InternalWindowProcessFunction

allowedLateness, ctx, windowAggregator, windowAssigner

Constructor Summary

Constructors

Constructor	Description
GeneralWindowProcessFunction(GroupWindowAssigner<W> windowAssigner, NamespaceAggsHandleFunctionBase<W> windowAggregator, long allowedLateness)

Method Summary

Modifier and Type	Method	Description
Collection<W>	assignActualWindows(org.apache.flink.table.data.RowData inputRow, long timestamp)	Assigns the input element into the actual windows which the Trigger should trigger on.
Collection<W>	assignStateNamespace(org.apache.flink.table.data.RowData inputRow, long timestamp)	Assigns the input element into the state namespace which the input element should be accumulated/retracted into.
void	cleanWindowIfNeeded(W window, long time)	Cleans the given window if needed.
void	prepareAggregateAccumulatorForEmit(W window)	Prepares the accumulator of the given window before emit the final result.

Methods inherited from class org.apache.flink.table.runtime.operators.window.groupwindow.internal.InternalWindowProcessFunction

close, isCleanupTime, isWindowLate, open

Methods inherited from class java.lang.Object

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

Constructor Details

GeneralWindowProcessFunction

public GeneralWindowProcessFunction(GroupWindowAssigner<W> windowAssigner,
 NamespaceAggsHandleFunctionBase<W> windowAggregator,
 long allowedLateness)

Method Details

assignStateNamespace

public Collection<W> assignStateNamespace(org.apache.flink.table.data.RowData inputRow,
 long timestamp)
                                   throws Exception

Description copied from class: InternalWindowProcessFunction

Assigns the input element into the state namespace which the input element should be accumulated/retracted into.

Specified by:

assignStateNamespace in class InternalWindowProcessFunction<K,W extends Window>

Parameters:

inputRow - the input element

timestamp - the timestamp of the element or the processing time (depends on the type of assigner)

Returns:

the state namespace

Throws:

Exception

assignActualWindows

public Collection<W> assignActualWindows(org.apache.flink.table.data.RowData inputRow,
 long timestamp)
                                  throws Exception

Description copied from class: InternalWindowProcessFunction

Assigns the input element into the actual windows which the Trigger should trigger on.

Specified by:

assignActualWindows in class InternalWindowProcessFunction<K,W extends Window>

Parameters:

inputRow - the input element

timestamp - the timestamp of the element or the processing time (depends on the type of assigner)

Returns:

the actual windows

Throws:

Exception

prepareAggregateAccumulatorForEmit

public void prepareAggregateAccumulatorForEmit(W window)
                                        throws Exception

Description copied from class: InternalWindowProcessFunction

Prepares the accumulator of the given window before emit the final result. The accumulator is stored in the state or will be created if there is no corresponding accumulator in state.

Specified by:

prepareAggregateAccumulatorForEmit in class InternalWindowProcessFunction<K,W extends Window>

Parameters:

window - the window

Throws:

Exception

cleanWindowIfNeeded

public void cleanWindowIfNeeded(W window,
 long time)
                         throws Exception

Description copied from class: InternalWindowProcessFunction

Cleans the given window if needed.

Specified by:

cleanWindowIfNeeded in class InternalWindowProcessFunction<K,W extends Window>

Parameters:

window - the window to cleanup

time - the current timestamp

Throws:

Exception