RowReader Class Reference

RowReader interface. More...

#include <RowReader.h>

Inheritance diagram for RowReader:

Public Member Functions
virtual sparksee::gdb::bool_t	Reset () throw (sparksee::gdb::IOException) =0
	Moves the reader to the beginning.
virtual sparksee::gdb::bool_t	Read (sparksee::gdb::StringList &row) throw (sparksee::gdb::IOException) =0
	Reads the next row as a string array.
virtual sparksee::gdb::int32_t	GetRow () throw (sparksee::gdb::IOException) =0
	The row number for the current row.
virtual void	Close () throw (sparksee::gdb::IOException) =0
	Closes the reader.
virtual	~RowReader ()
	Destructor.

Protected Member Functions
	RowReader ()
	Empty constructor.

Detailed Description

RowReader interface.

Common interface for those readers which get the data as an string array.

It works as follows: perform as many read operations as necessary and call close once at the end. Once close is called no more read operations can be executed.

Check out the 'Data import' section in the SPARKSEE User Manual for more details on this.

Author

Sparsity Technologies http://www.sparsity-technologies.com

Constructor & Destructor Documentation

RowReader()

RowReader::RowReader ( )

inlineprotected

Empty constructor.

Protected because no one should instantiate a RowReader. Just inherited classes can use this empty constructor.

Member Function Documentation

Close()

virtual void RowReader::Close ( ) throw ( sparksee::gdb::IOException )

pure virtual

Closes the reader.

Exceptions

IOException

If the close fails.

Implemented in CSVReader.

References Close().

Referenced by Close().

GetRow()

virtual sparksee::gdb::int32_t RowReader::GetRow ( ) throw ( sparksee::gdb::IOException )

pure virtual

The row number for the current row.

Returns

The current row number; 0 if there is no current row.

Exceptions

IOException

If it fails.

Implemented in CSVReader.

References GetRow().

Referenced by GetRow().

Read()

virtual sparksee::gdb::bool_t RowReader::Read ( sparksee::gdb::StringList & row ) throw ( sparksee::gdb::IOException )

pure virtual

Reads the next row as a string array.

Parameters

row	[out] A string list with each comma-separated element as a separate entry.

Returns

Returns true if a row had been read or false otherwise.

Exceptions

IOException

If bad things happen during the read.

Implemented in CSVReader.

References Read().

Referenced by Read().

Reset()

virtual sparksee::gdb::bool_t RowReader::Reset ( ) throw ( sparksee::gdb::IOException )

pure virtual

Moves the reader to the beginning.

Restarts the reader.

Returns

true if the reader can be restarted, false otherwise.

Exceptions

IOException

If bad things happen during the restart.

Implemented in CSVReader.

---

The documentation for this class was generated from the following file:

• RowReader.h