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

Class WindowOperator<K,W extends Window>

java.lang.Object

org.apache.flink.streaming.api.operators.AbstractStreamOperator<org.apache.flink.table.data.RowData>

org.apache.flink.table.runtime.operators.window.WindowOperator<K,W>

Type Parameters:

K - The type of key returned by the KeySelector.

W - The type of Window that the WindowAssigner assigns.

All Implemented Interfaces:

Serializable, org.apache.flink.api.common.state.CheckpointListener, org.apache.flink.streaming.api.operators.Input<org.apache.flink.table.data.RowData>, org.apache.flink.streaming.api.operators.KeyContext, org.apache.flink.streaming.api.operators.OneInputStreamOperator<org.apache.flink.table.data.RowData,org.apache.flink.table.data.RowData>, org.apache.flink.streaming.api.operators.SetupableStreamOperator<org.apache.flink.table.data.RowData>, org.apache.flink.streaming.api.operators.StreamOperator<org.apache.flink.table.data.RowData>, org.apache.flink.streaming.api.operators.StreamOperatorStateHandler.CheckpointedStreamOperator, org.apache.flink.streaming.api.operators.Triggerable<K,W>, org.apache.flink.util.Disposable

Direct Known Subclasses:

AggregateWindowOperator, TableAggregateWindowOperator

public abstract class WindowOperator<K,W extends Window>
extends org.apache.flink.streaming.api.operators.AbstractStreamOperator<org.apache.flink.table.data.RowData>
implements org.apache.flink.streaming.api.operators.OneInputStreamOperator<org.apache.flink.table.data.RowData,org.apache.flink.table.data.RowData>, org.apache.flink.streaming.api.operators.Triggerable<K,W>

An operator that implements the logic for windowing based on a WindowAssigner and Trigger.

This is the base class for AggregateWindowOperator and TableAggregateWindowOperator. The big difference between AggregateWindowOperator and TableAggregateWindowOperator is AggregateWindowOperator emits only one result for each aggregate group, while TableAggregateWindowOperator can emit multi results for each aggregate group.

When an element arrives it gets assigned a key using a KeySelector and it gets assigned to zero or more windows using a WindowAssigner. Based on this, the element is put into panes. A pane is the bucket of elements that have the same key and same Window. An element can be in multiple panes if it was assigned to multiple windows by the WindowAssigner.

Each pane gets its own instance of the provided Trigger. This trigger determines when the contents of the pane should be processed to emit results. When a trigger fires, the given NamespaceAggsHandleFunctionBase is invoked to produce the results that are emitted for the pane to which the Trigger belongs.

The parameter types: <IN>: RowData <OUT>: JoinedRowData(KEY, AGG_RESULT) <KEY>: GenericRowData <AGG_RESULT>: GenericRowData <ACC>: GenericRowData

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.flink.streaming.api.operators.TimestampedCollector<org.apache.flink.table.data.RowData>	collector This is used for emitting elements with a given timestamp.
protected org.apache.flink.runtime.state.internal.InternalValueState<K,W,org.apache.flink.table.data.RowData>	previousState
protected boolean	produceUpdates
protected java.time.ZoneId	shiftTimeZone The shift timezone of the window, if the proctime or rowtime type is TIMESTAMP_LTZ, the shift timezone is the timezone user configured in TableConfig, other cases the timezone is UTC which means never shift when assigning windows.
protected NamespaceAggsHandleFunctionBase<W>	windowAggregator
protected InternalWindowProcessFunction<K,W>	windowFunction

Fields inherited from class org.apache.flink.streaming.api.operators.AbstractStreamOperator

chainingStrategy, config, latencyStats, LOG, metrics, output, processingTimeService

Method Summary

Modifier and Type	Method and Description
void	close()
protected abstract void	compileGeneratedCode()
void	dispose()
protected abstract void	emitWindowResult(W window) Emits the window result of the given window.
protected org.apache.flink.metrics.Counter	getNumLateRecordsDropped()
protected org.apache.flink.metrics.Gauge<Long>	getWatermarkLatency()
void	onEventTime(org.apache.flink.streaming.api.operators.InternalTimer<K,W> timer)
void	onProcessingTime(org.apache.flink.streaming.api.operators.InternalTimer<K,W> timer)
void	open()
void	processElement(org.apache.flink.streaming.runtime.streamrecord.StreamRecord<org.apache.flink.table.data.RowData> record)

Methods inherited from class org.apache.flink.streaming.api.operators.AbstractStreamOperator

getChainingStrategy, getContainingTask, getCurrentKey, getExecutionConfig, getInternalTimerService, getKeyedStateBackend, getKeyedStateStore, getMetricGroup, getOperatorConfig, getOperatorID, getOperatorName, getOperatorStateBackend, getOrCreateKeyedState, getPartitionedState, getPartitionedState, getProcessingTimeService, getRuntimeContext, getTimeServiceManager, getUserCodeClassloader, initializeState, initializeState, isUsingCustomRawKeyedState, notifyCheckpointAborted, notifyCheckpointComplete, prepareSnapshotPreBarrier, processLatencyMarker, processLatencyMarker1, processLatencyMarker2, processWatermark, processWatermark1, processWatermark2, reportOrForwardLatencyMarker, setChainingStrategy, setCurrentKey, setKeyContextElement1, setKeyContextElement2, setProcessingTimeService, setup, snapshotState, snapshotState

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.streaming.api.operators.OneInputStreamOperator

setKeyContextElement

Methods inherited from interface org.apache.flink.streaming.api.operators.StreamOperator

getMetricGroup, getOperatorID, initializeState, prepareSnapshotPreBarrier, setKeyContextElement1, setKeyContextElement2, snapshotState

Methods inherited from interface org.apache.flink.api.common.state.CheckpointListener

notifyCheckpointAborted, notifyCheckpointComplete

Methods inherited from interface org.apache.flink.streaming.api.operators.KeyContext

getCurrentKey, setCurrentKey

Methods inherited from interface org.apache.flink.streaming.api.operators.Input

processLatencyMarker, processWatermark

Field Detail

produceUpdates

protected final boolean produceUpdates

shiftTimeZone

protected final java.time.ZoneId shiftTimeZone

The shift timezone of the window, if the proctime or rowtime type is TIMESTAMP_LTZ, the shift timezone is the timezone user configured in TableConfig, other cases the timezone is UTC which means never shift when assigning windows.

windowAggregator

protected NamespaceAggsHandleFunctionBase<W extends Window> windowAggregator

windowFunction

protected transient InternalWindowProcessFunction<K,W extends Window> windowFunction

collector

protected transient org.apache.flink.streaming.api.operators.TimestampedCollector<org.apache.flink.table.data.RowData> collector

This is used for emitting elements with a given timestamp.

previousState

protected transient org.apache.flink.runtime.state.internal.InternalValueState<K,W extends Window,org.apache.flink.table.data.RowData> previousState

Method Detail

compileGeneratedCode

protected abstract void compileGeneratedCode()

open

public void open()
          throws Exception

Specified by:

open in interface org.apache.flink.streaming.api.operators.StreamOperator<org.apache.flink.table.data.RowData>

Overrides:

open in class org.apache.flink.streaming.api.operators.AbstractStreamOperator<org.apache.flink.table.data.RowData>

Throws:

Exception

close

public void close()
           throws Exception

Specified by:

close in interface org.apache.flink.streaming.api.operators.StreamOperator<org.apache.flink.table.data.RowData>

Overrides:

close in class org.apache.flink.streaming.api.operators.AbstractStreamOperator<org.apache.flink.table.data.RowData>

Throws:

Exception

dispose

public void dispose()
             throws Exception

Specified by:

dispose in interface org.apache.flink.streaming.api.operators.StreamOperator<org.apache.flink.table.data.RowData>

Specified by:

dispose in interface org.apache.flink.util.Disposable

Overrides:

dispose in class org.apache.flink.streaming.api.operators.AbstractStreamOperator<org.apache.flink.table.data.RowData>

Throws:

Exception

processElement

public void processElement(org.apache.flink.streaming.runtime.streamrecord.StreamRecord<org.apache.flink.table.data.RowData> record)
                    throws Exception

Specified by:

processElement in interface org.apache.flink.streaming.api.operators.Input<org.apache.flink.table.data.RowData>

Throws:

Exception

onEventTime

public void onEventTime(org.apache.flink.streaming.api.operators.InternalTimer<K,W> timer)
                 throws Exception

Specified by:

onEventTime in interface org.apache.flink.streaming.api.operators.Triggerable<K,W extends Window>

Throws:

Exception

onProcessingTime

public void onProcessingTime(org.apache.flink.streaming.api.operators.InternalTimer<K,W> timer)
                      throws Exception

Specified by:

onProcessingTime in interface org.apache.flink.streaming.api.operators.Triggerable<K,W extends Window>

Throws:

Exception

emitWindowResult

protected abstract void emitWindowResult(W window)
                                  throws Exception

Emits the window result of the given window.

Throws:

Exception

getNumLateRecordsDropped

protected org.apache.flink.metrics.Counter getNumLateRecordsDropped()

getWatermarkLatency

protected org.apache.flink.metrics.Gauge<Long> getWatermarkLatency()