com.yahoo.bard.webservice.data.metric

Class LogicalMetricInfo

java.lang.Object

com.yahoo.bard.webservice.data.metric.LogicalMetricInfo

public class LogicalMetricInfo
extends Object

Contains information passed to LogicalMetric constructor. The reason for having this class is to allow custom logical metric configurations. For example, if only metric name is provided, other metric info, like description, are set to default, but if people want to configure description, for example, they can add the description, which is going to be picked up during logical metric construction.

Constructor Summary

Constructors

Constructor and Description
LogicalMetricInfo(String name) Constructor.
LogicalMetricInfo(String name, String longName) Constructor.
LogicalMetricInfo(String name, String longName, String category, String description) Constructor.
LogicalMetricInfo(String name, String longName, String category, String description, String type) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getCategory() Returns the category of the metric.
String	getDescription() Returns the description of the metric.
String	getLongName() Returns the long name of the metric.
String	getName() Returns the name of the metric.
String	getType() Returns the type of the metric.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogicalMetricInfo

public LogicalMetricInfo(String name,
                         String longName,
                         String category,
                         String description,
                         String type)

Constructor. Builds a fully specified Logical Metric Info.

Parameters:

name - Name of the metric

longName - Long name of the metric

category - Category of the metric

description - Description of the metric

type - Type of metric

LogicalMetricInfo

public LogicalMetricInfo(String name,
                         String longName,
                         String category,
                         String description)

Constructor. Builds a fully specified Logical Metric Info.

Parameters:

name - Name of the metric

longName - Long name of the metric

category - Category of the metric

description - Description of the metric

LogicalMetricInfo

public LogicalMetricInfo(String name)

Constructor. Builds a partially specified Logical Metric Info.

Parameters:

name - Name of the metric

LogicalMetricInfo

public LogicalMetricInfo(String name,
                         String longName)

Constructor. Builds a partially specified Logical Metric Info.

Parameters:

name - Name of the metric

longName - Long name of the metric

Method Detail

getName

public String getName()

Returns the name of the metric.

Returns:

the name of the metric

getLongName

public String getLongName()

Returns the long name of the metric.

Returns:

the long name of the metric

getCategory

public String getCategory()

Returns the category of the metric.

Returns:

the category of the metric

getDescription

public String getDescription()

Returns the description of the metric.

Returns:

the description of the metric

getType

public String getType()

Returns the type of the metric.

Returns:

the type of the metric