Package org.apache.flink.runtime.state

Class KeyGroupPartitioner<T>

java.lang.Object

org.apache.flink.runtime.state.KeyGroupPartitioner<T>

Type Parameters:

T - type of the partitioned elements.

public class KeyGroupPartitioner<T>
extends Object

Class that contains the base algorithm for partitioning data into key-groups. This algorithm currently works with two array (input, output) for optimal algorithmic complexity. Notice that this could also be implemented over a single array, using some cuckoo-hashing-style element replacement. This would have worse algorithmic complexity but better space efficiency. We currently prefer the trade-off in favor of better algorithmic complexity.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KeyGroupPartitioner.ElementReaderFunction<T>	This functional interface defines how one element is read from a DataInputView.
static interface	KeyGroupPartitioner.ElementWriterFunction<T>	This functional interface defines how one element is written to a DataOutputView.
static interface	KeyGroupPartitioner.KeyGroupElementsConsumer<T>	Functional interface to consume elements from a key group.
static interface	KeyGroupPartitioner.PartitioningResult<T>	This represents the result of key-group partitioning.

Constructor Summary

Constructors

Constructor	Description
KeyGroupPartitioner(T[] partitioningSource, int numberOfElements, T[] partitioningDestination, KeyGroupRange keyGroupRange, int totalKeyGroups, KeyExtractorFunction<T> keyExtractorFunction, KeyGroupPartitioner.ElementWriterFunction<T> elementWriterFunction)	Creates a new KeyGroupPartitioner.

Method Summary

Modifier and Type	Method	Description
static <T> StateSnapshotKeyGroupReader	createKeyGroupPartitionReader(KeyGroupPartitioner.ElementReaderFunction<T> readerFunction, KeyGroupPartitioner.KeyGroupElementsConsumer<T> elementConsumer)
KeyGroupPartitioner.PartitioningResult<T>	partitionByKeyGroup()	Partitions the data into key-groups and returns the result as a KeyGroupPartitioner.PartitioningResult.
protected void	reportAllElementKeyGroups()	This method iterates over the input data and reports the key-group for each element.
protected void	reportKeyGroupOfElementAtIndex(int index, int keyGroup)	This method reports in the bookkeeping data that the element at the given index belongs to the given key-group.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyGroupPartitioner

public KeyGroupPartitioner(@Nonnull
                           T[] partitioningSource,
                           @Nonnegative
                           int numberOfElements,
                           @Nonnull
                           T[] partitioningDestination,
                           @Nonnull
                           KeyGroupRange keyGroupRange,
                           @Nonnegative
                           int totalKeyGroups,
                           @Nonnull
                           KeyExtractorFunction<T> keyExtractorFunction,
                           @Nonnull
                           KeyGroupPartitioner.ElementWriterFunction<T> elementWriterFunction)

Creates a new KeyGroupPartitioner.

Parameters:

partitioningSource - the input for the partitioning. All elements must be densely packed in the index interval [0, numberOfElements[, without null values.

numberOfElements - the number of elements to consider from the input, starting at input index 0.

partitioningDestination - the output of the partitioning. Must have capacity of at least numberOfElements.

keyGroupRange - the key-group range of the data that will be partitioned by this instance.

totalKeyGroups - the total number of key groups in the job.

keyExtractorFunction - this function extracts the partition key from an element.

Method Detail

partitionByKeyGroup

public KeyGroupPartitioner.PartitioningResult<T> partitionByKeyGroup()

Partitions the data into key-groups and returns the result as a KeyGroupPartitioner.PartitioningResult.

reportAllElementKeyGroups

protected void reportAllElementKeyGroups()

This method iterates over the input data and reports the key-group for each element.

reportKeyGroupOfElementAtIndex

protected void reportKeyGroupOfElementAtIndex(int index,
                                              int keyGroup)

This method reports in the bookkeeping data that the element at the given index belongs to the given key-group.

createKeyGroupPartitionReader

public static <T> StateSnapshotKeyGroupReader createKeyGroupPartitionReader(@Nonnull
                                                                            KeyGroupPartitioner.ElementReaderFunction<T> readerFunction,
                                                                            @Nonnull
                                                                            KeyGroupPartitioner.KeyGroupElementsConsumer<T> elementConsumer)