org.apache.flink.runtime.state

Class AbstractHeapKvState<K,V,Backend extends StateBackend<Backend>>

java.lang.Object

org.apache.flink.runtime.state.AbstractHeapKvState<K,V,Backend>

Type Parameters:

K - The type of the key.

V - The type of the value.

Backend - The type of the backend that snapshots this key/value state.

All Implemented Interfaces:

org.apache.flink.api.common.state.OperatorState<V>, KvState<K,V,Backend>

Direct Known Subclasses:

FsHeapKvState, MemHeapKvState

public abstract class AbstractHeapKvState<K,V,Backend extends StateBackend<Backend>>
extends Object
implements KvState<K,V,Backend>

Base class for key/value state implementations that are backed by a regular heap hash map. The concrete implementations define how the state is checkpointed.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractHeapKvState(org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer, org.apache.flink.api.common.typeutils.TypeSerializer<V> valueSerializer, V defaultValue) Creates a new empty key/value state.
protected	AbstractHeapKvState(org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer, org.apache.flink.api.common.typeutils.TypeSerializer<V> valueSerializer, V defaultValue, HashMap<K,V> state) Creates a new key/value state for the given hash map of key/value pairs.

Method Summary

Modifier and Type	Method and Description
void	dispose() Disposes the key/value state, releasing all occupied resources.
org.apache.flink.api.common.typeutils.TypeSerializer<K>	getKeySerializer() Gets the serializer for the keys.
org.apache.flink.api.common.typeutils.TypeSerializer<V>	getValueSerializer() Gets the serializer for the values.
void	setCurrentKey(K currentKey) Sets the current key, which will be used to retrieve values for the next calls to OperatorState.value() and OperatorState.update(Object).
int	size() Gets the number of key/value pairs currently stored in the state.
void	update(V value)
V	value()
protected void	writeStateToOutputView(org.apache.flink.core.memory.DataOutputView out)

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.runtime.state.KvState

shapshot

Constructor Detail

AbstractHeapKvState

protected AbstractHeapKvState(org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer,
                              org.apache.flink.api.common.typeutils.TypeSerializer<V> valueSerializer,
                              V defaultValue)

Creates a new empty key/value state.

Parameters:

keySerializer - The serializer for the keys.

valueSerializer - The serializer for the values.

defaultValue - The value that is returned when no other value has been associated with a key, yet.

AbstractHeapKvState

protected AbstractHeapKvState(org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer,
                              org.apache.flink.api.common.typeutils.TypeSerializer<V> valueSerializer,
                              V defaultValue,
                              HashMap<K,V> state)

Creates a new key/value state for the given hash map of key/value pairs.

Parameters:

keySerializer - The serializer for the keys.

valueSerializer - The serializer for the values.

defaultValue - The value that is returned when no other value has been associated with a key, yet.

state - The state map to use in this kev/value state. May contain initial state.

Method Detail

value

public V value()

Specified by:

value in interface org.apache.flink.api.common.state.OperatorState<V>

update

public void update(V value)

Specified by:

update in interface org.apache.flink.api.common.state.OperatorState<V>

setCurrentKey

public void setCurrentKey(K currentKey)

Description copied from interface: KvState

Sets the current key, which will be used to retrieve values for the next calls to OperatorState.value() and OperatorState.update(Object).

Specified by:

setCurrentKey in interface KvState<K,V,Backend extends StateBackend<Backend>>

Parameters:

currentKey - The key.

size

public int size()

Description copied from interface: KvState

Gets the number of key/value pairs currently stored in the state. Note that is a key has been associated with "null", the key is removed from the state an will not be counted here.

Specified by:

size in interface KvState<K,V,Backend extends StateBackend<Backend>>

Returns:

The number of key/value pairs currently stored in the state.

dispose

public void dispose()

Description copied from interface: KvState

Disposes the key/value state, releasing all occupied resources.

Specified by:

dispose in interface KvState<K,V,Backend extends StateBackend<Backend>>

getKeySerializer

public org.apache.flink.api.common.typeutils.TypeSerializer<K> getKeySerializer()

Gets the serializer for the keys.

Returns:

The serializer for the keys.

getValueSerializer

public org.apache.flink.api.common.typeutils.TypeSerializer<V> getValueSerializer()

Gets the serializer for the values.

Returns:

The serializer for the values.

writeStateToOutputView

protected void writeStateToOutputView(org.apache.flink.core.memory.DataOutputView out)
                               throws IOException

Throws:

IOException