aboutsummaryrefslogtreecommitdiffstats
path: root/Frameworks/PostgresKit/Source/PGPostgresTypeHandlerProtocol.h
diff options
context:
space:
mode:
Diffstat (limited to 'Frameworks/PostgresKit/Source/PGPostgresTypeHandlerProtocol.h')
-rw-r--r--Frameworks/PostgresKit/Source/PGPostgresTypeHandlerProtocol.h78
1 files changed, 78 insertions, 0 deletions
diff --git a/Frameworks/PostgresKit/Source/PGPostgresTypeHandlerProtocol.h b/Frameworks/PostgresKit/Source/PGPostgresTypeHandlerProtocol.h
new file mode 100644
index 00000000..5c8dab83
--- /dev/null
+++ b/Frameworks/PostgresKit/Source/PGPostgresTypeHandlerProtocol.h
@@ -0,0 +1,78 @@
+//
+// $Id: PGPostgresTypeHandlerProtocol.h 3850 2012-09-13 09:05:50Z stuart02 $
+//
+// PGPostgresTypeHandlerProtocol.h
+// PostgresKit
+//
+// Copyright (c) 2008-2009 David Thorpe, djt@mutablelogic.com
+//
+// Forked by the Sequel Pro Team on July 22, 2012.
+//
+// Licensed under the Apache License, Version 2.0 (the "License"); you may not
+// use this file except in compliance with the License. You may obtain a copy of
+// the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+// License for the specific language governing permissions and limitations under
+// the License.
+
+@class PGPostgresConnection;
+
+/**
+ * @protocol PGPostgresTypeHandlerProtocol
+ */
+@protocol PGPostgresTypeHandlerProtocol
+
+/**
+ * @property The row within the result the handler is being queried about.
+ */
+@property (readwrite, assign) NSUInteger row;
+
+/**
+ * @property The column within the result the handler is being queried about.
+ */
+@property (readwrite, assign) NSUInteger column;
+
+/**
+ * @property The type of data within the result the handler is being queried about.
+ */
+@property (readwrite, assign) PGPostgresOid type;
+
+/**
+ * @property The result the handler is being asked to operate on.
+ */
+@property (readwrite, assign) const PGresult *result;
+
+/**
+ * The remote type values handled by this class (terminated by 0).
+ *
+ * @return The remote types as an array of PGPostgresOid's.
+ */
+- (PGPostgresOid *)remoteTypes;
+
+/**
+ * What is the native class this class handles.
+ *
+ * @return The native class.
+ */
+- (Class)nativeClass;
+
+/**
+ * Any aliases that the native class is known by.
+ *
+ * @return An of aliases as strings or nil if none.
+ */
+- (NSArray *)classAliases;
+
+/**
+ * Convert the value at the specified row and column in the supplied result to a native object.
+ *
+ * @return An object represenation of the data.
+ */
+- (id)objectFromResult;
+
+@end