org.apache.flink.runtime.state.heap

类 HeapPriorityQueueSet<T extends HeapPriorityQueueElement>

java.lang.Object

org.apache.flink.runtime.state.heap.AbstractHeapPriorityQueue<T>

org.apache.flink.runtime.state.heap.HeapPriorityQueue<T>

org.apache.flink.runtime.state.heap.HeapPriorityQueueSet<T>

类型参数:

T - type of the contained elements.

所有已实现的接口:

InternalPriorityQueue<T>, KeyGroupedInternalPriorityQueue<T>

public class HeapPriorityQueueSet<T extends HeapPriorityQueueElement>
extends HeapPriorityQueue<T>
implements KeyGroupedInternalPriorityQueue<T>

A heap-based priority queue with set semantics, based on HeapPriorityQueue. The heap is supported by hash set for fast contains (de-duplication) and deletes. Object identification happens based on Object.equals(Object).

Possible future improvements:

• We could also implement shrinking for the heap and the deduplication set.
• We could replace the deduplication maps with more efficient custom implementations. In particular, a hash set would be enough if it could return existing elements on unsuccessful adding, etc..

字段概要

从类继承的字段 org.apache.flink.runtime.state.heap.HeapPriorityQueue

elementPriorityComparator

从类继承的字段 org.apache.flink.runtime.state.heap.AbstractHeapPriorityQueue

queue, size

构造器概要

构造器

构造器和说明
HeapPriorityQueueSet(PriorityComparator<T> elementPriorityComparator, KeyExtractorFunction<T> keyExtractor, int minimumCapacity, KeyGroupRange keyGroupRange, int totalNumberOfKeyGroups) Creates an empty HeapPriorityQueueSet with the requested initial capacity.

方法概要

限定符和类型	方法和说明
boolean	add(T element) Adds the element to the queue.
void	clear() Clears the queue.
Set<T>	getSubsetForKeyGroup(int keyGroupId) Returns the subset of elements in the priority queue that belongs to the given key-group, within the operator's key-group range.
T	poll() Retrieves and removes the first element (w.r.t. the order) of this set, or returns null if this set is empty.
boolean	remove(T toRemove) In contrast to the superclass and to maintain set semantics, removal here is based on comparing the given element via Object.equals(Object).

从类继承的方法 org.apache.flink.runtime.state.heap.HeapPriorityQueue

addInternal, adjustModifiedElement, getHeadElementIndex, removeInternal

从类继承的方法 org.apache.flink.runtime.state.heap.AbstractHeapPriorityQueue

addAll, isEmpty, iterator, moveElementToIdx, peek, resizeForBulkLoad, resizeQueueArray, size, toArray

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.apache.flink.runtime.state.InternalPriorityQueue

addAll, isEmpty, iterator, peek, size

构造器详细资料

HeapPriorityQueueSet

public HeapPriorityQueueSet(@Nonnull
                            PriorityComparator<T> elementPriorityComparator,
                            @Nonnull
                            KeyExtractorFunction<T> keyExtractor,
                            @Nonnegative
                            int minimumCapacity,
                            @Nonnull
                            KeyGroupRange keyGroupRange,
                            @Nonnegative
                            int totalNumberOfKeyGroups)

Creates an empty HeapPriorityQueueSet with the requested initial capacity.

参数:

elementPriorityComparator - comparator for the priority of contained elements.

keyExtractor - function to extract a key from the contained elements.

minimumCapacity - the minimum and initial capacity of this priority queue.

keyGroupRange - the key-group range of the elements in this set.

totalNumberOfKeyGroups - the total number of key-groups of the job.

方法详细资料

poll

@Nullable
public T poll()

从接口复制的说明: InternalPriorityQueue

Retrieves and removes the first element (w.r.t. the order) of this set, or returns null if this set is empty.

NOTE: Correct key (i.e. the key of the polled element) must be set on KeyContext before calling this method.

指定者:

poll 在接口中 InternalPriorityQueue<T extends HeapPriorityQueueElement>

覆盖:

poll 在类中 AbstractHeapPriorityQueue<T extends HeapPriorityQueueElement>

返回:

the first element of this ordered set, or null if this set is empty.

add

public boolean add(@Nonnull
                   T element)

Adds the element to the queue. In contrast to the superclass and to maintain set semantics, this happens only if no such element is already contained (determined by Object.equals(Object)).

指定者:

add 在接口中 InternalPriorityQueue<T extends HeapPriorityQueueElement>

覆盖:

add 在类中 AbstractHeapPriorityQueue<T extends HeapPriorityQueueElement>

参数:

element - the element to add to the set.

返回:

true if the operation changed the head element or if is it unclear if the head element changed. Only returns false iff the head element was not changed by this operation.

remove

public boolean remove(@Nonnull
                      T toRemove)

In contrast to the superclass and to maintain set semantics, removal here is based on comparing the given element via Object.equals(Object).

指定者:

remove 在接口中 InternalPriorityQueue<T extends HeapPriorityQueueElement>

覆盖:

remove 在类中 AbstractHeapPriorityQueue<T extends HeapPriorityQueueElement>

参数:

toRemove - the element to remove.

返回:

true if the operation changed the head element or if is it unclear if the head element changed. Only returns false iff the head element was not changed by this operation.

clear

public void clear()

从类复制的说明: AbstractHeapPriorityQueue

Clears the queue.

覆盖:

clear 在类中 AbstractHeapPriorityQueue<T extends HeapPriorityQueueElement>

getSubsetForKeyGroup

@Nonnull
public Set<T> getSubsetForKeyGroup(int keyGroupId)

从接口复制的说明: KeyGroupedInternalPriorityQueue

Returns the subset of elements in the priority queue that belongs to the given key-group, within the operator's key-group range.

指定者:

getSubsetForKeyGroup 在接口中 KeyGroupedInternalPriorityQueue<T extends HeapPriorityQueueElement>