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

Class MetricInstance

java.lang.Object

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

public class MetricInstance
extends Object

A Metric instance holds all of the information needed to construct a LogicalMetric.

Metric name

The name of the Logical Metric when it's in the metric dictionary

Dependency Metric Names

The names of metrics either in the dictionary or raw druid metrics that this Logical Metric depends on

Maker

The Metric Maker that creates the actual Logical Metric

Constructor Summary

Constructors

Constructor and Description
MetricInstance(FieldName metricName, MetricMaker maker, FieldName... dependencyFields) Deprecated. logical metric needs more config-richness to not just configure metric name, but also metric long name, description, etc. Use MetricInstance(LogicalMetricInfo, MetricMaker, FieldName...) instead.
MetricInstance(LogicalMetricInfo logicalMetricInfo, MetricMaker maker) Construct a MetricInstance from FieldNames.
MetricInstance(LogicalMetricInfo logicalMetricInfo, MetricMaker maker, FieldName... dependencyFields) Construct a MetricInstance from FieldNames with a list of dependencyFields.
MetricInstance(LogicalMetricInfo logicalMetricInfo, MetricMaker maker, String... dependencyMetricNames) Construct a MetricInstance from Strings with a list of dependencyMetricNames.
MetricInstance(String metricName, MetricMaker maker, String... dependencyMetricNames) Deprecated. logical metric needs more config-richness to not just configure metric name, but also metric long name, description, etc. Use MetricInstance(LogicalMetricInfo, MetricMaker, String...) instead.

Method Summary

Modifier and Type	Method and Description
List<String>	getDependencyMetricNames()
LogicalMetricInfo	getLogicalMetricInfo() Returns the LogicalMetricInfo of this MetricInstance.
MetricMaker	getMaker()
String	getMetricName()
LogicalMetric	make() Make the Logical Metric from the information in this MetricInstance.
MetricInstance	withDependencyMetricNames(List<String> dependencyMetricNames) Makes a copy of the metric instance with new dependencyMetricNames.
MetricInstance	withMaker(MetricMaker maker) Makes a copy of the metric instance with new maker.
MetricInstance	withName(String metricName) Makes a copy of the metric instance with new metric name.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricInstance

@Deprecated
public MetricInstance(String metricName,
                                  MetricMaker maker,
                                  String... dependencyMetricNames)

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

Construct a MetricInstance from Strings with a list of dependencyMetricNames.

Parameters:

metricName - The name of the Logical Metric in the metric dictionary

maker - The Metric Maker that creates the actual Logical Metric

dependencyMetricNames - The names of metrics either in the dictionary or raw druid metrics that this Logical Metric depends on

MetricInstance

public MetricInstance(LogicalMetricInfo logicalMetricInfo,
                      MetricMaker maker,
                      String... dependencyMetricNames)

Construct a MetricInstance from Strings with a list of dependencyMetricNames.

Parameters:

logicalMetricInfo - Logical metric info provider

maker - The Metric Maker that creates the actual Logical Metric

dependencyMetricNames - The names of metrics either in the dictionary or raw druid metrics that this Logical Metric depends on

MetricInstance

@Deprecated
public MetricInstance(FieldName metricName,
                                  MetricMaker maker,
                                  FieldName... dependencyFields)

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

Construct a MetricInstance from FieldNames with a list of dependencyFields.

Parameters:

metricName - The name of the Logical Metric when it's in the metric dictionary

maker - The Metric Maker that creates the actual Logical Metric

dependencyFields - The field names that this Logical Metric depends on

MetricInstance

public MetricInstance(LogicalMetricInfo logicalMetricInfo,
                      MetricMaker maker,
                      FieldName... dependencyFields)

Construct a MetricInstance from FieldNames with a list of dependencyFields.

Parameters:

logicalMetricInfo - Logical metric info provider

maker - The Metric Maker that creates the actual Logical Metric

dependencyFields - The field names that this Logical Metric depends on

MetricInstance

public MetricInstance(LogicalMetricInfo logicalMetricInfo,
                      MetricMaker maker)

Construct a MetricInstance from FieldNames.

Parameters:

logicalMetricInfo - Logical metric info provider

maker - The Metric Maker that creates the actual Logical Metric

Method Detail

getMetricName

public String getMetricName()

getLogicalMetricInfo

public LogicalMetricInfo getLogicalMetricInfo()

Returns the LogicalMetricInfo of this MetricInstance.

Returns:

the LogicalMetricInfo of this MetricInstance

getDependencyMetricNames

public List<String> getDependencyMetricNames()

getMaker

public MetricMaker getMaker()

withName

public MetricInstance withName(String metricName)

Makes a copy of the metric instance with new metric name.

Parameters:

metricName - The name of the Logical Metric in the metric dictionary

Returns:

copy of the logical Metric

withMaker

public MetricInstance withMaker(MetricMaker maker)

Makes a copy of the metric instance with new maker.

Parameters:

maker - The Metric Maker that creates the actual Logical Metric

Returns:

copy of the logical Metric

withDependencyMetricNames

public MetricInstance withDependencyMetricNames(List<String> dependencyMetricNames)

Makes a copy of the metric instance with new dependencyMetricNames.

Parameters:

dependencyMetricNames - The name of metrics that this Logical Metric depends on

Returns:

copy of the logical Metric

make

public LogicalMetric make()

Make the Logical Metric from the information in this MetricInstance.

Returns:

The LogicalMetric with the provided name, using the given maker, that depends on the given metrics.