com.yahoo.bullet.querying.aggregations.sketches

Class TupleSketch

java.lang.Object

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

com.yahoo.bullet.querying.aggregations.sketches.DualSketch

com.yahoo.bullet.querying.aggregations.sketches.KMVSketch

com.yahoo.bullet.querying.aggregations.sketches.TupleSketch

public class TupleSketch
extends KMVSketch

Field Summary

Fields inherited from class com.yahoo.bullet.querying.aggregations.sketches.KMVSketch

META_STD_DEV_1, META_STD_DEV_2, META_STD_DEV_3, META_STD_DEV_LB, META_STD_DEV_UB

Fields inherited from class com.yahoo.bullet.querying.aggregations.sketches.Sketch

provider

Constructor Summary

Constructors

Constructor and Description
TupleSketch(com.yahoo.sketches.ResizeFactor resizeFactor, float samplingProbability, int nominalEntries, int maxSize, com.yahoo.bullet.record.BulletRecordProvider provider) Initialize a tuple sketch for summarizing group data.

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 String	getFamily() Returns a String representing the family of this sketch.
protected Double	getLowerBound(int standardDeviation) Gets the lower bound at this standard deviation after the last createResult.
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 Integer	getSize() Returns the size of the Sketch in bytes.
protected Double	getTheta() Gets the theta value for this sketch after the last createResult.
protected Double	getUpperBound(int standardDeviation) Gets the uppper bound at this standard deviation after the last createResult.
protected Boolean	isEstimationMode() Returns whether this sketch was in estimation mode or not.
protected void	mergeBothSketches() Merge and reset both the update sketch and the union sketch into the result.
protected void	mergeUnionSketch() Merge and reset just the union sketch into the result.
protected void	mergeUpdateSketch() Merge and reset just the update sketch into the result.
void	reset() Resets the Sketch to the original state.
byte[]	serialize() Serializes the sketch.
void	union(byte[] serialized) Union a sketch serialized using Sketch.serialize() into this.
protected boolean	unionedExistingResults() Merge the existing result into the union sketch if needed and return a boolean if the union was done.
void	update(String key, CachingGroupData data) Update the sketch with a key representing a group and the data for it.

Methods inherited from class com.yahoo.bullet.querying.aggregations.sketches.DualSketch

merge, union, update

Methods inherited from class com.yahoo.bullet.querying.aggregations.sketches.Sketch

getMetadata

Methods inherited from class java.lang.Object

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

Constructor Detail

TupleSketch

public TupleSketch(com.yahoo.sketches.ResizeFactor resizeFactor,
                   float samplingProbability,
                   int nominalEntries,
                   int maxSize,
                   com.yahoo.bullet.record.BulletRecordProvider provider)

Initialize a tuple sketch for summarizing group data.

Parameters:

resizeFactor - The ResizeFactor to use for the sketch.

samplingProbability - The sampling probability to use.

nominalEntries - The nominal entries for the sketch.

maxSize - The maximum size of groups to return.

provider - A BulletRecordProvider to generate BulletRecords.

Method Detail

update

public void update(String key,
                   CachingGroupData data)

Update the sketch with a key representing a group and the data for it.

Parameters:

key - The key to present the data to the sketch as.

data - The data for the group.

union

public void union(byte[] serialized)

Description copied from class: Sketch

Union a sketch serialized using Sketch.serialize() into this.

Specified by:

union in class Sketch

Parameters:

serialized - A sketch serialized using the serialize method.

serialize

public byte[] serialize()

Description copied from class: Sketch

Serializes the sketch.

Specified by:

serialize in class Sketch

Returns:

A byte[] representing the serialized sketch.

getRecords

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

Description copied from class: Sketch

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

Specified by:

getRecords in class Sketch

Returns:

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

getResult

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

Description copied from class: Sketch

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

Overrides:

getResult in class Sketch

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.

reset

public void reset()

Description copied from class: DualSketch

Resets the Sketch to the original state. The old results are lost. You should call this after you call Sketch.serialize() or Sketch.getResult(String, Map) if you want to add more data to the sketch. Call this after your reset operations to reset the metadata relating to storing two sketches. You should reset or remove all your sketches here.

Overrides:

reset in class DualSketch

mergeBothSketches

protected void mergeBothSketches()

Description copied from class: DualSketch

Merge and reset both the update sketch and the union sketch into the result.

Specified by:

mergeBothSketches in class DualSketch

mergeUpdateSketch

protected void mergeUpdateSketch()

Description copied from class: DualSketch

Merge and reset just the update sketch into the result.

Specified by:

mergeUpdateSketch in class DualSketch

mergeUnionSketch

protected void mergeUnionSketch()

Description copied from class: DualSketch

Merge and reset just the union sketch into the result.

Specified by:

mergeUnionSketch in class DualSketch

unionedExistingResults

protected boolean unionedExistingResults()

Description copied from class: DualSketch

Merge the existing result into the union sketch if needed and return a boolean if the union was done.

Specified by:

unionedExistingResults in class DualSketch

Returns:

A boolean denoting whether the union was done.

addMetadata

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

Description copied from class: Sketch

Adds the common metadata for this Sketch to Map.

Overrides:

addMetadata in class KMVSketch

Parameters:

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

Returns:

The created Map of sketch metadata.

isEstimationMode

protected Boolean isEstimationMode()

Description copied from class: Sketch

Returns whether this sketch was in estimation mode or not.

Specified by:

isEstimationMode in class Sketch

Returns:

A Boolean denoting whether this sketch was estimating.

getFamily

protected String getFamily()

Description copied from class: Sketch

Returns a String representing the family of this sketch.

Specified by:

getFamily in class Sketch

Returns:

The String family of this sketch.

getSize

protected Integer getSize()

Description copied from class: Sketch

Returns the size of the Sketch in bytes.

Specified by:

getSize in class Sketch

Returns:

An Integer representing the size of the sketch.

getTheta

protected Double getTheta()

Description copied from class: KMVSketch

Gets the theta value for this sketch after the last createResult. Only applicable after DualSketch.merge().

Specified by:

getTheta in class KMVSketch

Returns:

A Double value that is the theta for this sketch.

getLowerBound

protected Double getLowerBound(int standardDeviation)

Description copied from class: KMVSketch

Gets the lower bound at this standard deviation after the last createResult. Only applicable after DualSketch.merge().

Specified by:

getLowerBound in class KMVSketch

Parameters:

standardDeviation - The standard deviation.

Returns:

A Double representing the maximum value at this standard deviation.

getUpperBound

protected Double getUpperBound(int standardDeviation)

Description copied from class: KMVSketch

Gets the uppper bound at this standard deviation after the last createResult. Only applicable after DualSketch.merge().

Specified by:

getUpperBound in class KMVSketch

Parameters:

standardDeviation - The standard deviation.

Returns:

A Double representing the minimum value at this standard deviation.