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

Class NonKeyedWindowOperator.Context

java.lang.Object

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

All Implemented Interfaces:

Trigger.TriggerContext

Enclosing class:

NonKeyedWindowOperator<IN,ACC,OUT,W extends Window>

protected class NonKeyedWindowOperator.Context
extends Object
implements Trigger.TriggerContext

The Context is responsible for keeping track of the state 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 Trigger.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	processingTimeTimer
protected HashMap<String,Serializable>	state
protected long	watermarkTimer
protected W	window
protected WindowBuffer<IN,ACC>	windowBuffer

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Context(org.apache.flink.core.memory.DataInputView in, ClassLoader userClassloader)
	Context(W window, WindowBuffer<IN,ACC> windowBuffer)

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	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.
<S extends org.apache.flink.api.common.state.State> S	getPartitionedState(org.apache.flink.api.common.state.StateDescriptor<S,?> stateDescriptor) Retrieves an 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.
TriggerResult	onElement(StreamRecord<IN> element)
TriggerResult	onEventTime(long time)
TriggerResult	onProcessingTime(long time)
void	registerEventTimeTimer(long time) Register an event-time callback.
void	registerProcessingTimeTimer(long time) Register a system time callback.
protected void	writeToState(org.apache.flink.runtime.state.AbstractStateBackend.CheckpointStateOutputView out)

Methods inherited from class java.lang.Object

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

Field Detail

window

protected W extends Window window

windowBuffer

protected WindowBuffer<IN,ACC> windowBuffer

state

protected HashMap<String,Serializable> state

watermarkTimer

protected long watermarkTimer

processingTimeTimer

protected long processingTimeTimer

Constructor Detail

Context

public Context(W window,
               WindowBuffer<IN,ACC> windowBuffer)

Context

protected Context(org.apache.flink.core.memory.DataInputView in,
                  ClassLoader userClassloader)
           throws Exception

Throws:

Exception

Method Detail

getCurrentWatermark

public long getCurrentWatermark()

Description copied from interface: Trigger.TriggerContext

Returns the current watermark time.

Specified by:

getCurrentWatermark in interface Trigger.TriggerContext

writeToState

protected void writeToState(org.apache.flink.runtime.state.AbstractStateBackend.CheckpointStateOutputView out)
                     throws IOException

Throws:

IOException

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 an 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.

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

clear

public void clear()
           throws Exception

Throws:

Exception