com.yahoo.wiki.webservice.data.config.metric

Class FiliApiMetricName

java.lang.Object

com.yahoo.wiki.webservice.data.config.metric.FiliApiMetricName

All Implemented Interfaces:

ApiMetricName, FieldName

public class FiliApiMetricName
extends Object
implements ApiMetricName

Holds a metric name which is stored in fili.

Constructor Summary

Constructors

Constructor and Description
FiliApiMetricName(String name, TimeGrain timeGrain) Constructs a FiliApiMetricName.

Method Summary

Modifier and Type	Method and Description
String	asName() Get the name as it should be used in Druid Queries.
String	getApiName() The API Name is the external, end-user-facing name for the metric.
boolean	isValidFor(TimeGrain grain) Determine if this API Metric Name is valid for the given time grain.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yahoo.bard.webservice.data.config.names.ApiMetricName

isValidFor, isValidFor, of

Constructor Detail

FiliApiMetricName

public FiliApiMetricName(String name,
                         TimeGrain timeGrain)

Constructs a FiliApiMetricName.

Parameters:

name - The name of the metric.

timeGrain - A valid timegrain for this metric.

Method Detail

asName

public String asName()

Description copied from interface: FieldName

Get the name as it should be used in Druid Queries.

Specified by:

asName in interface FieldName

Returns:

The name of the enum as it should be used in Druid Queries.

toString

public String toString()

Overrides:

toString in class Object

isValidFor

public boolean isValidFor(TimeGrain grain)

Description copied from interface: ApiMetricName

Determine if this API Metric Name is valid for the given time grain.

An example of this is a DailyAverage metric than doesn't make sense at the Day grain, but does at the Week.

Specified by:

isValidFor in interface ApiMetricName

Parameters:

grain - TimeGrain to determine validity for

Returns:

True if the ApiMetricName is valid for the time grain

getApiName

public String getApiName()

Description copied from interface: ApiMetricName

The API Name is the external, end-user-facing name for the metric. This is the name of this metric in API requests.

Specified by:

getApiName in interface ApiMetricName

Returns:

User facing name for this metric