com.aquafold.openapi.io

Interface AQDataWriter

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Subinterfaces:

AQExcelWriter, AQFormattedTextWriter, AQHtmlWriter, AQTableWriter, AQTextFileWriter, AQTextStringWriter, AQXmlWriter

public interface AQDataWriter
extends java.io.Closeable

Interface represents a row-based data stream.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the stream.
void	setColumnStructure(AQColumnStructure columnStructure) Set column structure for subsequent write(AQDataRow od) or writeColumnNames() operation if write(AQDataReader d) or write(AQDataSet dataSet) is not used.
void	write(AQDataReader d) Sequentially writes all data rows present in the specified input.
void	write(AQDataRow od) Writes a single data row to the output stream.
void	write(AQDataSet dataSet) Writes all data rows in the specified data set.
void	write(java.lang.Object x) Appends a single unformatted row which contains Object.toString() representation of the specified object.
void	writeColumnNames() Writes column names.

Method Detail

write

void write(AQDataRow od)
    throws java.lang.Exception

Writes a single data row to the output stream. The first written row determines the column structure of the resulting output. All subsequent calls must supply rows with the same column structure.

Parameters:

od - the data row

Throws:

java.lang.Exception - On error

write

void write(AQDataReader d)
    throws java.lang.Exception

Sequentially writes all data rows present in the specified input.

Parameters:

d - the data reader

Throws:

java.lang.Exception - On error

write

void write(AQDataSet dataSet)
    throws java.lang.Exception

Writes all data rows in the specified data set.

Parameters:

dataSet - the data set

Throws:

java.lang.Exception - On error

write

void write(java.lang.Object x)
    throws java.lang.Exception

Appends a single unformatted row which contains Object.toString() representation of the specified object.

Parameters:

x - the object

Throws:

java.lang.Exception - On error

writeColumnNames

void writeColumnNames()
               throws java.lang.Exception

Writes column names.

Throws:

java.lang.Exception - On error

setColumnStructure

void setColumnStructure(AQColumnStructure columnStructure)

Set column structure for subsequent write(AQDataRow od) or writeColumnNames() operation if write(AQDataReader d) or write(AQDataSet dataSet) is not used.

Parameters:

columnStructure - the column structure

close

void close()
    throws java.io.IOException

Closes the stream.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException - On error