com.yahoo.bard.webservice.web

Class JsonResponse<T>

java.lang.Object

com.yahoo.bard.webservice.web.AbstractResponse<T>

com.yahoo.bard.webservice.web.JsonResponse<T>

Type Parameters:

T - the type of the raw data

All Implemented Interfaces:

ResponseStream

public class JsonResponse<T>
extends AbstractResponse<T>

Formats data of a response as JSON.

Field Summary

Fields inherited from class com.yahoo.bard.webservice.web.AbstractResponse

entries, objectMappers, pages, uriInfo

Constructor Summary

Constructors

Constructor and Description
JsonResponse(Stream<T> entries, Pagination<?> pages, javax.ws.rs.core.UriInfo uriInfo, String responseName, ObjectMappersSuite objectMappers) Constructor.

Method Summary

Modifier and Type	Method and Description
void	write(OutputStream os) Generates JSON response.

Methods inherited from class com.yahoo.bard.webservice.web.AbstractResponse

addLink, addLink, addLink, addLinks, addLinks, getResponseStream, writeMetaObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JsonResponse

public JsonResponse(Stream<T> entries,
                    Pagination<?> pages,
                    javax.ws.rs.core.UriInfo uriInfo,
                    String responseName,
                    ObjectMappersSuite objectMappers)

Constructor.

Parameters:

entries - The data entries to generate the response for

pages - The paginated set of results containing the pages being linked to.

uriInfo - UriInfo to generate the URL for the page links

responseName - Top level name of json object described the response data.

objectMappers - Suite of Object Mappers to use when serializing the response

Method Detail

write

public void write(OutputStream os)
           throws IOException

Generates JSON response.

format:

 {
     "responseName" : [
         {
             "id" : 1234,
             "description" : "description of dimension value",
         },
         {
             "id" : 1235,
             "description" : "another description",
         }
     ],
     "meta" : {
         "pagination" : {
             "paginationLinks" : {
                 "first" : "http://first_page_uri/", (optional)
                 "last" : "http://last_page_uri/", (optional)
                 "next" : "http://next_page_uri/", (optional)
                 "previous": "http://previous_page_uri/" (optional)
             },
             "currentPage": number of current page,
             "rowsPerPage": number of rows per page,
             "numberOfResults": number of results
         }
     }
 }

Specified by:

write in class AbstractResponse<T>

Parameters:

os - Output stream to write to

Throws:

IOException - if there's a problem writing to the stream