com.yahoo.bullet.querying.aggregations.sketches

Class Sketch

java.lang.Object

com.yahoo.bullet.querying.aggregations.sketches.Sketch

Direct Known Subclasses:

DualSketch, FrequentItemsSketch

public abstract class Sketch
extends Object

This class encapsulates a type of Sketch. Since one type of Sketch is used for updating and another for unioning, this will encapsulate both of them and provide methods to serialize, union and createResult results.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.yahoo.bullet.record.BulletRecordProvider	provider

Constructor Summary

Constructors

Constructor and Description
Sketch()

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	addMetadata(Map<String,String> conceptKeys) Adds the common metadata for this Sketch to Map.
protected abstract String	getFamily() Returns a String representing the family of this sketch.
Meta	getMetadata(String metaKey, Map<String,String> conceptKeys) Returns the sketch metadata as a Meta object.
abstract List<com.yahoo.bullet.record.BulletRecord>	getRecords() Collects the data presented to the sketch so far and returns the List of BulletRecord representation of the resulting data in the sketch.
Clip	getResult(String metaKey, Map<String,String> conceptKeys) Gets the result from the data presented to the sketch as a Clip.
protected abstract Integer	getSize() Returns the size of the Sketch in bytes.
protected abstract Boolean	isEstimationMode() Returns whether this sketch was in estimation mode or not.
abstract void	reset() Resets the Sketch to the original state.
abstract byte[]	serialize() Serializes the sketch.
abstract void	union(byte[] serialized) Union a sketch serialized using serialize() into this.

Methods inherited from class java.lang.Object

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

Field Detail

provider

protected com.yahoo.bullet.record.BulletRecordProvider provider

Constructor Detail

Sketch

public Sketch()

Method Detail

serialize

public abstract byte[] serialize()

Serializes the sketch.

Returns:

A byte[] representing the serialized sketch.

union

public abstract void union(byte[] serialized)

Union a sketch serialized using serialize() into this.

Parameters:

serialized - A sketch serialized using the serialize method.

getRecords

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

Collects the data presented to the sketch so far and returns the List of BulletRecord representation of the resulting data in the sketch. See getResult(String, Map) for getting the result including the metadata and see getMetadata(String, Map) for getting only the metadata.

Returns:

A list of resulting records representing the result in the sketch.

reset

public abstract void reset()

Resets the Sketch to the original state. The old results are lost. You should call this after you call serialize() or getResult(String, Map) if you want to add more data to the sketch.

getResult

public Clip getResult(String metaKey,
                      Map<String,String> conceptKeys)

Gets the result from the data presented to the sketch as a Clip. Also adds Meta if asked for.

Parameters:

metaKey - If set to a non-null value, Sketch metadata will be added to the result.

conceptKeys - If provided, these Meta.Concept names will be added to the metadata.

Returns:

A Clip of the results.

getMetadata

public Meta getMetadata(String metaKey,
                        Map<String,String> conceptKeys)

Returns the sketch metadata as a Meta object.

Parameters:

metaKey - The key to add the metadata as.

conceptKeys - If provided, these Meta.Concept names will be added to the metadata.

Returns:

The metadata object or an empty one if no metadata was collected.

addMetadata

protected Map<String,Object> addMetadata(Map<String,String> conceptKeys)

Adds the common metadata for this Sketch to Map.

Parameters:

conceptKeys - The Map of Meta.Concept names to their keys.

Returns:

The created Map of sketch metadata.

getFamily

protected abstract String getFamily()

Returns a String representing the family of this sketch.

Returns:

The String family of this sketch.

isEstimationMode

protected abstract Boolean isEstimationMode()

Returns whether this sketch was in estimation mode or not.

Returns:

A Boolean denoting whether this sketch was estimating.

getSize

protected abstract Integer getSize()

Returns the size of the Sketch in bytes.

Returns:

An Integer representing the size of the sketch.