Sparksee  5.2.0
STSRowReader Class Reference

RowReader interface. More...

Inheritance diagram for STSRowReader:
Inheritance graph
Collaboration diagram for STSRowReader:
Collaboration graph

Instance Methods

(BOOL) - reset
 Moves the reader to the beginning.
 
(BOOL) - read:
 Reads the next row as a string array.
 
(int) - getRow
 The row number for the current row.
 
(void) - close
 Closes the reader.
 

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

Method Documentation

- (void) close

Closes the reader.

Exceptions
System.IO.IOExceptionIf the close fails.

Implemented in STSCSVReader.

- (int) getRow

The row number for the current row.

Returns
The current row number; 0 if there is no current row.
Exceptions
System.IO.IOExceptionIf it fails.

Implemented in STSCSVReader.

- (BOOL) read: (STSStringList *)  row

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
System.IO.IOExceptionIf bad things happen during the read.

Implemented in STSCSVReader.

- (BOOL) reset

Moves the reader to the beginning.

Restarts the reader.

Returns
true if the reader can be restarted, false otherwise.
Exceptions
System.IO.IOExceptionIf bad things happen during the restart.

Implemented in STSCSVReader.


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