com.yahoo.bullet.querying.aggregations.grouping

Class GroupData

java.lang.Object

com.yahoo.bullet.querying.aggregations.grouping.GroupData

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CachingGroupData

public class GroupData
extends Object
implements Serializable

This class represents the results of a GroupOperations. The result is always a Number, so that is what this class stores. It is Serializable. It can compute all the operations if presented with a BulletRecord, merge other GroupData and present the results of the operations as a BulletRecord.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	fieldAliases
protected Map<String,String>	groupFields
protected Map<GroupOperation,Number>	metrics
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
GroupData(Map<String,String> groupFields, Map<String,String> fieldAliases, Map<GroupOperation,Number> metrics) Constructor that initializes the GroupData with an existing Map of GroupOperation to values and a Map of Strings that represent the group fields.
GroupData(Map<String,String> groupFields, Set<GroupOperation> operations) Constructor that initializes the GroupData with a Set of GroupOperation and a Map of Strings that represent the group fields.
GroupData(Set<GroupOperation> operations) Constructor that initializes the GroupData with a Set of GroupOperation.

Method Summary

Modifier and Type	Method and Description
void	combine(byte[] serializedGroupData) Merges the serialized form of a GroupData into this.
void	combine(GroupData otherData) Merge a GroupData into this.
void	consume(com.yahoo.bullet.record.BulletRecord data) Consumes the given BulletRecord and computes group operation metrics.
com.yahoo.bullet.record.BulletRecord	getAsBulletRecord(com.yahoo.bullet.record.BulletRecordProvider provider) Gets the metrics and the group values stored as a BulletRecord.
com.yahoo.bullet.record.BulletRecord	getAsBulletRecord(Map<String,String> mapping, com.yahoo.bullet.record.BulletRecordProvider provider) Gets the metrics and the group values stored as a BulletRecord.
com.yahoo.bullet.record.BulletRecord	getMetricsAsBulletRecord(com.yahoo.bullet.record.BulletRecordProvider provider) Gets the metrics stored for the group as a BulletRecord.
static String	getResultName(GroupOperation operation) Returns the name of the result field to use for the given GroupOperation.
static Map<GroupOperation,Number>	makeInitialMetrics(Set<GroupOperation> operations) Creates a Map of GroupOperation to their numeric metric values from a Set of GroupOperation.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

groupFields

protected Map<String,String> groupFields

fieldAliases

protected Map<String,String> fieldAliases

metrics

protected Map<GroupOperation,Number> metrics

Constructor Detail

GroupData

public GroupData(Map<String,String> groupFields,
                 Set<GroupOperation> operations)

Constructor that initializes the GroupData with a Set of GroupOperation and a Map of Strings that represent the group fields.

Parameters:

groupFields - The mappings of field names to their values that represent this group.

operations - The non-null operations that this will compute metrics for.

GroupData

public GroupData(Set<GroupOperation> operations)

Constructor that initializes the GroupData with a Set of GroupOperation.

Parameters:

operations - the non-null operations that this will compute metrics for.

GroupData

public GroupData(Map<String,String> groupFields,
                 Map<String,String> fieldAliases,
                 Map<GroupOperation,Number> metrics)

Constructor that initializes the GroupData with an existing Map of GroupOperation to values and a Map of Strings that represent the group fields. These arguments are not copied.

Parameters:

groupFields - The mapping of field names to their values that represent this group.

fieldAliases - The mapping of field names to their aliases.

metrics - The non-null Map of metrics for this object.

Method Detail

makeInitialMetrics

public static Map<GroupOperation,Number> makeInitialMetrics(Set<GroupOperation> operations)

Creates a Map of GroupOperation to their numeric metric values from a Set of GroupOperation.

Parameters:

operations - A set of operations.

Returns:

An empty map of metrics that represent these operations.

consume

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

Consumes the given BulletRecord and computes group operation metrics.

Parameters:

data - The record to compute metrics for.

combine

public void combine(byte[] serializedGroupData)

Merges the serialized form of a GroupData into this. For all GroupOperations present, their corresponding values will be merged according to their respective additive operation.

Parameters:

serializedGroupData - the serialized bytes of a GroupData.

combine

public void combine(GroupData otherData)

Merge a GroupData into this. For all GroupOperations present, their corresponding values will be merged according to their respective additive operation.

Parameters:

otherData - The other GroupData to merge.

getMetricsAsBulletRecord

public com.yahoo.bullet.record.BulletRecord getMetricsAsBulletRecord(com.yahoo.bullet.record.BulletRecordProvider provider)

Gets the metrics stored for the group as a BulletRecord.

Parameters:

provider - A BulletRecordProvider to generate BulletRecords.

Returns:

A non-null BulletRecord containing the data stored in this object.

getAsBulletRecord

public com.yahoo.bullet.record.BulletRecord getAsBulletRecord(com.yahoo.bullet.record.BulletRecordProvider provider)

Gets the metrics and the group values stored as a BulletRecord.

Parameters:

provider - A BulletRecordProvider to generate BulletRecords.

Returns:

A non-null BulletRecord containing the data stored in this object.

getAsBulletRecord

public com.yahoo.bullet.record.BulletRecord getAsBulletRecord(Map<String,String> mapping,
                                                              com.yahoo.bullet.record.BulletRecordProvider provider)

Gets the metrics and the group values stored as a BulletRecord.

Parameters:

mapping - An non-null new name mapping for the names of the group fields.

provider - A BulletRecordProvider to generate BulletRecords.

Returns:

A non-null BulletRecord containing the data stored in this object.

getResultName

public static String getResultName(GroupOperation operation)

Returns the name of the result field to use for the given GroupOperation.

Parameters:

operation - The operation to get the name for.

Returns:

a String representing a name for the result of the operation.