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

Class CountAggregation

java.lang.Object

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

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

All Implemented Interfaces:

MetricField

public class CountAggregation
extends Aggregation

Aggregation for counts.

Constructor Summary

Constructors

Constructor and Description
CountAggregation(String name) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getFieldName() The field name for aggregation.
String	getType() The Type name for the aggregation in the druid configuration.
boolean	isFloatingPoint() Indicate if the MetricField is a floating-point value.
org.apache.commons.lang3.tuple.Pair<Aggregation,Aggregation>	nest() Nesting a 'count' aggregation changes the outer aggregation to a 'longSum' whereas the inner aggregation remains unchanged.
Aggregation	withFieldName(String fieldName) Creates a new Aggregation with the provided field name.
CountAggregation	withName(String name) Creates a new Aggregation with the provided name.

Methods inherited from class com.yahoo.bard.webservice.druid.model.aggregation.Aggregation

equals, getDependentDimensions, getName, hashCode, isSketch, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CountAggregation

public CountAggregation(String name)

Constructor.

Parameters:

name - Name of the aggregation.

Method Detail

getFieldName

public String getFieldName()

Description copied from class: Aggregation

The field name for aggregation.

Overrides:

getFieldName in class Aggregation

Returns:

The field name for an aggregation.

getType

public String getType()

Description copied from class: Aggregation

The Type name for the aggregation in the druid configuration.

Specified by:

getType in class Aggregation

Returns:

the druid 'type' string

withName

public CountAggregation withName(String name)

Description copied from class: Aggregation

Creates a new Aggregation with the provided name.

Specified by:

withName in class Aggregation

Parameters:

name - Name for the new aggregation

Returns:

subclass of Aggregation

withFieldName

public Aggregation withFieldName(String fieldName)

Description copied from class: Aggregation

Creates a new Aggregation with the provided field name.

Specified by:

withFieldName in class Aggregation

Parameters:

fieldName - Field name for the new aggregation

Returns:

subclass of Aggregation

nest

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

Nesting a 'count' aggregation changes the outer aggregation to a 'longSum' whereas the inner aggregation remains unchanged. Base class aggregation transformation is also performed.

Overrides:

nest in class Aggregation

Returns:

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

isFloatingPoint

public boolean isFloatingPoint()

Description copied from interface: MetricField

Indicate if the MetricField is a floating-point value.

Specified by:

isFloatingPoint in interface MetricField

Overrides:

isFloatingPoint in class Aggregation

Returns:

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