org.apache.beam.sdk.transforms.windowing

Class CalendarWindows.YearsWindows

java.lang.Object

org.apache.beam.sdk.transforms.windowing.WindowFn<T,W>

org.apache.beam.sdk.transforms.windowing.NonMergingWindowFn<T,W>

org.apache.beam.sdk.transforms.windowing.PartitioningWindowFn<java.lang.Object,IntervalWindow>

org.apache.beam.sdk.transforms.windowing.CalendarWindows.YearsWindows

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

CalendarWindows

public static class CalendarWindows.YearsWindows
extends PartitioningWindowFn<java.lang.Object,IntervalWindow>

A WindowFn that windows elements into periods measured by years.

By default, periods of multiple years are measured starting at the epoch. This can be overridden with withStartingYear(int).

Years start on the first day of each calendar year, unless overridden by beginningOnDay(int, int).

The time zone used to determine calendar boundaries is UTC, unless this is overridden with the withTimeZone(org.joda.time.DateTimeZone) method.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.beam.sdk.transforms.windowing.WindowFn

WindowFn.AssignContext, WindowFn.MergeContext

Method Summary

Modifier and Type	Method and Description
IntervalWindow	assignWindow(Instant timestamp) Returns the single window to which elements with this timestamp belong.
CalendarWindows.YearsWindows	beginningOnDay(int monthOfYear, int dayOfMonth)
int	getDayOfMonth()
int	getMonthOfYear()
int	getNumber()
DateTime	getStartDate()
DateTimeZone	getTimeZone()
boolean	isCompatible(WindowFn<?,?> other) Returns whether this performs the same merging as the given WindowFn.
void	populateDisplayData(DisplayData.Builder builder) Register display data for the given transform or component.
void	verifyCompatibility(WindowFn<?,?> other) Throw IncompatibleWindowException if this WindowFn does not perform the same merging as the given $WindowFn.
Coder<IntervalWindow>	windowCoder() Returns the Coder used for serializing the windows used by this windowFn.
CalendarWindows.YearsWindows	withStartingYear(int year)
CalendarWindows.YearsWindows	withTimeZone(DateTimeZone timeZone)

Methods inherited from class org.apache.beam.sdk.transforms.windowing.PartitioningWindowFn

assignsToOneWindow, assignWindows, getDefaultWindowMappingFn

Methods inherited from class org.apache.beam.sdk.transforms.windowing.NonMergingWindowFn

isNonMerging, mergeWindows

Methods inherited from class org.apache.beam.sdk.transforms.windowing.WindowFn

getWindowTypeDescriptor

Methods inherited from class java.lang.Object

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

Method Detail

beginningOnDay

public CalendarWindows.YearsWindows beginningOnDay(int monthOfYear,
                                                   int dayOfMonth)

withStartingYear

public CalendarWindows.YearsWindows withStartingYear(int year)

withTimeZone

public CalendarWindows.YearsWindows withTimeZone(DateTimeZone timeZone)

assignWindow

public IntervalWindow assignWindow(Instant timestamp)

Description copied from class: PartitioningWindowFn

Returns the single window to which elements with this timestamp belong.

Specified by:

assignWindow in class PartitioningWindowFn<java.lang.Object,IntervalWindow>

windowCoder

public Coder<IntervalWindow> windowCoder()

Description copied from class: WindowFn

Returns the Coder used for serializing the windows used by this windowFn.

Specified by:

windowCoder in class WindowFn<java.lang.Object,IntervalWindow>

isCompatible

public boolean isCompatible(WindowFn<?,?> other)

Description copied from class: WindowFn

Returns whether this performs the same merging as the given WindowFn.

Specified by:

isCompatible in class WindowFn<java.lang.Object,IntervalWindow>

verifyCompatibility

public void verifyCompatibility(WindowFn<?,?> other)
                         throws IncompatibleWindowException

Description copied from class: WindowFn

Throw IncompatibleWindowException if this WindowFn does not perform the same merging as the given $WindowFn.

Overrides:

verifyCompatibility in class WindowFn<java.lang.Object,IntervalWindow>

Throws:

IncompatibleWindowException - if compared WindowFns are not compatible.

populateDisplayData

public void populateDisplayData(DisplayData.Builder builder)

Description copied from class: WindowFn

Register display data for the given transform or component.

populateDisplayData(DisplayData.Builder) is invoked by Pipeline runners to collect display data via DisplayData.from(HasDisplayData). Implementations may call super.populateDisplayData(builder) in order to register display data in the current namespace, but should otherwise use subcomponent.populateDisplayData(builder) to use the namespace of the subcomponent.

By default, does not register any display data. Implementors may override this method to provide their own display data.

Specified by:

populateDisplayData in interface HasDisplayData

Overrides:

populateDisplayData in class WindowFn<java.lang.Object,IntervalWindow>

Parameters:

builder - The builder to populate with display data.

See Also:

HasDisplayData

getTimeZone

public DateTimeZone getTimeZone()

getStartDate

public DateTime getStartDate()

getDayOfMonth

public int getDayOfMonth()

getMonthOfYear

public int getMonthOfYear()

getNumber

public int getNumber()