Package org.apache.flink.streaming.api.windowing.windows

Class TimeWindow

java.lang.Object

org.apache.flink.streaming.api.windowing.windows.Window

org.apache.flink.streaming.api.windowing.windows.TimeWindow

@PublicEvolving
public class TimeWindow
extends Window

A Window that represents a time interval from start (inclusive) to end (exclusive).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TimeWindow.Serializer	The serializer used to write the TimeWindow type.

Constructor Summary

Constructors

Constructor	Description
TimeWindow(long start, long end)

Method Summary

Modifier and Type	Method	Description
TimeWindow	cover(TimeWindow other)	Returns the minimal window covers both this window and the given window.
boolean	equals(Object o)
long	getEnd()	Gets the end timestamp of this window.
long	getStart()	Gets the starting timestamp of the window.
static long	getWindowStartWithOffset(long timestamp, long offset, long windowSize)	Method to get the window start for a timestamp.
int	hashCode()
boolean	intersects(TimeWindow other)	Returns true if this window intersects the given window or if this window is just after or before the given window.
long	maxTimestamp()	Gets the largest timestamp that still belongs to this window.
static void	mergeWindows(Collection<TimeWindow> windows, MergingWindowAssigner.MergeCallback<TimeWindow> c)	Merge overlapping TimeWindows.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TimeWindow

public TimeWindow(long start,
                  long end)

Method Detail

getStart

public long getStart()

Gets the starting timestamp of the window. This is the first timestamp that belongs to this window.

Returns:

The starting timestamp of this window.

getEnd

public long getEnd()

Gets the end timestamp of this window. The end timestamp is exclusive, meaning it is the first timestamp that does not belong to this window any more.

Returns:

The exclusive end timestamp of this window.

maxTimestamp

public long maxTimestamp()

Gets the largest timestamp that still belongs to this window.

This timestamp is identical to getEnd() - 1.

Specified by:

maxTimestamp in class Window

Returns:

The largest timestamp that still belongs to this window.

See Also:

getEnd()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

intersects

public boolean intersects(TimeWindow other)

Returns true if this window intersects the given window or if this window is just after or before the given window.

cover

public TimeWindow cover(TimeWindow other)

Returns the minimal window covers both this window and the given window.

mergeWindows

public static void mergeWindows(Collection<TimeWindow> windows,
                                MergingWindowAssigner.MergeCallback<TimeWindow> c)

Merge overlapping TimeWindows. For use by merging WindowAssigners.

getWindowStartWithOffset

public static long getWindowStartWithOffset(long timestamp,
                                            long offset,
                                            long windowSize)

Method to get the window start for a timestamp.

Parameters:

timestamp - epoch millisecond to get the window start.

offset - The offset which window start would be shifted by.

windowSize - The size of the generated windows.

Returns:

window start