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

Class WindowOperator.Context

java.lang.Object

org.apache.flink.streaming.runtime.operators.windowing.WindowOperator.Context

All Implemented Interfaces:

Trigger.OnMergeContext, Trigger.TriggerContext

Enclosing class:

WindowOperator<K,IN,ACC,OUT,W extends Window>

public class WindowOperator.Context
extends Object
implements Trigger.OnMergeContext

Context is a utility for handling Trigger invocations. It can be reused by setting the key and window fields. No internal state must be kept in the Context

Field Summary

Fields

Modifier and Type	Field and Description
protected K	key
protected Collection<W>	mergedWindows
protected W	window

Constructor Summary

Constructors

Constructor and Description
Context(K key, W window)

Method Summary

Modifier and Type	Method and Description
void	clear()
void	deleteEventTimeTimer(long time) Delete the event-time trigger for the given time.
void	deleteProcessingTimeTimer(long time) Delete the processing time trigger for the given time.
long	getCurrentProcessingTime() Returns the current processing time.
long	getCurrentWatermark() Returns the current watermark time.
<S extends Serializable> org.apache.flink.api.common.state.ValueState<S>	getKeyValueState(String name, Class<S> stateType, S defaultState) Retrieves a ValueState object that can be used to interact with fault-tolerant state that is scoped to the window and key of the current trigger invocation.
<S extends Serializable> org.apache.flink.api.common.state.ValueState<S>	getKeyValueState(String name, org.apache.flink.api.common.typeinfo.TypeInformation<S> stateType, S defaultState) Retrieves a ValueState object that can be used to interact with fault-tolerant state that is scoped to the window and key of the current trigger invocation.
org.apache.flink.metrics.MetricGroup	getMetricGroup() Returns the metric group for this Trigger.
<S extends org.apache.flink.api.common.state.State> S	getPartitionedState(org.apache.flink.api.common.state.StateDescriptor<S,?> stateDescriptor) Retrieves a State object that can be used to interact with fault-tolerant state that is scoped to the window and key of the current trigger invocation.
<S extends org.apache.flink.api.common.state.MergingState<?,?>> void	mergePartitionedState(org.apache.flink.api.common.state.StateDescriptor<S,?> stateDescriptor)
TriggerResult	onElement(StreamRecord<IN> element)
TriggerResult	onEventTime(long time)
void	onMerge(Collection<W> mergedWindows)
TriggerResult	onProcessingTime(long time)
void	registerEventTimeTimer(long time) Register an event-time callback.
void	registerProcessingTimeTimer(long time) Register a system time callback.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

key

protected K key

window

protected W extends Window window

mergedWindows

protected Collection<W extends Window> mergedWindows

Constructor Detail

Context

public Context(K key,
               W window)

Method Detail

getMetricGroup

public org.apache.flink.metrics.MetricGroup getMetricGroup()

Description copied from interface: Trigger.TriggerContext

Returns the metric group for this Trigger. This is the same metric group that would be returned from RuntimeContext.getMetricGroup() in a user function.

You must not call methods that create metric objects (such as MetricGroup.counter(int) multiple times but instead call once and store the metric object in a field.

Specified by:

getMetricGroup in interface Trigger.TriggerContext

getCurrentWatermark

public long getCurrentWatermark()

Description copied from interface: Trigger.TriggerContext

Returns the current watermark time.

Specified by:

getCurrentWatermark in interface Trigger.TriggerContext

getKeyValueState

public <S extends Serializable> org.apache.flink.api.common.state.ValueState<S> getKeyValueState(String name,
                                                                                                 Class<S> stateType,
                                                                                                 S defaultState)

Description copied from interface: Trigger.TriggerContext

Retrieves a ValueState object that can be used to interact with fault-tolerant state that is scoped to the window and key of the current trigger invocation.

Specified by:

getKeyValueState in interface Trigger.TriggerContext

Type Parameters:

S - The type of the state.

Parameters:

name - The name of the key/value state.

stateType - The class of the type that is stored in the state. Used to generate serializers for managed memory and checkpointing.

defaultState - The default state value, returned when the state is accessed and no value has yet been set for the key. May be null.

Returns:

The partitioned state object.

getKeyValueState

public <S extends Serializable> org.apache.flink.api.common.state.ValueState<S> getKeyValueState(String name,
                                                                                                 org.apache.flink.api.common.typeinfo.TypeInformation<S> stateType,
                                                                                                 S defaultState)

Description copied from interface: Trigger.TriggerContext

Retrieves a ValueState object that can be used to interact with fault-tolerant state that is scoped to the window and key of the current trigger invocation.

Specified by:

getKeyValueState in interface Trigger.TriggerContext

Type Parameters:

S - The type of the state.

Parameters:

name - The name of the key/value state.

stateType - The type information for the type that is stored in the state. Used to create serializers for managed memory and checkpoints.

defaultState - The default state value, returned when the state is accessed and no value has yet been set for the key. May be null.

Returns:

The partitioned state object.

getPartitionedState

public <S extends org.apache.flink.api.common.state.State> S getPartitionedState(org.apache.flink.api.common.state.StateDescriptor<S,?> stateDescriptor)

Description copied from interface: Trigger.TriggerContext

Retrieves a State object that can be used to interact with fault-tolerant state that is scoped to the window and key of the current trigger invocation.

Specified by:

getPartitionedState in interface Trigger.TriggerContext

Type Parameters:

S - The type of the state.

Parameters:

stateDescriptor - The StateDescriptor that contains the name and type of the state that is being accessed.

Returns:

The partitioned state object.

mergePartitionedState

public <S extends org.apache.flink.api.common.state.MergingState<?,?>> void mergePartitionedState(org.apache.flink.api.common.state.StateDescriptor<S,?> stateDescriptor)

Specified by:

mergePartitionedState in interface Trigger.OnMergeContext

getCurrentProcessingTime

public long getCurrentProcessingTime()

Description copied from interface: Trigger.TriggerContext

Returns the current processing time.

Specified by:

getCurrentProcessingTime in interface Trigger.TriggerContext

registerProcessingTimeTimer

public void registerProcessingTimeTimer(long time)

Description copied from interface: Trigger.TriggerContext

Register a system time callback. When the current system time passes the specified time Trigger.onProcessingTime(long, Window, TriggerContext) is called with the time specified here.

Specified by:

registerProcessingTimeTimer in interface Trigger.TriggerContext

Parameters:

time - The time at which to invoke Trigger.onProcessingTime(long, Window, TriggerContext)

registerEventTimeTimer

public void registerEventTimeTimer(long time)

Description copied from interface: Trigger.TriggerContext

Register an event-time callback. When the current watermark passes the specified time Trigger.onEventTime(long, Window, TriggerContext) is called with the time specified here.

Specified by:

registerEventTimeTimer in interface Trigger.TriggerContext

Parameters:

time - The watermark at which to invoke Trigger.onEventTime(long, Window, TriggerContext)

See Also:

Watermark

deleteProcessingTimeTimer

public void deleteProcessingTimeTimer(long time)

Description copied from interface: Trigger.TriggerContext

Delete the processing time trigger for the given time.

Specified by:

deleteProcessingTimeTimer in interface Trigger.TriggerContext

deleteEventTimeTimer

public void deleteEventTimeTimer(long time)

Description copied from interface: Trigger.TriggerContext

Delete the event-time trigger for the given time.

Specified by:

deleteEventTimeTimer in interface Trigger.TriggerContext

onElement

public TriggerResult onElement(StreamRecord<IN> element)
                        throws Exception

Throws:

Exception

onProcessingTime

public TriggerResult onProcessingTime(long time)
                               throws Exception

Throws:

Exception

onEventTime

public TriggerResult onEventTime(long time)
                          throws Exception

Throws:

Exception

onMerge

public void onMerge(Collection<W> mergedWindows)
             throws Exception

Throws:

Exception

clear

public void clear()
           throws Exception

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object