baseten / Sources / PGTSResultSet.h

//
// PGTSResultSet.h
// BaseTen
//
// Copyright (C) 2006 Marko Karppinen & Co. LLC.
//
// Before using this software, please review the available licensing options
// by visiting http://www.karppinen.fi/baseten/licensing/ or by contacting
// us at sales@karppinen.fi. Without an additional license, this software
// may be distributed only in compliance with the GNU General Public License.
//
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License, version 2.0,
// as published by the Free Software Foundation.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
//
// $Id$
//

#import <Foundation/Foundation.h>
#import <BaseTen/postgresql/libpq-fe.h>


@class PGTSConnection;


@interface PGTSResultSet : NSObject
{
}
+ (id) resultWithPGresult: (const PGresult *) aResult connection: (PGTSConnection *) aConnection;
+ (NSError *) errorForPGresult: (const PGresult *) result;
@end


@interface PGTSResultSet (Implementation)
- (id) initWithPGResult: (const PGresult *) aResult connection: (PGTSConnection *) aConnection;
- (PGTSConnection *) connection;
- (BOOL) querySucceeded;
- (ExecStatusType) status;
- (BOOL) advanceRow;
- (id) valueForFieldAtIndex: (int) columnIndex row: (int) rowIndex;
- (id) valueForFieldAtIndex: (int) columnIndex;
- (id) valueForKey: (NSString *) aName row: (int) rowIndex;
- (BOOL) setClass: (Class) aClass forKey: (NSString *) aName;
- (BOOL) setClass: (Class) aClass forFieldAtIndex: (int) fieldIndex;
- (PGresult *) PGresult;
- (NSArray *) resultAsArray;

- (BOOL) isAtEnd;
- (int) currentRow;
- (id) currentRowAsObject;
- (void) setRowClass: (Class) aClass;
- (void) setValuesFromRow: (int) rowIndex target: (id) targetObject nullPlaceholder: (id) nullPlaceholder;
- (NSDictionary *) currentRowAsDictionary;
- (void) goBeforeFirstRow;
- (BOOL) goToRow: (int) aRow;
- (void) goBeforeFirstRowWithValue: (id) value forKey: (NSString *) columnName;
- (int) count;
- (unsigned long long) numberOfRowsAffectedByCommand;
- (BOOL) advanceRow;
- (NSInteger) identifier;
- (void) setIdentifier: (NSInteger) anIdentifier;
- (NSError *) error;
- (NSString *) errorString;
- (void) setUserInfo: (id) userInfo;
- (id) userInfo;

- (void) setDeterminesFieldClassesAutomatically: (BOOL) aBool;
@end


@protocol PGTSResultRowProtocol <NSObject>
/** 
 * \internal
 * \brief Called when a new result set and row index are associated with the target 
 */
- (void) PGTSSetRow: (int) row resultSet: (PGTSResultSet *) res;
@end
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.