Package org.apache.flink.streaming.api.operators.sortpartition

Class KeyedSortPartitionOperator<INPUT,KEY>

java.lang.Object

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

org.apache.flink.streaming.api.operators.sortpartition.KeyedSortPartitionOperator<INPUT,KEY>

Type Parameters:

INPUT - The type of input record.

KEY - The type of record key, which has already been defined in KeyedStream.

All Implemented Interfaces:

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

@Internal
public class KeyedSortPartitionOperator<INPUT,KEY>
extends AbstractStreamOperator<INPUT>
implements OneInputStreamOperator<INPUT,INPUT>, BoundedOneInput

The KeyedSortPartitionOperator sorts records of a partition on KeyedStream. It ensures that all records with the same key are sorted in a user-defined order.

To sort the record key first and then record at the same time, both the record key and the record will be written to ExternalSorter directly. However, if the record is sorted according to the selected key by KeySelector, the selected sort key should also be written with the record key and the record to ExternalSorter to avoid repeated key selections.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected TypeInformation<INPUT>	inputType	The type information of input records.
protected KeySelector<INPUT,?>	sortFieldSelector	The selector to create the sort key for records, which will be null if it's not used.

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

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

Constructor Summary

Constructors

Constructor	Description
KeyedSortPartitionOperator(TypeInformation<INPUT> inputType, int positionSortField, Order sortOrder)
KeyedSortPartitionOperator(TypeInformation<INPUT> inputType, String stringSortField, Order sortOrder)
KeyedSortPartitionOperator(TypeInformation<INPUT> inputType, KeySelector<INPUT,K> sortFieldSelector, Order sortOrder)

Method Summary

Modifier and Type	Method	Description
void	endInput()	It is notified that no more data will arrive from the input.
OperatorAttributes	getOperatorAttributes()	Called to get the OperatorAttributes of the operator.
void	processElement(StreamRecord<INPUT> element)	Processes one element that arrived on this input of the MultipleInputStreamOperator.
protected void	setup(StreamTask<?,?> containingTask, StreamConfig config, Output<StreamRecord<INPUT>> output)

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

close, 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, isUsingCustomRawKeyedState, notifyCheckpointAborted, notifyCheckpointComplete, open, prepareSnapshotPreBarrier, processLatencyMarker, processLatencyMarker1, processLatencyMarker2, processRecordAttributes, processRecordAttributes1, processRecordAttributes2, processWatermark, processWatermark1, processWatermark2, processWatermarkStatus, processWatermarkStatus1, processWatermarkStatus2, reportOrForwardLatencyMarker, setCurrentKey, setKeyContextElement1, setKeyContextElement2, setMailboxExecutor, setProcessingTimeService, 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, processWatermark, 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

close, finish, getMetricGroup, getOperatorID, initializeState, open, prepareSnapshotPreBarrier, setKeyContextElement1, setKeyContextElement2, snapshotState

Field Detail

inputType

protected final TypeInformation<INPUT> inputType

The type information of input records.

sortFieldSelector

protected final KeySelector<INPUT,?> sortFieldSelector

The selector to create the sort key for records, which will be null if it's not used.

Constructor Detail

KeyedSortPartitionOperator

public KeyedSortPartitionOperator(TypeInformation<INPUT> inputType,
                                  int positionSortField,
                                  Order sortOrder)

KeyedSortPartitionOperator

public KeyedSortPartitionOperator(TypeInformation<INPUT> inputType,
                                  String stringSortField,
                                  Order sortOrder)

KeyedSortPartitionOperator

public KeyedSortPartitionOperator(TypeInformation<INPUT> inputType,
                                  KeySelector<INPUT,K> sortFieldSelector,
                                  Order sortOrder)

Method Detail

setup

protected void setup(StreamTask<?,?> containingTask,
                     StreamConfig config,
                     Output<StreamRecord<INPUT>> output)

Overrides:

setup in class AbstractStreamOperator<INPUT>

processElement

public void processElement(StreamRecord<INPUT> 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<INPUT>

Throws:

Exception

endInput

public void endInput()
              throws Exception

Description copied from interface: BoundedOneInput

It is notified that no more data will arrive from the input.

WARNING: It is not safe to use this method to commit any transactions or other side effects! You can use this method to flush any buffered data that can later on be committed e.g. in a CheckpointListener.notifyCheckpointComplete(long).

NOTE: Given it is semantically very similar to the StreamOperator.finish() method. It might be dropped in favour of the other method at some point in time.

Specified by:

endInput in interface BoundedOneInput

Throws:

Exception

getOperatorAttributes

public OperatorAttributes getOperatorAttributes()

Description copied from interface: StreamOperator

Called to get the OperatorAttributes of the operator. If there is no defined attribute, a default OperatorAttributes is built.

Specified by:

getOperatorAttributes in interface StreamOperator<INPUT>

Returns:

OperatorAttributes of the operator.