Package org.apache.flink.table.runtime.operators.window.tvf.unslicing

Class UnsliceAssigners.WindowedUnsliceAssigner

java.lang.Object

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

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

org.apache.flink.table.runtime.operators.window.tvf.unslicing.UnsliceAssigners.WindowedUnsliceAssigner

All Implemented Interfaces:

Serializable, InternalTimeWindowAssigner, WindowAssigner, UnsliceAssigner<TimeWindow>

Enclosing class:

UnsliceAssigners

public static class UnsliceAssigners.WindowedUnsliceAssigner
extends MergingWindowAssigner<TimeWindow>
implements UnsliceAssigner<TimeWindow>, InternalTimeWindowAssigner

The UnsliceAssigner for elements have been merged into unslicing windows and attached window start and end timestamps.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
WindowedUnsliceAssigner(int windowStartIndex, int windowEndIndex, UnsliceAssigner<TimeWindow> innerAssigner)

Method Summary

Modifier and Type	Method	Description
Optional<TimeWindow>	assignActualWindow(org.apache.flink.table.data.RowData element, ClockService clock, MergingWindowProcessFunction<?,TimeWindow> windowFunction)	Returns the Window that the given element should belong to be used to trigger on.
Optional<TimeWindow>	assignStateNamespace(org.apache.flink.table.data.RowData element, ClockService clock, MergingWindowProcessFunction<?,TimeWindow> windowFunction)	Returns the Window that the given element should belong to be used as a namespace to restore the state.
Collection<TimeWindow>	assignWindows(org.apache.flink.table.data.RowData element, long timestamp)	Given the timestamp and element, returns the set of windows into which it should be placed.
String	getDescription()	Returns a description of this window assigner.
MergingWindowAssigner<TimeWindow>	getMergingWindowAssigner()	Currently, unslice assigner has an inner MergingWindowAssigner to reuse the logic in GroupWindowAssigner to merge windows.
org.apache.flink.api.common.typeutils.TypeSerializer<TimeWindow>	getWindowSerializer(org.apache.flink.api.common.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.
void	mergeWindows(TimeWindow newWindow, NavigableSet<TimeWindow> sortedWindows, MergeCallback<TimeWindow,Collection<TimeWindow>> callback)	Determines which windows (if any) should be merged.
String	toString()
InternalTimeWindowAssigner	withEventTime()
InternalTimeWindowAssigner	withProcessingTime()

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

open

Methods inherited from class java.lang.Object

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

Constructor Detail

WindowedUnsliceAssigner

public WindowedUnsliceAssigner(int windowStartIndex,
                               int windowEndIndex,
                               UnsliceAssigner<TimeWindow> innerAssigner)

Method Detail

assignActualWindow

public Optional<TimeWindow> assignActualWindow(org.apache.flink.table.data.RowData element,
                                               ClockService clock,
                                               MergingWindowProcessFunction<?,TimeWindow> windowFunction)
                                        throws Exception

Description copied from interface: UnsliceAssigner

Returns the Window that the given element should belong to be used to trigger on.

See more details in MergingWindowProcessFunction.assignActualWindows(org.apache.flink.table.data.RowData, long).

Specified by:

assignActualWindow in interface UnsliceAssigner<TimeWindow>

Parameters:

element - the element to which slice should belong to.

clock - the service to get current processing time.

Returns:

if empty, that means the element is late.

Throws:

Exception

assignStateNamespace

public Optional<TimeWindow> assignStateNamespace(org.apache.flink.table.data.RowData element,
                                                 ClockService clock,
                                                 MergingWindowProcessFunction<?,TimeWindow> windowFunction)
                                          throws Exception

Description copied from interface: UnsliceAssigner

Returns the Window that the given element should belong to be used as a namespace to restore the state.

See more details in MergingWindowProcessFunction.assignStateNamespace(org.apache.flink.table.data.RowData, long).

Specified by:

assignStateNamespace in interface UnsliceAssigner<TimeWindow>

Parameters:

element - the element to which slice should belong to.

clock - the service to get current processing time.

Returns:

if empty, that means the element is late.

Throws:

Exception

getMergingWindowAssigner

public MergingWindowAssigner<TimeWindow> getMergingWindowAssigner()

Description copied from interface: UnsliceAssigner

Currently, unslice assigner has an inner MergingWindowAssigner to reuse the logic in GroupWindowAssigner to merge windows.

Specified by:

getMergingWindowAssigner in interface UnsliceAssigner<TimeWindow>

isEventTime

public boolean isEventTime()

Description copied from class: GroupWindowAssigner

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

Specified by:

isEventTime in interface WindowAssigner

Specified by:

isEventTime in class GroupWindowAssigner<TimeWindow>

assignWindows

public Collection<TimeWindow> assignWindows(org.apache.flink.table.data.RowData element,
                                            long timestamp)
                                     throws IOException

Description copied from class: GroupWindowAssigner

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

Specified by:

assignWindows in class GroupWindowAssigner<TimeWindow>

Parameters:

element - The element to which windows should be assigned.

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

Throws:

IOException

getWindowSerializer

public org.apache.flink.api.common.typeutils.TypeSerializer<TimeWindow> getWindowSerializer(org.apache.flink.api.common.ExecutionConfig executionConfig)

Description copied from class: GroupWindowAssigner

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

Specified by:

getWindowSerializer in class GroupWindowAssigner<TimeWindow>

toString

public String toString()

Specified by:

toString in class GroupWindowAssigner<TimeWindow>

getDescription

public String getDescription()

Description copied from interface: WindowAssigner

Returns a description of this window assigner.

Specified by:

getDescription in interface WindowAssigner

withEventTime

public InternalTimeWindowAssigner withEventTime()

Specified by:

withEventTime in interface InternalTimeWindowAssigner

Returns:

an InternalTimeWindowAssigner which in event time mode.

withProcessingTime

public InternalTimeWindowAssigner withProcessingTime()

Specified by:

withProcessingTime in interface InternalTimeWindowAssigner

Returns:

an InternalTimeWindowAssigner which in processing time mode.

mergeWindows

public void mergeWindows(TimeWindow newWindow,
                         NavigableSet<TimeWindow> sortedWindows,
                         MergeCallback<TimeWindow,Collection<TimeWindow>> callback)

Description copied from class: MergingWindowAssigner

Determines which windows (if any) should be merged.

Specified by:

mergeWindows in class MergingWindowAssigner<TimeWindow>

Parameters:

newWindow - The new window

sortedWindows - The sorted window candidates.

callback - A callback that can be invoked to signal which windows should be merged.