com.yahoo.bullet.common

Interface Monoidal

All Superinterfaces:

Closable

All Known Subinterfaces:

Strategy

All Known Implementing Classes:

AdditiveTumbling, Basic, FrequentItemsSketchingStrategy, GroupAllStrategy, QuantileSketchingStrategy, Querier, RawStrategy, Scheme, SketchingStrategy, SlidingRecord, ThetaSketchingStrategy, Tumbling, TupleSketchingStrategy

public interface Monoidal
extends Closable

This interface captures the associative operations that can be performed within Bullet. The identity is this object when initially constructed or when reset(). This is a special case of a Monoid that works on BulletRecord and allows you to collapse chained combinations of them with combine(byte[]) or merge(Monoidal). You can extract the data using getData() to use with combine(byte[]) or as results to present to the work with getResult() or getRecords() or getMetadata(). Note that getMetadata() might not be strictly monoidal since they may not reset to the identity upon reset().

Method Summary

Modifier and Type	Method and Description
void	combine(byte[] data) Combines a serialized piece of data into this Monoid.
void	consume(com.yahoo.bullet.record.BulletRecord data) Consumes a single BulletRecord into this Monoid.
byte[]	getData() Get the data serialized as a byte[].
Meta	getMetadata() Get the metadata only of the data so far.
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.
default void	merge(Monoidal other) Combine the data from another instance of the same type of object into this Monoid.
void	reset() Reset the data so far and make this the identity element for the Monoid with respect to inserting data.

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

isClosed

Method Detail

consume

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

Consumes a single BulletRecord into this Monoid.

Parameters:

data - The BulletRecord to consume.

combine

void combine(byte[] data)

Combines a serialized piece of data into this Monoid.

Parameters:

data - A serialized representation of the data produced by getData().

merge

default void merge(Monoidal other)

Combine the data from another instance of the same type of object into this Monoid. By default, just unconditionally calls the getData() method on the object and passes it to combine(byte[]).

Parameters:

other - The non-null other object to combine data from.

getData

byte[] getData()

Get the data serialized as a byte[].

Returns:

the serialized representation of the data so far.

getResult

Clip getResult()

Get the data so far as a Clip.

Returns:

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

getRecords

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

Get the data so far as a List of BulletRecord.

Returns:

The resulting list of records representing the data.

getMetadata

Meta getMetadata()

Get the metadata only of the data so far. Might not be reset().

Returns:

The Meta collected so far.

reset

void reset()

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