com.yahoo.bard.webservice.data.metric

Class LogicalMetric

java.lang.Object

com.yahoo.bard.webservice.data.metric.LogicalMetric

public class LogicalMetric
extends Object

A LogicalMetric is a set of its TemplateQueries, Mapper, and its name.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CATEGORY

Constructor Summary

Constructors

Constructor and Description
LogicalMetric(TemplateDruidQuery templateDruidQuery, ResultSetMapper calculation, LogicalMetricInfo logicalMetricInfo) Constructor.
LogicalMetric(TemplateDruidQuery templateDruidQuery, ResultSetMapper calculation, String name) Deprecated. Properties, such as name, of LogicalMetric is stored in a unified object called LogicalMetricInfo. Use new constructor LogicalMetric(TemplateDruidQuery, ResultSetMapper, LogicalMetricInfo) instead.
LogicalMetric(TemplateDruidQuery templateDruidQuery, ResultSetMapper calculation, String name, String description) Deprecated. Properties, such as name, of LogicalMetric is stored in a unified object called LogicalMetricInfo. Use new constructor LogicalMetric(TemplateDruidQuery, ResultSetMapper, LogicalMetricInfo) instead.
LogicalMetric(TemplateDruidQuery templateDruidQuery, ResultSetMapper calculation, String name, String longName, String category, String description) Deprecated. Properties, such as name, of LogicalMetric is stored in a unified object called LogicalMetricInfo. Use new constructor LogicalMetric(TemplateDruidQuery, ResultSetMapper, LogicalMetricInfo) instead.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
ResultSetMapper	getCalculation()
String	getCategory()
String	getDescription()
String	getLongName()
MetricField	getMetricField()
String	getName()
TemplateDruidQuery	getTemplateDruidQuery()
String	getType()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CATEGORY

public static final String DEFAULT_CATEGORY

See Also:

Constant Field Values

Constructor Detail

LogicalMetric

@Deprecated
public LogicalMetric(TemplateDruidQuery templateDruidQuery,
                                 ResultSetMapper calculation,
                                 String name,
                                 String longName,
                                 String category,
                                 String description)

Deprecated. Properties, such as name, of LogicalMetric is stored in a unified object called LogicalMetricInfo. Use new constructor LogicalMetric(TemplateDruidQuery, ResultSetMapper, LogicalMetricInfo) instead.

Build a fully specified Logical Metric.

Parameters:

templateDruidQuery - Query the metric needs

calculation - Mapper for the metric

name - Name of the metric

longName - Long name of the metric

category - Category of the metric

description - Description of the metric

LogicalMetric

@Deprecated
public LogicalMetric(TemplateDruidQuery templateDruidQuery,
                                 ResultSetMapper calculation,
                                 String name,
                                 String description)

Deprecated. Properties, such as name, of LogicalMetric is stored in a unified object called LogicalMetricInfo. Use new constructor LogicalMetric(TemplateDruidQuery, ResultSetMapper, LogicalMetricInfo) instead.

Build a slightly more specified Logical Metric.

Note: The description is set to the same as the name.

Parameters:

templateDruidQuery - Query the metric needs

calculation - Mapper for the metric

name - Name of the metric

description - Description of the metric

LogicalMetric

@Deprecated
public LogicalMetric(TemplateDruidQuery templateDruidQuery,
                                 ResultSetMapper calculation,
                                 String name)

Deprecated. Properties, such as name, of LogicalMetric is stored in a unified object called LogicalMetricInfo. Use new constructor LogicalMetric(TemplateDruidQuery, ResultSetMapper, LogicalMetricInfo) instead.

Build a partly specified Logical Metric.

Note: The description is set to the same as the name.

Parameters:

templateDruidQuery - Query the metric needs

calculation - Mapper for the metric

name - Name of the metric

LogicalMetric

public LogicalMetric(TemplateDruidQuery templateDruidQuery,
                     ResultSetMapper calculation,
                     LogicalMetricInfo logicalMetricInfo)

Constructor. Builds a Logical Metric whose instance variables are provided by a LogicalMetricInfo object.

Parameters:

templateDruidQuery - Query the metric needs

calculation - Mapper for the metric

logicalMetricInfo - Logical Metric info provider

Method Detail

getName

public String getName()

getDescription

public String getDescription()

getCalculation

public ResultSetMapper getCalculation()

getTemplateDruidQuery

public TemplateDruidQuery getTemplateDruidQuery()

getMetricField

public MetricField getMetricField()

getCategory

public String getCategory()

getLongName

public String getLongName()

getType

public String getType()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object