com.yahoo.bullet.windowing

Class Basic

java.lang.Object

com.yahoo.bullet.windowing.Scheme

com.yahoo.bullet.windowing.Basic

All Implemented Interfaces:

Closable, Monoidal

Direct Known Subclasses:

SlidingRecord, Tumbling

public class Basic
extends Scheme

This is a scheme that does not do any windowing. It just proxies the Monoidal calls to the Strategy. This window is only ever closed when the underlying Strategy is also Strategy.isClosed().

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME
protected long	windowCount

Fields inherited from class com.yahoo.bullet.windowing.Scheme

aggregation, metadataKeys, window

Constructor Summary

Constructors

Constructor and Description
Basic(Strategy aggregation, Window window, BulletConfig config) Creates an instance of this windowing scheme with the provided Strategy and BulletConfig.

Method Summary

Modifier and Type	Method and Description
void	combine(byte[] data) This combines any data fed to it even if it is isClosed() or isClosedForPartition().
void	consume(com.yahoo.bullet.record.BulletRecord data) This consumes any data fed to it even if it is isClosed() or isClosedForPartition().
protected long	count() Counts the number of windows that have been opened since creation.
byte[]	getData() Get the data serialized as a byte[].
protected Map<String,Object>	getMetadata(Map<String,String> metadataKeys) Return any metadata for the windowing scheme with the given configured names for the metadata concepts.
List<com.yahoo.bullet.record.BulletRecord>	getRecords() Get the data so far as a List of BulletRecord.
Clip	getResult() Get the data so far as a Clip.
boolean	isClosed() Returns true if this is currently closed.
boolean	isClosedForPartition() Returns true if this window is closed when operating in partition mode.
protected String	name() Gets the name of this windowing scheme.
void	reset() Reset the data so far and make this the identity element for the Monoid with respect to inserting data.
void	resetForPartition() Resets the window when operating in partition mode.
void	start() Readies the window for querying.

Methods inherited from class com.yahoo.bullet.windowing.Scheme

getMetadata

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yahoo.bullet.common.Monoidal

merge

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

windowCount

protected long windowCount

Constructor Detail

Basic

public Basic(Strategy aggregation,
             Window window,
             BulletConfig config)

Creates an instance of this windowing scheme with the provided Strategy and BulletConfig.

Parameters:

aggregation - The non-null initialized aggregation strategy that this window will operate.

window - The initialized, configured window to use.

config - The validated config to use.

Method Detail

getMetadata

protected Map<String,Object> getMetadata(Map<String,String> metadataKeys)

Description copied from class: Scheme

Return any metadata for the windowing scheme with the given configured names for the metadata concepts.

Specified by:

getMetadata in class Scheme

Parameters:

metadataKeys - The mapping of metadata concepts to their names to get metadata for.

Returns:

A Map of strings to objects of the metadata.

consume

public void consume(com.yahoo.bullet.record.BulletRecord data)

This consumes any data fed to it even if it is isClosed() or isClosedForPartition().

Parameters:

data - The BulletRecord to consume.

combine

public void combine(byte[] data)

This combines any data fed to it even if it is isClosed() or isClosedForPartition().

Parameters:

data - The BulletRecord to consume.

getData

public byte[] getData()

Description copied from interface: Monoidal

Get the data serialized as a byte[].

Returns:

the serialized representation of the data so far.

getResult

public Clip getResult()

Description copied from interface: Monoidal

Get the data so far as a Clip.

Returns:

The resulting Clip representing the data and the metadata so far.

getRecords

public List<com.yahoo.bullet.record.BulletRecord> getRecords()

Description copied from interface: Monoidal

Get the data so far as a List of BulletRecord.

Returns:

The resulting list of records representing the data.

reset

public void reset()

Description copied from interface: Monoidal

Reset the data so far and make this the identity element for the Monoid with respect to inserting data.

resetForPartition

public void resetForPartition()

Description copied from class: Scheme

Resets the window when operating in partition mode. If this window has been consuming slices of data (partitions) instead of the full data, you should use this method to reset the window to maintain the windowing invariant.

Specified by:

resetForPartition in class Scheme

isClosed

public boolean isClosed()

Description copied from interface: Closable

Returns true if this is currently closed.

Returns:

A boolean denoting whether this object is current closed.

isClosedForPartition

public boolean isClosedForPartition()

Description copied from class: Scheme

Returns true if this window is closed when operating in partition mode. If this window has been consuming slices of the data (partitions) instead of the full data, this can be used to determine whether the window could or needs to emit data to maintain the windowing invariant.

Specified by:

isClosedForPartition in class Scheme

Returns:

A boolean whether this window is considered closed if it were consuming a slice of the data.

start

public void start()

Description copied from class: Scheme

Readies the window for querying. This is called in Querier.restart().

Specified by:

start in class Scheme

name

protected String name()

Gets the name of this windowing scheme.

Returns:

A String name for this window.

count

protected long count()

Counts the number of windows that have been opened since creation.

Returns:

A long representing the number of windows opened.