com.yahoo.wiki.webservice.data.config.names

Enum WikiApiMetricName

java.lang.Object

java.lang.Enum<WikiApiMetricName>

com.yahoo.wiki.webservice.data.config.names.WikiApiMetricName

All Implemented Interfaces:

ApiMetricName, FieldName, Serializable, Comparable<WikiApiMetricName>

public enum WikiApiMetricName
extends Enum<WikiApiMetricName>
implements ApiMetricName

Hold the list of API metric names.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADDED
COUNT
DELETED
DELTA

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()
static WikiApiMetricName	valueOf(String name) Returns the enum constant of this type with the specified name.
static WikiApiMetricName[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

isValidFor, isValidFor, of

Enum Constant Detail

COUNT

public static final WikiApiMetricName COUNT

ADDED

public static final WikiApiMetricName ADDED

DELTA

public static final WikiApiMetricName DELTA

DELETED

public static final WikiApiMetricName DELETED

Method Detail

values

public static WikiApiMetricName[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (WikiApiMetricName c : WikiApiMetricName.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static WikiApiMetricName valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<WikiApiMetricName>

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

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.

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