org.apache.flink.streaming.api.windowing.policy

Class TumblingEvictionPolicy<DATA>

java.lang.Object

org.apache.flink.streaming.api.windowing.policy.TumblingEvictionPolicy<DATA>

Type Parameters:

DATA - The type of the data points which is handled by this policy

All Implemented Interfaces:

Serializable, Cloneable, CloneableEvictionPolicy<DATA>, EvictionPolicy<DATA>

public class TumblingEvictionPolicy<DATA>
extends Object
implements CloneableEvictionPolicy<DATA>

This eviction policy deletes all elements from the buffer in case a trigger occurred. Therefore, it is the default eviction policy to be used for any tumbling window. By default this policy does not react on fake elements. Wrap it in an ActiveEvictionPolicyWrapper to make it clearing the buffer even on fake elements.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TumblingEvictionPolicy() This is the default constructor providing no special functionality.
TumblingEvictionPolicy(int startValue) This constructor allows to set a custom start value for the element counter.

Method Summary

Modifier and Type	Method and Description
TumblingEvictionPolicy<DATA>	clone() This method should return an exact copy of the object it belongs to including the current object state.
boolean	equals(Object other)
int	notifyEviction(Object datapoint, boolean triggered, int bufferSize) Deletes all elements from the buffer in case the trigger occurred.
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TumblingEvictionPolicy

public TumblingEvictionPolicy()

This is the default constructor providing no special functionality. This eviction policy deletes all elements from the buffer in case a trigger occurred. Therefore, it is the default eviction policy to be used for any tumbling window.

TumblingEvictionPolicy

public TumblingEvictionPolicy(int startValue)

This constructor allows to set a custom start value for the element counter. This eviction policy deletes all elements from the buffer in case a trigger occurred. Therefore, it is the default eviction policy to be used for any tumbling window.

Parameters:

startValue - A start value for the element counter

Method Detail

notifyEviction

public int notifyEviction(Object datapoint,
                          boolean triggered,
                          int bufferSize)

Deletes all elements from the buffer in case the trigger occurred.

Specified by:

notifyEviction in interface EvictionPolicy<DATA>

Parameters:

datapoint - data point the data point which arrived

triggered - Information whether the UDF was triggered or not

bufferSize - The current size of the element buffer at the operator

Returns:

The number of elements to be deleted from the buffer

clone

public TumblingEvictionPolicy<DATA> clone()

Description copied from interface: CloneableEvictionPolicy

This method should return an exact copy of the object it belongs to including the current object state.

Specified by:

clone in interface CloneableEvictionPolicy<DATA>

Overrides:

clone in class Object

Returns:

a copy of this object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object