com.yahoo.bard.webservice.web

Class JsonResponseWriter

java.lang.Object

com.yahoo.bard.webservice.web.JsonAndJsonApiResponseWriter

com.yahoo.bard.webservice.web.JsonResponseWriter

All Implemented Interfaces:

ResponseWriter

public class JsonResponseWriter
extends JsonAndJsonApiResponseWriter

Serializer for Json format. The response when serialized is in the following format

 
 {
     "metricColumn1Name" : metricValue1,
     "metricColumn2Name" : metricValue2,
     .
     .
     .
     "dimensionColumnName" : "dimensionRowDesc",
     "dateTime" : "formattedDateTimeString"
 },
   "linkName1" : "http://uri1",
   "linkName2": "http://uri2",
   ...
   "linkNameN": "http://uriN"
 
 

Where "linkName1" ... "linkNameN" are the N keys in paginationLinks, and "http://uri1" ... "http://uriN" are the associated URI's.

Constructor Summary

Constructors

Constructor and Description
JsonResponseWriter(ObjectMappersSuite objectMappers) Constructor.

Method Summary

Modifier and Type	Method and Description
void	write(ApiRequest request, ResponseData responseData, OutputStream os) Writes JSON response.

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

getObjectMappers, writeMetaObject

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonResponseWriter

public JsonResponseWriter(ObjectMappersSuite objectMappers)

Constructor.

Parameters:

objectMappers - ObjectMappersSuite object needed for JsonFactory

Method Detail

write

public void write(ApiRequest request,
                  ResponseData responseData,
                  OutputStream os)
           throws IOException

Writes JSON response.

Parameters:

request - ApiRequest object with all the associated info in it

responseData - Data object containing all the result information

os - OutputStream

Throws:

IOException - if a problem is encountered writing to the OutputStream