com.yahoo.bard.webservice.web.endpoints

Class TablesServlet

java.lang.Object

com.yahoo.bard.webservice.web.endpoints.EndpointServlet

com.yahoo.bard.webservice.web.endpoints.TablesServlet

All Implemented Interfaces:

BardConfigResources

@Path(value="/tables")
 @Singleton
public class TablesServlet
extends EndpointServlet
implements BardConfigResources

Resource code for table resource endpoints.

Field Summary

Fields inherited from class com.yahoo.bard.webservice.web.endpoints.EndpointServlet

objectMappers

Constructor Summary

Constructors

Constructor and Description
TablesServlet(ResourceDictionaries resourceDictionaries, RequestMapper requestMapper, ObjectMappersSuite objectMappers, GranularityParser granularityParser, ResponseFormatResolver formatResolver) Constructor.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getAllTables(String perPage, String page, String format, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.container.ContainerRequestContext containerRequestContext) Get all the logical tables as a summary list.
DruidFilterBuilder	getFilterBuilder() Filter builder isn't used in TablesServlet but is part of the configuration interface, so this is an empty implementation.
GranularityParser	getGranularityParser() A parser for string to granularities.
HavingGenerator	getHavingApiGenerator() Having Api generator isn't used in TablesServlet but is part of the configuration interface, so this is an empty implementation.
static Set<Map<String,Object>>	getLogicalAll(Collection<LogicalTable> logicalTables, javax.ws.rs.core.UriInfo uriInfo) Get the summary list view of the logical tables.
LogicalTableDictionary	getLogicalTableDictionary() The dictionary of logical tables.
protected static Map<String,Object>	getLogicalTableFullView(LogicalTable logicalTable, javax.ws.rs.core.UriInfo uriInfo) Deprecated. In order to display constrained data availability in table resource, this method needs to accept a TablesApiRequest as a parameter. Use getLogicalTableFullView(TablesApiRequestImpl, UriInfo) instead.
protected static Map<String,Object>	getLogicalTableFullView(TablesApiRequestImpl tablesApiRequest, javax.ws.rs.core.UriInfo uriInfo) Get the full view of the logical table.
static Set<Map<String,String>>	getLogicalTableListSummaryView(Collection<LogicalTable> logicalTables, javax.ws.rs.core.UriInfo uriInfo) Get the summary list view of the logical tables.
static Map<String,String>	getLogicalTableSummaryView(LogicalTable logicalTable, javax.ws.rs.core.UriInfo uriInfo) Get the summary view of the logical table.
static String	getLogicalTableUrl(LogicalTable logicalTable, javax.ws.rs.core.UriInfo uriInfo) Get the URL of the logical table.
RequestMapper	getRequestMapper()
ResourceDictionaries	getResourceDictionaries() The collection of resource dictionaries.
org.joda.time.DateTimeZone	getSystemTimeZone() SystemTimeZone isn't used in TablesServlet but is part of the configuration interface, so this is an empty implementation.
javax.ws.rs.core.Response	getTable(String tableName, String perPage, String page, String format, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.container.ContainerRequestContext containerRequestContext) Get all grain-specific logical tables for a logical table name as a summary list.
javax.ws.rs.core.Response	getTableByGrain(String tableName, String grain, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.container.ContainerRequestContext containerRequestContext) Get unconstrained logical table details for a grain-specific logical table.
javax.ws.rs.core.Response	getTableByGrainAndConstraint(String tableName, String granularity, List<javax.ws.rs.core.PathSegment> dimensions, String metrics, String intervals, String filters, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.container.ContainerRequestContext containerRequestContext) Get constrained logical table details for a grain-specific logical table.
javax.ws.rs.core.Response	getTablesFullView(String perPage, String page, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.container.ContainerRequestContext containerRequestContext) Get all the tables full view.

Methods inherited from class com.yahoo.bard.webservice.web.endpoints.EndpointServlet

formatResponse

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.util.BardConfigResources

getDimensionDictionary, getMetricDictionary

Constructor Detail

TablesServlet

@Inject
public TablesServlet(ResourceDictionaries resourceDictionaries,
                             @Named(value="tablesApiRequestMapper")
                             RequestMapper requestMapper,
                             ObjectMappersSuite objectMappers,
                             GranularityParser granularityParser,
                             ResponseFormatResolver formatResolver)

Constructor.

Parameters:

resourceDictionaries - Dictionary holder

requestMapper - Mapper to change the API request if needed

objectMappers - JSON tools

granularityParser - Helper for parsing granularities

formatResolver - The formatResolver for determining correct response format

Method Detail

getAllTables

@GET
 @Timed
public javax.ws.rs.core.Response getAllTables(@DefaultValue(value="") @NotNull @QueryParam(value="perPage")
                                                           String perPage,
                                                           @DefaultValue(value="") @NotNull @QueryParam(value="page")
                                                           String page,
                                                           @QueryParam(value="format")
                                                           String format,
                                                           @Context
                                                           javax.ws.rs.core.UriInfo uriInfo,
                                                           @Context
                                                           javax.ws.rs.container.ContainerRequestContext containerRequestContext)

Get all the logical tables as a summary list.

Parameters:

perPage - number of values to return per page

page - the page to start from

format - The name of the output format type

uriInfo - UriInfo of the request

containerRequestContext - The context of data provided by the Jersey container for this request

Returns:

The list of logical tables

{ "tables": <List of Table Summaries> }

See Also:

getLogicalTableListSummaryView(Collection, UriInfo)

getTable

@GET
 @Timed
 @Path(value="/{tableName}")
public javax.ws.rs.core.Response getTable(@PathParam(value="tableName")
                                                                                    String tableName,
                                                                                    @DefaultValue(value="") @NotNull @QueryParam(value="perPage")
                                                                                    String perPage,
                                                                                    @DefaultValue(value="") @NotNull @QueryParam(value="page")
                                                                                    String page,
                                                                                    @QueryParam(value="format")
                                                                                    String format,
                                                                                    @Context
                                                                                    javax.ws.rs.core.UriInfo uriInfo,
                                                                                    @Context
                                                                                    javax.ws.rs.container.ContainerRequestContext containerRequestContext)

Get all grain-specific logical tables for a logical table name as a summary list.

Parameters:

tableName - Table to get all the grain-specific logical tables for

perPage - number of values to return per page

page - the page to start from

format - The name of the output format type

uriInfo - UriInfo of the request

containerRequestContext - The context of data provided by the Jersey container for this request

Returns:

The list of grain-specific logical tables

{ "tables": <List of Table Summaries> }

See Also:

getLogicalTableListSummaryView(Collection, UriInfo)

getTableByGrain

@GET
 @Timed
 @Produces(value="application/json")
 @Path(value="/{tableName}/{granularity}")
public javax.ws.rs.core.Response getTableByGrain(@PathParam(value="tableName")
                                                                                                                                              String tableName,
                                                                                                                                              @PathParam(value="granularity")
                                                                                                                                              String grain,
                                                                                                                                              @Context
                                                                                                                                              javax.ws.rs.core.UriInfo uriInfo,
                                                                                                                                              @Context
                                                                                                                                              javax.ws.rs.container.ContainerRequestContext containerRequestContext)

Get unconstrained logical table details for a grain-specific logical table.

See getTableByGrainAndConstraint(String, String, List, String, String, String, UriInfo, ContainerRequestContext) for getting constrained logical table details

Parameters:

tableName - Logical table name (part of the logical table ID)

grain - Logical table grain (part of the logical table ID)

uriInfo - UriInfo of the request

containerRequestContext - The context of data provided by the Jersey container for this request

Returns:

The grain-specific logical table

See Also:

TODO: Need to delegate to constrained endpoint

getTableByGrainAndConstraint

@GET
 @Timed
 @Produces(value="application/json")
 @Path(value="/{tableName}/{granularity}/{dimensions:.*}")
public javax.ws.rs.core.Response getTableByGrainAndConstraint(@PathParam(value="tableName")
                                                                                                                                                                           String tableName,
                                                                                                                                                                           @PathParam(value="granularity")
                                                                                                                                                                           String granularity,
                                                                                                                                                                           @PathParam(value="dimensions")
                                                                                                                                                                           List<javax.ws.rs.core.PathSegment> dimensions,
                                                                                                                                                                           @QueryParam(value="metrics")
                                                                                                                                                                           String metrics,
                                                                                                                                                                           @QueryParam(value="dateTime")
                                                                                                                                                                           String intervals,
                                                                                                                                                                           @QueryParam(value="filters")
                                                                                                                                                                           String filters,
                                                                                                                                                                           @Context
                                                                                                                                                                           javax.ws.rs.core.UriInfo uriInfo,
                                                                                                                                                                           @Context
                                                                                                                                                                           javax.ws.rs.container.ContainerRequestContext containerRequestContext)

Get constrained logical table details for a grain-specific logical table.

An example query to this endpoint is

     
     /tables/myTable/week/dim1/dim2?metrics=myMetric&filters=dim3|id-in[foo,bar]
     
 

TODO: filter physical tables by interval and filter clause, i.e. "filters=dim3|id-in[foo,bar]". This query has an optional list of path separated grouping dimensions, an optional list of metrics, and an optional filter clause.

The query would result in a table response with the metrics, dimensions, and available intervals restricted down to the set of items that are still "reachable" given the constraints in the query (dim1, dim2, dim3, and myMetric, in this case). So, if the table normally indicates that dim7 is one of it's dimensions, but there isn't a backing physical table for myTable that has dim1, dim2, dim3, and myMetric along with dim7, then dim7 would not be in the dimension list returned in the response.

Parameters:

tableName - Logical table name

granularity - Logical table grain (part of the logical table ID)

dimensions - Requested list of dimensions (e.g. dim1, dim2)

metrics - Requested list of metrics (e.g. myMetric)

intervals - Requested list of intervals. This is a required

filters - Requested list of filters (e.g. dim3|id-in[foo,bar])

uriInfo - UriInfo of the request

containerRequestContext - The context of data provided by the Jersey container for this request

Returns:

The grain-specific logical table See getLogicalTableFullView(TablesApiRequestImpl, UriInfo)

getTablesFullView

@Timed
public javax.ws.rs.core.Response getTablesFullView(@DefaultValue(value="") @NotNull @QueryParam(value="perPage")
                                                          String perPage,
                                                          @DefaultValue(value="") @NotNull @QueryParam(value="page")
                                                          String page,
                                                          @Context
                                                          javax.ws.rs.core.UriInfo uriInfo,
                                                          @Context
                                                          javax.ws.rs.container.ContainerRequestContext containerRequestContext)

Get all the tables full view.

Parameters:

perPage - number of values to return per page

page - the page to start from

uriInfo - UriInfo of the request

containerRequestContext - The context of data provided by the Jersey container for this request

Returns:

full view of the tables

getLogicalTableListSummaryView

public static Set<Map<String,String>> getLogicalTableListSummaryView(Collection<LogicalTable> logicalTables,
                                                                     javax.ws.rs.core.UriInfo uriInfo)

Get the summary list view of the logical tables.

Parameters:

logicalTables - Collection of logical tables to get the summary view for

uriInfo - UriInfo of the request

Returns:

Summary list view of the logical tables

getLogicalAll

public static Set<Map<String,Object>> getLogicalAll(Collection<LogicalTable> logicalTables,
                                                    javax.ws.rs.core.UriInfo uriInfo)

Get the summary list view of the logical tables.

Parameters:

logicalTables - Collection of logical tables to get the summary view for

uriInfo - UriInfo of the request

Returns:

Summary list view of the logical tables

getLogicalTableSummaryView

public static Map<String,String> getLogicalTableSummaryView(LogicalTable logicalTable,
                                                            javax.ws.rs.core.UriInfo uriInfo)

Get the summary view of the logical table.

Parameters:

logicalTable - Logical table to get the view of

uriInfo - UriInfo of the request

Returns:

Summary view of the logical table

getLogicalTableFullView

@Deprecated
protected static Map<String,Object> getLogicalTableFullView(LogicalTable logicalTable,
                                                                        javax.ws.rs.core.UriInfo uriInfo)

Deprecated. In order to display constrained data availability in table resource, this method needs to accept a TablesApiRequest as a parameter. Use getLogicalTableFullView(TablesApiRequestImpl, UriInfo) instead.

Get the full view of the logical table.

Parameters:

logicalTable - Logical table to get the view of

uriInfo - UriInfo of the request

Returns:

Full view of the logical table

getLogicalTableFullView

protected static Map<String,Object> getLogicalTableFullView(TablesApiRequestImpl tablesApiRequest,
                                                            javax.ws.rs.core.UriInfo uriInfo)

Get the full view of the logical table.

Parameters:

tablesApiRequest - Table API request that contains information about requested logical table and provides components for constructing a QueryPlanningConstraint, which will be used to filter and constrain table availabilities

uriInfo - UriInfo of the request

Returns:

Full view of the logical table

getLogicalTableUrl

public static String getLogicalTableUrl(LogicalTable logicalTable,
                                        javax.ws.rs.core.UriInfo uriInfo)

Get the URL of the logical table.

Parameters:

logicalTable - Logical table to get the URL of

uriInfo - URI Info for the request

Returns:

The absolute URL for the logical table

getResourceDictionaries

public ResourceDictionaries getResourceDictionaries()

Description copied from interface: BardConfigResources

The collection of resource dictionaries.

Specified by:

getResourceDictionaries in interface BardConfigResources

Returns:

A dictionary of resource dictionaries

getGranularityParser

public GranularityParser getGranularityParser()

Description copied from interface: BardConfigResources

A parser for string to granularities.

Specified by:

getGranularityParser in interface BardConfigResources

Returns:

A granularity parser

getFilterBuilder

public DruidFilterBuilder getFilterBuilder()

Filter builder isn't used in TablesServlet but is part of the configuration interface, so this is an empty implementation.

Specified by:

getFilterBuilder in interface BardConfigResources

Returns:

null because TablesApiRequest doesn't require it

getHavingApiGenerator

public HavingGenerator getHavingApiGenerator()

Having Api generator isn't used in TablesServlet but is part of the configuration interface, so this is an empty implementation.

Specified by:

getHavingApiGenerator in interface BardConfigResources

Returns:

null because TablesApiRequest doesn't require it

getSystemTimeZone

public org.joda.time.DateTimeZone getSystemTimeZone()

SystemTimeZone isn't used in TablesServlet but is part of the configuration interface, so this is an empty implementation.

Specified by:

getSystemTimeZone in interface BardConfigResources

Returns:

null because TablesApiRequest doesn't require it

getRequestMapper

public RequestMapper getRequestMapper()

getLogicalTableDictionary

public LogicalTableDictionary getLogicalTableDictionary()

Description copied from interface: BardConfigResources

The dictionary of logical tables.

Specified by:

getLogicalTableDictionary in interface BardConfigResources

Returns:

A logical table dictionary