com.yahoo.bard.webservice.web

Class CsvResponse<T>

java.lang.Object

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

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

Type Parameters:

T - the type of the raw data

All Implemented Interfaces:

ResponseStream

public class CsvResponse<T>
extends AbstractResponse<T>

Formats data of a response as CSV.

Field Summary

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

entries, objectMappers, pages, uriInfo

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	write(OutputStream os) Writes CSV 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

CsvResponse

public CsvResponse(Stream<T> entries,
                   Pagination<?> pages,
                   javax.ws.rs.core.UriInfo uriInfo,
                   List<String> columnNames,
                   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.

columnNames - The CSV header. If null this class will try to extract the header given that the entries represent maps with strings as keys.

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

Method Detail

write

public void write(OutputStream os)
           throws IOException

Writes CSV response.

Specified by:

write in class AbstractResponse<T>

Parameters:

os - The output stream to write document bytes to

Throws:

IOException - If an error occurs while writing this stream