org.apache.samza.operators.windows.internal

Class WindowInternal<M extends MessageEnvelope,K,WV>

java.lang.Object

org.apache.samza.operators.windows.internal.WindowInternal<M,K,WV>

All Implemented Interfaces:

Window<M,K,WV,WindowPane<K,WV>>

@InterfaceStability.Unstable
public final class WindowInternal<M extends MessageEnvelope,K,WV>
extends java.lang.Object
implements Window<M,K,WV,WindowPane<K,WV>>

Internal representation of a Window. This specifies default, early and late triggers for the Window and whether to accumulate or discard previously emitted panes. Note: This class is meant to be used internally by Samza, and is not to be instantiated by programmers.

Constructor Summary

Constructors

Constructor and Description
WindowInternal(Trigger defaultTrigger, java.util.function.BiFunction<M,WV,WV> foldFunction, java.util.function.Function<M,K> keyExtractor, java.util.function.Function<M,java.lang.Long> eventTimeExtractor)

Method Summary

Modifier and Type	Method and Description
Trigger	getDefaultTrigger()
Trigger	getEarlyTrigger()
java.util.function.Function<M,java.lang.Long>	getEventTimeExtractor()
java.util.function.BiFunction<M,WV,WV>	getFoldFunction()
java.util.function.Function<M,K>	getKeyExtractor()
Trigger	getLateTrigger()
Window<M,K,WV,WindowPane<K,WV>>	setAccumulationMode(AccumulationMode mode) Specify how a Window should process its previously emitted WindowPanes.
Window<M,K,WV,WindowPane<K,WV>>	setEarlyTrigger(Trigger trigger) Set the early triggers for this Window.
Window<M,K,WV,WindowPane<K,WV>>	setLateTrigger(Trigger trigger) Set the late triggers for this Window.

Methods inherited from class java.lang.Object

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

Constructor Detail

WindowInternal

public WindowInternal(Trigger defaultTrigger,
                      java.util.function.BiFunction<M,WV,WV> foldFunction,
                      java.util.function.Function<M,K> keyExtractor,
                      java.util.function.Function<M,java.lang.Long> eventTimeExtractor)

Method Detail

setEarlyTrigger

public Window<M,K,WV,WindowPane<K,WV>> setEarlyTrigger(Trigger trigger)

Description copied from interface: Window

Set the early triggers for this Window.

Use the Triggers APIs to create instances of Trigger

Specified by:

setEarlyTrigger in interface Window<M extends MessageEnvelope,K,WV,WindowPane<K,WV>>

Parameters:

trigger - the early trigger

Returns:

the Window function with the early trigger

setLateTrigger

public Window<M,K,WV,WindowPane<K,WV>> setLateTrigger(Trigger trigger)

Description copied from interface: Window

Set the late triggers for this Window.

Use the Triggers APIs to create instances of Trigger

Specified by:

setLateTrigger in interface Window<M extends MessageEnvelope,K,WV,WindowPane<K,WV>>

Parameters:

trigger - the late trigger

Returns:

the Window function with the late trigger

setAccumulationMode

public Window<M,K,WV,WindowPane<K,WV>> setAccumulationMode(AccumulationMode mode)

Description copied from interface: Window

Specify how a Window should process its previously emitted WindowPanes.

There are two types of AccumulationModes:

• ACCUMULATING: Specifies that window panes should include all messages collected for the window (key) so far, even if they were included in previously emitted window panes.
• DISCARDING: Specifies that window panes should only include messages collected for this window (key) since the last emitted window pane.

Specified by:

setAccumulationMode in interface Window<M extends MessageEnvelope,K,WV,WindowPane<K,WV>>

Parameters:

mode - the accumulation mode

Returns:

the Window function with the specified AccumulationMode.

getDefaultTrigger

public Trigger getDefaultTrigger()

getEarlyTrigger

public Trigger getEarlyTrigger()

getLateTrigger

public Trigger getLateTrigger()

getFoldFunction

public java.util.function.BiFunction<M,WV,WV> getFoldFunction()

getKeyExtractor

public java.util.function.Function<M,K> getKeyExtractor()

getEventTimeExtractor

public java.util.function.Function<M,java.lang.Long> getEventTimeExtractor()