Sparksee  5.2.0
STSResultSet Class Reference

ResultSet class. More...

Inheritance diagram for STSResultSet:
Inheritance graph
Collaboration diagram for STSResultSet:
Collaboration graph

Instance Methods

(int) - getNumColumns
 Gets the number of columns.
 
(NSString *) - getColumnName:
 Gets the name for the given column.
 
(int) - getColumnIndex:
 Gets the column index for the given column name.
 
(enum STSDataType) - getColumnDataType:
 Gets the datatype for the given column.
 
(BOOL) - next
 Fetches the next row.
 
(void) - getColumnWithValue:value:
 Gets the value for the given column.
 
(STSValue *) - getColumn:
 Gets the value for the given column.
 
(void) - rewind
 Positions the cursor before the first row.
 
(NSString *) - getJSON:
 Returns rows in JSON format.
 
(void) - close
 Closes the ResultSet instance.
 
(BOOL) - isClosed
 Check if the ResultSet instance is closed.
 

Detailed Description

ResultSet class.

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

Method Documentation

- (STSValue*) getColumn: (int)  index

Gets the value for the given column.

QueryExceptionIf a database access error occurs.

Parameters
index[in] Column index.
Returns
The Value of the given column.
- (enum STSDataType) getColumnDataType: (int)  index

Gets the datatype for the given column.

Parameters
index[in] Column index.
Returns
DataType for the given column.
- (int) getColumnIndex: (NSString *)  name

Gets the column index for the given column name.

Parameters
name[in] Column name.
Returns
Column index.
- (NSString*) getColumnName: (int)  index

Gets the name for the given column.

Parameters
index[in] Column index.
Returns
Column name.
- (void) getColumnWithValue: (int)  index
value: (STSValue *)  value 

Gets the value for the given column.

QueryExceptionIf a database access error occurs.

Parameters
index[in] Column index.
value[in|out] Value.
- (NSString*) getJSON: (int)  rows

Returns rows in JSON format.

Rows are returned from the current position.

Parameters
rows[in] Maximum number of rows
Returns
JSON representation of the next <rows> rows in the resultset
- (int) getNumColumns

Gets the number of columns.

Columns are in the range [0...COLUMNS).

Returns
The number of columns.
- (BOOL) next

Fetches the next row.

A ResultSet cursor is initially positioned before the first row; the first call to the method "Next" makes the first row the current row; the second call makes the second row the current row, and so on.

QueryExceptionIf a database access error occurs.

Returns
TRUE if the next row has been successfully fetched, FALSE otherwise.

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