com.yahoo.bard.webservice.web.apirequest

Class DefaultDataApiRequestFactory

java.lang.Object

com.yahoo.bard.webservice.web.apirequest.DefaultDataApiRequestFactory

All Implemented Interfaces:

DataApiRequestFactory

public class DefaultDataApiRequestFactory
extends Object
implements DataApiRequestFactory

An implementation of DataApiRequestFactory that does not modify the initial parameters at all.

Constructor Summary

Constructors

Constructor and Description
DefaultDataApiRequestFactory()

Method Summary

Modifier and Type

Method and Description

DataApiRequest

buildApiRequest(String tableName, String granularity, List<javax.ws.rs.core.PathSegment> dimensions, String logicalMetrics, String intervals, String apiFilters, String havings, String sorts, String count, String topN, String format, String timeZoneId, String asyncAfter, String perPage, String page, javax.ws.rs.core.UriInfo uriInfo, BardConfigResources bardConfigResources) Factory method for building DataApiRequest objects.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultDataApiRequestFactory

public DefaultDataApiRequestFactory()

Method Detail

buildApiRequest

public DataApiRequest buildApiRequest(String tableName,
                                      String granularity,
                                      List<javax.ws.rs.core.PathSegment> dimensions,
                                      String logicalMetrics,
                                      String intervals,
                                      String apiFilters,
                                      String havings,
                                      String sorts,
                                      String count,
                                      String topN,
                                      String format,
                                      String timeZoneId,
                                      String asyncAfter,
                                      String perPage,
                                      String page,
                                      javax.ws.rs.core.UriInfo uriInfo,
                                      BardConfigResources bardConfigResources)

Description copied from interface: DataApiRequestFactory

Factory method for building DataApiRequest objects.

Specified by:

buildApiRequest in interface DataApiRequestFactory

Parameters:

tableName - logical table corresponding to the table name specified in the URL

granularity - string time granularity in URL

dimensions - single dimension or multiple dimensions separated by '/' in URL

logicalMetrics - URL logical metric query string in the format:

 single metric or multiple logical metrics separated by ',' 

intervals - URL intervals query string in the format:

 single interval in ISO 8601 format, multiple values separated by ',' 

apiFilters - URL filter query String

havings - URL having query String

sorts - string of sort columns along with sort direction

count - count of number of records to be returned in the response

topN - number of first records per time bucket to be returned in the response

format - response data format

timeZoneId - a joda time zone id

asyncAfter - How long the user is willing to wait for a synchronous request in milliseconds

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.

uriInfo - The URI of the request object.

bardConfigResources - The configuration resources used to build this api request

Returns:

A DataApiRequestImpl instance