com.yahoo.bard.webservice.druid.model.aggregation

Class Aggregation

java.lang.Object

com.yahoo.bard.webservice.druid.model.aggregation.Aggregation

All Implemented Interfaces:

MetricField

Direct Known Subclasses:

CardinalityAggregation, CountAggregation, DoubleMaxAggregation, DoubleMinAggregation, DoubleSumAggregation, FilteredAggregation, LongMaxAggregation, LongMinAggregation, LongSumAggregation, MaxAggregation, MinAggregation, SketchAggregation

public abstract class Aggregation
extends Object
implements MetricField

Base type for aggregations.

Constructor Summary

Constructors

Constructor and Description
Aggregation(String name, String fieldName) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Set<Dimension>	getDependentDimensions() Get the dimensions, if any, this metric depends on.
String	getFieldName() The field name for aggregation.
String	getName() Get the name of the metric field in the response.
abstract String	getType() The Type name for the aggregation in the druid configuration.
int	hashCode()
boolean	isFloatingPoint() Indicate if the MetricField is a floating-point value.
boolean	isSketch() Indicate if the MetricField is based on a sketch.
org.apache.commons.lang3.tuple.Pair<Aggregation,Aggregation>	nest() Splits an Aggregation for 2-pass aggregation into an inner & outer Aggregation.
String	toString()
abstract Aggregation	withFieldName(String fieldName) Creates a new Aggregation with the provided field name.
abstract Aggregation	withName(String name) Creates a new Aggregation with the provided name.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Aggregation

public Aggregation(@NotNull
                   String name,
                   String fieldName)

Constructor.

Parameters:

name - Name of the aggregation

fieldName - Name of the column that this aggregation is aggregating over

Method Detail

getName

public String getName()

Description copied from interface: MetricField

Get the name of the metric field in the response.

Specified by:

getName in interface MetricField

Returns:

the name of the metric field in the response

getFieldName

public String getFieldName()

The field name for aggregation.

Returns:

The field name for an aggregation.

getType

public abstract String getType()

The Type name for the aggregation in the druid configuration.

Returns:

the druid 'type' string

withName

public abstract Aggregation withName(String name)

Creates a new Aggregation with the provided name.

Parameters:

name - Name for the new aggregation

Returns:

subclass of Aggregation

withFieldName

public abstract Aggregation withFieldName(String fieldName)

Creates a new Aggregation with the provided field name.

Parameters:

fieldName - Field name for the new aggregation

Returns:

subclass of Aggregation

nest

public org.apache.commons.lang3.tuple.Pair<Aggregation,Aggregation> nest()

Splits an Aggregation for 2-pass aggregation into an inner & outer Aggregation. The outer aggregation fieldName will reference the inner aggregation name. The inner aggregation is unmodified.

Returns:

A pair where pair.left is the outer aggregation and pair.right is the inner.

isSketch

public boolean isSketch()

Description copied from interface: MetricField

Indicate if the MetricField is based on a sketch.

Specified by:

isSketch in interface MetricField

Returns:

true if the metric field is sketch-based, false otherwise

isFloatingPoint

public boolean isFloatingPoint()

Description copied from interface: MetricField

Indicate if the MetricField is a floating-point value.

Specified by:

isFloatingPoint in interface MetricField

Returns:

true if the metric field is a floating-point value, false otherwise.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDependentDimensions

public Set<Dimension> getDependentDimensions()

Description copied from interface: MetricField

Get the dimensions, if any, this metric depends on.

Specified by:

getDependentDimensions in interface MetricField

Returns:

A set of dimensions required to satisfy this metric field