com.yahoo.bard.webservice.web.apirequest

Class MetricsApiRequestImpl

java.lang.Object

com.yahoo.bard.webservice.web.apirequest.ApiRequestImpl

com.yahoo.bard.webservice.web.apirequest.MetricsApiRequestImpl

All Implemented Interfaces:

ApiRequest, MetricsApiRequest

public class MetricsApiRequestImpl
extends ApiRequestImpl
implements MetricsApiRequest

Metrics API Request Implementation binds, validates, and models the parts of a request to the metrics endpoint.

Field Summary

Fields inherited from class com.yahoo.bard.webservice.web.apirequest.ApiRequestImpl

asyncAfter, builder, COMMA_AFTER_BRACKET_PATTERN, format, pagination, paginationParameters, uriInfo

Fields inherited from interface com.yahoo.bard.webservice.web.apirequest.MetricsApiRequest

REQUEST_MAPPER_NAMESPACE

Fields inherited from interface com.yahoo.bard.webservice.web.apirequest.ApiRequest

ASYNCHRONOUS_ASYNC_AFTER_VALUE, SYNCHRONOUS_ASYNC_AFTER_VALUE

Constructor Summary

Constructors

Constructor and Description
MetricsApiRequestImpl(String metricName, String format, String perPage, String page, MetricDictionary metricDictionary, javax.ws.rs.core.UriInfo uriInfo) Parses the API request URL and generates the Api Request object.

Method Summary

Modifier and Type	Method and Description
protected Set<LogicalMetric>	generateMetrics(String metricName, MetricDictionary metricDictionary) Generates the set of all available metrics.
LogicalMetric	getMetric() Returns an available metric.
Set<LogicalMetric>	getMetrics() Returns a set of all available metrics.

Methods inherited from class com.yahoo.bard.webservice.web.apirequest.ApiRequestImpl

addPageLink, addPageLink, generateAcceptFormat, generateAsyncAfter, generateDimensions, generateFilters, generateGranularity, generateGranularity, generateIntervals, generateIntervals, generateLogicalMetrics, generateMetricName, generatePaginationParameters, generateTable, generateTimeZone, getAllPagesPaginationFactory, getAsDateTime, getAsyncAfter, getBuilder, getDefaultPagination, getFormat, getPage, getPage, getPagination, getPaginationParameters, getUriInfo, validateMetrics, validateRequestDimensions, validateTimeAlignment

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yahoo.bard.webservice.web.apirequest.ApiRequest

generateDateTimeFormatter, getAsyncAfter, getBuilder, getDefaultPagination, getFormat, getPage, getPage, getPagination, getPaginationParameters, getUriInfo

Constructor Detail

MetricsApiRequestImpl

public MetricsApiRequestImpl(String metricName,
                             String format,
                             @NotNull
                             String perPage,
                             @NotNull
                             String page,
                             MetricDictionary metricDictionary,
                             javax.ws.rs.core.UriInfo uriInfo)
                      throws BadApiRequestException

Parses the API request URL and generates the Api Request object.

Parameters:

metricName - string corresponding to the metric name specified in the URL

 ((field name and operation):((multiple values bounded by [])or(single value))))(followed by , or end of string)
 

format - response data format JSON or CSV. Default is JSON.

perPage - number of rows to display per page of results. If present in the original request, must be a positive integer. If not present, must be the empty string.

page - desired page of results. If present in the original request, must be a positive integer. If not present, must be the empty string.

metricDictionary - cache containing all the valid metric objects.

uriInfo - The URI of the request object.

Throws:

BadApiRequestException - is thrown in the following scenarios:

1. Invalid logical metric in the API request.
2. Pagination parameters in the API request that are not positive integers.

Method Detail

generateMetrics

protected Set<LogicalMetric> generateMetrics(String metricName,
                                             MetricDictionary metricDictionary)
                                      throws BadApiRequestException

Generates the set of all available metrics.

Parameters:

metricName - string corresponding to the metric name specified in the URL

metricDictionary - metric dictionary that contains the map of valid metric names to metric objects.

Returns:

Set of metric objects.

Throws:

BadApiRequestException - if an invalid metric is requested or the metric dictionary is empty.

getMetrics

public Set<LogicalMetric> getMetrics()

Description copied from interface: MetricsApiRequest

Returns a set of all available metrics.

Specified by:

getMetrics in interface MetricsApiRequest

Returns:

the set of all available metrics

getMetric

public LogicalMetric getMetric()

Description copied from interface: MetricsApiRequest

Returns an available metric.

Specified by:

getMetric in interface MetricsApiRequest

Returns:

an available metric