com.yahoo.bard.webservice.druid.model

Interface MetricField

All Known Subinterfaces:

WithFields<T>

All Known Implementing Classes:

Aggregation, ArithmeticPostAggregation, CardinalityAggregation, ConstantPostAggregation, CountAggregation, DoubleMaxAggregation, DoubleMinAggregation, DoubleSumAggregation, FieldAccessorPostAggregation, FilteredAggregation, FuzzySetPostAggregation, LongMaxAggregation, LongMinAggregation, LongSumAggregation, MaxAggregation, MinAggregation, PostAggregation, SketchAggregation, SketchCountAggregation, SketchEstimatePostAggregation, SketchMergeAggregation, SketchSetOperationPostAggregation, ThetaSketchAggregation, ThetaSketchEstimatePostAggregation, ThetaSketchSetOperationPostAggregation

public interface MetricField

This marker interface combines Aggregations and PostAggregations so that they can be collectively referenced.

This may become a sub interface of a TBD Column interface to flag all dimensions and metrics.

Method Summary

Modifier and Type	Method and Description
Set<Dimension>	getDependentDimensions() Get the dimensions, if any, this metric depends on.
String	getName() Get the name of the metric field in the response.
boolean	isFloatingPoint() Indicate if the MetricField is a floating-point value.
boolean	isSketch() Indicate if the MetricField is based on a sketch.

Method Detail

getName

String getName()

Get the name of the metric field in the response.

Returns:

the name of the metric field in the response

isSketch

boolean isSketch()

Indicate if the MetricField is based on a sketch.

Returns:

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

isFloatingPoint

boolean isFloatingPoint()

Indicate if the MetricField is a floating-point value.

Returns:

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

getDependentDimensions

Set<Dimension> getDependentDimensions()

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

Returns:

A set of dimensions required to satisfy this metric field