com.yahoo.bard.webservice.web.apirequest

Class TablesApiRequestImpl

java.lang.Object

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

com.yahoo.bard.webservice.web.apirequest.TablesApiRequestImpl

All Implemented Interfaces:

ApiRequest, TablesApiRequest

public class TablesApiRequestImpl
extends ApiRequestImpl
implements TablesApiRequest

Tables API Request Implementation binds, validates, and models the parts of a request to the table 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.TablesApiRequest

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
TablesApiRequestImpl(String tableName, String granularity, String format, String perPage, String page, javax.ws.rs.core.UriInfo uriInfo, BardConfigResources bardConfigResources) Parses the API request URL and generates the Api Request object.
TablesApiRequestImpl(String tableName, String granularity, String format, String perPage, String page, javax.ws.rs.core.UriInfo uriInfo, BardConfigResources bardConfigResources, List<javax.ws.rs.core.PathSegment> dimensions, String metrics, String intervals, String filters, String timeZoneId) Parses the API request URL and generates the API Request object with specified query constraints, i.e.

Method Summary

Modifier and Type	Method and Description
protected LinkedHashSet<LogicalMetric>	generateLogicalMetrics(String apiMetricQuery, MetricDictionary metricDictionary) Extracts the list of metrics from the url metric query string and generates a set of LogicalMetrics.
protected Set<LogicalTable>	generateTables(String tableName, LogicalTableDictionary tableDictionary) Extracts the list of logical table names from the url table path segment and generates a set of logical table objects based on it.
ApiFilters	getApiFilters() Returns a map of filters by dimension for this request, grouped by dimensions.
Set<Dimension>	getDimensions() Returns the set of grouping dimensions on this request.
Set<Dimension>	getFilterDimensions() Returns the dimensions used in filters on this request.
Granularity	getGranularity() Returns the grain to group the results of this request.
Set<org.joda.time.Interval>	getIntervals() Returns the intervals for this query.
Set<LogicalMetric>	getLogicalMetrics() Returns the logical metrics requested in this query.
LogicalTable	getTable() Returns the LogicalTable requested in the table API request URL.
Set<LogicalTable>	getTables() Returns a set of LogicalTables associated with a table API request.
TablesApiRequest	withBuilder(javax.ws.rs.core.Response.ResponseBuilder builder)
TablesApiRequest	withDimensions(Set<Dimension> dimensions)
TablesApiRequest	withFilters(Map<Dimension,Set<ApiFilter>> filters)
TablesApiRequest	withFormat(ResponseFormatType format)
TablesApiRequest	withGranularity(Set<LogicalTable> tables)
TablesApiRequest	withIntervals(Set<org.joda.time.Interval> intervals)
TablesApiRequest	withMetrics(Set<LogicalMetric> logicalMetrics)
TablesApiRequest	withPaginationParameters(Optional<PaginationParameters> paginationParameters)
TablesApiRequest	withTable(LogicalTable table)
TablesApiRequest	withTables(Granularity granularity)
TablesApiRequest	withTables(Set<LogicalTable> tables)
TablesApiRequest	withUriInfo(javax.ws.rs.core.UriInfo uriInfo)

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

addPageLink, addPageLink, generateAcceptFormat, generateAsyncAfter, generateDimensions, generateFilters, generateGranularity, generateGranularity, generateIntervals, generateIntervals, 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

TablesApiRequestImpl

public TablesApiRequestImpl(String tableName,
                            String granularity,
                            String format,
                            @NotNull
                            String perPage,
                            @NotNull
                            String page,
                            javax.ws.rs.core.UriInfo uriInfo,
                            BardConfigResources bardConfigResources)
                     throws BadApiRequestException

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

Parameters:

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

granularity - string time granularity in 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.

uriInfo - The URI of the request object.

bardConfigResources - The configuration resources used to build this api request

Throws:

BadApiRequestException - is thrown in the following scenarios:

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

TablesApiRequestImpl

public TablesApiRequestImpl(String tableName,
                            String granularity,
                            String format,
                            @NotNull
                            String perPage,
                            @NotNull
                            String page,
                            javax.ws.rs.core.UriInfo uriInfo,
                            BardConfigResources bardConfigResources,
                            List<javax.ws.rs.core.PathSegment> dimensions,
                            String metrics,
                            String intervals,
                            String filters,
                            String timeZoneId)
                     throws BadApiRequestException

Parses the API request URL and generates the API Request object with specified query constraints, i.e. dimensions, metrics, date time intervals, and filters.

Parameters:

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

granularity - Requested time granularity

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

perPage - Number of rows to display per page of results. It must represent a positive integer or an empty string if it's not specified

page - Desired page of results. It must represent a positive integer or an empty string if it's not specified

uriInfo - The URI of the request

bardConfigResources - The configuration resources used to build this API request

dimensions - Grouping dimensions / Dimension constraint

metrics - Metrics constraint

intervals - Data / Time constraint

filters - Filter constraint

timeZoneId - A joda time zone id

Throws:

BadApiRequestException - on

1. invalid table
2. invalid pagination parameters

Method Detail

generateTables

protected Set<LogicalTable> generateTables(String tableName,
                                           LogicalTableDictionary tableDictionary)
                                    throws BadApiRequestException

Extracts the list of logical table names from the url table path segment and generates a set of logical table objects based on it.

Parameters:

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

tableDictionary - Logical table dictionary contains the map of valid table names and table objects.

Returns:

Set of logical table objects.

Throws:

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

generateLogicalMetrics

protected LinkedHashSet<LogicalMetric> generateLogicalMetrics(String apiMetricQuery,
                                                              MetricDictionary metricDictionary)
                                                       throws BadApiRequestException

Extracts the list of metrics from the url metric query string and generates a set of LogicalMetrics.

Overrides:

generateLogicalMetrics in class ApiRequestImpl

Parameters:

apiMetricQuery - URL query string containing the metrics separated by ','.

metricDictionary - Metric dictionary contains the map of valid metric names and logical metric objects.

Returns:

Set of metric objects.

Throws:

BadApiRequestException - if the metric dictionary returns a null or if the apiMetricQuery is invalid.

getTables

public Set<LogicalTable> getTables()

Description copied from interface: TablesApiRequest

Returns a set of LogicalTables associated with a table API request.

Specified by:

getTables in interface TablesApiRequest

Returns:

the set of LogicalTables associated with a table API request

getTable

public LogicalTable getTable()

Description copied from interface: TablesApiRequest

Returns the LogicalTable requested in the table API request URL.

Specified by:

getTable in interface TablesApiRequest

Returns:

the LogicalTable requested in the table API request URL

getGranularity

public Granularity getGranularity()

Description copied from interface: TablesApiRequest

Returns the grain to group the results of this request.

Specified by:

getGranularity in interface TablesApiRequest

Returns:

the grain to group the results of this request

getDimensions

public Set<Dimension> getDimensions()

Description copied from interface: TablesApiRequest

Returns the set of grouping dimensions on this request.

Specified by:

getDimensions in interface TablesApiRequest

Returns:

the set of grouping dimensions on this request

getFilterDimensions

public Set<Dimension> getFilterDimensions()

Description copied from interface: TablesApiRequest

Returns the dimensions used in filters on this request.

Specified by:

getFilterDimensions in interface TablesApiRequest

Returns:

the dimensions used in filters on this request

getApiFilters

public ApiFilters getApiFilters()

Description copied from interface: TablesApiRequest

Returns a map of filters by dimension for this request, grouped by dimensions.

Specified by:

getApiFilters in interface TablesApiRequest

Returns:

the map of filters by dimension for this request, grouped by dimensions

getIntervals

public Set<org.joda.time.Interval> getIntervals()

Description copied from interface: TablesApiRequest

Returns the intervals for this query.

Specified by:

getIntervals in interface TablesApiRequest

Returns:

the intervals for this query

getLogicalMetrics

public Set<LogicalMetric> getLogicalMetrics()

Description copied from interface: TablesApiRequest

Returns the logical metrics requested in this query.

Specified by:

getLogicalMetrics in interface TablesApiRequest

Returns:

the logical metrics requested in this query

withFormat

public TablesApiRequest withFormat(ResponseFormatType format)

Specified by:

withFormat in interface TablesApiRequest

withPaginationParameters

public TablesApiRequest withPaginationParameters(Optional<PaginationParameters> paginationParameters)

Specified by:

withPaginationParameters in interface TablesApiRequest

withUriInfo

public TablesApiRequest withUriInfo(javax.ws.rs.core.UriInfo uriInfo)

Specified by:

withUriInfo in interface TablesApiRequest

withBuilder

public TablesApiRequest withBuilder(javax.ws.rs.core.Response.ResponseBuilder builder)

Specified by:

withBuilder in interface TablesApiRequest

withTables

public TablesApiRequest withTables(Set<LogicalTable> tables)

Specified by:

withTables in interface TablesApiRequest

withTable

public TablesApiRequest withTable(LogicalTable table)

Specified by:

withTable in interface TablesApiRequest

withGranularity

public TablesApiRequest withGranularity(Set<LogicalTable> tables)

Specified by:

withGranularity in interface TablesApiRequest

withTables

public TablesApiRequest withTables(Granularity granularity)

Specified by:

withTables in interface TablesApiRequest

withDimensions

public TablesApiRequest withDimensions(Set<Dimension> dimensions)

Specified by:

withDimensions in interface TablesApiRequest

withMetrics

public TablesApiRequest withMetrics(Set<LogicalMetric> logicalMetrics)

Specified by:

withMetrics in interface TablesApiRequest

withIntervals

public TablesApiRequest withIntervals(Set<org.joda.time.Interval> intervals)

Specified by:

withIntervals in interface TablesApiRequest

withFilters

public TablesApiRequest withFilters(Map<Dimension,Set<ApiFilter>> filters)

Specified by:

withFilters in interface TablesApiRequest