com.aquafold.openapi.io

Interface AQDataReader

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Subinterfaces:

AQExcelReader, AQFormattedTextReader, AQHttpLogReader, AQResultSet, AQTextFileReader, AQTextStringReader

public interface AQDataReader
extends java.io.Closeable

A reader which extracts data into a sequence of AQDataRow objects.

Method Summary

Modifier and Type	Method and Description
void	close() Use this method to release critical resources (e.g.
AQColumnStructure	getColumnStructure() To get the reader column structure.
AQDataSet	read() Sequentially reads the input stream into an in-memory data set.
AQDataRow	readNextRow() Returns a next data row or null if no more rows is available, or end of file is reached.

Method Detail

readNextRow

AQDataRow readNextRow()
               throws java.lang.Exception

Returns a next data row or null if no more rows is available, or end of file is reached.

Returns:

the data row

Throws:

java.lang.Exception - on error

close

void close()
    throws java.io.IOException

Use this method to release critical resources (e.g. database, file) immediately instead of waiting for this to happen when it's automatically closed. It is generally good practice to release resources as soon as you are finished with them.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException - if an I/O error occurs

read

AQDataSet read()
        throws java.lang.Exception

Sequentially reads the input stream into an in-memory data set.

Returns:

the data set

Throws:

java.lang.Exception - On Error.

getColumnStructure

AQColumnStructure getColumnStructure()

To get the reader column structure.

Example: var r = aqua.io.newTextReader(); print(r.columnStructure); r.columnNames = ['a','b','c']; print(r.columnStructure);

Returns:

An AQColumnStructure object; null if column structure is not available.