com.yahoo.bard.webservice.web

Class JsonAndJsonApiResponseWriter

java.lang.Object

com.yahoo.bard.webservice.web.JsonAndJsonApiResponseWriter

All Implemented Interfaces:

ResponseWriter

Direct Known Subclasses:

JsonApiResponseWriter, JsonResponseWriter

public abstract class JsonAndJsonApiResponseWriter
extends Object
implements ResponseWriter

An wrapper for JsonResponseWriter and JsonApiResponseWriter. Hosts functions and variables that are frequently used by the two children writers.

Constructor Summary

Constructors

Constructor and Description
JsonAndJsonApiResponseWriter(ObjectMappersSuite objectMappers) Constructor for both Json and JsonApi format serializer.

Method Summary

Modifier and Type	Method and Description
protected ObjectMappersSuite	getObjectMappers()
void	writeMetaObject(com.fasterxml.jackson.core.JsonGenerator generator, Collection<org.joda.time.Interval> missingIntervals, SimplifiedIntervalList volatileIntervals, ResponseData responseData) Builds the meta object for the JSON response.

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.ResponseWriter

write

Constructor Detail

JsonAndJsonApiResponseWriter

public JsonAndJsonApiResponseWriter(ObjectMappersSuite objectMappers)

Constructor for both Json and JsonApi format serializer.

Parameters:

objectMappers - ObjectMappersSuite object needed for JsonFactory

Method Detail

getObjectMappers

protected ObjectMappersSuite getObjectMappers()

writeMetaObject

public void writeMetaObject(com.fasterxml.jackson.core.JsonGenerator generator,
                            Collection<org.joda.time.Interval> missingIntervals,
                            SimplifiedIntervalList volatileIntervals,
                            ResponseData responseData)
                     throws IOException

Builds the meta object for the JSON response. The meta object is only built if there were missing intervals, or the results are being paginated.

Parameters:

generator - The JsonGenerator used to build the JSON response.

missingIntervals - The set of intervals that do not contain data.

volatileIntervals - The set of intervals that have volatile data.

responseData - The ResponseData object containing pagination and paginationLinks.

Throws:

IOException - if the generator throws an IOException.