org.apache.flink.runtime.state.heap

Class InternalKeyContextImpl<K>

java.lang.Object

org.apache.flink.runtime.state.heap.InternalKeyContextImpl<K>

Type Parameters:

K - Type of the key.

All Implemented Interfaces:

InternalKeyContext<K>

public class InternalKeyContextImpl<K>
extends Object
implements InternalKeyContext<K>

The default InternalKeyContext implementation.

Constructor Summary

Constructors

Constructor and Description
InternalKeyContextImpl(KeyGroupRange keyGroupRange, int numberOfKeyGroups)

Method Summary

Modifier and Type	Method and Description
K	getCurrentKey() Used by states to access the current key.
int	getCurrentKeyGroupIndex() Returns the key-group to which the current key belongs.
KeyGroupRange	getKeyGroupRange() Returns the key groups for this backend.
int	getNumberOfKeyGroups() Returns the number of key-groups aka max parallelism.
void	setCurrentKey(K currentKey) Set current key of the context.
void	setCurrentKeyGroupIndex(int currentKeyGroupIndex) Set current key group index of the context.

Methods inherited from class java.lang.Object

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

Constructor Detail

InternalKeyContextImpl

public InternalKeyContextImpl(@Nonnull
                              KeyGroupRange keyGroupRange,
                              @Nonnegative
                              int numberOfKeyGroups)

Method Detail

getCurrentKey

public K getCurrentKey()

Description copied from interface: InternalKeyContext

Used by states to access the current key.

Specified by:

getCurrentKey in interface InternalKeyContext<K>

getCurrentKeyGroupIndex

public int getCurrentKeyGroupIndex()

Description copied from interface: InternalKeyContext

Returns the key-group to which the current key belongs.

Specified by:

getCurrentKeyGroupIndex in interface InternalKeyContext<K>

getNumberOfKeyGroups

public int getNumberOfKeyGroups()

Description copied from interface: InternalKeyContext

Returns the number of key-groups aka max parallelism.

Specified by:

getNumberOfKeyGroups in interface InternalKeyContext<K>

getKeyGroupRange

public KeyGroupRange getKeyGroupRange()

Description copied from interface: InternalKeyContext

Returns the key groups for this backend.

Specified by:

getKeyGroupRange in interface InternalKeyContext<K>

setCurrentKey

public void setCurrentKey(@Nonnull
                          K currentKey)

Description copied from interface: InternalKeyContext

Set current key of the context.

Specified by:

setCurrentKey in interface InternalKeyContext<K>

Parameters:

currentKey - the current key to set to.

setCurrentKeyGroupIndex

public void setCurrentKeyGroupIndex(int currentKeyGroupIndex)

Description copied from interface: InternalKeyContext

Set current key group index of the context.

Specified by:

setCurrentKeyGroupIndex in interface InternalKeyContext<K>

Parameters:

currentKeyGroupIndex - the current key group index to set to.