RowReader Class Reference
[Io]

RowReader interface. More...

Inheritance diagram for RowReader:

Inheritance graph

List of all members.

Public Member Functions

virtual sparksee::gdb::bool_t Reset ()=0 throw (sparksee::gdb::IOException)
 Moves the reader to the beginning.
virtual sparksee::gdb::bool_t Read (sparksee::gdb::StringList &row)=0 throw (sparksee::gdb::IOException)
 Reads the next row as a string array.
virtual sparksee::gdb::int32_t GetRow ()=0 throw (sparksee::gdb::IOException)
 The row number for the current row.
virtual void Close ()=0 throw (sparksee::gdb::IOException)
 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 (  )  [inline, protected]

Empty constructor.

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


Member Function Documentation

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.

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.

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.

virtual void RowReader::Close (  )  throw (sparksee::gdb::IOException) [pure virtual]

Closes the reader.

Exceptions:
IOException If the close fails.

Implemented in CSVReader.


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

Generated on Fri Sep 12 13:36:40 2014 for Sparksee by  doxygen 1.5.6