com.yahoo.bard.webservice.data.config.names

Interface ApiMetricName

All Superinterfaces:

FieldName

All Known Implementing Classes:

FiliApiMetricName, WikiApiMetricName

public interface ApiMetricName
extends FieldName

Interface to mark metric names.

Metric names are used as the keys in the metric dictionary and are also used in the query api to select logical metrics.

Method Summary

Modifier and Type	Method and Description
String	getApiName() The API Name is the external, end-user-facing name for the metric.
default boolean	isValidFor(Granularity granularity) Determine if this API Metric Name is valid for the given time grain.
default boolean	isValidFor(Granularity granularity, LogicalMetric logicalMetric) Determine if this API Metric Name is valid for the given time grain.
boolean	isValidFor(TimeGrain grain) Determine if this API Metric Name is valid for the given time grain.
static ApiMetricName	of(String name) Wrap a string in an anonymous instance of ApiMetricName.

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

asName

Method Detail

isValidFor

boolean isValidFor(TimeGrain grain)

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.

Parameters:

grain - TimeGrain to determine validity for

Returns:

True if the ApiMetricName is valid for the time grain

isValidFor

default boolean isValidFor(Granularity granularity)

Determine if this API Metric Name is valid for the given time grain. This capability is provided as a convenience for configurers to filter metrics from a TableGroup onto a set of LogicalTable instances at configuration time.

This version only takes the time grain into account. The default implementation simply sets a required minimum grain for the metric.

An example of this is a DailyAverage metric that doesn't make sense to query by the HOUR grain, but does at WEEK.

Parameters:

granularity - TimeGrain to determine validity for

Returns:

True if the ApiMetricName is valid for the time grain

isValidFor

default boolean isValidFor(Granularity granularity,
                           LogicalMetric logicalMetric)

Determine if this API Metric Name is valid for the given time grain. This capability is provided as a convenience for configurers to filter metrics from a TableGroup onto a set of LogicalTable instances at configuration time. This version allows the logical metric itself to be used for filtering.

An example of this is a DailyAverage metric that doesn't make sense to query by the HOUR grain, but does at WEEK.

Parameters:

granularity - TimeGrain to determine validity for

logicalMetric - The metric whose validity is being tested.

Returns:

True if the ApiMetricName is valid for the time grain

getApiName

String getApiName()

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

Returns:

User facing name for this metric

of

static ApiMetricName of(String name)

Wrap a string in an anonymous instance of ApiMetricName.

Parameters:

name - the name being wrapped

Returns:

an anonymous subclass instance of ApiMetricName