com.yahoo.bard.webservice.data.config.metric.makers

Class MetricMaker

java.lang.Object

com.yahoo.bard.webservice.data.config.metric.makers.MetricMaker

Direct Known Subclasses:

AggregationAverageMaker, ArithmeticMaker, CardinalityMaker, ConstantMaker, CountMaker, FilteredAggregationMaker, RawAggregationMetricMaker, RowNumMaker, SketchSetOperationMaker, ThetaSketchSetOperationMaker

public abstract class MetricMaker
extends Object

Metric maker produces new metrics from existing metrics or raw configuration.

Field Summary

Fields

Modifier and Type	Field and Description
MetricDictionary	metrics The metric dictionary from which dependent metrics will be resolved.
static Function<String,ResultSetMapper>	NO_OP_MAP_PROVIDER
static NoOpResultSetMapper	NO_OP_MAPPER

Constructor Summary

Constructors

Constructor and Description
MetricMaker(MetricDictionary metrics) Construct a fully specified MetricMaker.

Method Summary

Modifier and Type	Method and Description
protected void	assertDependentMetricsExist(List<String> dependentMetrics) Checks that the dependent metrics are in the dictionary, and throws an exception if any are not.
protected void	assertRequiredDependentMetricCount(String dictionaryName, List<String> dependentMetrics) Checks that we have the right number of metrics, and throws an exception if we don't.
protected abstract int	getDependentMetricsRequired() Get the number of dependent metrics the maker requires for making the metric.
protected TemplateDruidQuery	getDependentQuery(String name) Deprecated. Instead get the metric in the calling function and then get the TDQ out only if necessary
protected TemplateDruidQuery	getMergedQuery(List<String> names) A helper function returning the resulting aggregation set from merging one or more template druid queries.
protected static PostAggregation	getNumericField(MetricField field) Prepare a post aggregation for a field expecting a numeric value.
protected PostAggregation	getNumericField(String fieldName) Deprecated. use the static version getNumericField(MetricField) by preference
protected static PostAggregation	getSketchField(MetricField field) Prepare a post aggregation for a field expecting a sketch value.
protected PostAggregation	getSketchField(String fieldName) Deprecated. use the static version getSketchField(MetricField) by preference
LogicalMetric	make(LogicalMetricInfo logicalMetricInfo, List<String> dependentMetrics) Make the metric.
LogicalMetric	make(String metricName, List<String> dependentMetrics) Deprecated. logical metric needs more config-richness to not just configure metric name, but also metric long name, description, etc. Use make(LogicalMetricInfo, List) instead.
LogicalMetric	make(String metricName, String dependentMetric) Make the metric.
protected LogicalMetric	makeInner(LogicalMetricInfo logicalMetricInfo, List<String> dependentMetrics) Delegated to for actually making the metric.
protected LogicalMetric	makeInner(String metricName, List<String> dependentMetrics) Deprecated. logical metric needs more config-richness to not just configure metric name, but also metric long name, description, etc. Use makeInner(LogicalMetricInfo, List) instead.

Methods inherited from class java.lang.Object

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

Field Detail

NO_OP_MAPPER

public static final NoOpResultSetMapper NO_OP_MAPPER

NO_OP_MAP_PROVIDER

public static final Function<String,ResultSetMapper> NO_OP_MAP_PROVIDER

metrics

public final MetricDictionary metrics

The metric dictionary from which dependent metrics will be resolved.

Constructor Detail

MetricMaker

public MetricMaker(MetricDictionary metrics)

Construct a fully specified MetricMaker.

Parameters:

metrics - A mapping of metric names to the corresponding LogicalMetrics. Used to resolve metric names when making the logical metric.

Method Detail

make

@Deprecated
public LogicalMetric make(String metricName,
                                      List<String> dependentMetrics)

Deprecated. logical metric needs more config-richness to not just configure metric name, but also metric long name, description, etc. Use make(LogicalMetricInfo, List) instead.

Make the metric.

This method also sanity-checks the dependent metrics to make sure that they are metrics we have built and are in the metric dictionary.

Also sanity-checks that the number of dependent metrics are correct for the maker.

Parameters:

metricName - Name for the metric we're making

dependentMetrics - Metrics this metric depends on

Returns:

The new logicalMetric

make

public LogicalMetric make(LogicalMetricInfo logicalMetricInfo,
                          List<String> dependentMetrics)

Make the metric.

This method also sanity-checks the dependent metrics to make sure that they are metrics we have built and are in the metric dictionary.

Also sanity-checks that the number of dependent metrics are correct for the maker.

Parameters:

logicalMetricInfo - Logical metric info provider

dependentMetrics - Metrics this metric depends on

Returns:

The new logicalMetric

assertRequiredDependentMetricCount

protected void assertRequiredDependentMetricCount(String dictionaryName,
                                                  List<String> dependentMetrics)

Checks that we have the right number of metrics, and throws an exception if we don't.

Parameters:

dictionaryName - Name of the metric being made

dependentMetrics - List of dependent metrics needed to make the metric

assertDependentMetricsExist

protected void assertDependentMetricsExist(List<String> dependentMetrics)

Checks that the dependent metrics are in the dictionary, and throws an exception if any are not.

Parameters:

dependentMetrics - List of dependent metrics needed to check

make

public LogicalMetric make(String metricName,
                          String dependentMetric)

Make the metric.

Parameters:

metricName - Name for the metric we're making

dependentMetric - Metric this metric depends on

Returns:

The new logicalMetric

makeInner

@Deprecated
protected LogicalMetric makeInner(String metricName,
                                              List<String> dependentMetrics)

Deprecated. logical metric needs more config-richness to not just configure metric name, but also metric long name, description, etc. Use makeInner(LogicalMetricInfo, List) instead.

Delegated to for actually making the metric.

Parameters:

metricName - Name for the metric we're making

dependentMetrics - Metrics this metric depends on

Returns:

the new logicalMetric

makeInner

protected LogicalMetric makeInner(LogicalMetricInfo logicalMetricInfo,
                                  List<String> dependentMetrics)

Delegated to for actually making the metric.

Parameters:

logicalMetricInfo - Logical metric info provider

dependentMetrics - Metrics this metric depends on

Returns:

the new logicalMetric

getDependentMetricsRequired

protected abstract int getDependentMetricsRequired()

Get the number of dependent metrics the maker requires for making the metric.

Returns:

the number of dependent metrics the maker requires for making the metric

getDependentQuery

@Deprecated
protected TemplateDruidQuery getDependentQuery(String name)

Deprecated. Instead get the metric in the calling function and then get the TDQ out only if necessary

Fetch the TemplateDruidQuery of the dependent metric from the Metric Dictionary.

Parameters:

name - Name of the metric to fetch the template druid query from

Returns:

The template druid query of the metric

getMergedQuery

protected TemplateDruidQuery getMergedQuery(List<String> names)

A helper function returning the resulting aggregation set from merging one or more template druid queries.

Parameters:

names - Names of the metrics to fetch and merge the aggregation clauses from

Returns:

The merged query

getNumericField

@Deprecated
protected PostAggregation getNumericField(String fieldName)

Deprecated. use the static version getNumericField(MetricField) by preference

Prepare a post aggregation for a field expecting a numeric value.

The post-agg is created per the following heuristics:

If it's an aggregator

wrap it in a field accessor

If it's a sketch

wrap it in a sketch estimate

If it's already a numeric post aggregator

simply return it

Parameters:

fieldName - The name for the aggregation or post aggregation column being gotten

Returns:

A post aggregator representing a number field value

getNumericField

protected static PostAggregation getNumericField(MetricField field)

Prepare a post aggregation for a field expecting a numeric value.

The post-agg is created per the following heuristics:

If it's an aggregator

wrap it in a field accessor

If it's a sketch

wrap it in a sketch estimate

If it's already a numeric post aggregator

simply return it

Parameters:

field - The field being coerced

Returns:

A post aggregator representing a number field value

getSketchField

@Deprecated
protected PostAggregation getSketchField(String fieldName)

Deprecated. use the static version getSketchField(MetricField) by preference

Prepare a post aggregation for a field expecting a sketch value.

The post-agg is created per the following heuristics:

If it's an aggregator

wrap it in a field accessor

If it's a sketch estimate

unwrap the sketch estimate

If it's already a sketch post aggregator

simply return it

Otherwise

This is an illegal field

Parameters:

fieldName - The name for the aggregation or post aggregation column being gotten

Returns:

A post aggregator representing a number field value

getSketchField

protected static PostAggregation getSketchField(MetricField field)

Prepare a post aggregation for a field expecting a sketch value.

The post-agg is created per the following heuristics:

If it's an aggregator

wrap it in a field accessor

If it's a sketch estimate

unwrap the sketch estimate

If it's already a sketch post aggregator

simply return it

Otherwise

This is an illegal field

Parameters:

field - The field being coerced

Returns:

A post aggregator representing a number field value