org.apache.flink.api.java.operators

Class SortedGrouping<T>

java.lang.Object

org.apache.flink.api.java.operators.Grouping<T>

org.apache.flink.api.java.operators.SortedGrouping<T>

Type Parameters:

T - The type of the elements of the sorted and grouped DataSet.

Deprecated.

All Flink DataSet APIs are deprecated since Flink 1.18 and will be removed in a future Flink major version. You can still build your application in DataSet, but you should move to either the DataStream and/or Table API.

@Deprecated
 @Public
public class SortedGrouping<T>
extends Grouping<T>

SortedGrouping is an intermediate step for a transformation on a grouped and sorted DataSet.

The following transformation can be applied on sorted groups:

• reduceGroup(org.apache.flink.api.common.functions.GroupReduceFunction),

See Also:

FLIP-131: Consolidate the user-facing Dataflow SDKs/APIs (and deprecate the DataSet API

Field Summary

Fields inherited from class org.apache.flink.api.java.operators.Grouping

customPartitioner, inputDataSet, keys

Constructor Summary

Constructors

Constructor and Description
SortedGrouping(DataSet<T> set, Keys<T> keys, int field, Order order) Deprecated.
SortedGrouping(DataSet<T> set, Keys<T> keys, Keys.SelectorFunctionKeys<T,K> keySelector, Order order) Deprecated.
SortedGrouping(DataSet<T> set, Keys<T> keys, String field, Order order) Deprecated.

Method Summary

Modifier and Type	Method and Description
<R> GroupCombineOperator<T,R>	combineGroup(GroupCombineFunction<T,R> combiner) Deprecated. Applies a GroupCombineFunction on a grouped DataSet.
GroupReduceOperator<T,T>	first(int n) Deprecated. Returns a new set containing the first n elements in this grouped and sorted DataSet.
protected Ordering	getGroupOrdering() Deprecated.
protected int[]	getGroupSortKeyPositions() Deprecated.
protected Order[]	getGroupSortOrders() Deprecated.
protected Keys.SelectorFunctionKeys<T,?>	getSortSelectionFunctionKey() Deprecated.
<R> GroupReduceOperator<T,R>	reduceGroup(GroupReduceFunction<T,R> reducer) Deprecated. Applies a GroupReduce transformation on a grouped and sorted DataSet.
SortedGrouping<T>	sortGroup(int field, Order order) Deprecated. Sorts Tuple elements within a group on the specified field in the specified Order.
SortedGrouping<T>	sortGroup(String field, Order order) Deprecated. Sorts Tuple or POJO elements within a group on the specified field in the specified Order.
SortedGrouping<T>	withPartitioner(Partitioner<?> partitioner) Deprecated. Uses a custom partitioner for the grouping.

Methods inherited from class org.apache.flink.api.java.operators.Grouping

getCustomPartitioner, getInputDataSet, getKeys

Methods inherited from class java.lang.Object

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

Constructor Detail

SortedGrouping

public SortedGrouping(DataSet<T> set,
                      Keys<T> keys,
                      int field,
                      Order order)

Deprecated.

SortedGrouping

public SortedGrouping(DataSet<T> set,
                      Keys<T> keys,
                      String field,
                      Order order)

Deprecated.

SortedGrouping

public SortedGrouping(DataSet<T> set,
                      Keys<T> keys,
                      Keys.SelectorFunctionKeys<T,K> keySelector,
                      Order order)

Deprecated.

Method Detail

getGroupSortKeyPositions

protected int[] getGroupSortKeyPositions()

Deprecated.

getGroupSortOrders

protected Order[] getGroupSortOrders()

Deprecated.

getGroupOrdering

protected Ordering getGroupOrdering()

Deprecated.

withPartitioner

public SortedGrouping<T> withPartitioner(Partitioner<?> partitioner)

Deprecated.

Uses a custom partitioner for the grouping.

Parameters:

partitioner - The custom partitioner.

Returns:

The grouping object itself, to allow for method chaining.

getSortSelectionFunctionKey

protected Keys.SelectorFunctionKeys<T,?> getSortSelectionFunctionKey()

Deprecated.

reduceGroup

public <R> GroupReduceOperator<T,R> reduceGroup(GroupReduceFunction<T,R> reducer)

Deprecated.

Applies a GroupReduce transformation on a grouped and sorted DataSet.

The transformation calls a RichGroupReduceFunction for each group of the DataSet. A GroupReduceFunction can iterate over all elements of a group and emit any number of output elements including none.

Parameters:

reducer - The GroupReduceFunction that is applied on each group of the DataSet.

Returns:

A GroupReduceOperator that represents the reduced DataSet.

See Also:

RichGroupReduceFunction, GroupReduceOperator, DataSet

combineGroup

public <R> GroupCombineOperator<T,R> combineGroup(GroupCombineFunction<T,R> combiner)

Deprecated.

Applies a GroupCombineFunction on a grouped DataSet. A CombineFunction is similar to a GroupReduceFunction but does not perform a full data exchange. Instead, the CombineFunction calls the combine method once per partition for combining a group of results. This operator is suitable for combining values into an intermediate format before doing a proper groupReduce where the data is shuffled across the node for further reduction. The GroupReduce operator can also be supplied with a combiner by implementing the RichGroupReduce function. The combine method of the RichGroupReduce function demands input and output type to be the same. The CombineFunction, on the other side, can have an arbitrary output type.

Parameters:

combiner - The GroupCombineFunction that is applied on the DataSet.

Returns:

A GroupCombineOperator which represents the combined DataSet.

first

public GroupReduceOperator<T,T> first(int n)

Deprecated.

Returns a new set containing the first n elements in this grouped and sorted DataSet.

Parameters:

n - The desired number of elements for each group.

Returns:

A GroupReduceOperator that represents the DataSet containing the elements.

sortGroup

public SortedGrouping<T> sortGroup(int field,
                                   Order order)

Deprecated.

Sorts Tuple elements within a group on the specified field in the specified Order.

Note: Only groups of Tuple or Pojo elements can be sorted.

Groups can be sorted by multiple fields by chaining sortGroup(int, Order) calls.

Parameters:

field - The Tuple field on which the group is sorted.

order - The Order in which the specified Tuple field is sorted.

Returns:

A SortedGrouping with specified order of group element.

See Also:

Tuple, Order

sortGroup

public SortedGrouping<T> sortGroup(String field,
                                   Order order)

Deprecated.

Sorts Tuple or POJO elements within a group on the specified field in the specified Order.

Note: Only groups of Tuple or Pojo elements can be sorted.

Groups can be sorted by multiple fields by chaining sortGroup(String, Order) calls.

Parameters:

field - The Tuple or Pojo field on which the group is sorted.

order - The Order in which the specified field is sorted.

Returns:

A SortedGrouping with specified order of group element.

See Also:

Tuple, Order