com.yahoo.bard.webservice.web.apirequest

Class SlicesApiRequestImpl

java.lang.Object

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

com.yahoo.bard.webservice.web.apirequest.SlicesApiRequestImpl

All Implemented Interfaces:

ApiRequest, SlicesApiRequest

public class SlicesApiRequestImpl
extends ApiRequestImpl
implements SlicesApiRequest

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

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
SlicesApiRequestImpl(String sliceName, String format, String perPage, String page, PhysicalTableDictionary tableDictionary, DataSourceMetadataService dataSourceMetadataService, 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 Map<String,Object>	generateSlice(String sliceName, PhysicalTableDictionary tableDictionary, DataSourceMetadataService dataSourceMetadataService, javax.ws.rs.core.UriInfo uriInfo) Generates a slice object for a given slice name.
protected Set<Map<String,String>>	generateSlices(PhysicalTableDictionary tableDictionary, javax.ws.rs.core.UriInfo uriInfo) Generates the set of all available slices.
Map<String,Object>	getSlice() Returns a slice object.
Set<Map<String,String>>	getSlices() Returns a set of all available slices.

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

SlicesApiRequestImpl

public SlicesApiRequestImpl(String sliceName,
                            String format,
                            @NotNull
                            String perPage,
                            @NotNull
                            String page,
                            PhysicalTableDictionary tableDictionary,
                            DataSourceMetadataService dataSourceMetadataService,
                            javax.ws.rs.core.UriInfo uriInfo)
                     throws BadApiRequestException

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

Parameters:

sliceName - string corresponding to the slice 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.

tableDictionary - cache containing all the valid physical table objects.

dataSourceMetadataService - a resource holding the available datasource metadata

uriInfo - The URI of the request object.

Throws:

BadApiRequestException - is thrown in the following scenarios:

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

Method Detail

generateSlices

protected Set<Map<String,String>> generateSlices(PhysicalTableDictionary tableDictionary,
                                                 javax.ws.rs.core.UriInfo uriInfo)
                                          throws BadApiRequestException

Generates the set of all available slices.

Parameters:

tableDictionary - Physical table dictionary contains the map of valid table names to table objects.

uriInfo - The URI of the request object.

Returns:

Set of slice objects.

Throws:

BadApiRequestException - if the physical table dictionary is empty.

generateSlice

protected Map<String,Object> generateSlice(String sliceName,
                                           PhysicalTableDictionary tableDictionary,
                                           DataSourceMetadataService dataSourceMetadataService,
                                           javax.ws.rs.core.UriInfo uriInfo)
                                    throws BadApiRequestException

Generates a slice object for a given slice name.

Parameters:

sliceName - string corresponding to the slice name specified in the URL

tableDictionary - Physical table dictionary contains the map of valid table names to table objects.

dataSourceMetadataService - a resource holding the available datasource metadata

uriInfo - The URI of the request object.

Returns:

Set of logical table objects.

Throws:

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

getSlices

public Set<Map<String,String>> getSlices()

Description copied from interface: SlicesApiRequest

Returns a set of all available slices.

Specified by:

getSlices in interface SlicesApiRequest

Returns:

the set of all available slices

getSlice

public Map<String,Object> getSlice()

Description copied from interface: SlicesApiRequest

Returns a slice object.

Specified by:

getSlice in interface SlicesApiRequest

Returns:

the slice object