com.yahoo.bard.webservice.web.endpoints

Class DimensionsServlet

java.lang.Object

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

com.yahoo.bard.webservice.web.endpoints.DimensionsServlet

@Path(value="/dimensions")
 @Singleton
public class DimensionsServlet
extends EndpointServlet

Resource code for dimension resource endpoints.

Field Summary

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

objectMappers

Constructor Summary

Constructors

Constructor and Description
DimensionsServlet(DimensionDictionary dimensionDictionary, LogicalTableDictionary logicalTableDictionary, RequestMapper requestMapper, ObjectMappersSuite objectMappers, ResponseFormatResolver formatResolver) Constructor.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getAllDimensions(String perPage, String page, String format, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.container.ContainerRequestContext containerRequestContext) Get all the dimensions as a summary list.
javax.ws.rs.core.Response	getDimension(String dimensionName, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.container.ContainerRequestContext containerRequestContext) Get the details of a dimension.
static Set<Map<String,String>>	getDimensionFieldListSummaryView(Collection<DimensionField> dimensionFields) Deprecated. should be private, now the internal usage need is gone, will deprecate in case someone is using it
static Map<String,String>	getDimensionFieldSummaryView(DimensionField dimensionField) Deprecated. should be private, now the internal usage need is gone, will deprecate in case someone is using it
static Map<String,Object>	getDimensionFullView(Dimension dimension, LogicalTableDictionary logicalTableDictionary, javax.ws.rs.core.UriInfo uriInfo) Get the full view of the dimension.
static LinkedHashSet<Map<String,Object>>	getDimensionListSummaryView(Iterable<Dimension> dimensions, javax.ws.rs.core.UriInfo uriInfo) Get the summary list view of the dimensions.
javax.ws.rs.core.Response	getDimensionRows(String dimensionName, String filterQuery, String perPage, String page, String format, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.container.ContainerRequestContext containerRequestContext) Endpoint to get values of a dimension.
static Map<String,Object>	getDimensionSummaryView(Dimension dimension, javax.ws.rs.core.UriInfo uriInfo) Get the summary view of the dimension.
static String	getDimensionUrl(Dimension dimension, javax.ws.rs.core.UriInfo uriInfo) Get the URL of the dimension.
static String	getDimensionValuesUrl(Dimension dimension, javax.ws.rs.core.UriInfo uriInfo) Get the URL of the dimension values collection.

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

Constructor Detail

DimensionsServlet

@Inject
public DimensionsServlet(DimensionDictionary dimensionDictionary,
                                 LogicalTableDictionary logicalTableDictionary,
                                 @Named(value="dimensionsApiRequestMapper")
                                 RequestMapper requestMapper,
                                 ObjectMappersSuite objectMappers,
                                 ResponseFormatResolver formatResolver)

Constructor.

Parameters:

dimensionDictionary - All dimensions

logicalTableDictionary - All logical tables

requestMapper - Mapper to change the API request if needed

objectMappers - JSON tools

formatResolver - The formatResolver for determining correct response format

Method Detail

getAllDimensions

@GET
 @Timed
public javax.ws.rs.core.Response getAllDimensions(@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 dimensions as a summary list.

Parameters:

perPage - number of values to return per page

page - the page to start from

format - the format to use for the response

uriInfo - UriInfo of the request

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

Returns:

The list of dimensions

 {
     "dimensions":  <List of Dimension Summaries>
 }
 

See Also:

getDimensionListSummaryView(Iterable, UriInfo)

getDimension

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

Get the details of a dimension.

Parameters:

dimensionName - Dimension to get the details of

uriInfo - UriInfo of the request

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

Returns:

Full view of the dimension

See Also:

getDimensionFullView(Dimension, LogicalTableDictionary, UriInfo)

getDimensionRows

@GET
 @Timed
 @Path(value="/{dimensionName}/values")
public javax.ws.rs.core.Response getDimensionRows(@PathParam(value="dimensionName")
                                                                                                       String dimensionName,
                                                                                                       @QueryParam(value="filters")
                                                                                                       String filterQuery,
                                                                                                       @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)

Endpoint to get values of a dimension.

Parameters:

dimensionName - The dimension

filterQuery - The filters

page - The page number

perPage - The number of rows per page

format - The format of the response

uriInfo - The injected UriInfo

containerRequestContext - The injected request context

Returns:

OK(200) else Bad Request(400). Response format: JSON or CSV JSON Response:

 JSON:
 {
     "rows" : [
             { "id" : 1234, "description" : "description of dimension value" },
             { "id" : 1235, "description" : "another description" }
     ],
     "next" : "http:// <next_page_uri>/,
     "previous": "http:// <previous_page_uri>/
 }

 CSV:
     id, description
     1234, description of dimension value
     1235, another description
     ...
 

getDimensionListSummaryView

public static LinkedHashSet<Map<String,Object>> getDimensionListSummaryView(Iterable<Dimension> dimensions,
                                                                            javax.ws.rs.core.UriInfo uriInfo)

Get the summary list view of the dimensions.

Parameters:

dimensions - Collection of dimensions to get the summary view for

uriInfo - UriInfo of the request

Returns:

Summary list view of the dimensions

getDimensionSummaryView

public static Map<String,Object> getDimensionSummaryView(Dimension dimension,
                                                         javax.ws.rs.core.UriInfo uriInfo)

Get the summary view of the dimension.

Parameters:

dimension - Dimension to get the view of

uriInfo - UriInfo of the request

Returns:

Summary view of the dimension

getDimensionFullView

public static Map<String,Object> getDimensionFullView(Dimension dimension,
                                                      LogicalTableDictionary logicalTableDictionary,
                                                      javax.ws.rs.core.UriInfo uriInfo)

Get the full view of the dimension.

Parameters:

dimension - Dimension to get the view of

logicalTableDictionary - Logical Table Dictionary to look up the logical tables this dimension is on

uriInfo - UriInfo of the request

Returns:

Full view of the dimension

getDimensionFieldListSummaryView

@Deprecated
public static Set<Map<String,String>> getDimensionFieldListSummaryView(Collection<DimensionField> dimensionFields)

Deprecated. should be private, now the internal usage need is gone, will deprecate in case someone is using it

Get the summary list view of the dimension fields.

Parameters:

dimensionFields - Collection of dimension fields to get the summary view for

Returns:

Summary list view of the dimension fields

getDimensionFieldSummaryView

@Deprecated
public static Map<String,String> getDimensionFieldSummaryView(DimensionField dimensionField)

Deprecated. should be private, now the internal usage need is gone, will deprecate in case someone is using it

Get the summary view of the DimensionField.

Parameters:

dimensionField - Dimension Field to get the view of

Returns:

Summary view of the dimension field

getDimensionUrl

public static String getDimensionUrl(Dimension dimension,
                                     javax.ws.rs.core.UriInfo uriInfo)

Get the URL of the dimension.

Parameters:

dimension - Dimension to get the URL of

uriInfo - URI Info for the request

Returns:

The absolute URL for the dimension

getDimensionValuesUrl

public static String getDimensionValuesUrl(Dimension dimension,
                                           javax.ws.rs.core.UriInfo uriInfo)

Get the URL of the dimension values collection.

Parameters:

dimension - Dimension to get the URL of

uriInfo - URI Info for the request

Returns:

The absolute URL for the dimension