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

Class LocalSlicingWindowAggOperator

java.lang.Object

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

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

All Implemented Interfaces:

Serializable, CheckpointListener, Input<RowData>, KeyContext, KeyContextHandler, OneInputStreamOperator<RowData,RowData>, StreamOperator<RowData>, StreamOperatorStateHandler.CheckpointedStreamOperator, YieldingOperator<RowData>

public class LocalSlicingWindowAggOperator
extends AbstractStreamOperator<RowData>
implements OneInputStreamOperator<RowData,RowData>

The operator used for local window aggregation.

Note: this only supports event-time window.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected TimestampedCollector<RowData>	collector	This is used for emitting elements with a given timestamp.

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

combinedWatermark, config, lastRecordAttributes1, lastRecordAttributes2, latencyStats, LOG, metrics, output, processingTimeService, stateHandler, stateKeySelector1, stateKeySelector2, timeServiceManager

Constructor Summary

Constructors

Constructor	Description
LocalSlicingWindowAggOperator(RowDataKeySelector keySelector, SliceAssigner sliceAssigner, WindowBuffer.LocalFactory windowBufferFactory, ZoneId shiftTimezone)

Method Summary

Modifier and Type	Method	Description
void	close()	This method is called at the very end of the operator's life, both in the case of a successful completion of the operation, and in the case of a failure and canceling.
void	open()	This method is called immediately before any elements are processed, it should contain the operator's initialization logic, e.g. state initialization.
void	prepareSnapshotPreBarrier(long checkpointId)	This method is called when the operator should do a snapshot, before it emits its own checkpoint barrier.
void	processElement(StreamRecord<RowData> element)	Processes one element that arrived on this input of the MultipleInputStreamOperator.
void	processWatermark(Watermark mark)	Processes a Watermark that arrived on the first input of this two-input operator.

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

finish, getContainingTask, getCurrentKey, getExecutionConfig, getInternalTimerService, getKeyedStateBackend, getKeyedStateStore, getMetricGroup, getOperatorConfig, getOperatorID, getOperatorName, getOperatorStateBackend, getOrCreateKeyedState, getPartitionedState, getPartitionedState, getProcessingTimeService, getRuntimeContext, getStateKeySelector1, getStateKeySelector2, getTimeServiceManager, getUserCodeClassloader, hasKeyContext1, hasKeyContext2, initializeState, initializeState, isAsyncStateProcessingEnabled, isUsingCustomRawKeyedState, notifyCheckpointAborted, notifyCheckpointComplete, processLatencyMarker, processLatencyMarker1, processLatencyMarker2, processRecordAttributes, processRecordAttributes1, processRecordAttributes2, processWatermark1, processWatermark2, processWatermarkStatus, processWatermarkStatus, processWatermarkStatus1, processWatermarkStatus2, reportOrForwardLatencyMarker, setCurrentKey, setKeyContextElement1, setKeyContextElement2, setMailboxExecutor, setProcessingTimeService, setup, snapshotState, snapshotState, useSplittableTimers

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.api.common.state.CheckpointListener

notifyCheckpointAborted, notifyCheckpointComplete

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

processLatencyMarker, processRecordAttributes, processWatermarkStatus

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

getCurrentKey, setCurrentKey

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

hasKeyContext

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

setKeyContextElement

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

finish, getMetricGroup, getOperatorAttributes, getOperatorID, initializeState, setKeyContextElement1, setKeyContextElement2, snapshotState

Field Detail

collector

protected transient TimestampedCollector<RowData> collector

This is used for emitting elements with a given timestamp.

Constructor Detail

LocalSlicingWindowAggOperator

public LocalSlicingWindowAggOperator(RowDataKeySelector keySelector,
                                     SliceAssigner sliceAssigner,
                                     WindowBuffer.LocalFactory windowBufferFactory,
                                     ZoneId shiftTimezone)

Method Detail

open

public void open()
          throws Exception

Description copied from class: AbstractStreamOperator

This method is called immediately before any elements are processed, it should contain the operator's initialization logic, e.g. state initialization.

The default implementation does nothing.

Specified by:

open in interface StreamOperator<RowData>

Overrides:

open in class AbstractStreamOperator<RowData>

Throws:

Exception - An exception in this method causes the operator to fail.

processElement

public void processElement(StreamRecord<RowData> element)
                    throws Exception

Description copied from interface: Input

Processes one element that arrived on this input of the MultipleInputStreamOperator. This method is guaranteed to not be called concurrently with other methods of the operator.

Specified by:

processElement in interface Input<RowData>

Throws:

Exception

processWatermark

public void processWatermark(Watermark mark)
                      throws Exception

Description copied from interface: Input

Processes a Watermark that arrived on the first input of this two-input operator. This method is guaranteed to not be called concurrently with other methods of the operator.

Specified by:

processWatermark in interface Input<RowData>

Overrides:

processWatermark in class AbstractStreamOperator<RowData>

Throws:

Exception

See Also:

Watermark

prepareSnapshotPreBarrier

public void prepareSnapshotPreBarrier(long checkpointId)
                               throws Exception

Description copied from interface: StreamOperator

This method is called when the operator should do a snapshot, before it emits its own checkpoint barrier.

This method is intended not for any actual state persistence, but only for emitting some data before emitting the checkpoint barrier. Operators that maintain some small transient state that is inefficient to checkpoint (especially when it would need to be checkpointed in a re-scalable way) but can simply be sent downstream before the checkpoint. An example are opportunistic pre-aggregation operators, which have small the pre-aggregation state that is frequently flushed downstream.

Important: This method should not be used for any actual state snapshot logic, because it will inherently be within the synchronous part of the operator's checkpoint. If heavy work is done within this method, it will affect latency and downstream checkpoint alignments.

Specified by:

prepareSnapshotPreBarrier in interface StreamOperator<RowData>

Overrides:

prepareSnapshotPreBarrier in class AbstractStreamOperator<RowData>

Parameters:

checkpointId - The ID of the checkpoint.

Throws:

Exception - Throwing an exception here causes the operator to fail and go into recovery.

close

public void close()
           throws Exception

Description copied from interface: StreamOperator

This method is called at the very end of the operator's life, both in the case of a successful completion of the operation, and in the case of a failure and canceling.

This method is expected to make a thorough effort to release all resources that the operator has acquired.

NOTE:It can not emit any records! If you need to emit records at the end of processing, do so in the StreamOperator.finish() method.

Specified by:

close in interface StreamOperator<RowData>

Overrides:

close in class AbstractStreamOperator<RowData>

Throws:

Exception