< PLResultSet > Protocol Reference

Represents a set of results returned by an SQL query. More...

#import <PLResultSet.h>

List of all members.

Public Member Functions
(BOOL)	- next
	Move the result cursor to the next available row.
(PLResultSetStatus)	- nextAndReturnError:
	Move the result cursor to the next available row.
(void)	- close
	Close the result set, and return any held database resources.
(int)	- columnIndexForName:
	Map the given column name to a column index.
(int32_t)	- intForColumnIndex:
	Return the integer value of the given column index from the current result row.
(int32_t)	- intForColumn:
	Return the integer value of the named column from the current result row.
(NSString *)	- stringForColumnIndex:
	Return the string value of the given column index from the current result row.
(NSString *)	- stringForColumn:
	Return the string value of the named column from the current result row.
(int64_t)	- bigIntForColumnIndex:
	Returns the 64 bit big integer (long) value of the given column index the current result row.
(int64_t)	- bigIntForColumn:
	Returns the 64 bit big integer (long) value of the named column from the current result row.
(BOOL)	- isNullForColumnIndex:
	Returns YES if the value of the given column index is NULL, NO otherwise.
(BOOL)	- isNullForColumn:
	Returns YES if the value of the named column is NULL, NO otherwise.
(BOOL)	- boolForColumn:
	Returns the BOOL value of the named column from the current result row.
(BOOL)	- boolForColumnIndex:
	Returns the BOOL value of the given column index from the current result row.
(float)	- floatForColumn:
	Returns the float value of the named column from the current result row.
(float)	- floatForColumnIndex:
	Returns the float value of the given column index from the current result row.
(double)	- doubleForColumn:
	Returns the double value of the named column from the current result row.
(double)	- doubleForColumnIndex:
	Returns the double value of the given column index from the current result row.
(NSDate *)	- dateForColumn:
	Returns the NSDate value of the named column from the current result row.
(NSDate *)	- dateForColumnIndex:
	Returns the NSDate value of the given column index from the current result row.
(NSData *)	- dataForColumn:
	Returns the NSData value of the named column from the current result row.
(NSData *)	- dataForColumnIndex:
	Returns the NSData value of the given column index from the current result row.
(id)	- objectForColumn:
	Return the value of the named column as a Foundation Objective-C object, using the database driver's built-in SQL and Foundation data-type mappings.
(id)	- objectForColumnIndex:
	Return the value of the named column as a Foundation Objective-C object, using the database driver's built-in SQL and Foundation data-type mappings.

---

Detailed Description

Represents a set of results returned by an SQL query.

Thread Safety

PLResultSet instances implement no locking and must not be shared between threads without external synchronization.

---

Member Function Documentation

- (int64_t) bigIntForColumn:

(NSString *)

columnName

Returns the 64 bit big integer (long) value of the named column from the current result row.

Will throw NSException if the column name is unknown, or if the column value is NULL.

- (int64_t) bigIntForColumnIndex:

(int)

columnIndex

Returns the 64 bit big integer (long) value of the given column index the current result row.

Will throw NSException if the column index is out of range, or if the column value is NULL.

- (BOOL) boolForColumn:

(NSString *)

columnName

Returns the BOOL value of the named column from the current result row.

Will throw NSException if the column name is unknown, or if the column value is NULL.

- (BOOL) boolForColumnIndex:

(int)

columnIndex

Returns the BOOL value of the given column index from the current result row.

Will throw NSException if the column index is out of range, or if the column value is NULL.

- (void) close

Close the result set, and return any held database resources.

After calling, no further PLResultSet methods may be called on the instance.

As PLResultSet objects may be placed into autorelease pools, with indeterminate release of database resources, this method should be used to ensure that the database connection remains usable once finished with a result set.

Failure to call close will not result in any memory leaks, but may prevent further use of the database connection (until the result set is released).

- (int) columnIndexForName:

(NSString *)

name

Map the given column name to a column index.

Will throw NSException if the column name is unknown.

Parameters:

name

Name of the column.

Returns:

Returns the index of the column name, or throws an NSException if the column can not be found.

- (NSData *) dataForColumn:

(NSString *)

columnName

Returns the NSData value of the named column from the current result row.

Will throw NSException if the column name is unknown, or if the column value is NULL.

- (NSData *) dataForColumnIndex:

(int)

columnIndex

Returns the NSData value of the given column index from the current result row.

Will throw NSException if the column index is out of range, or if the column value is NULL.

- (NSDate *) dateForColumn:

(NSString *)

columnName

Returns the NSDate value of the named column from the current result row.

Will throw NSException if the column name is unknown, or if the column value is NULL.

- (NSDate *) dateForColumnIndex:

(int)

columnIndex

Returns the NSDate value of the given column index from the current result row.

Will throw NSException if the column index is out of range, or if the column value is NULL.

- (double) doubleForColumn:

(NSString *)

columnName

Returns the double value of the named column from the current result row.

Will throw NSException if the column name is unknown, or if the column value is NULL.

- (double) doubleForColumnIndex:

(int)

columnIndex

Returns the double value of the given column index from the current result row.

Will throw NSException if the column index is out of range, or if the column value is NULL.

- (float) floatForColumn:

(NSString *)

columnName

Returns the float value of the named column from the current result row.

Will throw NSException if the column name is unknown, or if the column value is NULL.

- (float) floatForColumnIndex:

(int)

columnIndex

Returns the float value of the given column index from the current result row.

Will throw NSException if the column index is out of range, or if the column value is NULL.

- (int32_t) intForColumn:

(NSString *)

columnName

Return the integer value of the named column from the current result row.

Will throw NSException if the column name is unknown, or if the column value is NULL.

- (int32_t) intForColumnIndex:

(int)

columnIdx

Return the integer value of the given column index from the current result row.

Will throw NSException if the column index is out of range, or if the column value is NULL.

- (BOOL) isNullForColumn:

(NSString *)

columnName

Returns YES if the value of the named column is NULL, NO otherwise.

Will throw NSException if the column index is out of range.

- (BOOL) isNullForColumnIndex:

(int)

columnIndex

Returns YES if the value of the given column index is NULL, NO otherwise.

Will throw NSException if the column index is out of range.

- (BOOL) next

Move the result cursor to the next available row.

If no further rows are available or an error occurs, returns NO.

Returns:

YES if the cursor was moved to the next row, NO if no further rows were available or an error has occured.

Deprecated:

This method fails to differentiate between end of rows and an error condition. New code should be written to use -[PLResultSet nextAndReturnError:].

- (PLResultSetStatus) nextAndReturnError:

(NSError **)

outError

Move the result cursor to the next available row.

If no further rows are available or an error occurs, returns NO.

Parameters:

outError

A pointer to an NSError object variable. If an error occurs, this pointer will contain an error object indicating why the statement could not be executed. If no error occurs, this parameter's value will not be modified. You may specify NULL for this parameter, and no error information will be provided.

Returns:

Returns PLResultSetStatusRow if the next row is available, or PLResultSetStatusDone if no further rows are available. If an error occurs, PLResultSetStatusError will be returned.

- (id) objectForColumn:

(NSString *)

columnName

Return the value of the named column as a Foundation Objective-C object, using the database driver's built-in SQL and Foundation data-type mappings.

Will throw NSException if the column name is unknown, or if the column value is NULL.

Parameters:

columnName

Name of column value to return.

- (id) objectForColumnIndex:

(int)

columnIndex

Return the value of the named column as a Foundation Objective-C object, using the database driver's built-in SQL and Foundation data-type mappings.

Will throw NSException if the column index is out of range, or if the column value is NULL.

Parameters:

columnIndex

Index of column value to return.

- (NSString *) stringForColumn:

(NSString *)

columnName

Return the string value of the named column from the current result row.

Will throw NSException if the column name is unknown, or if the column value is NULL.

- (NSString *) stringForColumnIndex:

(int)

columnIndex

Return the string value of the given column index from the current result row.

Will throw NSException if the column index is out of range, or if the column value is NULL.

---

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

• Classes/PLResultSet.h