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

Class ArithmeticMaker

java.lang.Object

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

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

public class ArithmeticMaker
extends MetricMaker

Metric maker for performing binary arithmetic operations on metrics.

Field Summary

Fields inherited from class com.yahoo.bard.webservice.data.config.metric.makers.MetricMaker

metrics, NO_OP_MAP_PROVIDER, NO_OP_MAPPER

Constructor Summary

Constructors

Constructor and Description
ArithmeticMaker(MetricDictionary metricDictionary, ArithmeticPostAggregation.ArithmeticPostAggregationFunction function) Build an ArithmeticMaker with SketchRoundUpMapper as the ResultSetMapper for building the LogicalMetric.
ArithmeticMaker(MetricDictionary metricDictionary, ArithmeticPostAggregation.ArithmeticPostAggregationFunction function, ColumnMapper resultSetMapper) Deprecated. to override default mapping, use the Function constructor
ArithmeticMaker(MetricDictionary metricDictionary, ArithmeticPostAggregation.ArithmeticPostAggregationFunction function, Function<String,ResultSetMapper> resultSetMapperSupplier) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	assertRequiredDependentMetricCount(String dictionaryName, List<String> dependentMetrics) Unlike most other metrics, Arithmetic metrics require at least DEPENDENT_METRICS_REQUIRED dependent metrics, rather than exactly DEPENDENT_METRICS_REQUIRED.
protected int	getDependentMetricsRequired() Get the number of dependent metrics the maker requires for making the metric.
protected LogicalMetric	makeInner(LogicalMetricInfo logicalMetricInfo, List<String> dependentMetrics) Delegated to for actually making the metric.

Methods inherited from class com.yahoo.bard.webservice.data.config.metric.makers.MetricMaker

assertDependentMetricsExist, getDependentQuery, getMergedQuery, getNumericField, getNumericField, getSketchField, getSketchField, make, make, make, makeInner

Methods inherited from class java.lang.Object

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

Constructor Detail

ArithmeticMaker

public ArithmeticMaker(MetricDictionary metricDictionary,
                       ArithmeticPostAggregation.ArithmeticPostAggregationFunction function,
                       Function<String,ResultSetMapper> resultSetMapperSupplier)

Constructor.

Parameters:

metricDictionary - The dictionary used to resolve dependent metrics when building the LogicalMetric

function - The arithmetic operation performed by the LogicalMetrics constructed by this maker

resultSetMapperSupplier - A function that takes a metric column name and produces at build time, a result set mapper.

ArithmeticMaker

@Deprecated
public ArithmeticMaker(MetricDictionary metricDictionary,
                                   ArithmeticPostAggregation.ArithmeticPostAggregationFunction function,
                                   ColumnMapper resultSetMapper)

Deprecated. to override default mapping, use the Function constructor

Constructor.

Parameters:

metricDictionary - The dictionary used to resolve dependent metrics when building the LogicalMetric

function - The arithmetic operation performed by the LogicalMetrics constructed by this maker

resultSetMapper - The mapping function to be applied to the result that is returned by the query that is built from the LogicalMetric which is built by this maker.

ArithmeticMaker

public ArithmeticMaker(MetricDictionary metricDictionary,
                       ArithmeticPostAggregation.ArithmeticPostAggregationFunction function)

Build an ArithmeticMaker with SketchRoundUpMapper as the ResultSetMapper for building the LogicalMetric.

Parameters:

metricDictionary - The dictionary used to resolve dependent metrics when building the LogicalMetric

function - The arithmetic operation performed by the LogicalMetrics constructed by this maker

Method Detail

makeInner

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

Description copied from class: MetricMaker

Delegated to for actually making the metric.

Overrides:

makeInner in class MetricMaker

Parameters:

logicalMetricInfo - Logical metric info provider

dependentMetrics - Metrics this metric depends on

Returns:

the new logicalMetric

getDependentMetricsRequired

protected int getDependentMetricsRequired()

Description copied from class: MetricMaker

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

Specified by:

getDependentMetricsRequired in class MetricMaker

Returns:

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

assertRequiredDependentMetricCount

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

Unlike most other metrics, Arithmetic metrics require at least DEPENDENT_METRICS_REQUIRED dependent metrics, rather than exactly DEPENDENT_METRICS_REQUIRED.

Overrides:

assertRequiredDependentMetricCount in class MetricMaker

Parameters:

dictionaryName - Name of the metric being made

dependentMetrics - List of dependent metrics needed to make the metric