org.apache.flink.streaming.runtime.operators.windowing.buffers

Interface WindowBuffer<T>

Type Parameters:

T - The type of elements that this WindowBuffer can store.

All Superinterfaces:

Serializable

All Known Subinterfaces:

EvictingWindowBuffer<T>

All Known Implementing Classes:

HeapWindowBuffer, PreAggregatingHeapWindowBuffer

public interface WindowBuffer<T>
extends Serializable

A WindowBuffer is used by WindowOperator to store the elements of one pane.

A pane is the bucket of elements that have the same key (assigned by the KeySelector) and same Window. An element can be in multiple panes of it was assigned to multiple windows by the WindowAssigner. These panes all have their own instance of the Evictor.

Method Summary

Methods

Modifier and Type	Method and Description
Iterable<StreamRecord<T>>	getElements() Returns all elements that are currently in the buffer.
Iterable<T>	getUnpackedElements() Returns all elements that are currently in the buffer.
int	size() Returns the number of elements that are currently in the buffer.
void	storeElement(StreamRecord<T> element) Adds the element to the buffer.

Method Detail

storeElement

void storeElement(StreamRecord<T> element)
                  throws Exception

Adds the element to the buffer.

Parameters:

element - The element to add.

Throws:

Exception

getElements

Iterable<StreamRecord<T>> getElements()

Returns all elements that are currently in the buffer.

getUnpackedElements

Iterable<T> getUnpackedElements()

Returns all elements that are currently in the buffer. This will unwrap the contained elements from their StreamRecord.

size

int size()

Returns the number of elements that are currently in the buffer.