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

Class FilteredAggregation

java.lang.Object

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

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

All Implemented Interfaces:

MetricField

public class FilteredAggregation
extends Aggregation

FilteredAggregation wraps aggregation with the associated filter.

Constructor Summary

Constructors

Constructor and Description
FilteredAggregation(String name, Aggregation aggregation, Filter filter) Constructor.
FilteredAggregation(String name, String fieldName, Aggregation aggregation, Filter filter) Deprecated. Filtered Aggregations do not have their own field name, they use the one from their aggregator

Method Summary

Modifier and Type	Method and Description
Aggregation	getAggregation()
Set<Dimension>	getDependentDimensions() Get the dimensions, if any, this metric depends on.
String	getFieldName() The field name for aggregation.
Filter	getFilter()
String	getName() Get the name of the metric field in the response.
String	getType() The Type name for the aggregation in the druid configuration.
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 filtered aggregation & outer aggregation.
Aggregation	withAggregation(Aggregation aggregation) Creates a new Filtered Aggregation with the provided aggregation.
Aggregation	withFieldName(String fieldName) Creates a new Aggregation with the provided field name.
Aggregation	withFilter(Filter filter) Creates a new Filtered Aggregation with the provided filter.
Aggregation	withName(String name) Creates a new Aggregation with the provided name.

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

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FilteredAggregation

public FilteredAggregation(@NotNull
                           String name,
                           Aggregation aggregation,
                           Filter filter)

Constructor.

Parameters:

name - Name of the filtered aggregator

aggregation - Existing aggregator being filtered

filter - filter to apply to that aggregator

FilteredAggregation

@Deprecated
public FilteredAggregation(@NotNull
                                       String name,
                                       String fieldName,
                                       Aggregation aggregation,
                                       Filter filter)

Deprecated. Filtered Aggregations do not have their own field name, they use the one from their aggregator

Constructor.

Parameters:

name - Name of the filtered aggregator

fieldName - Field name to be considered to apply the metric filter

aggregation - Existing aggregator being filtered

filter - filter to apply to that aggregator

Method Detail

nest

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

Splits an Aggregation for 2-pass aggregation into an inner filtered aggregation & outer aggregation. The outer aggregation is obtained by unwrapping the inner filtered aggregation and getting just the aggregation. The outer aggregation fieldName will reference the inner aggregation name. The inner aggregation is unmodified.

Overrides:

nest in class Aggregation

Returns:

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

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

Overrides:

getDependentDimensions in class Aggregation

Returns:

A set of dimensions required to satisfy this metric field

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.

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

Overrides:

getName in class Aggregation

Returns:

the name of the metric field in the response

getAggregation

public Aggregation getAggregation()

getFilter

public Filter getFilter()

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

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

withName

public Aggregation 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

withFilter

public Aggregation withFilter(Filter filter)

Creates a new Filtered Aggregation with the provided filter.

Parameters:

filter - metricFilter Filter object

Returns:

new FilteredAggregation instance with the provided filter

withAggregation

public Aggregation withAggregation(Aggregation aggregation)

Creates a new Filtered Aggregation with the provided aggregation.

Parameters:

aggregation - aggregation of the logical metric

Returns:

new FilteredAggregation instance with the provided aggregation

isSketch

public boolean isSketch()

Description copied from interface: MetricField

Indicate if the MetricField is based on a sketch.

Specified by:

isSketch in interface MetricField

Overrides:

isSketch in class Aggregation

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

Overrides:

isFloatingPoint in class Aggregation

Returns:

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