org.apache.flink.table.runtime.dataview

Class StateListView<N,EE>

java.lang.Object

org.apache.flink.table.api.dataview.ListView<EE>

org.apache.flink.table.runtime.dataview.StateListView<N,EE>

Type Parameters:

EE - the external type of element in the ListView

All Implemented Interfaces:

DataView, StateDataView<N>

Direct Known Subclasses:

StateListView.KeyedStateListView, StateListView.NamespacedStateListView

@Internal
public abstract class StateListView<N,EE>
extends ListView<EE>
implements StateDataView<N>

StateListView is a ListView which is implemented using state backends.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StateListView.KeyedStateListView<N,T> StateListView.KeyedStateListView is an default implementation of StateListView whose underlying representation is a keyed state.
static class	StateListView.NamespacedStateListView<N,T> StateListView.NamespacedStateListView is an StateListView whose underlying representation is a keyed and namespaced state.

Field Summary

Fields inherited from class org.apache.flink.table.api.dataview.ListView

elementType

Constructor Summary

Constructors

Constructor and Description
StateListView()

Method Summary

Modifier and Type	Method and Description
void	add(EE value) Adds the given value to the list.
void	addAll(List<EE> list) Adds all of the elements of the specified list to this list view.
void	clear() Removes all of the elements from this list view.
Iterable<EE>	get() Returns an iterable of the list view.
List<EE>	getList() Returns the entire view's content as an instance of List.
protected abstract ListState<EE>	getListState()
boolean	remove(EE value) Removes the given value from the list.
void	setList(List<EE> list) Replaces the entire view's content with the content of the given List.

Methods inherited from class org.apache.flink.table.api.dataview.ListView

equals, hashCode, newListViewDataType

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.table.runtime.dataview.StateDataView

setCurrentNamespace

Constructor Detail

StateListView

public StateListView()

Method Detail

getList

public List<EE> getList()

Description copied from class: ListView

Returns the entire view's content as an instance of List.

Overrides:

getList in class ListView<EE>

setList

public void setList(List<EE> list)

Description copied from class: ListView

Replaces the entire view's content with the content of the given List.

Overrides:

setList in class ListView<EE>

get

public Iterable<EE> get()
                 throws Exception

Description copied from class: ListView

Returns an iterable of the list view.

Overrides:

get in class ListView<EE>

Returns:

The iterable of the list.

Throws:

Exception - Thrown if the system cannot get data.

add

public void add(EE value)
         throws Exception

Description copied from class: ListView

Adds the given value to the list.

Overrides:

add in class ListView<EE>

Parameters:

value - The element to be appended to this list view.

Throws:

Exception - Thrown if the system cannot add data.

addAll

public void addAll(List<EE> list)
            throws Exception

Description copied from class: ListView

Adds all of the elements of the specified list to this list view.

Overrides:

addAll in class ListView<EE>

Parameters:

list - The list with the elements that will be stored in this list view.

Throws:

Exception - Thrown if the system cannot add all data.

remove

public boolean remove(EE value)
               throws Exception

Description copied from class: ListView

Removes the given value from the list.

Overrides:

remove in class ListView<EE>

Parameters:

value - The element to be removed from this list view.

Throws:

Exception

clear

public void clear()

Description copied from class: ListView

Removes all of the elements from this list view.

Specified by:

clear in interface DataView

Overrides:

clear in class ListView<EE>

getListState

protected abstract ListState<EE> getListState()