Package org.apache.druid.sql.http

Class ObjectWriter

java.lang.Object

org.apache.druid.sql.http.ObjectWriter

All Implemented Interfaces:

Closeable, AutoCloseable, ResultFormat.Writer

public class ObjectWriter
extends Object
implements ResultFormat.Writer

Constructor Summary

Constructors

Constructor	Description
ObjectWriter(OutputStream outputStream, com.fasterxml.jackson.databind.ObjectMapper jsonMapper)

Method Summary

Modifier and Type	Method	Description
void	close()
void	writeHeader(org.apache.calcite.rel.type.RelDataType rowType, boolean includeTypes, boolean includeSqlTypes)
void	writeHeaderFromRowSignature(RowSignature signature, boolean includeTypes)
void	writeResponseEnd()	End of the response.
void	writeResponseStart()	Start of the response, called once per writer.
void	writeRowEnd()	End of each result row.
void	writeRowField(String name, Object value)	Field within a row.
void	writeRowStart()	Start of each result row.

Methods inherited from class java.lang.Object

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

Constructor Details

ObjectWriter

public ObjectWriter(OutputStream outputStream,
 com.fasterxml.jackson.databind.ObjectMapper jsonMapper)
             throws IOException

Throws:

IOException

Method Details

writeResponseStart

public void writeResponseStart()
                        throws IOException

Description copied from interface: ResultFormat.Writer

Start of the response, called once per writer.

Specified by:

writeResponseStart in interface ResultFormat.Writer

Throws:

IOException

writeResponseEnd

public void writeResponseEnd()
                      throws IOException

Description copied from interface: ResultFormat.Writer

End of the response. Must allow the user to know that they have read all data successfully.

Specified by:

writeResponseEnd in interface ResultFormat.Writer

Throws:

IOException

writeHeader

public void writeHeader(org.apache.calcite.rel.type.RelDataType rowType,
 boolean includeTypes,
 boolean includeSqlTypes)
                 throws IOException

Specified by:

writeHeader in interface ResultFormat.Writer

Throws:

IOException

writeHeaderFromRowSignature

public void writeHeaderFromRowSignature(RowSignature signature,
 boolean includeTypes)
                                 throws IOException

Specified by:

writeHeaderFromRowSignature in interface ResultFormat.Writer

Throws:

IOException

writeRowStart

public void writeRowStart()
                   throws IOException

Description copied from interface: ResultFormat.Writer

Start of each result row.

Specified by:

writeRowStart in interface ResultFormat.Writer

Throws:

IOException

writeRowField

public void writeRowField(String name,
 @Nullable
 Object value)
                   throws IOException

Description copied from interface: ResultFormat.Writer

Field within a row.

Specified by:

writeRowField in interface ResultFormat.Writer

Throws:

IOException

writeRowEnd

public void writeRowEnd()
                 throws IOException

Description copied from interface: ResultFormat.Writer

End of each result row.

Specified by:

writeRowEnd in interface ResultFormat.Writer

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException