com.yahoo.bard.webservice.web

Class CsvResponseWriter

java.lang.Object

com.yahoo.bard.webservice.web.CsvResponseWriter

All Implemented Interfaces:

ResponseWriter

public class CsvResponseWriter
extends Object
implements ResponseWriter

Serializer for CSV format.

Constructor Summary

Constructors

Constructor and Description
CsvResponseWriter(ObjectMappersSuite objectMappers) Constructor.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.dataformat.csv.CsvSchema	buildCsvHeaders(ResponseData responseData) Builds the CSV header.
void	write(ApiRequest request, ResponseData responseData, OutputStream outputStream) Serializes the ResultSet (pulled from the ResponseData) and any desired metadata and adds it to the specified output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvResponseWriter

public CsvResponseWriter(ObjectMappersSuite objectMappers)

Constructor.

Parameters:

objectMappers - ObjectMappersSuite object needed for CsvMapper

Method Detail

write

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

Description copied from interface: ResponseWriter

Serializes the ResultSet (pulled from the ResponseData) and any desired metadata and adds it to the specified output stream.

Specified by:

write in interface ResponseWriter

Parameters:

request - ApiRequest object with all the associated info in it

responseData - Data object containing all the result information

outputStream - OutputStream

Throws:

IOException - if a problem is encountered writing to the OutputStream

buildCsvHeaders

public com.fasterxml.jackson.dataformat.csv.CsvSchema buildCsvHeaders(ResponseData responseData)

Builds the CSV header.

Parameters:

responseData - Data object containing all the result information

Returns:

The CSV schema with the header