AbstractHeapState (flink 1.0-SNAPSHOT API)

java.lang.Object
- org.apache.flink.runtime.state.AbstractHeapState<K,N,SV,S,SD,Backend>

Type Parameters:

K - The type of the key.

N - The type of the namespace.

SV - The type of the values in the state.

S - The type of State

SD - The type of StateDescriptor for the State S

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

All Implemented Interfaces:

State, KvState<K,N,S,SD,Backend>

Direct Known Subclasses:

AbstractFsState, AbstractMemState
```
public abstract class AbstractHeapState<K,N,SV,S extends State,SD extends StateDescriptor<S,?>,Backend extends AbstractStateBackend>
extends Object
implements KvState<K,N,S,SD,Backend>, State
```
Base class for partitioned ListState implementations that are backed by a regular heap hash map. The concrete implementations define how the state is checkpointed.

Field Summary

Fields
Modifier and Type	Field and Description
`protected K`	`currentKey` The current key, which the next value methods will refer to
`protected N`	`currentNamespace` The current namespace, which the access methods will refer to.
`protected Map<K,SV>`	`currentNSState` Cache the state map for the current key.
`protected TypeSerializer<K>`	`keySerializer` The serializer for the keys
`protected TypeSerializer<N>`	`namespaceSerializer` The serializer for the namespace
`protected HashMap<N,Map<K,SV>>`	`state` Map containing the actual key/value pairs
`protected SD`	`stateDesc` This holds the name of the state and can create an initial default value for the state.
`protected TypeSerializer<SV>`	`stateSerializer` Serializer for the state value.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractHeapState(TypeSerializer<K> keySerializer, TypeSerializer<N> namespaceSerializer, TypeSerializer<SV> stateSerializer, SD stateDesc)` Creates a new empty key/value state.
`protected`	`AbstractHeapState(TypeSerializer<K> keySerializer, TypeSerializer<N> namespaceSerializer, TypeSerializer<SV> stateSerializer, SD stateDesc, HashMap<N,Map<K,SV>> state)` Creates a new key/value state for the given hash map of key/value pairs.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Removes the value mapped under the current key.
`void`	`dispose()` Disposes the key/value state, releasing all occupied resources.
`TypeSerializer<K>`	`getKeySerializer()` Gets the serializer for the keys.
`TypeSerializer<N>`	`getNamespaceSerializer()` Gets the serializer for the namespace.
`void`	`setCurrentKey(K currentKey)` Sets the current key, which will be used when using the state access methods.
`void`	`setCurrentNamespace(N namespace)` Sets the current namespace, which will be used when using the state access methods.
`protected int`	`size()` Returns the number of all state pairs in this state, across namespaces.

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
snapshot

- Field Detail
  - state
```
protected final HashMap<N,Map<K,SV>> state
```
    Map containing the actual key/value pairs
  - stateSerializer
```
protected final TypeSerializer<SV> stateSerializer
```
    Serializer for the state value. The state value could be a List, for example.
  - keySerializer
```
protected final TypeSerializer<K> keySerializer
```
    The serializer for the keys
  - namespaceSerializer
```
protected final TypeSerializer<N> namespaceSerializer
```
    The serializer for the namespace
  - stateDesc
```
protected final SD extends StateDescriptor<S,?> stateDesc
```
    This holds the name of the state and can create an initial default value for the state.
  - currentKey
```
protected K currentKey
```
    The current key, which the next value methods will refer to
  - currentNamespace
```
protected N currentNamespace
```
    The current namespace, which the access methods will refer to.
  - currentNSState
```
protected Map<K,SV> currentNSState
```
    Cache the state map for the current key.
- Constructor Detail
  - AbstractHeapState
```
protected AbstractHeapState(TypeSerializer<K> keySerializer,
                            TypeSerializer<N> namespaceSerializer,
                            TypeSerializer<SV> stateSerializer,
                            SD stateDesc)
```
    Creates a new empty key/value state.
    
    Parameters:
    
    keySerializer - The serializer for the keys.
    
    namespaceSerializer - The serializer for the namespace.
    
    stateDesc - The state identifier for the state. This contains name and can create a default state value.
  - AbstractHeapState
```
protected AbstractHeapState(TypeSerializer<K> keySerializer,
                            TypeSerializer<N> namespaceSerializer,
                            TypeSerializer<SV> stateSerializer,
                            SD stateDesc,
                            HashMap<N,Map<K,SV>> state)
```
    Creates a new key/value state for the given hash map of key/value pairs.
    
    Parameters:
    
    keySerializer - The serializer for the keys.
    
    stateDesc - The state identifier for the state. This contains name and can create a default state value.
    
    state - The state map to use in this kev/value state. May contain initial state.
- Method Detail
  - clear
```
public final void clear()
```
    Description copied from interface: State
    
    Removes the value mapped under the current key.
    
    Specified by:
    
    clear in interface State
  - setCurrentKey
```
public final void setCurrentKey(K currentKey)
```
    Description copied from interface: KvState
    
    Sets the current key, which will be used when using the state access methods.
    
    Specified by:
    
    setCurrentKey in interface KvState<K,N,S extends State,SD extends StateDescriptor<S,?>,Backend extends AbstractStateBackend>
    
    Parameters:
    
    currentKey - The key.
  - setCurrentNamespace
```
public final void setCurrentNamespace(N namespace)
```
    Description copied from interface: KvState
    
    Sets the current namespace, which will be used when using the state access methods.
    
    Specified by:
    
    setCurrentNamespace in interface KvState<K,N,S extends State,SD extends StateDescriptor<S,?>,Backend extends AbstractStateBackend>
    
    Parameters:
    
    namespace - The namespace.
  - size
```
protected final int size()
```
    Returns the number of all state pairs in this state, across namespaces.
  - 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,N,S extends State,SD extends StateDescriptor<S,?>,Backend extends AbstractStateBackend>
  - getKeySerializer
```
public final TypeSerializer<K> getKeySerializer()
```
    Gets the serializer for the keys.
    
    Returns:
    
    The serializer for the keys.
  - getNamespaceSerializer
```
public final TypeSerializer<N> getNamespaceSerializer()
```
    Gets the serializer for the namespace.
    
    Returns:
    
    The serializer for the namespace.

Back to Flink Website

Class AbstractHeapState<K,N,SV,S extends State,SD extends StateDescriptor<S,?>,Backend extends AbstractStateBackend>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.flink.runtime.state.KvState

Field Detail

state

stateSerializer

keySerializer

namespaceSerializer

stateDesc

currentKey

currentNamespace

currentNSState

Constructor Detail

AbstractHeapState

AbstractHeapState

Method Detail

clear

setCurrentKey

setCurrentNamespace

size

dispose

getKeySerializer

getNamespaceSerializer

Back to Flink Website