com.yahoo.bard.webservice.web.apirequest

Class DimensionsApiRequestImpl

java.lang.Object

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

com.yahoo.bard.webservice.web.apirequest.DimensionsApiRequestImpl

All Implemented Interfaces:

ApiRequest, DimensionsApiRequest

public class DimensionsApiRequestImpl
extends ApiRequestImpl
implements DimensionsApiRequest

Dimension API Request Implementation binds, validates, and models the parts of a request to the dimension 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.DimensionsApiRequest

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
DimensionsApiRequestImpl(String dimension, String filters, String format, String perPage, String page, DimensionDictionary dimensionDictionary, 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 LinkedHashSet<Dimension>	generateDimensions(String apiDimension, DimensionDictionary dimensionDictionary) Returns a set of dimension names that contains either the requested dimension or all the available ones.
protected LinkedHashSet<ApiFilter>	generateFilters(String filterQuery, DimensionDictionary dimensionDictionary) Generates filter objects based on the filter query in the api request.
Dimension	getDimension()
LinkedHashSet<Dimension>	getDimensions()
Set<ApiFilter>	getFilters()
DimensionsApiRequest	withBuilder(javax.ws.rs.core.Response.ResponseBuilder builder)
DimensionsApiRequest	withDimensions(LinkedHashSet<Dimension> dimensions)
DimensionsApiRequest	withFilters(Set<ApiFilter> filters)
DimensionsApiRequest	withFormat(ResponseFormatType format)
DimensionsApiRequest	withPaginationParameters(Optional<PaginationParameters> paginationParameters)
DimensionsApiRequest	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, 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

DimensionsApiRequestImpl

public DimensionsApiRequestImpl(String dimension,
                                String filters,
                                String format,
                                @NotNull
                                String perPage,
                                @NotNull
                                String page,
                                DimensionDictionary dimensionDictionary,
                                javax.ws.rs.core.UriInfo uriInfo)
                         throws BadApiRequestException

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

Parameters:

dimension - single dimension URL

filters - URL filter query String in the format:

 ((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.

dimensionDictionary - cache containing all the valid dimension objects.

uriInfo - The URI of the request object.

Throws:

BadApiRequestException - is thrown in the following scenarios:

1. Invalid dimension in the API request.
2. Invalid filter syntax in the API request.
3. Invalid filter dimensions in the API request.
4. Pagination parameters in the API request that are not positive integers.

Method Detail

generateDimensions

protected LinkedHashSet<Dimension> generateDimensions(String apiDimension,
                                                      DimensionDictionary dimensionDictionary)
                                               throws BadApiRequestException

Returns a set of dimension names that contains either the requested dimension or all the available ones.

Parameters:

apiDimension - Dimension string from the URL.

dimensionDictionary - Dimension dictionary contains the map of valid dimension names and dimension objects.

Returns:

Set of dimension objects.

Throws:

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

generateFilters

protected LinkedHashSet<ApiFilter> generateFilters(String filterQuery,
                                                   DimensionDictionary dimensionDictionary)
                                            throws BadApiRequestException

Generates filter objects based on the filter query in the api request.

Parameters:

filterQuery - Expects a URL filter query String in the format: (dimension name).(fieldname)-(operation):[?(value or comma separated values)]?

dimensionDictionary - DimensionDictionary

Returns:

Set of filter objects.

Throws:

BadApiRequestException - if the filter query string does not match required syntax.

withFormat

public DimensionsApiRequest withFormat(ResponseFormatType format)

Specified by:

withFormat in interface DimensionsApiRequest

withPaginationParameters

public DimensionsApiRequest withPaginationParameters(Optional<PaginationParameters> paginationParameters)

Specified by:

withPaginationParameters in interface DimensionsApiRequest

withUriInfo

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

Specified by:

withUriInfo in interface DimensionsApiRequest

withBuilder

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

Specified by:

withBuilder in interface DimensionsApiRequest

withDimensions

public DimensionsApiRequest withDimensions(LinkedHashSet<Dimension> dimensions)

Specified by:

withDimensions in interface DimensionsApiRequest

withFilters

public DimensionsApiRequest withFilters(Set<ApiFilter> filters)

Specified by:

withFilters in interface DimensionsApiRequest

getDimensions

public LinkedHashSet<Dimension> getDimensions()

Specified by:

getDimensions in interface DimensionsApiRequest

getDimension

public Dimension getDimension()

Specified by:

getDimension in interface DimensionsApiRequest

getFilters

public Set<ApiFilter> getFilters()

Specified by:

getFilters in interface DimensionsApiRequest