com.yahoo.bullet.query

Class Window

java.lang.Object

com.yahoo.bullet.query.Window

All Implemented Interfaces:

Configurable, Serializable

public class Window
extends Object
implements Configurable, Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Window.Classification Represents the type of window.
static class	Window.Unit Represents the type of the window unit for either emit or include.

Field Summary

Fields

Modifier and Type	Field and Description
static BulletException	IMPROPER_EMIT
static BulletException	IMPROPER_EVERY
static BulletException	IMPROPER_INCLUDE
static BulletException	NO_RECORD_ALL

Constructor Summary

Constructors

Constructor and Description
Window(Integer emitEvery, Window.Unit emitType) Constructor that creates a window with only emit fields.
Window(Integer emitEvery, Window.Unit emitType, Window.Unit includeType, Integer includeFirst) Constructor that creates a window with emit and include fields.

Method Summary

Modifier and Type	Method and Description
void	configure(BulletConfig config) Takes a BulletConfig containing configuration and applies it to itself.
Scheme	getScheme(Strategy strategy, BulletConfig config) Returns the appropriate window scheme based on the Window Window.Classification.
Window.Classification	getType() Gets the classification of this window for the given emit and include types.
boolean	isTimeBased() Returns true if this is a time based window (emits based on time).
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

IMPROPER_EMIT

public static final BulletException IMPROPER_EMIT

IMPROPER_EVERY

public static final BulletException IMPROPER_EVERY

IMPROPER_INCLUDE

public static final BulletException IMPROPER_INCLUDE

NO_RECORD_ALL

public static final BulletException NO_RECORD_ALL

Constructor Detail

Window

public Window(Integer emitEvery,
              Window.Unit emitType)

Constructor that creates a window with only emit fields.

Parameters:

emitEvery - The non-null emit every field.

emitType - The non-null emit unit type.

Window

public Window(Integer emitEvery,
              Window.Unit emitType,
              Window.Unit includeType,
              Integer includeFirst)

Constructor that creates a window with emit and include fields.

Parameters:

emitEvery - The non-null emit every field.

emitType - The non-null emit unit type.

includeType - The non-null include unit type.

includeFirst - The include first field. Can be null if the include unit type is ALL.

Method Detail

configure

public void configure(BulletConfig config)

Description copied from interface: Configurable

Takes a BulletConfig containing configuration and applies it to itself.

Specified by:

configure in interface Configurable

Parameters:

config - The configuration containing the settings.

getScheme

public Scheme getScheme(Strategy strategy,
                        BulletConfig config)

Returns the appropriate window scheme based on the Window Window.Classification.

Parameters:

strategy - The Strategy to be passed on to the window scheme.

config - The BulletConfig to be passed on to the window scheme.

Returns:

The appropriate window scheme based on the window classification.

getType

public Window.Classification getType()

Gets the classification of this window for the given emit and include types.

Returns:

The Window.Classification of this window.

isTimeBased

public boolean isTimeBased()

Returns true if this is a time based window (emits based on time).

Returns:

A boolean denoting whether this window is a time based window.

toString

public String toString()

Overrides:

toString in class Object