Changeset 77

Show
Ignore:
Timestamp:
05/16/07 10:30:13 (6 years ago)
Author:
jjr8
Message:

* Added DatabaseAccess? package.
* Fixed bug in ArcGIS interop that prevented GeoEco? from passing back complex objects returned by the geoprocessor.
* Added logger for DatabaseAccess?.
* Fixed bug in ClassMetadata?.ValidateMethodInvocation? that prevented it from being called properly by the base class implementation of a method that was overriden by the derived class.
* Added Metadata.py helper functions for copying properties, arguments and results.
* Deleted the obsolete Tools package.
* Added NoneTypeMetadata? to Types.py to represent parameters that must be None.

Location:
MGET/Branches/Jason
Files:
143 added
1 removed
30 modified

Legend:

Unmodified
Added
Removed
  • MGET/Branches/Jason/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Class_GeoEco.DatabaseAccess.DatabaseConnection.html

    r76 r77  
    44            td.metadataTitle { font-size: 80%; font-weight: bold; font-family: avantgarde, sans-serif; } 
    55            td.metadataValue { padding-left: 0.5em; } 
    6           </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="GeoEco.DatabaseAccess Module" href="Module_GeoEco.DatabaseAccess.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="Module Index" href="Module_GeoEco.DatabaseAccess.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="DeleteCursorClass Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.DeleteCursorClass.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Module_GeoEco.DatabaseAccess.html?format=raw">GeoEco.DatabaseAccess Module</a> <b class="navlabel">Up:</b> <a class="sectref" href="Module_GeoEco.DatabaseAccess.html?format=raw">Module Index</a> <b class="navlabel">Next:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.DeleteCursorClass.html?format=raw">DeleteCursorClass Property</a> </div><hr /></div></div><h1><tt class="class">DatabaseConnection</tt> Class</h1><p>Represents a connection to a database.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Module:</td><td class="metadataValue"><tt class="module"><a href="Module_GeoEco.DatabaseAccess.html?format=raw">GeoEco.DatabaseAccess</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue"><span style="color: red;">Intended for GeoEco internal use only; not recommended for external callers</span></td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Not exposed as a COM class</td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Not exposed to ArcGIS</td></tr></table><h3>Read-only properties</h3><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.DatabaseConnection.DeleteCursorClass.html?format=raw">DeleteCursorClass</a></tt></b></dt><dd>Subclass of DeleteCursor that implements a delete cursor for this type of database connection.</dd></dl><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.DatabaseConnection.DeleteCursorSupported.html?format=raw">DeleteCursorSupported</a></tt></b></dt><dd>True if this connection supports delete cursors for deleting existing table rows.</dd></dl><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorClass.html?format=raw">InsertCursorClass</a></tt></b></dt><dd>Subclass of InsertCursor that implements an insert cursor for this type of database connection.</dd></dl><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorSupported.html?format=raw">InsertCursorSupported</a></tt></b></dt><dd>True if this connection supports insert cursors for appending rows to tables.</dd></dl><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.DatabaseConnection.OrderBySupported.html?format=raw">OrderBySupported</a></tt></b></dt><dd>True if the select, update, and delete cursors for this connection support the orderByFields and fieldOrders parameters.</dd></dl><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SelectCursorClass.html?format=raw">SelectCursorClass</a></tt></b></dt><dd>Subclass of SelectCursor that implements a select cursor for this type of database connection.</dd></dl><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SelectCursorSupported.html?format=raw">SelectCursorSupported</a></tt></b></dt><dd>True if this connection supports select cursors for reading rows from tables.</dd></dl><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SelectFieldsSupported.html?format=raw">SelectFieldsSupported</a></tt></b></dt><dd>True if the select cursors for this connection support the selectFields parameter.</dd></dl><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SpatialReferenceSupported.html?format=raw">SpatialReferenceSupported</a></tt></b></dt><dd>True if the cursors for this connection support the spatialReference parameter.</dd></dl><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.DatabaseConnection.UpdateCursorClass.html?format=raw">UpdateCursorClass</a></tt></b></dt><dd>Subclass of UpdateCursor that implements an update cursor for this type of database connection.</dd></dl><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.DatabaseConnection.UpdateCursorSupported.html?format=raw">UpdateCursorSupported</a></tt></b></dt><dd>True if this connection supports update cursors for changing the values of fields of existing table rows.</dd></dl><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.DatabaseConnection.WhereClauseSupported.html?format=raw">WhereClauseSupported</a></tt></b></dt><dd>True if the select, update, and delete cursors for this connection support the whereClause parameter.</dd></dl><h3>Instance methods</h3><dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><tt class="method"><a href="Method_GeoEco.DatabaseAccess.DatabaseConnection.OpenSelectCursor.html?format=raw">OpenSelectCursor</a></tt></b>(</td><td><var>table</var><big>[</big><var>, selectFields</var><big>[</big><var>, whereClause</var><big>[</big><var>, orderByFields</var><big>[</big><var>, fieldOrders</var><big>[</big><var>, spatialReference</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt><dd>Opens a cursor for selecting (reading) rows from a table.</dd></dl><h3>Remarks</h3><p>This base class class defines the properties and methods that all 
     6          </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="GeoEco.DatabaseAccess Module" href="Module_GeoEco.DatabaseAccess.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="Module Index" href="Module_GeoEco.DatabaseAccess.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="InsertCursorClass Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorClass.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Module_GeoEco.DatabaseAccess.html?format=raw">GeoEco.DatabaseAccess Module</a> <b class="navlabel">Up:</b> <a class="sectref" href="Module_GeoEco.DatabaseAccess.html?format=raw">Module Index</a> <b class="navlabel">Next:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorClass.html?format=raw">InsertCursorClass Property</a> </div><hr /></div></div><h1><tt class="class">DatabaseConnection</tt> Class</h1><p>Represents a connection to a database.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Module:</td><td class="metadataValue"><tt class="module"><a href="Module_GeoEco.DatabaseAccess.html?format=raw">GeoEco.DatabaseAccess</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue"><span style="color: red;">Intended for GeoEco internal use only; not recommended for external callers</span></td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Not exposed as a COM class</td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Not exposed to ArcGIS</td></tr></table><h3>Read-only properties</h3><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorClass.html?format=raw">InsertCursorClass</a></tt></b></dt><dd>Subclass of InsertCursor that implements an insert cursor for this type of database connection.</dd></dl><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorSupported.html?format=raw">InsertCursorSupported</a></tt></b></dt><dd>True if this connection supports insert cursors.</dd></dl><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.DatabaseConnection.OrderBySupported.html?format=raw">OrderBySupported</a></tt></b></dt><dd>True if the select and delete cursors for this connection support the orderByFields and fieldOrders parameters.</dd></dl><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SelectCursorClass.html?format=raw">SelectCursorClass</a></tt></b></dt><dd>Subclass of SelectCursor that implements a select cursor for this type of database connection.</dd></dl><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SelectCursorSupported.html?format=raw">SelectCursorSupported</a></tt></b></dt><dd>True if this connection supports select cursors.</dd></dl><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SelectFieldsSupported.html?format=raw">SelectFieldsSupported</a></tt></b></dt><dd>True if the select cursors for this connection support the selectFields parameter.</dd></dl><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SpatialReferenceSupported.html?format=raw">SpatialReferenceSupported</a></tt></b></dt><dd>True if the cursors for this connection support the spatialReference parameter.</dd></dl><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.DatabaseConnection.UpdateCursorClass.html?format=raw">UpdateCursorClass</a></tt></b></dt><dd>Subclass of UpdateCursor that implements an update cursor for this type of database connection.</dd></dl><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.DatabaseConnection.UpdateCursorSupported.html?format=raw">UpdateCursorSupported</a></tt></b></dt><dd>True if this connection supports update cursors.</dd></dl><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.DatabaseConnection.WhereClauseSupported.html?format=raw">WhereClauseSupported</a></tt></b></dt><dd>True if the select and update cursors for this connection support the whereClause parameter.</dd></dl><h3>Instance methods</h3><dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><tt class="method"><a href="Method_GeoEco.DatabaseAccess.DatabaseConnection.OpenInsertCursor.html?format=raw">OpenInsertCursor</a></tt></b>(</td><td><var>table</var><big>[</big><var>, spatialReference</var><big>]</big><var></var>)</td></tr></table></dt><dd>Opens a cursor for inserting rows into a table.</dd></dl><dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><tt class="method"><a href="Method_GeoEco.DatabaseAccess.DatabaseConnection.OpenSelectCursor.html?format=raw">OpenSelectCursor</a></tt></b>(</td><td><var>table</var><big>[</big><var>, selectFields</var><big>[</big><var>, whereClause</var><big>[</big><var>, orderByFields</var><big>[</big><var>, fieldOrders</var><big>[</big><var>, spatialReference</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt><dd>Opens a cursor for reading rows from a table.</dd></dl><dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><tt class="method"><a href="Method_GeoEco.DatabaseAccess.DatabaseConnection.OpenUpdateCursor.html?format=raw">OpenUpdateCursor</a></tt></b>(</td><td><var>table</var><big>[</big><var>, selectFields</var><big>[</big><var>, whereClause</var><big>[</big><var>, orderByFields</var><big>[</big><var>, fieldOrders</var><big>[</big><var>, spatialReference</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt><dd>Opens a cursor for reading, updating, and deleting the values of rows in a table.</dd></dl><h3>Remarks</h3><p>This base class class defines the properties and methods that all 
    77database connection classes must implement to be used within 
    88GeoEco.This is an abstract class; do not instantiate it directly.</p><p>Each derived class wraps a specific low-level database access API. 
    99For example, the ArcGIS91DatabaseConnection class wraps the ArcGIS 9.1 
    1010geoprocessor functions. To add support for a new low-level API, 
    11 create a new derived class.</p><p>You may notice that this class does not define a constructor or methods 
    12 for opening and closing the connection. This was done for two reasons:</p><p>First, different low-level database access APIs require different 
    13 parameters for establishing connections. Some APIs, such as the ArcGIS 
    14 geoprocessor (our primary use case) do not have a notion of 
    15 connections at all (the connection is established and managed by the 
    16 cursor objects). It seemed difficult to provide a single method 
    17 signature that would cover all cases but not be clunky.</p><p>Second, the design pattern used throughout GeoEco does not really 
    18 require an abstraction for the connection open and close. A given 
    19 GeoEco "tool" provides at least two implementations of itself. The 
    20 first accepts a DatabaseConnection instance for a connection that is 
    21 already open. This allows the caller to pass in any type of connection 
    22 that supports the options required by the tool (the tool should check 
    23 the properties of the DatabaseConnection and raise an error if a 
    24 required option is not supported). The second and subsequent 
    25 implementations are written for users of specific types of databases. 
    26 These accept connection parameters, establish the connections, and 
    27 invoke the first implementation.</p><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="GeoEco.DatabaseAccess Module" href="Module_GeoEco.DatabaseAccess.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="Module Index" href="Module_GeoEco.DatabaseAccess.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="DeleteCursorClass Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.DeleteCursorClass.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Module_GeoEco.DatabaseAccess.html?format=raw">GeoEco.DatabaseAccess Module</a> <b class="navlabel">Up:</b> <a class="sectref" href="Module_GeoEco.DatabaseAccess.html?format=raw">Module Index</a> <b class="navlabel">Next:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.DeleteCursorClass.html?format=raw">DeleteCursorClass Property</a> </div></div></div></body></html> 
     11create a new derived class.</p><p>This class does not define a constructor or methods for opening and 
     12closing the connection. This was done for two reasons:</p><ul><li>Different low-level database access APIs require different 
     13parameters for establishing connections. Some APIs do not have a 
     14notion of connections at all. For example, the ArcGIS geoprocessor, 
     15our primary use case, manages connections as part of cursor objects. 
     16It seemed difficult to provide a single method signature that would 
     17cover all cases but not be clunky.</li><li>The design pattern used throughout GeoEco does not really 
     18require a common abstraction for opening and closing connections. 
     19Most GeoEco functions intended for external callers provide are 
     20available in at least two implementations. The first accepts a 
     21DatabaseConnection instance for a connection that is already open. 
     22This allows the caller to pass in any type of open connection 
     23(providing it supports the required options). The second and 
     24subsequent implementations are written for users of specific types 
     25of databases. These accept connection information, establish the 
     26connections, and invoke the first implementation.</li></ul><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="GeoEco.DatabaseAccess Module" href="Module_GeoEco.DatabaseAccess.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="Module Index" href="Module_GeoEco.DatabaseAccess.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="InsertCursorClass Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorClass.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Module_GeoEco.DatabaseAccess.html?format=raw">GeoEco.DatabaseAccess Module</a> <b class="navlabel">Up:</b> <a class="sectref" href="Module_GeoEco.DatabaseAccess.html?format=raw">Module Index</a> <b class="navlabel">Next:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorClass.html?format=raw">InsertCursorClass Property</a> </div></div></div></body></html> 
  • MGET/Branches/Jason/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Class_GeoEco.DatabaseAccess.SelectCursor.html

    r76 r77  
    44            td.metadataTitle { font-size: 80%; font-weight: bold; font-family: avantgarde, sans-serif; } 
    55            td.metadataValue { padding-left: 0.5em; } 
    6           </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="OpenSelectCursor Method" href="Method_GeoEco.DatabaseAccess.DatabaseConnection.OpenSelectCursor.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="Module Index" href="Module_GeoEco.DatabaseAccess.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="SelectCursor Constructor" href="Method_GeoEco.DatabaseAccess.SelectCursor.__init__.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.DatabaseConnection.OpenSelectCursor.html?format=raw">OpenSelectCursor Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Module_GeoEco.DatabaseAccess.html?format=raw">Module Index</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.SelectCursor.__init__.html?format=raw">SelectCursor Constructor</a> </div><hr /></div></div><h1><tt class="class">SelectCursor</tt> Class</h1><p>Represents a cursor used to select (read) rows from a table.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Module:</td><td class="metadataValue"><tt class="module"><a href="Module_GeoEco.DatabaseAccess.html?format=raw">GeoEco.DatabaseAccess</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue"><span style="color: red;">Intended for GeoEco internal use only; not recommended for external callers</span></td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Not exposed as a COM class</td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Not exposed to ArcGIS</td></tr></table><h3>Constructor</h3><dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><span class="typelabel">class</span> <tt class="method"><a href="Method_GeoEco.DatabaseAccess.SelectCursor.__init__.html?format=raw">SelectCursor</a></tt></b>(</td><td><big>[</big><var>connection</var><big>[</big><var>, table</var><big>[</big><var>, selectFields</var><big>[</big><var>, whereClause</var><big>[</big><var>, orderByFields</var><big>[</big><var>, fieldOrders</var><big>[</big><var>, spatialReference</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt><dd>Constructs a new SelectCursor instance.</dd></dl><h3>Instance methods</h3><dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><tt class="method"><a href="Method_GeoEco.DatabaseAccess.SelectCursor.Open.html?format=raw">Open</a></tt></b>(</td><td><var>connection</var><var>, table</var><big>[</big><var>, selectFields</var><big>[</big><var>, whereClause</var><big>[</big><var>, orderByFields</var><big>[</big><var>, fieldOrders</var><big>[</big><var>, spatialReference</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt><dd>Opens a cursor for selecting (reading) rows from a table.</dd></dl><dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><tt class="method"><a href="Method_GeoEco.DatabaseAccess.SelectCursor.__del__.html?format=raw">__del__</a></tt></b>(</td><td>)</td></tr></table></dt><dd>Closes the cursor.</dd></dl><h3>Remarks</h3><p>This base class class defines the properties and methods that all 
     6          </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="__del__ Method" href="Method_GeoEco.DatabaseAccess.InsertCursor.__del__.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="Module Index" href="Module_GeoEco.DatabaseAccess.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="SelectCursor Constructor" href="Method_GeoEco.DatabaseAccess.SelectCursor.__init__.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.InsertCursor.__del__.html?format=raw">__del__ Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Module_GeoEco.DatabaseAccess.html?format=raw">Module Index</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.SelectCursor.__init__.html?format=raw">SelectCursor Constructor</a> </div><hr /></div></div><h1><tt class="class">SelectCursor</tt> Class</h1><p>Represents a cursor used to read rows from a table.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Module:</td><td class="metadataValue"><tt class="module"><a href="Module_GeoEco.DatabaseAccess.html?format=raw">GeoEco.DatabaseAccess</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue"><span style="color: red;">Intended for GeoEco internal use only; not recommended for external callers</span></td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Not exposed as a COM class</td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Not exposed to ArcGIS</td></tr></table><h3>Constructor</h3><dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><span class="typelabel">class</span> <tt class="method"><a href="Method_GeoEco.DatabaseAccess.SelectCursor.__init__.html?format=raw">SelectCursor</a></tt></b>(</td><td><big>[</big><var>connection</var><big>[</big><var>, table</var><big>[</big><var>, selectFields</var><big>[</big><var>, whereClause</var><big>[</big><var>, orderByFields</var><big>[</big><var>, fieldOrders</var><big>[</big><var>, spatialReference</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt><dd>Constructs a new SelectCursor instance.</dd></dl><h3>Read-only properties</h3><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.SelectCursor.AtEnd.html?format=raw">AtEnd</a></tt></b></dt><dd>True if the cursor has moved past the end of the result set.</dd></dl><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.SelectCursor.Connection.html?format=raw">Connection</a></tt></b></dt><dd>DatabaseConnection instance that this cursor is associated with.</dd></dl><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.SelectCursor.FieldOrders.html?format=raw">FieldOrders</a></tt></b></dt><dd>The list of ORDER BY field orders provided by the caller when the cursor was opened.</dd></dl><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.SelectCursor.IsOpen.html?format=raw">IsOpen</a></tt></b></dt><dd>True if this cursor is open. If False, the other methods of this object will fail until the cursor is opened.</dd></dl><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.SelectCursor.OrderByFields.html?format=raw">OrderByFields</a></tt></b></dt><dd>The list of ORDER BY field names provided by the caller when the cursor was opened.</dd></dl><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.SelectCursor.RowIndex.html?format=raw">RowIndex</a></tt></b></dt><dd>The zero-based row index of the cursor in the result set.</dd></dl><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.SelectCursor.SelectFields.html?format=raw">SelectFields</a></tt></b></dt><dd>List of field names provided by the caller when the cursor was opened.</dd></dl><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.SelectCursor.SpatialReference.html?format=raw">SpatialReference</a></tt></b></dt><dd>The spatial reference provided by the caller when the cursor was opened.</dd></dl><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.SelectCursor.Table.html?format=raw">Table</a></tt></b></dt><dd>Database table that this cursor is accessing.</dd></dl><dl><dt><b><tt class="member"><a href="Property_GeoEco.DatabaseAccess.SelectCursor.WhereClause.html?format=raw">WhereClause</a></tt></b></dt><dd>The WHERE clause provided by the caller when the cursor was opened.</dd></dl><h3>Instance methods</h3><dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><tt class="method"><a href="Method_GeoEco.DatabaseAccess.SelectCursor.GetValue.html?format=raw">GetValue</a></tt></b>(</td><td><var>field</var>)</td></tr></table></dt><dd>Gets the value of a field of the current row.</dd></dl><dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><tt class="method"><a href="Method_GeoEco.DatabaseAccess.SelectCursor.NextRow.html?format=raw">NextRow</a></tt></b>(</td><td>)</td></tr></table></dt><dd>Moves the cursor to the next row in the result set.</dd></dl><dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><tt class="method"><a href="Method_GeoEco.DatabaseAccess.SelectCursor.Open.html?format=raw">Open</a></tt></b>(</td><td><var>connection</var><var>, table</var><big>[</big><var>, selectFields</var><big>[</big><var>, whereClause</var><big>[</big><var>, orderByFields</var><big>[</big><var>, fieldOrders</var><big>[</big><var>, spatialReference</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt><dd>Opens the cursor.</dd></dl><dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><tt class="method"><a href="Method_GeoEco.DatabaseAccess.SelectCursor._Close.html?format=raw">_Close</a></tt></b>(</td><td>)</td></tr></table></dt><dd>Implements the cursor's close operation.</dd></dl><dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><tt class="method"><a href="Method_GeoEco.DatabaseAccess.SelectCursor._GetValue.html?format=raw">_GetValue</a></tt></b>(</td><td><var>field</var>)</td></tr></table></dt><dd>Implements the cursor's get value operation.</dd></dl><dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><tt class="method"><a href="Method_GeoEco.DatabaseAccess.SelectCursor._NextRow.html?format=raw">_NextRow</a></tt></b>(</td><td>)</td></tr></table></dt><dd>Implements the cursor's row-advance operation.</dd></dl><dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><tt class="method"><a href="Method_GeoEco.DatabaseAccess.SelectCursor._Open.html?format=raw">_Open</a></tt></b>(</td><td><var>connection</var><var>, table</var><var>, selectFields</var><var>, whereClause</var><var>, orderByFields</var><var>, fieldOrders</var><var>, spatialReference</var>)</td></tr></table></dt><dd>Implements the cursor's open operation.</dd></dl><dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><tt class="method"><a href="Method_GeoEco.DatabaseAccess.SelectCursor.__del__.html?format=raw">__del__</a></tt></b>(</td><td>)</td></tr></table></dt><dd>Closes the cursor.</dd></dl><h3>Remarks</h3><p>This base class class defines the properties and methods that all 
    77select cursor classes must implement to be used within GeoEco. This is 
    88an abstract class; do not instantiate it directly. The appropriate way 
     
    1111low-level database access API. For example, the ArcGIS91SelectCursor 
    1212class wraps the ArcGIS 9.1 geoprocessor's SearchCursor function. To 
    13 add support for a new low-level API, create a new derived class.</p><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="OpenSelectCursor Method" href="Method_GeoEco.DatabaseAccess.DatabaseConnection.OpenSelectCursor.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="Module Index" href="Module_GeoEco.DatabaseAccess.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="SelectCursor Constructor" href="Method_GeoEco.DatabaseAccess.SelectCursor.__init__.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.DatabaseConnection.OpenSelectCursor.html?format=raw">OpenSelectCursor Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Module_GeoEco.DatabaseAccess.html?format=raw">Module Index</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.SelectCursor.__init__.html?format=raw">SelectCursor Constructor</a> </div></div></div></body></html> 
     13add support for a new low-level API, create a new derived class.</p><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="__del__ Method" href="Method_GeoEco.DatabaseAccess.InsertCursor.__del__.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="Module Index" href="Module_GeoEco.DatabaseAccess.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="SelectCursor Constructor" href="Method_GeoEco.DatabaseAccess.SelectCursor.__init__.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.InsertCursor.__del__.html?format=raw">__del__ Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Module_GeoEco.DatabaseAccess.html?format=raw">Module Index</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.SelectCursor.__init__.html?format=raw">SelectCursor Constructor</a> </div></div></div></body></html> 
  • MGET/Branches/Jason/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Method_GeoEco.DatabaseAccess.DatabaseConnection.OpenSelectCursor.html

    r76 r77  
    44            td.metadataTitle { font-size: 80%; font-weight: bold; font-family: avantgarde, sans-serif; } 
    55            td.metadataValue { padding-left: 0.5em; } 
    6           </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="WhereClauseSupported Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.WhereClauseSupported.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="SelectCursor Class" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.WhereClauseSupported.html?format=raw">WhereClauseSupported Property</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw">SelectCursor Class</a> </div><hr /></div></div><h1><tt class="member">OpenSelectCursor</tt> Method</h1><p>Opens a cursor for selecting (reading) rows from a table.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue"><span style="color: red;">Intended for GeoEco internal use only; not recommended for external callers</span></td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Not exposed by a COM class</td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Not exposed as an ArcGIS geoprocessing tool</td></tr><tr valign="baseline"><td class="metadataTitle">Method type:</td><td class="metadataValue">Instance Method</td></tr></table><h3>Usage</h3><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><var>obj.</var><b><tt class="method">OpenSelectCursor</tt></b>(</td><td><var>table</var><big>[</big><var>, selectFields</var><big>[</big><var>, whereClause</var><big>[</big><var>, orderByFields</var><big>[</big><var>, fieldOrders</var><big>[</big><var>, spatialReference</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table><h3>Arguments</h3><dl><dt><var>table</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>Database table to access.</p></dd></dl><dl><dt><var>selectFields</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">list</tt> of <tt class="class">unicode</tt>, or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr></table><p>List of fields to retrieve for each row (i.e., the list of columns 
     6          </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="OpenInsertCursor Method" href="Method_GeoEco.DatabaseAccess.DatabaseConnection.OpenInsertCursor.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="OpenUpdateCursor Method" href="Method_GeoEco.DatabaseAccess.DatabaseConnection.OpenUpdateCursor.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.DatabaseConnection.OpenInsertCursor.html?format=raw">OpenInsertCursor Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.DatabaseConnection.OpenUpdateCursor.html?format=raw">OpenUpdateCursor Method</a> </div><hr /></div></div><h1><tt class="member">OpenSelectCursor</tt> Method</h1><p>Opens a cursor for reading rows from a table.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue"><span style="color: red;">Intended for GeoEco internal use only; not recommended for external callers</span></td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Not exposed by a COM class</td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Not exposed as an ArcGIS geoprocessing tool</td></tr><tr valign="baseline"><td class="metadataTitle">Method type:</td><td class="metadataValue">Instance Method</td></tr></table><h3>Usage</h3><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><var>cursor</var> = <var>obj.</var><b><tt class="method">OpenSelectCursor</tt></b>(</td><td><var>table</var><big>[</big><var>, selectFields</var><big>[</big><var>, whereClause</var><big>[</big><var>, orderByFields</var><big>[</big><var>, fieldOrders</var><big>[</big><var>, spatialReference</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table><h3>Arguments</h3><dl><dt><var>table</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>Database table to access.</p></dd></dl><dl><dt><var>selectFields</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">list</tt> of <tt class="class">unicode</tt>, or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr></table><p>List of fields to retrieve for each row (i.e., the list of columns 
    77specified in the SELECT clause of a SQL SELECT statement).</p><p>If a list is not provided, or an empty list is provided, all of the 
    88fields will be returned. If a non-empty list is provided, only those 
    99fields will be returned.</p><p>Do not supply a list containing "*", as would be done in a SQL SELECT 
    1010statement that wanted to retrieve all fields. To retrieve all fields, 
    11 simply omit this parameter when you call this method.</p><p>If the connection's SelectFieldsSupported property is False, then this 
     11simply omit this parameter when you call this method.</p><p>If the connection's SelectFieldsSupported property is False, this 
    1212method will fail if you provide a value for this parameter.</p><p>This usual reason to suppy a list of fields is to minimize database 
    1313and network load. If you are not concerned about database peformance, 
    14 there is no reason to provide a value for this parameter.</p></dd></dl><dl><dt><var>whereClause</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>SQL WHERE clause that specifies the subset of rows to return.</p><p>If this parameter is not provided, all of the rows will be returned.</p><p>If the connection's WhereClauseSupported property is False, then this 
     14there is no reason to provide a value for this parameter.</p></dd></dl><dl><dt><var>whereClause</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>SQL WHERE clause that specifies the subset of rows to return.</p><p>If this parameter is not provided, all of the rows will be returned.</p><p>If the connection's WhereClauseSupported property is False, this 
    1515method will fail if you provide a value for this parameter.</p></dd></dl><dl><dt><var>orderByFields</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">list</tt> of <tt class="class">unicode</tt>, or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr></table><p>List of fields that will be used to sort the returned rows (i.e., 
    1616the list of columns specified in the ORDER BY clause of a SQL SELECT 
     
    1919access API.</p><p>The sort order for each field is specified by corresponding element of 
    2020the list passed for the fieldOrders parameter. That list must have the 
    21 same number of elements as this one.</p><p>If the connection's OrderBySupported property is False, then this 
    22 method will fail if you provide a value for this parameter.</p></dd></dl><dl><dt><var>fieldOrders</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">list</tt> of <tt class="class">unicode</tt>, or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr></table><p>List of strings, either 'Ascending' or 'Descending', that specify 
     21same number of elements as this one.</p><p>If the connection's OrderBySupported property is False, this method 
     22will fail if you provide a value for this parameter.</p></dd></dl><dl><dt><var>fieldOrders</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">list</tt> of <tt class="class">unicode</tt>, or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr></table><p>List of strings, either 'Ascending' or 'Descending', that specify 
    2323the sort order for the fields passed in for the orderByFields 
    2424parameter. This list must have the same number of elements as the one 
    2525passed for orderByFields.</p><p>If a list is not provided, or an empty list is provided, the rows will 
    2626be returned in the default order determined by the underlying database 
    27 access API.</p><p>If the connection's OrderBySupported property is False, then this 
    28 method will fail if you provide a value for this parameter.</p></dd></dl><dl><dt><var>spatialReference</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>Coordinate system into which coordinate fields should be 
    29 projected. At the time of this writing, only the ArcGIS 9.2 
    30 geoprocessor supported this parameter. Please see the ArcGIS 
    31 documentation for more information.</p><p>If the connection's SpatialReferenceSupported property is False, then 
    32 this method will fail if you provide a value for this parameter.</p></dd></dl><h3>Remarks</h3><p>This method will fail if the connection's SelectCursorSupported 
     27access API.</p><p>If the connection's OrderBySupported property is False, this method 
     28will fail if you provide a value for this parameter.</p></dd></dl><dl><dt><var>spatialReference</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>Coordinate system into which coordinate fields should be 
     29projected. At the time of this writing, only the ArcGIS geoprocessor 
     30supported this parameter. Please see the ArcGIS documentation for more 
     31information.</p><p>If the connection's SpatialReferenceSupported property is False, this 
     32method will fail if you provide a value for this parameter.</p></dd></dl><h3>Returns</h3><dl><dt><var>cursor</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">SelectCursor</tt></td></tr></table><p>The object representing the opened cursor.</p></dd></dl><h3>Remarks</h3><p>This method will fail if the connection's SelectCursorSupported 
    3333property is False or if the connection is not open.</p><p>table is the only required parameter. You may provide the other 
    3434parameters if they underlying database access API supports them. To 
     
    3636property specified by the parameter's documentation. This method will 
    3737fail if you provide a value for an unsupported parameter.</p><p>The cursor will be closed automatically when all references to the 
    38 cursor object are released.</p><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="WhereClauseSupported Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.WhereClauseSupported.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="SelectCursor Class" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.WhereClauseSupported.html?format=raw">WhereClauseSupported Property</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw">SelectCursor Class</a> </div></div></div></body></html> 
     38cursor object are released.</p><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="OpenInsertCursor Method" href="Method_GeoEco.DatabaseAccess.DatabaseConnection.OpenInsertCursor.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="OpenUpdateCursor Method" href="Method_GeoEco.DatabaseAccess.DatabaseConnection.OpenUpdateCursor.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.DatabaseConnection.OpenInsertCursor.html?format=raw">OpenInsertCursor Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.DatabaseConnection.OpenUpdateCursor.html?format=raw">OpenUpdateCursor Method</a> </div></div></div></body></html> 
  • MGET/Branches/Jason/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Method_GeoEco.DatabaseAccess.SelectCursor.Open.html

    r76 r77  
    44            td.metadataTitle { font-size: 80%; font-weight: bold; font-family: avantgarde, sans-serif; } 
    55            td.metadataValue { padding-left: 0.5em; } 
    6           </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="SelectCursor Constructor" href="Method_GeoEco.DatabaseAccess.SelectCursor.__init__.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="SelectCursor Class" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="__del__ Method" href="Method_GeoEco.DatabaseAccess.SelectCursor.__del__.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.SelectCursor.__init__.html?format=raw">SelectCursor Constructor</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw">SelectCursor Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.SelectCursor.__del__.html?format=raw">__del__ Method</a> </div><hr /></div></div><h1><tt class="member">Open</tt> Method</h1><p>Opens a cursor for selecting (reading) rows from a table.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw">SelectCursor</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue"><span style="color: red;">Intended for GeoEco internal use only; not recommended for external callers</span></td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Not exposed by a COM class</td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Not exposed as an ArcGIS geoprocessing tool</td></tr><tr valign="baseline"><td class="metadataTitle">Method type:</td><td class="metadataValue">Instance Method</td></tr></table><h3>Usage</h3><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><var>obj.</var><b><tt class="method">Open</tt></b>(</td><td><var>connection</var><var>, table</var><big>[</big><var>, selectFields</var><big>[</big><var>, whereClause</var><big>[</big><var>, orderByFields</var><big>[</big><var>, fieldOrders</var><big>[</big><var>, spatialReference</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table><h3>Arguments</h3><dl><dt><var>connection</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">DatabaseConnection</tt> or <tt class="class">None</tt></td></tr></table><p>DatabaseConnection instance that manages the database connection that should be 
    7 used to open this cursor.</p></dd></dl><dl><dt><var>table</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>Name of the database table to query.</p></dd></dl><dl><dt><var>selectFields</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">list</tt> of <tt class="class">unicode</tt>, or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr></table><p>List of fields to retrieve for each row (i.e., the list of columns 
     6          </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="NextRow Method" href="Method_GeoEco.DatabaseAccess.SelectCursor.NextRow.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="SelectCursor Class" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="_Close Method" href="Method_GeoEco.DatabaseAccess.SelectCursor._Close.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.SelectCursor.NextRow.html?format=raw">NextRow Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw">SelectCursor Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.SelectCursor._Close.html?format=raw">_Close Method</a> </div><hr /></div></div><h1><tt class="member">Open</tt> Method</h1><p>Opens the cursor.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw">SelectCursor</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue"><span style="color: red;">Intended for GeoEco internal use only; not recommended for external callers</span></td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Not exposed by a COM class</td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Not exposed as an ArcGIS geoprocessing tool</td></tr><tr valign="baseline"><td class="metadataTitle">Method type:</td><td class="metadataValue">Instance Method</td></tr></table><h3>Usage</h3><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><var>cursor.</var><b><tt class="method">Open</tt></b>(</td><td><var>connection</var><var>, table</var><big>[</big><var>, selectFields</var><big>[</big><var>, whereClause</var><big>[</big><var>, orderByFields</var><big>[</big><var>, fieldOrders</var><big>[</big><var>, spatialReference</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table><h3>Arguments</h3><dl><dt><var>connection</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">DatabaseConnection</tt></td></tr></table><p>DatabaseConnection instance that manages the database connection that should be 
     7used to open this cursor.</p></dd></dl><dl><dt><var>table</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>Database table to access.</p></dd></dl><dl><dt><var>selectFields</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">list</tt> of <tt class="class">unicode</tt>, or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr></table><p>List of fields to retrieve for each row (i.e., the list of columns 
    88specified in the SELECT clause of a SQL SELECT statement).</p><p>If a list is not provided, or an empty list is provided, all of the 
    99fields will be returned. If a non-empty list is provided, only those 
    1010fields will be returned.</p><p>Do not supply a list containing "*", as would be done in a SQL SELECT 
    1111statement that wanted to retrieve all fields. To retrieve all fields, 
    12 simply omit this parameter when you call this method.</p><p>If the connection's SelectFieldsSupported property is False, then this 
     12simply omit this parameter when you call this method.</p><p>If the connection's SelectFieldsSupported property is False, this 
    1313method will fail if you provide a value for this parameter.</p><p>This usual reason to suppy a list of fields is to minimize database 
    1414and network load. If you are not concerned about database peformance, 
    15 there is no reason to provide a value for this parameter.</p></dd></dl><dl><dt><var>whereClause</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>SQL WHERE clause that specifies the subset of rows to return.</p><p>If this parameter is not provided, all of the rows will be returned.</p><p>If the connection's WhereClauseSupported property is False, then this 
     15there is no reason to provide a value for this parameter.</p></dd></dl><dl><dt><var>whereClause</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>SQL WHERE clause that specifies the subset of rows to return.</p><p>If this parameter is not provided, all of the rows will be returned.</p><p>If the connection's WhereClauseSupported property is False, this 
    1616method will fail if you provide a value for this parameter.</p></dd></dl><dl><dt><var>orderByFields</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">list</tt> of <tt class="class">unicode</tt>, or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr></table><p>List of fields that will be used to sort the returned rows (i.e., 
    1717the list of columns specified in the ORDER BY clause of a SQL SELECT 
     
    2020access API.</p><p>The sort order for each field is specified by corresponding element of 
    2121the list passed for the fieldOrders parameter. That list must have the 
    22 same number of elements as this one.</p><p>If the connection's OrderBySupported property is False, then this 
    23 method will fail if you provide a value for this parameter.</p></dd></dl><dl><dt><var>fieldOrders</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">list</tt> of <tt class="class">unicode</tt>, or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr></table><p>List of strings, either 'Ascending' or 'Descending', that specify 
     22same number of elements as this one.</p><p>If the connection's OrderBySupported property is False, this method 
     23will fail if you provide a value for this parameter.</p></dd></dl><dl><dt><var>fieldOrders</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">list</tt> of <tt class="class">unicode</tt>, or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr></table><p>List of strings, either 'Ascending' or 'Descending', that specify 
    2424the sort order for the fields passed in for the orderByFields 
    2525parameter. This list must have the same number of elements as the one 
    2626passed for orderByFields.</p><p>If a list is not provided, or an empty list is provided, the rows will 
    2727be returned in the default order determined by the underlying database 
    28 access API.</p><p>If the connection's OrderBySupported property is False, then this 
    29 method will fail if you provide a value for this parameter.</p></dd></dl><dl><dt><var>spatialReference</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>Coordinate system into which coordinate fields should be 
    30 projected. At the time of this writing, only the ArcGIS 9.2 
    31 geoprocessor supported this parameter. Please see the ArcGIS 
    32 documentation for more information.</p><p>If the connection's SpatialReferenceSupported property is False, then 
    33 this method will fail if you provide a value for this parameter.</p></dd></dl><h3>Remarks</h3><p>This method will fail if the database connection is not open.</p><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="SelectCursor Constructor" href="Method_GeoEco.DatabaseAccess.SelectCursor.__init__.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="SelectCursor Class" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="__del__ Method" href="Method_GeoEco.DatabaseAccess.SelectCursor.__del__.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.SelectCursor.__init__.html?format=raw">SelectCursor Constructor</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw">SelectCursor Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.SelectCursor.__del__.html?format=raw">__del__ Method</a> </div></div></div></body></html> 
     28access API.</p><p>If the connection's OrderBySupported property is False, this method 
     29will fail if you provide a value for this parameter.</p></dd></dl><dl><dt><var>spatialReference</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>Coordinate system into which coordinate fields should be 
     30projected. At the time of this writing, only the ArcGIS geoprocessor 
     31supported this parameter. Please see the ArcGIS documentation for more 
     32information.</p><p>If the connection's SpatialReferenceSupported property is False, this 
     33method will fail if you provide a value for this parameter.</p></dd></dl><h3>Remarks</h3><p>This method will fail if the database connection is not open. Once 
     34the cursor has been opened, it cannot be re-opened. To open another 
     35cursor, instantiate another cursor object.</p><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="NextRow Method" href="Method_GeoEco.DatabaseAccess.SelectCursor.NextRow.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="SelectCursor Class" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="_Close Method" href="Method_GeoEco.DatabaseAccess.SelectCursor._Close.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.SelectCursor.NextRow.html?format=raw">NextRow Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw">SelectCursor Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.SelectCursor._Close.html?format=raw">_Close Method</a> </div></div></div></body></html> 
  • MGET/Branches/Jason/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Method_GeoEco.DatabaseAccess.SelectCursor.__del__.html

    r76 r77  
    44            td.metadataTitle { font-size: 80%; font-weight: bold; font-family: avantgarde, sans-serif; } 
    55            td.metadataValue { padding-left: 0.5em; } 
    6           </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="Open Method" href="Method_GeoEco.DatabaseAccess.SelectCursor.Open.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="SelectCursor Class" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="GeoEco.DatabaseAccess.ArcGIS Module" href="Module_GeoEco.DatabaseAccess.ArcGIS.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.SelectCursor.Open.html?format=raw">Open Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw">SelectCursor Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Module_GeoEco.DatabaseAccess.ArcGIS.html?format=raw">GeoEco.DatabaseAccess.ArcGIS Module</a> </div><hr /></div></div><h1><tt class="member">__del__</tt> Method</h1><p>Closes the cursor.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw">SelectCursor</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue"><span style="color: red;">Intended for GeoEco internal use only; not recommended for external callers</span></td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Not exposed by a COM class</td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Not exposed as an ArcGIS geoprocessing tool</td></tr><tr valign="baseline"><td class="metadataTitle">Method type:</td><td class="metadataValue">Instance Method</td></tr></table><h3>Usage</h3><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><var>obj.</var><b><tt class="method">__del__</tt></b>(</td><td>)</td></tr></table><h3>Remarks</h3><p>This destructor is automatically called when all of the references 
    7 to the SelectCursor instance are released, either explicitly by the caller or 
    8 when the Python garbage collector releases them. In general, you do 
    9 not need to worry about explicitly releasing your database cursors 
    10 unless you are concerned about database locks. To explicitly release 
    11 your cursor, simply release all references to the SelectCursor instance.</p><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="Open Method" href="Method_GeoEco.DatabaseAccess.SelectCursor.Open.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="SelectCursor Class" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="GeoEco.DatabaseAccess.ArcGIS Module" href="Module_GeoEco.DatabaseAccess.ArcGIS.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.SelectCursor.Open.html?format=raw">Open Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw">SelectCursor Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Module_GeoEco.DatabaseAccess.ArcGIS.html?format=raw">GeoEco.DatabaseAccess.ArcGIS Module</a> </div></div></div></body></html> 
     6          </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="_Open Method" href="Method_GeoEco.DatabaseAccess.SelectCursor._Open.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="SelectCursor Class" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.SelectCursor._Open.html?format=raw">_Open Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw">SelectCursor Class</a> </div><hr /></div></div><h1><tt class="member">__del__</tt> Method</h1><p>Closes the cursor.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw">SelectCursor</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue"><span style="color: red;">Intended for GeoEco internal use only; not recommended for external callers</span></td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Not exposed by a COM class</td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Not exposed as an ArcGIS geoprocessing tool</td></tr><tr valign="baseline"><td class="metadataTitle">Method type:</td><td class="metadataValue">Instance Method</td></tr></table><h3>Usage</h3><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><var>cursor.</var><b><tt class="method">__del__</tt></b>(</td><td>)</td></tr></table><h3>Remarks</h3><p>This destructor is automatically called when all of the references 
     7to this instance are released, either explicitly by the caller or when 
     8the Python garbage collector releases them. In general, you do not 
     9need to worry about explicitly releasing your database cursors unless 
     10you are concerned about database locks. To explicitly release your 
     11cursor, simply release all references to this instance.</p><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="_Open Method" href="Method_GeoEco.DatabaseAccess.SelectCursor._Open.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="SelectCursor Class" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.SelectCursor._Open.html?format=raw">_Open Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw">SelectCursor Class</a> </div></div></div></body></html> 
  • MGET/Branches/Jason/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Method_GeoEco.DatabaseAccess.SelectCursor.__init__.html

    r76 r77  
    44            td.metadataTitle { font-size: 80%; font-weight: bold; font-family: avantgarde, sans-serif; } 
    55            td.metadataValue { padding-left: 0.5em; } 
    6           </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="SelectCursor Class" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="SelectCursor Class" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="Open Method" href="Method_GeoEco.DatabaseAccess.SelectCursor.Open.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw">SelectCursor Class</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw">SelectCursor Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.SelectCursor.Open.html?format=raw">Open Method</a> </div><hr /></div></div><h1><tt class="member">SelectCursor</tt> Constructor</h1><p>Constructs a new SelectCursor instance.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw">SelectCursor</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue"><span style="color: red;">Intended for GeoEco internal use only; not recommended for external callers</span></td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Not exposed by a COM class</td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Not exposed as an ArcGIS geoprocessing tool</td></tr><tr valign="baseline"><td class="metadataTitle">Method type:</td><td class="metadataValue">Instance Method</td></tr></table><h3>Usage</h3><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><tt class="method">SelectCursor</tt></b>(</td><td><big>[</big><var>connection</var><big>[</big><var>, table</var><big>[</big><var>, selectFields</var><big>[</big><var>, whereClause</var><big>[</big><var>, orderByFields</var><big>[</big><var>, fieldOrders</var><big>[</big><var>, spatialReference</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table><h3>Arguments</h3><dl><dt><var>connection</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">DatabaseConnection</tt> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr></table><p>DatabaseConnection instance that manages the database connection that should be 
     6          </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="SelectCursor Class" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="SelectCursor Class" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="AtEnd Property" href="Property_GeoEco.DatabaseAccess.SelectCursor.AtEnd.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw">SelectCursor Class</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw">SelectCursor Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.SelectCursor.AtEnd.html?format=raw">AtEnd Property</a> </div><hr /></div></div><h1><tt class="member">SelectCursor</tt> Constructor</h1><p>Constructs a new SelectCursor instance.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw">SelectCursor</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue"><span style="color: red;">Intended for GeoEco internal use only; not recommended for external callers</span></td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Not exposed by a COM class</td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Not exposed as an ArcGIS geoprocessing tool</td></tr><tr valign="baseline"><td class="metadataTitle">Method type:</td><td class="metadataValue">Instance Method</td></tr></table><h3>Usage</h3><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><var>cursor</var> = <b><tt class="method">SelectCursor</tt></b>(</td><td><big>[</big><var>connection</var><big>[</big><var>, table</var><big>[</big><var>, selectFields</var><big>[</big><var>, whereClause</var><big>[</big><var>, orderByFields</var><big>[</big><var>, fieldOrders</var><big>[</big><var>, spatialReference</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table><h3>Arguments</h3><dl><dt><var>connection</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">DatabaseConnection</tt> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr></table><p>DatabaseConnection instance that manages the database connection that should be 
    77used to open this cursor.</p><p>If this parameter is provided, the table parameter must also be 
    88provided, and the cursor will be opened immediately. The database 
    9 connection must be open for the cursor to be opened.</p></dd></dl><dl><dt><var>table</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>Name of the database table to query.</p><p>If this parameter is provided, the connection parameter must also be 
     9connection must be open for the cursor to be opened.</p></dd></dl><dl><dt><var>table</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>Database table to access.</p><p>If this parameter is provided, the connection parameter must also be 
    1010provided, and the cursor will be opened immediately.</p></dd></dl><dl><dt><var>selectFields</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">list</tt> of <tt class="class">unicode</tt>, or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr></table><p>List of fields to retrieve for each row (i.e., the list of columns 
    1111specified in the SELECT clause of a SQL SELECT statement).</p><p>If a list is not provided, or an empty list is provided, all of the 
     
    1313fields will be returned.</p><p>Do not supply a list containing "*", as would be done in a SQL SELECT 
    1414statement that wanted to retrieve all fields. To retrieve all fields, 
    15 simply omit this parameter when you call this method.</p><p>If the connection's SelectFieldsSupported property is False, then this 
     15simply omit this parameter when you call this method.</p><p>If the connection's SelectFieldsSupported property is False, this 
    1616method will fail if you provide a value for this parameter.</p><p>This usual reason to suppy a list of fields is to minimize database 
    1717and network load. If you are not concerned about database peformance, 
    18 there is no reason to provide a value for this parameter.</p></dd></dl><dl><dt><var>whereClause</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>SQL WHERE clause that specifies the subset of rows to return.</p><p>If this parameter is not provided, all of the rows will be returned.</p><p>If the connection's WhereClauseSupported property is False, then this 
     18there is no reason to provide a value for this parameter.</p></dd></dl><dl><dt><var>whereClause</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>SQL WHERE clause that specifies the subset of rows to return.</p><p>If this parameter is not provided, all of the rows will be returned.</p><p>If the connection's WhereClauseSupported property is False, this 
    1919method will fail if you provide a value for this parameter.</p></dd></dl><dl><dt><var>orderByFields</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">list</tt> of <tt class="class">unicode</tt>, or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr></table><p>List of fields that will be used to sort the returned rows (i.e., 
    2020the list of columns specified in the ORDER BY clause of a SQL SELECT 
     
    2323access API.</p><p>The sort order for each field is specified by corresponding element of 
    2424the list passed for the fieldOrders parameter. That list must have the 
    25 same number of elements as this one.</p><p>If the connection's OrderBySupported property is False, then this 
    26 method will fail if you provide a value for this parameter.</p></dd></dl><dl><dt><var>fieldOrders</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">list</tt> of <tt class="class">unicode</tt>, or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr></table><p>List of strings, either 'Ascending' or 'Descending', that specify 
     25same number of elements as this one.</p><p>If the connection's OrderBySupported property is False, this method 
     26will fail if you provide a value for this parameter.</p></dd></dl><dl><dt><var>fieldOrders</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">list</tt> of <tt class="class">unicode</tt>, or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr></table><p>List of strings, either 'Ascending' or 'Descending', that specify 
    2727the sort order for the fields passed in for the orderByFields 
    2828parameter. This list must have the same number of elements as the one 
    2929passed for orderByFields.</p><p>If a list is not provided, or an empty list is provided, the rows will 
    3030be returned in the default order determined by the underlying database 
    31 access API.</p><p>If the connection's OrderBySupported property is False, then this 
    32 method will fail if you provide a value for this parameter.</p></dd></dl><dl><dt><var>spatialReference</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>Coordinate system into which coordinate fields should be 
    33 projected. At the time of this writing, only the ArcGIS 9.2 
    34 geoprocessor supported this parameter. Please see the ArcGIS 
    35 documentation for more information.</p><p>If the connection's SpatialReferenceSupported property is False, then 
    36 this method will fail if you provide a value for this parameter.</p></dd></dl><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="SelectCursor Class" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="SelectCursor Class" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="Open Method" href="Method_GeoEco.DatabaseAccess.SelectCursor.Open.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw">SelectCursor Class</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw">SelectCursor Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.SelectCursor.Open.html?format=raw">Open Method</a> </div></div></div></body></html> 
     31access API.</p><p>If the connection's OrderBySupported property is False, this method 
     32will fail if you provide a value for this parameter.</p></dd></dl><dl><dt><var>spatialReference</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>Coordinate system into which coordinate fields should be 
     33projected. At the time of this writing, only the ArcGIS geoprocessor 
     34supported this parameter. Please see the ArcGIS documentation for more 
     35information.</p><p>If the connection's SpatialReferenceSupported property is False, this 
     36method will fail if you provide a value for this parameter.</p></dd></dl><h3>Returns</h3><dl><dt><var>cursor</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">SelectCursor</tt></td></tr></table><p>New SelectCursor instance.</p></dd></dl><h3>Remarks</h3><p>This is an abstract class; do not instantiate it directly. The 
     37appropriate way to obtain an instance of this class is to call the 
     38OpenSelectCursor method of a DatabaseConnection instance.</p><p>Derived classes that override this constructor should ensure they 
     39explicitly invoke it from their own implementation, so that the base 
     40class is properly initialized.</p><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="SelectCursor Class" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="SelectCursor Class" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="AtEnd Property" href="Property_GeoEco.DatabaseAccess.SelectCursor.AtEnd.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw">SelectCursor Class</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw">SelectCursor Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.SelectCursor.AtEnd.html?format=raw">AtEnd Property</a> </div></div></div></body></html> 
  • MGET/Branches/Jason/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Method_GeoEco.Test.ParameterPassingTests.COMParameterPassingTests.TestClassMethod.html

    r61 r77  
    44            td.metadataTitle { font-size: 80%; font-weight: bold; font-family: avantgarde, sans-serif; } 
    55            td.metadataValue { padding-left: 0.5em; } 
    6           </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="TestVarargsParameter2 Method" href="Method_GeoEco.Test.ParameterPassingTests.COMParameterPassingTests.TestVarargsParameter2.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="COMParameterPassingTests Class" href="Class_GeoEco.Test.ParameterPassingTests.COMParameterPassingTests.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="GeoEco.Tools Module" href="Module_GeoEco.Tools.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.Test.ParameterPassingTests.COMParameterPassingTests.TestVarargsParameter2.html?format=raw">TestVarargsParameter2 Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.Test.ParameterPassingTests.COMParameterPassingTests.html?format=raw">COMParameterPassingTests Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Module_GeoEco.Tools.html?format=raw">GeoEco.Tools Module</a> </div><hr /></div></div><h1><tt class="member">TestClassMethod</tt> Method</h1><p>Adds two integers.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.Test.ParameterPassingTests.COMParameterPassingTests.html?format=raw">COMParameterPassingTests</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue"><span style="color: red;">Intended for GeoEco internal use only; not recommended for external callers</span></td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Method_GeoEco.COMParameterPassingTests.TestClassMethod.html?format=raw">TestClassMethod</a> method of COM class <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Class_GeoEco.COMParameterPassingTests.html?format=raw">GeoEco.COMParameterPassingTests</a></td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../ArcGISReference/COMParameterPassingTests.TestClassMethod.html?format=raw"></a> geoprocessing tool</td></tr><tr valign="baseline"><td class="metadataTitle">Method type:</td><td class="metadataValue">Classmethod</td></tr></table><h3>Usage</h3><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><var>c</var> = <b><tt class="method">COMParameterPassingTests.TestClassMethod</tt></b>(</td><td><var>a</var><var>, b</var>)</td></tr></table><h3>Arguments</h3><dl><dt><var>a</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">int</tt></td></tr></table><p>The first integer.</p></dd></dl><dl><dt><var>b</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">int</tt></td></tr></table><p>The second integer.</p></dd></dl><h3>Returns</h3><dl><dt><var>c</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">int</tt></td></tr></table><p>The first integer plus the second integer.</p></dd></dl><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="TestVarargsParameter2 Method" href="Method_GeoEco.Test.ParameterPassingTests.COMParameterPassingTests.TestVarargsParameter2.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="COMParameterPassingTests Class" href="Class_GeoEco.Test.ParameterPassingTests.COMParameterPassingTests.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="GeoEco.Tools Module" href="Module_GeoEco.Tools.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.Test.ParameterPassingTests.COMParameterPassingTests.TestVarargsParameter2.html?format=raw">TestVarargsParameter2 Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.Test.ParameterPassingTests.COMParameterPassingTests.html?format=raw">COMParameterPassingTests Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Module_GeoEco.Tools.html?format=raw">GeoEco.Tools Module</a> </div></div></div></body></html> 
     6          </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="TestVarargsParameter2 Method" href="Method_GeoEco.Test.ParameterPassingTests.COMParameterPassingTests.TestVarargsParameter2.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="COMParameterPassingTests Class" href="Class_GeoEco.Test.ParameterPassingTests.COMParameterPassingTests.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="GeoEco.Types Module" href="Module_GeoEco.Types.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.Test.ParameterPassingTests.COMParameterPassingTests.TestVarargsParameter2.html?format=raw">TestVarargsParameter2 Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.Test.ParameterPassingTests.COMParameterPassingTests.html?format=raw">COMParameterPassingTests Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Module_GeoEco.Types.html?format=raw">GeoEco.Types Module</a> </div><hr /></div></div><h1><tt class="member">TestClassMethod</tt> Method</h1><p>Adds two integers.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.Test.ParameterPassingTests.COMParameterPassingTests.html?format=raw">COMParameterPassingTests</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue"><span style="color: red;">Intended for GeoEco internal use only; not recommended for external callers</span></td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Method_GeoEco.COMParameterPassingTests.TestClassMethod.html?format=raw">TestClassMethod</a> method of COM class <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Class_GeoEco.COMParameterPassingTests.html?format=raw">GeoEco.COMParameterPassingTests</a></td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../ArcGISReference/COMParameterPassingTests.TestClassMethod.html?format=raw"></a> geoprocessing tool</td></tr><tr valign="baseline"><td class="metadataTitle">Method type:</td><td class="metadataValue">Classmethod</td></tr></table><h3>Usage</h3><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><var>c</var> = <b><tt class="method">COMParameterPassingTests.TestClassMethod</tt></b>(</td><td><var>a</var><var>, b</var>)</td></tr></table><h3>Arguments</h3><dl><dt><var>a</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">int</tt></td></tr></table><p>The first integer.</p></dd></dl><dl><dt><var>b</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">int</tt></td></tr></table><p>The second integer.</p></dd></dl><h3>Returns</h3><dl><dt><var>c</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">int</tt></td></tr></table><p>The first integer plus the second integer.</p></dd></dl><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="TestVarargsParameter2 Method" href="Method_GeoEco.Test.ParameterPassingTests.COMParameterPassingTests.TestVarargsParameter2.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="COMParameterPassingTests Class" href="Class_GeoEco.Test.ParameterPassingTests.COMParameterPassingTests.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="GeoEco.Types Module" href="Module_GeoEco.Types.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.Test.ParameterPassingTests.COMParameterPassingTests.TestVarargsParameter2.html?format=raw">TestVarargsParameter2 Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.Test.ParameterPassingTests.COMParameterPassingTests.html?format=raw">COMParameterPassingTests Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Module_GeoEco.Types.html?format=raw">GeoEco.Types Module</a> </div></div></div></body></html> 
  • MGET/Branches/Jason/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/ModuleIndex.html

    r76 r77  
    88          be warned that their documentation is sparse, they are more likely to change in 
    99          future versions of <tt class="module">GeoEco</tt>, and we are less inclined to assist 
    10           you in taking a dependency on them.</p><h3>For external callers:</h3><table class="synopsistable" valign="baseline"><tr class="oddrow"><td><b><tt class="module"><a href="Module_GeoEco.ArcGIS.html?format=raw">GeoEco.ArcGIS</a></tt></b></td><td> </td><td class="synopsis">Provides utility functions for interacting with the ESRI ArcGIS software package.</td></tr><tr><td><b><tt class="module"><a href="Module_GeoEco.DataManagement.ArcGISRasters.html?format=raw">GeoEco.DataManagement.ArcGISRasters</a></tt></b></td><td> </td><td class="synopsis">Provides methods for performing common data management operations on ArcGIS rasters.</td></tr><tr class="oddrow"><td><b><tt class="module"><a href="Module_GeoEco.DataManagement.BinaryRasters.html?format=raw">GeoEco.DataManagement.BinaryRasters</a></tt></b></td><td> </td><td class="synopsis">Provides methods for manipulating binary raster files.</td></tr><tr><td><b><tt class="module"><a href="Module_GeoEco.DataManagement.Directories.html?format=raw">GeoEco.DataManagement.Directories</a></tt></b></td><td> </td><td class="synopsis">Provides methods for performing common directory operations.</td></tr><tr class="oddrow"><td><b><tt class="module"><a href="Module_GeoEco.DataManagement.Files.html?format=raw">GeoEco.DataManagement.Files</a></tt></b></td><td> </td><td class="synopsis">Provides methods for performing common file operations.</td></tr><tr><td><b><tt class="module"><a href="Module_GeoEco.DataManagement.HDFs.html?format=raw">GeoEco.DataManagement.HDFs</a></tt></b></td><td> </td><td class="synopsis">Provides methods for manipulating HDF files.</td></tr><tr class="oddrow"><td><b><tt class="module"><a href="Module_GeoEco.DataManagement.Processes.html?format=raw">GeoEco.DataManagement.Processes</a></tt></b></td><td> </td><td class="synopsis">Provides utility classes for working with processes.</td></tr><tr><td><b><tt class="module"><a href="Module_GeoEco.DataManagement.Shapefiles.html?format=raw">GeoEco.DataManagement.Shapefiles</a></tt></b></td><td> </td><td class="synopsis">Provides classes for performing common operations on shapefiles.</td></tr><tr class="oddrow"><td><b><tt class="module"><a href="Module_GeoEco.Logging.html?format=raw">GeoEco.Logging</a></tt></b></td><td> </td><td class="synopsis">Implements the Logger class, which other GeoEco classes use to report activity to the user.</td></tr><tr><td><b><tt class="module"><a href="Module_GeoEco.R.html?format=raw">GeoEco.R</a></tt></b></td><td> </td><td class="synopsis">Provides methods for calling the R statistics program.</td></tr></table><h3>For internal use only:</h3><table class="synopsistable" valign="baseline"><tr class="oddrow"><td><b><tt class="module"><a href="Module_GeoEco.html?format=raw">GeoEco</a></tt></b></td><td> </td><td class="synopsis"></td></tr><tr><td><b><tt class="module"><a href="Module_GeoEco.COM.html?format=raw">GeoEco.COM</a></tt></b></td><td> </td><td class="synopsis"></td></tr><tr class="oddrow"><td><b><tt class="module"><a href="Module_GeoEco.DataManagement.html?format=raw">GeoEco.DataManagement</a></tt></b></td><td> </td><td class="synopsis"></td></tr><tr><td><b><tt class="module"><a href="Module_GeoEco.DatabaseAccess.html?format=raw">GeoEco.DatabaseAccess</a></tt></b></td><td> </td><td class="synopsis">Base classes that define the interfaces used internally by GeoEco to access databases.</td></tr><tr class="oddrow"><td><b><tt class="module"><a href="Module_GeoEco.DatabaseAccess.ArcGIS.html?format=raw">GeoEco.DatabaseAccess.ArcGIS</a></tt></b></td><td> </td><td class="synopsis"></td></tr><tr><td><b><tt class="module"><a href="Module_GeoEco.Dependencies.html?format=raw">GeoEco.Dependencies</a></tt></b></td><td> </td><td class="synopsis"></td></tr><tr class="oddrow"><td><b><tt class="module"><a href="Module_GeoEco.DynamicDocString.html?format=raw">GeoEco.DynamicDocString</a></tt></b></td><td> </td><td class="synopsis"></td></tr><tr><td><b><tt class="module"><a href="Module_GeoEco.Exceptions.html?format=raw">GeoEco.Exceptions</a></tt></b></td><td> </td><td class="synopsis"></td></tr><tr class="oddrow"><td><b><tt class="module"><a href="Module_GeoEco.Internationalization.html?format=raw">GeoEco.Internationalization</a></tt></b></td><td> </td><td class="synopsis"></td></tr><tr><td><b><tt class="module"><a href="Module_GeoEco.Metadata.html?format=raw">GeoEco.Metadata</a></tt></b></td><td> </td><td class="synopsis">Classes used to describe the modules, classes, properties and methods in the GeoEco Python package.</td></tr><tr class="oddrow"><td><b><tt class="module"><a href="Module_GeoEco.Test.html?format=raw">GeoEco.Test</a></tt></b></td><td> </td><td class="synopsis"></td></tr><tr><td><b><tt class="module"><a href="Module_GeoEco.Test.ParameterPassingTests.html?format=raw">GeoEco.Test.ParameterPassingTests</a></tt></b></td><td> </td><td class="synopsis">Implements classes for testing the correct passing of parameters to and from GeoEco classes, COM clients, and ArcGIS.</td></tr><tr class="oddrow"><td><b><tt class="module"><a href="Module_GeoEco.Tools.html?format=raw">GeoEco.Tools</a></tt></b></td><td> </td><td class="synopsis"></td></tr><tr><td><b><tt class="module"><a href="Module_GeoEco.Types.html?format=raw">GeoEco.Types</a></tt></b></td><td> </td><td class="synopsis"></td></tr></table><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="Contributing to GeoEco" href="ContributingToGeoEco.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="GeoEco Python Reference Documentation" href="PythonReference.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="Copyright and License" href="CopyrightAndLicense.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="ContributingToGeoEco.html?format=raw">Contributing to GeoEco</a> <b class="navlabel">Up:</b> <a class="sectref" href="PythonReference.html?format=raw">GeoEco Python Reference Documentation</a> <b class="navlabel">Next:</b> <a class="sectref" href="CopyrightAndLicense.html?format=raw">Copyright and License</a> </div></div></div></body></html> 
     10          you in taking a dependency on them.</p><h3>For external callers:</h3><table class="synopsistable" valign="baseline"><tr class="oddrow"><td><b><tt class="module"><a href="Module_GeoEco.ArcGIS.html?format=raw">GeoEco.ArcGIS</a></tt></b></td><td> </td><td class="synopsis">Provides utility functions for interacting with the ESRI ArcGIS software package.</td></tr><tr><td><b><tt class="module"><a href="Module_GeoEco.DataManagement.ArcGISRasters.html?format=raw">GeoEco.DataManagement.ArcGISRasters</a></tt></b></td><td> </td><td class="synopsis">Provides methods for performing common data management operations on ArcGIS rasters.</td></tr><tr class="oddrow"><td><b><tt class="module"><a href="Module_GeoEco.DataManagement.BinaryRasters.html?format=raw">GeoEco.DataManagement.BinaryRasters</a></tt></b></td><td> </td><td class="synopsis">Provides methods for manipulating binary raster files.</td></tr><tr><td><b><tt class="module"><a href="Module_GeoEco.DataManagement.Directories.html?format=raw">GeoEco.DataManagement.Directories</a></tt></b></td><td> </td><td class="synopsis">Provides methods for performing common directory operations.</td></tr><tr class="oddrow"><td><b><tt class="module"><a href="Module_GeoEco.DataManagement.Files.html?format=raw">GeoEco.DataManagement.Files</a></tt></b></td><td> </td><td class="synopsis">Provides methods for performing common file operations.</td></tr><tr><td><b><tt class="module"><a href="Module_GeoEco.DataManagement.HDFs.html?format=raw">GeoEco.DataManagement.HDFs</a></tt></b></td><td> </td><td class="synopsis">Provides methods for manipulating HDF files.</td></tr><tr class="oddrow"><td><b><tt class="module"><a href="Module_GeoEco.DataManagement.Processes.html?format=raw">GeoEco.DataManagement.Processes</a></tt></b></td><td> </td><td class="synopsis">Provides utility classes for working with processes.</td></tr><tr><td><b><tt class="module"><a href="Module_GeoEco.DataManagement.Shapefiles.html?format=raw">GeoEco.DataManagement.Shapefiles</a></tt></b></td><td> </td><td class="synopsis">Provides classes for performing common operations on shapefiles.</td></tr><tr class="oddrow"><td><b><tt class="module"><a href="Module_GeoEco.Logging.html?format=raw">GeoEco.Logging</a></tt></b></td><td> </td><td class="synopsis">Implements the Logger class, which other GeoEco classes use to report activity to the user.</td></tr><tr><td><b><tt class="module"><a href="Module_GeoEco.R.html?format=raw">GeoEco.R</a></tt></b></td><td> </td><td class="synopsis">Provides methods for calling the R statistics program.</td></tr></table><h3>For internal use only:</h3><table class="synopsistable" valign="baseline"><tr class="oddrow"><td><b><tt class="module"><a href="Module_GeoEco.html?format=raw">GeoEco</a></tt></b></td><td> </td><td class="synopsis"></td></tr><tr><td><b><tt class="module"><a href="Module_GeoEco.COM.html?format=raw">GeoEco.COM</a></tt></b></td><td> </td><td class="synopsis"></td></tr><tr class="oddrow"><td><b><tt class="module"><a href="Module_GeoEco.DataManagement.html?format=raw">GeoEco.DataManagement</a></tt></b></td><td> </td><td class="synopsis"></td></tr><tr><td><b><tt class="module"><a href="Module_GeoEco.DatabaseAccess.html?format=raw">GeoEco.DatabaseAccess</a></tt></b></td><td> </td><td class="synopsis">Base classes that define the interfaces used internally by GeoEco to access databases.</td></tr><tr class="oddrow"><td><b><tt class="module"><a href="Module_GeoEco.DatabaseAccess.ArcGIS.html?format=raw">GeoEco.DatabaseAccess.ArcGIS</a></tt></b></td><td> </td><td class="synopsis">Classes for accessing databases via the ArcGIS geoprocessor.</td></tr><tr><td><b><tt class="module"><a href="Module_GeoEco.Dependencies.html?format=raw">GeoEco.Dependencies</a></tt></b></td><td> </td><td class="synopsis"></td></tr><tr class="oddrow"><td><b><tt class="module"><a href="Module_GeoEco.DynamicDocString.html?format=raw">GeoEco.DynamicDocString</a></tt></b></td><td> </td><td class="synopsis"></td></tr><tr><td><b><tt class="module"><a href="Module_GeoEco.Exceptions.html?format=raw">GeoEco.Exceptions</a></tt></b></td><td> </td><td class="synopsis"></td></tr><tr class="oddrow"><td><b><tt class="module"><a href="Module_GeoEco.Internationalization.html?format=raw">GeoEco.Internationalization</a></tt></b></td><td> </td><td class="synopsis"></td></tr><tr><td><b><tt class="module"><a href="Module_GeoEco.Metadata.html?format=raw">GeoEco.Metadata</a></tt></b></td><td> </td><td class="synopsis">Classes used to describe the modules, classes, properties and methods in the GeoEco Python package.</td></tr><tr class="oddrow"><td><b><tt class="module"><a href="Module_GeoEco.Test.html?format=raw">GeoEco.Test</a></tt></b></td><td> </td><td class="synopsis"></td></tr><tr><td><b><tt class="module"><a href="Module_GeoEco.Test.ParameterPassingTests.html?format=raw">GeoEco.Test.ParameterPassingTests</a></tt></b></td><td> </td><td class="synopsis">Implements classes for testing the correct passing of parameters to and from GeoEco classes, COM clients, and ArcGIS.</td></tr><tr class="oddrow"><td><b><tt class="module"><a href="Module_GeoEco.Types.html?format=raw">GeoEco.Types</a></tt></b></td><td> </td><td class="synopsis"></td></tr></table><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="Contributing to GeoEco" href="ContributingToGeoEco.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="GeoEco Python Reference Documentation" href="PythonReference.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="Copyright and License" href="CopyrightAndLicense.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="ContributingToGeoEco.html?format=raw">Contributing to GeoEco</a> <b class="navlabel">Up:</b> <a class="sectref" href="PythonReference.html?format=raw">GeoEco Python Reference Documentation</a> <b class="navlabel">Next:</b> <a class="sectref" href="CopyrightAndLicense.html?format=raw">Copyright and License</a> </div></div></div></body></html> 
  • MGET/Branches/Jason/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Module_GeoEco.DatabaseAccess.ArcGIS.html

    r76 r77  
    11<?xml version="1.0" encoding="utf-8"?> 
    22<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 
    3 <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>GeoEco.DatabaseAccess.ArcGIS Module</title><link rel="stylesheet" type="text/css" href="lib.css?format=raw" /></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="__del__ Method" href="Method_GeoEco.DatabaseAccess.SelectCursor.__del__.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="GeoEco.Dependencies Module" href="Module_GeoEco.Dependencies.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.SelectCursor.__del__.html?format=raw">__del__ Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="ModuleIndex.html?format=raw">Module Index</a> <b class="navlabel">Next:</b> <a class="sectref" href="Module_GeoEco.Dependencies.html?format=raw">GeoEco.Dependencies Module</a> </div><hr /></div></div><h1><tt class="module">GeoEco.DatabaseAccess.ArcGIS</tt> Module</h1><p></p><p style="color: red;">This module is intended for GeoEco internal use only and is not recommended for external callers.</p><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="__del__ Method" href="Method_GeoEco.DatabaseAccess.SelectCursor.__del__.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="GeoEco.Dependencies Module" href="Module_GeoEco.Dependencies.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.SelectCursor.__del__.html?format=raw">__del__ Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="ModuleIndex.html?format=raw">Module Index</a> <b class="navlabel">Next:</b> <a class="sectref" href="Module_GeoEco.Dependencies.html?format=raw">GeoEco.Dependencies Module</a> </div></div></div></body></html> 
     3<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>GeoEco.DatabaseAccess.ArcGIS Module</title><link rel="stylesheet" type="text/css" href="lib.css?format=raw" /></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="__del__ Method" href="Method_GeoEco.DatabaseAccess.UpdateCursor.__del__.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="ArcGIS91DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.ArcGIS.ArcGIS91DatabaseConnection.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.UpdateCursor.__del__.html?format=raw">__del__ Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="ModuleIndex.html?format=raw">Module Index</a> <b class="navlabel">Next:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.ArcGIS.ArcGIS91DatabaseConnection.html?format=raw">ArcGIS91DatabaseConnection Class</a> </div><hr /></div></div><h1><tt class="module">GeoEco.DatabaseAccess.ArcGIS</tt> Module</h1><p>Classes for accessing databases via the ArcGIS geoprocessor.</p><p style="color: red;">This module is intended for GeoEco internal use only and is not recommended for external callers.</p><dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><span class="typelabel">class</span> <tt class="class"><a href="Class_GeoEco.DatabaseAccess.ArcGIS.ArcGIS91DatabaseConnection.html?format=raw">ArcGIS91DatabaseConnection</a></tt></b>(</td><td>)</td></tr></table></dt><dd>Represents a database connection established through the ArcGIS geoprocessor, version 9.1 or later.</dd></dl><dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><span class="typelabel">class</span> <tt class="class"><a href="Class_GeoEco.DatabaseAccess.ArcGIS.ArcGIS91InsertCursor.html?format=raw">ArcGIS91InsertCursor</a></tt></b>(</td><td><big>[</big><var>connection</var><big>[</big><var>, table</var><big>[</big><var>, spatialReference</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt><dd>Represents a cursor used to insert rows into a table using the ArcGIS geoprocessor, version 9.1 or later.</dd></dl><dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><span class="typelabel">class</span> <tt class="class"><a href="Class_GeoEco.DatabaseAccess.ArcGIS.ArcGIS91SelectCursor.html?format=raw">ArcGIS91SelectCursor</a></tt></b>(</td><td><big>[</big><var>connection</var><big>[</big><var>, table</var><big>[</big><var>, selectFields</var><big>[</big><var>, whereClause</var><big>[</big><var>, orderByFields</var><big>[</big><var>, fieldOrders</var><big>[</big><var>, spatialReference</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt><dd>Represents a cursor used to read rows from a table using the ArcGIS geoprocessor, version 9.1 or later.</dd></dl><dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><span class="typelabel">class</span> <tt class="class"><a href="Class_GeoEco.DatabaseAccess.ArcGIS.ArcGIS91UpdateCursor.html?format=raw">ArcGIS91UpdateCursor</a></tt></b>(</td><td><big>[</big><var>connection</var><big>[</big><var>, table</var><big>[</big><var>, selectFields</var><big>[</big><var>, whereClause</var><big>[</big><var>, orderByFields</var><big>[</big><var>, fieldOrders</var><big>[</big><var>, spatialReference</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt><dd>Represents a cursor used to read, update, and delete rows of a table using the ArcGIS geoprocessor, version 9.1 or later.</dd></dl><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="__del__ Method" href="Method_GeoEco.DatabaseAccess.UpdateCursor.__del__.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="ArcGIS91DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.ArcGIS.ArcGIS91DatabaseConnection.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.UpdateCursor.__del__.html?format=raw">__del__ Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="ModuleIndex.html?format=raw">Module Index</a> <b class="navlabel">Next:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.ArcGIS.ArcGIS91DatabaseConnection.html?format=raw">ArcGIS91DatabaseConnection Class</a> </div></div></div></body></html> 
  • MGET/Branches/Jason/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Module_GeoEco.DatabaseAccess.html

    r76 r77  
    44technology has its own access API. Unified APIs exist but they are 
    55either tied to a particular platform (e.g. OLE DB, ADO, or ODBC on 
    6 Windows; the ArcGIS geoprocessor's database-independent cursor 
    7 functions) or do not support all needed operations or databases (e.g. 
     6Windows) or do not support all needed operations or databases (e.g. 
    87implementations of the Python DB API 2.0, which do not provide 
    9 query-language-independent APIs for creating/deleting tables and 
    10 fields, and for wich there is no ArcGIS implementation). To prevent 
    11 GeoEco modules from taking direct dependencies on database access APIs 
    12 in a disorganized fashion and thereby providing an inconsistent level 
    13 of database support, an additional layer of abstraction is needed.</p><p>This module defines a set of abstract base classes that define the 
     8query-language-independent APIs for creating and deleting tables and 
     9fields). To prevent GeoEco modules from taking direct dependencies on 
     10database access APIs in a disorganized fashion and providing an 
     11inconsistent level of database support, an additional layer of 
     12abstraction is needed.</p><p>This module defines a set of abstract base classes that define the 
    1413database access API used by all GeoEco modules. Because ArcGIS users 
    1514constituted the majority of early GeoEco users, and because the ArcGIS 
     
    2726users or situations requiring high performance. If ESRI ever provides 
    2827a better API that is platform independent, we will consider rewriting 
    29 this one from scratch.</p><dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><span class="typelabel">class</span> <tt class="class"><a href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection</a></tt></b>(</td><td>)</td></tr></table></dt><dd>Represents a connection to a database.</dd></dl><dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><span class="typelabel">class</span> <tt class="class"><a href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw">SelectCursor</a></tt></b>(</td><td><big>[</big><var>connection</var><big>[</big><var>, table</var><big>[</big><var>, selectFields</var><big>[</big><var>, whereClause</var><big>[</big><var>, orderByFields</var><big>[</big><var>, fieldOrders</var><big>[</big><var>, spatialReference</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt><dd>Represents a cursor used to select (read) rows from a table.</dd></dl><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="CopyToDirectory Method" href="Method_GeoEco.DataManagement.Shapefiles.Shapefile.CopyToDirectory.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DataManagement.Shapefiles.Shapefile.CopyToDirectory.html?format=raw">CopyToDirectory Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="ModuleIndex.html?format=raw">Module Index</a> <b class="navlabel">Next:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> </div></div></div></body></html> 
     28this one from scratch.</p><dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><span class="typelabel">class</span> <tt class="class"><a href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection</a></tt></b>(</td><td>)</td></tr></table></dt><dd>Represents a connection to a database.</dd></dl><dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><span class="typelabel">class</span> <tt class="class"><a href="Class_GeoEco.DatabaseAccess.InsertCursor.html?format=raw">InsertCursor</a></tt></b>(</td><td><big>[</big><var>connection</var><big>[</big><var>, table</var><big>[</big><var>, spatialReference</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt><dd>Represents a cursor used to insert rows into a table.</dd></dl><dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><span class="typelabel">class</span> <tt class="class"><a href="Class_GeoEco.DatabaseAccess.SelectCursor.html?format=raw">SelectCursor</a></tt></b>(</td><td><big>[</big><var>connection</var><big>[</big><var>, table</var><big>[</big><var>, selectFields</var><big>[</big><var>, whereClause</var><big>[</big><var>, orderByFields</var><big>[</big><var>, fieldOrders</var><big>[</big><var>, spatialReference</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt><dd>Represents a cursor used to read rows from a table.</dd></dl><dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><span class="typelabel">class</span> <tt class="class"><a href="Class_GeoEco.DatabaseAccess.UpdateCursor.html?format=raw">UpdateCursor</a></tt></b>(</td><td><big>[</big><var>connection</var><big>[</big><var>, table</var><big>[</big><var>, selectFields</var><big>[</big><var>, whereClause</var><big>[</big><var>, orderByFields</var><big>[</big><var>, fieldOrders</var><big>[</big><var>, spatialReference</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt><dd>Represents a cursor used to read, update, and delete rows into a table.</dd></dl><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="CopyToDirectory Method" href="Method_GeoEco.DataManagement.Shapefiles.Shapefile.CopyToDirectory.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DataManagement.Shapefiles.Shapefile.CopyToDirectory.html?format=raw">CopyToDirectory Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="ModuleIndex.html?format=raw">Module Index</a> <b class="navlabel">Next:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> </div></div></div></body></html> 
  • MGET/Branches/Jason/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Module_GeoEco.Dependencies.html

    r76 r77  
    11<?xml version="1.0" encoding="utf-8"?> 
    22<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 
    3 <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>GeoEco.Dependencies Module</title><link rel="stylesheet" type="text/css" href="lib.css?format=raw" /></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="GeoEco.DatabaseAccess.ArcGIS Module" href="Module_GeoEco.DatabaseAccess.ArcGIS.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="GeoEco.DynamicDocString Module" href="Module_GeoEco.DynamicDocString.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Module_GeoEco.DatabaseAccess.ArcGIS.html?format=raw">GeoEco.DatabaseAccess.ArcGIS Module</a> <b class="navlabel">Up:</b> <a class="sectref" href="ModuleIndex.html?format=raw">Module Index</a> <b class="navlabel">Next:</b> <a class="sectref" href="Module_GeoEco.DynamicDocString.html?format=raw">GeoEco.DynamicDocString Module</a> </div><hr /></div></div><h1><tt class="module">GeoEco.Dependencies</tt> Module</h1><p></p><p style="color: red;">This module is intended for GeoEco internal use only and is not recommended for external callers.</p><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="GeoEco.DatabaseAccess.ArcGIS Module" href="Module_GeoEco.DatabaseAccess.ArcGIS.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="GeoEco.DynamicDocString Module" href="Module_GeoEco.DynamicDocString.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Module_GeoEco.DatabaseAccess.ArcGIS.html?format=raw">GeoEco.DatabaseAccess.ArcGIS Module</a> <b class="navlabel">Up:</b> <a class="sectref" href="ModuleIndex.html?format=raw">Module Index</a> <b class="navlabel">Next:</b> <a class="sectref" href="Module_GeoEco.DynamicDocString.html?format=raw">GeoEco.DynamicDocString Module</a> </div></div></div></body></html> 
     3<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>GeoEco.Dependencies Module</title><link rel="stylesheet" type="text/css" href="lib.css?format=raw" /></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="__del__ Method" href="Method_GeoEco.DatabaseAccess.ArcGIS.ArcGIS91UpdateCursor.__del__.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="GeoEco.DynamicDocString Module" href="Module_GeoEco.DynamicDocString.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.ArcGIS.ArcGIS91UpdateCursor.__del__.html?format=raw">__del__ Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="ModuleIndex.html?format=raw">Module Index</a> <b class="navlabel">Next:</b> <a class="sectref" href="Module_GeoEco.DynamicDocString.html?format=raw">GeoEco.DynamicDocString Module</a> </div><hr /></div></div><h1><tt class="module">GeoEco.Dependencies</tt> Module</h1><p></p><p style="color: red;">This module is intended for GeoEco internal use only and is not recommended for external callers.</p><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="__del__ Method" href="Method_GeoEco.DatabaseAccess.ArcGIS.ArcGIS91UpdateCursor.__del__.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="GeoEco.DynamicDocString Module" href="Module_GeoEco.DynamicDocString.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.ArcGIS.ArcGIS91UpdateCursor.__del__.html?format=raw">__del__ Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="ModuleIndex.html?format=raw">Module Index</a> <b class="navlabel">Next:</b> <a class="sectref" href="Module_GeoEco.DynamicDocString.html?format=raw">GeoEco.DynamicDocString Module</a> </div></div></div></body></html> 
  • MGET/Branches/Jason/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Module_GeoEco.Types.html

    r61 r77  
    11<?xml version="1.0" encoding="utf-8"?> 
    22<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 
    3 <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>GeoEco.Types Module</title><link rel="stylesheet" type="text/css" href="lib.css?format=raw" /></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="GeoEco.Tools Module" href="Module_GeoEco.Tools.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Module_GeoEco.Tools.html?format=raw">GeoEco.Tools Module</a> <b class="navlabel">Up:</b> <a class="sectref" href="ModuleIndex.html?format=raw">Module Index</a> </div><hr /></div></div><h1><tt class="module">GeoEco.Types</tt> Module</h1><p></p><p style="color: red;">This module is intended for GeoEco internal use only and is not recommended for external callers.</p><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="GeoEco.Tools Module" href="Module_GeoEco.Tools.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Module_GeoEco.Tools.html?format=raw">GeoEco.Tools Module</a> <b class="navlabel">Up:</b> <a class="sectref" href="ModuleIndex.html?format=raw">Module Index</a> </div></div></div></body></html> 
     3<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>GeoEco.Types Module</title><link rel="stylesheet" type="text/css" href="lib.css?format=raw" /></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="TestClassMethod Method" href="Method_GeoEco.Test.ParameterPassingTests.COMParameterPassingTests.TestClassMethod.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.Test.ParameterPassingTests.COMParameterPassingTests.TestClassMethod.html?format=raw">TestClassMethod Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="ModuleIndex.html?format=raw">Module Index</a> </div><hr /></div></div><h1><tt class="module">GeoEco.Types</tt> Module</h1><p></p><p style="color: red;">This module is intended for GeoEco internal use only and is not recommended for external callers.</p><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="TestClassMethod Method" href="Method_GeoEco.Test.ParameterPassingTests.COMParameterPassingTests.TestClassMethod.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.Test.ParameterPassingTests.COMParameterPassingTests.TestClassMethod.html?format=raw">TestClassMethod Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="ModuleIndex.html?format=raw">Module Index</a> </div></div></div></body></html> 
  • MGET/Branches/Jason/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorClass.html

    r76 r77  
    44            td.metadataTitle { font-size: 80%; font-weight: bold; font-family: avantgarde, sans-serif; } 
    55            td.metadataValue { padding-left: 0.5em; } 
    6           </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="DeleteCursorSupported Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.DeleteCursorSupported.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="InsertCursorSupported Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorSupported.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.DeleteCursorSupported.html?format=raw">DeleteCursorSupported Property</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorSupported.html?format=raw">InsertCursorSupported Property</a> </div><hr /></div></div><h1><tt class="member">InsertCursorClass</tt> Property</h1><p>Subclass of InsertCursor that implements an insert cursor for this type of database connection.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue"><span style="color: red;">Intended for GeoEco internal use only; not recommended for external callers</span></td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Not exposed by a COM class</td></tr><tr valign="baseline"><td class="metadataTitle">Read-only:</td><td class="metadataValue">Yes</td></tr><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">InsertCursor</tt></td></tr></table><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="DeleteCursorSupported Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.DeleteCursorSupported.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="InsertCursorSupported Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorSupported.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.DeleteCursorSupported.html?format=raw">DeleteCursorSupported Property</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorSupported.html?format=raw">InsertCursorSupported Property</a> </div></div></div></body></html> 
     6          </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="InsertCursorSupported Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorSupported.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorSupported.html?format=raw">InsertCursorSupported Property</a> </div><hr /></div></div><h1><tt class="member">InsertCursorClass</tt> Property</h1><p>Subclass of InsertCursor that implements an insert cursor for this type of database connection.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue"><span style="color: red;">Intended for GeoEco internal use only; not recommended for external callers</span></td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Not exposed by a COM class</td></tr><tr valign="baseline"><td class="metadataTitle">Read-only:</td><td class="metadataValue">Yes</td></tr><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">InsertCursor</tt></td></tr></table><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="InsertCursorSupported Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorSupported.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorSupported.html?format=raw">InsertCursorSupported Property</a> </div></div></div></body></html> 
  • MGET/Branches/Jason/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorSupported.html

    r76 r77  
    44            td.metadataTitle { font-size: 80%; font-weight: bold; font-family: avantgarde, sans-serif; } 
    55            td.metadataValue { padding-left: 0.5em; } 
    6           </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="InsertCursorClass Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorClass.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="OrderBySupported Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.OrderBySupported.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorClass.html?format=raw">InsertCursorClass Property</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.OrderBySupported.html?format=raw">OrderBySupported Property</a> </div><hr /></div></div><h1><tt class="member">InsertCursorSupported</tt> Property</h1><p>True if this connection supports insert cursors for appending rows to tables.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue"><span style="color: red;">Intended for GeoEco internal use only; not recommended for external callers</span></td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Not exposed by a COM class</td></tr><tr valign="baseline"><td class="metadataTitle">Read-only:</td><td class="metadataValue">Yes</td></tr><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr></table><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="InsertCursorClass Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorClass.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="OrderBySupported Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.OrderBySupported.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorClass.html?format=raw">InsertCursorClass Property</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.OrderBySupported.html?format=raw">OrderBySupported Property</a> </div></div></div></body></html> 
     6          </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="InsertCursorClass Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorClass.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="OrderBySupported Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.OrderBySupported.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorClass.html?format=raw">InsertCursorClass Property</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.OrderBySupported.html?format=raw">OrderBySupported Property</a> </div><hr /></div></div><h1><tt class="member">InsertCursorSupported</tt> Property</h1><p>True if this connection supports insert cursors.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue"><span style="color: red;">Intended for GeoEco internal use only; not recommended for external callers</span></td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Not exposed by a COM class</td></tr><tr valign="baseline"><td class="metadataTitle">Read-only:</td><td class="metadataValue">Yes</td></tr><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr></table><h3>Remarks</h3><p>If False, you cannot open insert cursors using this connection.</p><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="InsertCursorClass Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorClass.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="OrderBySupported Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.OrderBySupported.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorClass.html?format=raw">InsertCursorClass Property</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.OrderBySupported.html?format=raw">OrderBySupported Property</a> </div></div></div></body></html> 
  • MGET/Branches/Jason/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Property_GeoEco.DatabaseAccess.DatabaseConnection.OrderBySupported.html

    r76 r77  
    44            td.metadataTitle { font-size: 80%; font-weight: bold; font-family: avantgarde, sans-serif; } 
    55            td.metadataValue { padding-left: 0.5em; } 
    6           </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="InsertCursorSupported Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorSupported.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="SelectCursorClass Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SelectCursorClass.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorSupported.html?format=raw">InsertCursorSupported Property</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SelectCursorClass.html?format=raw">SelectCursorClass Property</a> </div><hr /></div></div><h1><tt class="member">OrderBySupported</tt> Property</h1><p>True if the select, update, and delete cursors for this connection support the orderByFields and fieldOrders parameters.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue"><span style="color: red;">Intended for GeoEco internal use only; not recommended for external callers</span></td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Not exposed by a COM class</td></tr><tr valign="baseline"><td class="metadataTitle">Read-only:</td><td class="metadataValue">Yes</td></tr><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr></table><h3>Remarks</h3><p>If False, you may not provide values for the orderByFields and fieldOrders parameters when opening select, update, or delete cursors.</p><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="InsertCursorSupported Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorSupported.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="SelectCursorClass Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SelectCursorClass.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorSupported.html?format=raw">InsertCursorSupported Property</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SelectCursorClass.html?format=raw">SelectCursorClass Property</a> </div></div></div></body></html> 
     6          </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="InsertCursorSupported Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorSupported.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="SelectCursorClass Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SelectCursorClass.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorSupported.html?format=raw">InsertCursorSupported Property</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SelectCursorClass.html?format=raw">SelectCursorClass Property</a> </div><hr /></div></div><h1><tt class="member">OrderBySupported</tt> Property</h1><p>True if the select and delete cursors for this connection support the orderByFields and fieldOrders parameters.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue"><span style="color: red;">Intended for GeoEco internal use only; not recommended for external callers</span></td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Not exposed by a COM class</td></tr><tr valign="baseline"><td class="metadataTitle">Read-only:</td><td class="metadataValue">Yes</td></tr><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr></table><h3>Remarks</h3><p>If False, you may not provide values for the orderByFields and fieldOrders parameters when opening select or update cursors.</p><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="InsertCursorSupported Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorSupported.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="SelectCursorClass Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SelectCursorClass.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.InsertCursorSupported.html?format=raw">InsertCursorSupported Property</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SelectCursorClass.html?format=raw">SelectCursorClass Property</a> </div></div></div></body></html> 
  • MGET/Branches/Jason/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Property_GeoEco.DatabaseAccess.DatabaseConnection.SelectCursorSupported.html

    r76 r77  
    44            td.metadataTitle { font-size: 80%; font-weight: bold; font-family: avantgarde, sans-serif; } 
    55            td.metadataValue { padding-left: 0.5em; } 
    6           </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="SelectCursorClass Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SelectCursorClass.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="SelectFieldsSupported Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SelectFieldsSupported.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SelectCursorClass.html?format=raw">SelectCursorClass Property</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SelectFieldsSupported.html?format=raw">SelectFieldsSupported Property</a> </div><hr /></div></div><h1><tt class="member">SelectCursorSupported</tt> Property</h1><p>True if this connection supports select cursors for reading rows from tables.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue"><span style="color: red;">Intended for GeoEco internal use only; not recommended for external callers</span></td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Not exposed by a COM class</td></tr><tr valign="baseline"><td class="metadataTitle">Read-only:</td><td class="metadataValue">Yes</td></tr><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr></table><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="SelectCursorClass Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SelectCursorClass.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="SelectFieldsSupported Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SelectFieldsSupported.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SelectCursorClass.html?format=raw">SelectCursorClass Property</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SelectFieldsSupported.html?format=raw">SelectFieldsSupported Property</a> </div></div></div></body></html> 
     6          </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="SelectCursorClass Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SelectCursorClass.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="SelectFieldsSupported Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SelectFieldsSupported.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SelectCursorClass.html?format=raw">SelectCursorClass Property</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SelectFieldsSupported.html?format=raw">SelectFieldsSupported Property</a> </div><hr /></div></div><h1><tt class="member">SelectCursorSupported</tt> Property</h1><p>True if this connection supports select cursors.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue"><span style="color: red;">Intended for GeoEco internal use only; not recommended for external callers</span></td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Not exposed by a COM class</td></tr><tr valign="baseline"><td class="metadataTitle">Read-only:</td><td class="metadataValue">Yes</td></tr><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr></table><h3>Remarks</h3><p>If False, you cannot open select cursors using this connection.</p><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="SelectCursorClass Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SelectCursorClass.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="SelectFieldsSupported Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SelectFieldsSupported.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SelectCursorClass.html?format=raw">SelectCursorClass Property</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.SelectFieldsSupported.html?format=raw">SelectFieldsSupported Property</a> </div></div></div></body></html> 
  • MGET/Branches/Jason/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Property_GeoEco.DatabaseAccess.DatabaseConnection.UpdateCursorSupported.html

    r76 r77  
    44            td.metadataTitle { font-size: 80%; font-weight: bold; font-family: avantgarde, sans-serif; } 
    55            td.metadataValue { padding-left: 0.5em; } 
    6           </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="UpdateCursorClass Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.UpdateCursorClass.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="WhereClauseSupported Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.WhereClauseSupported.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.UpdateCursorClass.html?format=raw">UpdateCursorClass Property</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.WhereClauseSupported.html?format=raw">WhereClauseSupported Property</a> </div><hr /></div></div><h1><tt class="member">UpdateCursorSupported</tt> Property</h1><p>True if this connection supports update cursors for changing the values of fields of existing table rows.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue"><span style="color: red;">Intended for GeoEco internal use only; not recommended for external callers</span></td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Not exposed by a COM class</td></tr><tr valign="baseline"><td class="metadataTitle">Read-only:</td><td class="metadataValue">Yes</td></tr><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr></table><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="UpdateCursorClass Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.UpdateCursorClass.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="WhereClauseSupported Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.WhereClauseSupported.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.UpdateCursorClass.html?format=raw">UpdateCursorClass Property</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.WhereClauseSupported.html?format=raw">WhereClauseSupported Property</a> </div></div></div></body></html> 
     6          </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="UpdateCursorClass Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.UpdateCursorClass.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="WhereClauseSupported Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.WhereClauseSupported.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.UpdateCursorClass.html?format=raw">UpdateCursorClass Property</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.WhereClauseSupported.html?format=raw">WhereClauseSupported Property</a> </div><hr /></div></div><h1><tt class="member">UpdateCursorSupported</tt> Property</h1><p>True if this connection supports update cursors.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue"><span style="color: red;">Intended for GeoEco internal use only; not recommended for external callers</span></td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Not exposed by a COM class</td></tr><tr valign="baseline"><td class="metadataTitle">Read-only:</td><td class="metadataValue">Yes</td></tr><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr></table><h3>Remarks</h3><p>If False, you cannot open update cursors using this connection.</p><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="UpdateCursorClass Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.UpdateCursorClass.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="WhereClauseSupported Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.WhereClauseSupported.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.UpdateCursorClass.html?format=raw">UpdateCursorClass Property</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.WhereClauseSupported.html?format=raw">WhereClauseSupported Property</a> </div></div></div></body></html> 
  • MGET/Branches/Jason/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Property_GeoEco.DatabaseAccess.DatabaseConnection.WhereClauseSupported.html

    r76 r77  
    44            td.metadataTitle { font-size: 80%; font-weight: bold; font-family: avantgarde, sans-serif; } 
    55            td.metadataValue { padding-left: 0.5em; } 
    6           </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="UpdateCursorSupported Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.UpdateCursorSupported.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="OpenSelectCursor Method" href="Method_GeoEco.DatabaseAccess.DatabaseConnection.OpenSelectCursor.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.UpdateCursorSupported.html?format=raw">UpdateCursorSupported Property</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.DatabaseConnection.OpenSelectCursor.html?format=raw">OpenSelectCursor Method</a> </div><hr /></div></div><h1><tt class="member">WhereClauseSupported</tt> Property</h1><p>True if the select, update, and delete cursors for this connection support the whereClause parameter.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue"><span style="color: red;">Intended for GeoEco internal use only; not recommended for external callers</span></td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Not exposed by a COM class</td></tr><tr valign="baseline"><td class="metadataTitle">Read-only:</td><td class="metadataValue">Yes</td></tr><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr></table><h3>Remarks</h3><p>If False, you may not provide a value for the whereClause parameter when opening select, update, or delete cursors.</p><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="UpdateCursorSupported Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.UpdateCursorSupported.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="OpenSelectCursor Method" href="Method_GeoEco.DatabaseAccess.DatabaseConnection.OpenSelectCursor.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.UpdateCursorSupported.html?format=raw">UpdateCursorSupported Property</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.DatabaseConnection.OpenSelectCursor.html?format=raw">OpenSelectCursor Method</a> </div></div></div></body></html> 
     6          </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="UpdateCursorSupported Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.UpdateCursorSupported.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="OpenInsertCursor Method" href="Method_GeoEco.DatabaseAccess.DatabaseConnection.OpenInsertCursor.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.UpdateCursorSupported.html?format=raw">UpdateCursorSupported Property</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.DatabaseConnection.OpenInsertCursor.html?format=raw">OpenInsertCursor Method</a> </div><hr /></div></div><h1><tt class="member">WhereClauseSupported</tt> Property</h1><p>True if the select and update cursors for this connection support the whereClause parameter.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue"><span style="color: red;">Intended for GeoEco internal use only; not recommended for external callers</span></td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Not exposed by a COM class</td></tr><tr valign="baseline"><td class="metadataTitle">Read-only:</td><td class="metadataValue">Yes</td></tr><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr></table><h3>Remarks</h3><p>If False, you may not provide a value for the whereClause parameter when opening select or update cursors.</p><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="UpdateCursorSupported Property" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.UpdateCursorSupported.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="DatabaseConnection Class" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="OpenInsertCursor Method" href="Method_GeoEco.DatabaseAccess.DatabaseConnection.OpenInsertCursor.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Property_GeoEco.DatabaseAccess.DatabaseConnection.UpdateCursorSupported.html?format=raw">UpdateCursorSupported Property</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DatabaseAccess.DatabaseConnection.html?format=raw">DatabaseConnection Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DatabaseAccess.DatabaseConnection.OpenInsertCursor.html?format=raw">OpenInsertCursor Method</a> </div></div></div></body></html> 
  • MGET/Branches/Jason/PythonPackage/setup.py

    r74 r77  
    289289    # Various parts of this script modify these parameters. 
    290290 
    291     packages = ['GeoEco', 'GeoEco.DataManagement', 'GeoEco.Test', 'GeoEco.Tools']       # TODO: Generate this list automatically 
     291    packages = ['GeoEco', 'GeoEco.DatabaseAccess', 'GeoEco.DataManagement', 'GeoEco.Test']       # TODO: Generate this list automatically 
    292292    packageData = {'GeoEco': [os.path.join(u'Configuration', u'*')]} 
    293293    scripts = [] 
  • MGET/Branches/Jason/PythonPackage/src/GeoEco/ArcGIS.py

    r74 r77  
    10021002        del _args[0] 
    10031003        self._LogDebug(_(u'ArcGIS %s object 0x%08X: Invoking %s%s...') % (self._Name, id(self._Object), method.__name__, inspect.formatargvalues(_args, _varargs, _varkw, _locals))) 
     1004 
     1005        # If any of the arguments that we will pass to the method are 
     1006        # _ArcGISObjectWrapper, extract the wrapped object so that we will pass 
     1007        # it instead. 
     1008 
     1009        for argName in _args: 
     1010            if isinstance(_locals[argName], _ArcGISObjectWrapper): 
     1011                _locals[argName] = _locals[argName]._Object 
     1012 
     1013        if _varargs is not None: 
     1014            _varargsList = list(_locals[_varargs]) 
     1015            for i in range(len(_varargsList)): 
     1016                if isinstance(_varargsList[i], _ArcGISObjectWrapper): 
     1017                    _varargsList[i] = _varargsList[i]._Object 
     1018            _locals[_varargs] = tuple(_varargsList) 
    10041019 
    10051020        # Build the source code needed to invoke the method. 
  • MGET/Branches/Jason/PythonPackage/src/GeoEco/Configuration/Logging.ini

    r56 r77  
    5555 
    5656[loggers] 
    57 keys=root,GeoEco,ArcGIS,COM,R 
     57keys=root,GeoEco,ArcGIS,COM,DatabaseAccess,R 
    5858 
    5959# Log GeoEco informational, warning and error messages to the console. 
     
    9696qualname=GeoEco.COM 
    9797 
     98# Only log warnings and errors from GeoEco.DatabaseAccess. Change 
     99# "level=WARNING" to "level=DEBUG" to see a complete low-level trace all GeoEco 
     100# interactions with databases. Note: this will generate a LOT of messages if 
     101# for scenarios that involve significant database I/O. 
     102 
     103[logger_DatabaseAccess] 
     104level=WARNING 
     105handlers=Console,ArcGIS 
     106propagate=0 
     107qualname=GeoEco.DatabaseAccess 
     108 
    98109# Only log warnings and errors from the R statistics program. Change 
    99110# "level=INFO" to "level=DEBUG" to see a complete low-level trace of all 
  • MGET/Branches/Jason/PythonPackage/src/GeoEco/DatabaseAccess/ArcGIS.py

    r76 r77  
    1919# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA. 
    2020 
    21 from GeoEco.ArcGIS import GeoprocessorManager 
    22 from GeoEco.DatabaseAccess import DatabaseConnection, SelectCursor 
     21from GeoEco.ArcGIS import GeoprocessorManager, ArcGISDependency 
     22from GeoEco.DatabaseAccess import DatabaseConnection, SelectCursor, InsertCursor, UpdateCursor 
    2323from GeoEco.DynamicDocString import DynamicDocString 
    2424from GeoEco.Internationalization import _ 
     25from GeoEco.Logging import Logger 
    2526 
    2627 
     
    3435        return True 
    3536 
     37    def _GetInsertCursorSupported(self): 
     38        return True 
     39 
     40    def _GetUpdateCursorSupported(self): 
     41        return True 
     42 
    3643    def _GetSelectCursorClass(self): 
    37         return ArcGISSelectCursor 
     44        return ArcGIS91SelectCursor 
     45 
     46    def _GetInsertCursorClass(self): 
     47        return ArcGIS91InsertCursor 
     48 
     49    def _GetUpdateCursorClass(self): 
     50        return ArcGIS91UpdateCursor 
     51 
     52    def _GetSelectFieldsSupported(self): 
     53        return False 
    3854 
    3955    def _GetWhereClauseSupported(self): 
    4056        return True 
    4157 
     58    def _GetOrderBySupported(self): 
     59        return False 
     60 
    4261    def _GetSpatialReferenceSupported(self): 
    4362        return True 
     63 
     64    SelectCursorSupported = property(_GetSelectCursorSupported, doc=DynamicDocString()) 
     65    InsertCursorSupported = property(_GetInsertCursorSupported, doc=DynamicDocString()) 
     66    UpdateCursorSupported = property(_GetUpdateCursorSupported, doc=DynamicDocString()) 
     67 
     68    SelectCursorClass = property(_GetSelectCursorClass, doc=DynamicDocString()) 
     69    InsertCursorClass = property(_GetInsertCursorClass, doc=DynamicDocString()) 
     70    UpdateCursorClass = property(_GetUpdateCursorClass, doc=DynamicDocString()) 
     71 
     72    SelectFieldsSupported = property(_GetSelectFieldsSupported, doc=DynamicDocString()) 
     73    WhereClauseSupported = property(_GetWhereClauseSupported, doc=DynamicDocString()) 
     74    OrderBySupported = property(_GetOrderBySupported, doc=DynamicDocString()) 
     75    SpatialReferenceSupported = property(_GetSpatialReferenceSupported, doc=DynamicDocString()) 
    4476 
    4577 
     
    5082        self.__class__.__doc__.Obj.ValidateMethodInvocation() 
    5183        self._ArcGISCursor = None 
     84        self._ArcGISRow = None 
    5285        super(ArcGIS91SelectCursor, self).__init__(connection, table, selectFields, whereClause, orderByFields, fieldOrders, spatialReference) 
    5386 
    5487    def _Open(self, connection, table, selectFields, whereClause, orderByFields, fieldOrders, spatialReference): 
    5588        self.__class__.__doc__.Obj.ValidateMethodInvocation() 
    56         assert self._ArcGISCursor is None, u'This %s is already open.' % unicode(self.__class__.__name__) 
    57         self._ArcGISCursor = GeoprocessorManager.GetWrappedGeoprocessor().SearchCursor(table, whereClause, spatialReference) 
     89        try: 
     90            self._ArcGISCursor = GeoprocessorManager.GetWrappedGeoprocessor().SearchCursor(table, whereClause, spatialReference) 
     91        except: 
     92            Logger.LogExceptionAsError(_(u'Failed to open an ArcGIS SearchCursor for table %s.') % table) 
     93            raise 
    5894 
    5995    def _Close(self): 
    60         assert self._ArcGISCursor is not None, u'This %s is not open.' % unicode(self.__class__.__name__) 
     96        self._ArcGISRow = None 
    6197        self._ArcGISCursor = None 
    6298 
     99    def _NextRow(self): 
     100        try: 
     101            self._ArcGISRow = self._ArcGISCursor.Next() 
     102        except: 
     103            Logger.LogExceptionAsError(_(u'Failed retrieve a row from an ArcGIS SearchCursor for table %s.') % self.Table) 
     104            raise 
     105        return self._ArcGISRow is not None 
     106 
     107    def _GetValue(self, field): 
     108        try: 
     109            value = self._ArcGISRow.GetValue(field) 
     110        except: 
     111            Logger.LogExceptionAsError(_(u'Failed to get the value of field %(field)s from an ArcGIS SearchCursor for table %(table)s.') % {u'field': field, u'table': self.Table}) 
     112            raise 
     113        return value 
     114 
     115 
     116class ArcGIS91InsertCursor(InsertCursor): 
     117    __doc__ = DynamicDocString() 
     118 
     119    def __init__(self, connection=None, table=None, spatialReference=None): 
     120        self.__class__.__doc__.Obj.ValidateMethodInvocation() 
     121        self._ArcGISCursor = None 
     122        self._ArcGISRow = None 
     123        super(ArcGIS91InsertCursor, self).__init__(connection, table, spatialReference) 
     124 
     125    def _Open(self, connection, table, spatialReference): 
     126        self.__class__.__doc__.Obj.ValidateMethodInvocation() 
     127        try: 
     128            self._ArcGISCursor = GeoprocessorManager.GetWrappedGeoprocessor().InsertCursor(table, spatialReference) 
     129        except: 
     130            Logger.LogExceptionAsError(_(u'Failed to open table %s using  an ArcGIS InsertCursor.') % table) 
     131            raise 
     132 
     133    def _Close(self): 
     134        self._ArcGISRow = None 
     135        self._ArcGISCursor = None 
     136 
     137    def _SetValue(self, field, value): 
     138        try: 
     139            if self._ArcGISRow is None: 
     140                self._ArcGISRow = self._ArcGISCursor.NewRow() 
     141            self._ArcGISRow.SetValue(field, value) 
     142        except: 
     143            Logger.LogExceptionAsError(_(u'Failed to set the value of field %(field)s to %(val)s for a new row of table %(table)s using an ArcGIS InsertCursor.') % {u'field': field, u'val': repr(value), u'table': self.Table}) 
     144            raise 
     145 
     146    def _InsertRow(self): 
     147        try: 
     148            if self._ArcGISRow is None: 
     149                self._ArcGISRow = self._ArcGISCursor.NewRow() 
     150            self._ArcGISCursor.InsertRow(self._ArcGISRow) 
     151            self._ArcGISRow = None 
     152        except: 
     153            Logger.LogExceptionAsError(_(u'Failed to insert a new row into table %(table)s using of an ArcGIS InsertCursor.') % {u'table': self.Table}) 
     154            raise 
     155 
     156 
     157class ArcGIS91UpdateCursor(UpdateCursor): 
     158    __doc__ = DynamicDocString() 
     159 
     160    def __init__(self, connection=None, table=None, selectFields=None, whereClause=None, orderByFields=None, fieldOrders=None, spatialReference=None): 
     161        self.__class__.__doc__.Obj.ValidateMethodInvocation() 
     162        self._ArcGISCursor = None 
     163        self._ArcGISRow = None 
     164        super(ArcGIS91UpdateCursor, self).__init__(connection, table, whereClause, orderByFields, fieldOrders, spatialReference) 
     165 
     166    def _Open(self, connection, table, selectFields, whereClause, orderByFields, fieldOrders, spatialReference): 
     167        self.__class__.__doc__.Obj.ValidateMethodInvocation() 
     168        try: 
     169            self._ArcGISCursor = GeoprocessorManager.GetWrappedGeoprocessor().UpdateCursor(table, whereClause, spatialReference) 
     170        except: 
     171            Logger.LogExceptionAsError(_(u'Failed to open table %s using an ArcGIS UpdateCursor.') % table) 
     172            raise 
     173 
     174    def _Close(self): 
     175        self._ArcGISRow = None 
     176        self._ArcGISCursor = None 
     177 
     178    def _NextRow(self): 
     179        try: 
     180            self._ArcGISRow = self._ArcGISCursor.Next() 
     181        except: 
     182            Logger.LogExceptionAsError(_(u'Failed retrieve a row from table %s using an ArcGIS UpdateCursor.') % self.Table) 
     183            raise 
     184        return self._ArcGISRow is not None 
     185 
     186    def _GetValue(self, field): 
     187        try: 
     188            value = self._ArcGISRow.GetValue(field) 
     189        except: 
     190            Logger.LogExceptionAsError(_(u'Failed to get the value of field %(field)s from table %(table)s using an ArcGIS UpdateCursor.') % {u'field': field, u'table': self.Table}) 
     191            raise 
     192        return value 
     193 
     194    def _SetValue(self, field, value): 
     195        try: 
     196            self._ArcGISRow.SetValue(field, value) 
     197        except: 
     198            Logger.LogExceptionAsError(_(u'Failed to set the value of field %(field)s to %(val)s for a row of table %(table)s using an ArcGIS UpdateCursor.') % {u'field': field, u'val': repr(value), u'table': self.Table}) 
     199            raise 
     200 
     201    def _UpdateRow(self): 
     202        try: 
     203            self._ArcGISCursor.UpdateRow(self._ArcGISRow) 
     204            self._ArcGISRow = None 
     205        except: 
     206            Logger.LogExceptionAsError(_(u'Failed to update a row of table %(table)s using of an ArcGIS UpdateCursor.') % {u'table': self.Table}) 
     207            raise 
     208 
     209    def _DeleteRow(self): 
     210        try: 
     211            self._ArcGISCursor.DeleteRow(self._ArcGISRow) 
     212            self._ArcGISRow = None 
     213        except: 
     214            Logger.LogExceptionAsError(_(u'Failed to delete a row of table %(table)s using of an ArcGIS UpdateCursor.') % {u'table': self.Table}) 
     215            raise 
     216 
     217 
     218############################################################################### 
     219# Metadata: module 
     220############################################################################### 
     221 
     222from GeoEco.Metadata import * 
     223from GeoEco.Types import * 
     224 
     225AddModuleMetadata(shortDescription=_(u'Classes for accessing databases via the ArcGIS geoprocessor.')) 
     226 
     227############################################################################### 
     228# Metadata: ArcGIS91DatabaseConnection class 
     229############################################################################### 
     230 
     231AddClassMetadata(ArcGIS91DatabaseConnection, 
     232    shortDescription=_(u'Represents a database connection established through the ArcGIS geoprocessor, version 9.1 or later.'), 
     233    longDescription=_( 
     234u"""The ArcGIS geoprocessor does not actually expose connections 
     235explicitly. Instead, it opens and closes them on the fly from within 
     236its various methods, whenever they are needed. As a result, this class 
     237does not expose an Open method and the caller does not pass in any 
     238connection information. Instead, all of the connection information is 
     239present in the table parameter that is passed to the other methods. 
     240Typically, the table parameter should contain the full path to the 
     241table as it would be accessed from ArcCatalog, including the database 
     242name and so on. For example, a path to a table in a personal 
     243geodatabase would look like:: 
     244 
     245    C:\\\\MyGeodatabases\\\\MyGeoDB.gdb\\\\MyTable 
     246 
     247Please review the ArcGIS documentation for complete documentation 
     248and examples of the paths expected by ArcGIS. 
     249 
     250The ArcGIS 9.1 geoprocessor supports select, insert and update 
     251cursors, and the whereClause and spatialReference cursor parameters. 
     252The 9.2 geoprocessor adds support for the selectFields, orderByFields, 
     253and fieldOrders parameters. 
     254 
     255This class is forward-compatible with ArcGIS 9.x versions newer than 
     2569.1 (e.g. 9.2).""")) 
     257 
     258# Constructor 
     259 
     260AddMethodMetadata(ArcGIS91DatabaseConnection.__init__, 
     261    shortDescription=_(u'Constructs a new %s instance.') % ArcGIS91DatabaseConnection.__name__, 
     262    dependencies=[ArcGISDependency(9, 1)]) 
     263 
     264AddArgumentMetadata(ArcGIS91DatabaseConnection.__init__, u'self', 
     265    typeMetadata=ClassInstanceTypeMetadata(cls=ArcGIS91DatabaseConnection), 
     266    description=_(u'%s instance.') % ArcGIS91DatabaseConnection.__name__) 
     267 
     268AddResultMetadata(ArcGIS91DatabaseConnection.__init__, u'conn', 
     269    typeMetadata=ClassInstanceTypeMetadata(cls=ArcGIS91DatabaseConnection), 
     270    description=_(u'New %s instance.') % ArcGIS91DatabaseConnection.__name__) 
     271 
     272# Properties 
     273 
     274AddPropertyMetadata(ArcGIS91DatabaseConnection.SelectCursorSupported, 
     275    typeMetadata=BooleanTypeMetadata(), 
     276    shortDescription=_(u'Returns True. ArcGIS 9.1 supports select cursors for reading rows from tables.')) 
     277 
     278AddPropertyMetadata(ArcGIS91DatabaseConnection.InsertCursorSupported, 
     279    typeMetadata=BooleanTypeMetadata(), 
     280    shortDescription=_(u'Returns True. ArcGIS 9.1 supports insert cursors for appending rows to tables.')) 
     281 
     282AddPropertyMetadata(ArcGIS91DatabaseConnection.UpdateCursorSupported, 
     283    typeMetadata=BooleanTypeMetadata(), 
     284    shortDescription=_(u'Returns True. ArcGIS 9.1 supports update cursors for changing the values of fields of existing table rows.')) 
     285 
     286AddPropertyMetadata(ArcGIS91DatabaseConnection.SelectCursorClass, 
     287    typeMetadata=ClassTypeMetadata(cls=ArcGIS91SelectCursor), 
     288    shortDescription=_(u'Returns %s.') % ArcGIS91SelectCursor.__name__) 
     289 
     290AddPropertyMetadata(ArcGIS91DatabaseConnection.InsertCursorClass, 
     291    typeMetadata=ClassTypeMetadata(cls=ArcGIS91InsertCursor), 
     292    shortDescription=_(u'Returns %s.') % ArcGIS91InsertCursor.__name__) 
     293 
     294AddPropertyMetadata(ArcGIS91DatabaseConnection.UpdateCursorClass, 
     295    typeMetadata=ClassTypeMetadata(cls=ArcGIS91UpdateCursor), 
     296    shortDescription=_(u'Returns %s.') % ArcGIS91UpdateCursor.__name__) 
     297 
     298AddPropertyMetadata(ArcGIS91DatabaseConnection.SelectFieldsSupported, 
     299    typeMetadata=BooleanTypeMetadata(), 
     300    shortDescription=_(u'Returns False. ArcGIS 9.1 does not support the selectFields parameter for select cursors.'), 
     301    longDescription=_(u'%s will fail if you supply a value for the selectFields parameter.') % ArcGIS91SelectCursor.__name__) 
     302 
     303AddPropertyMetadata(ArcGIS91DatabaseConnection.WhereClauseSupported, 
     304    typeMetadata=BooleanTypeMetadata(), 
     305    shortDescription=_(u'Returns True. ArcGIS 9.1 supports the whereClause parameter for select, update, and delete cursors.')), 
     306 
     307AddPropertyMetadata(ArcGIS91DatabaseConnection.OrderBySupported, 
     308    typeMetadata=BooleanTypeMetadata(), 
     309    shortDescription=_(u'Returns False. ArcGIS 9.1 does not support the orderByFields and fieldOrders parameters of select, update, and delete cursors.'), 
     310    longDescription=_(u'%s and %s will fail if you supply a value for either the orderByFields or the fieldOrders parameter.') % (ArcGIS91SelectCursor.__name__, ArcGIS91UpdateCursor.__name__)) 
     311 
     312AddPropertyMetadata(ArcGIS91DatabaseConnection.SpatialReferenceSupported, 
     313    typeMetadata=BooleanTypeMetadata(), 
     314    shortDescription=_(u'Returns True. ArcGIS 9.1 supports the spatialReference parameter for select, update, and delete cursors.')) 
     315 
     316############################################################################### 
     317# Metadata: ArcGIS91SelectCursor class 
     318############################################################################### 
     319 
     320AddClassMetadata(ArcGIS91SelectCursor, 
     321    shortDescription=_(u'Represents a cursor used to read rows from a table using the ArcGIS geoprocessor, version 9.1 or later.'), 
     322    longDescription=_( 
     323u"""This class is not intended to be instantiated directly. Call 
     324OpenSelectCursor on the database connection object to obtain an 
     325instance. 
     326 
     327This class is forward-compatible with ArcGIS 9.x versions newer than 
     3289.1 (e.g. 9.2).""")) 
     329 
     330# Constructor 
     331 
     332AddMethodMetadata(ArcGIS91SelectCursor.__init__, 
     333    shortDescription=_(u'Constructs a new %s instance and, optionally, opens it.') % ArcGIS91SelectCursor.__name__, 
     334    longDescription=ArcGIS91SelectCursor.__doc__.Obj.LongDescription, 
     335    dependencies=[ArcGISDependency(9, 1)]) 
     336 
     337AddArgumentMetadata(ArcGIS91SelectCursor.__init__, u'self', 
     338    typeMetadata=ClassInstanceTypeMetadata(cls=ArcGIS91SelectCursor), 
     339    description=_(u'%s instance.') % ArcGIS91SelectCursor.__name__) 
     340 
     341AddArgumentMetadata(ArcGIS91SelectCursor.__init__, u'connection', 
     342    typeMetadata=ClassInstanceTypeMetadata(cls=ArcGIS91DatabaseConnection, canBeNone=True), 
     343    description=_(u'%s instance.') % ArcGIS91DatabaseConnection.__name__) 
     344 
     345AddArgumentMetadata(ArcGIS91SelectCursor.__init__, u'table', 
     346    typeMetadata=UnicodeStringTypeMetadata(minLength=1, canBeNone=True), 
     347    description=_( 
     348u"""Database table to access. 
     349 
     350If this parameter is provided, the connection parameter must also be 
     351provided, and the cursor will be opened immediately. 
     352 
     353Typically, this parameter should contain the full path to the table as 
     354it would be accessed from ArcCatalog, including the database name and 
     355so on. For example, a path to a table in a personal geodatabase would 
     356look like: 
     357 
     358    C:\\\\MyGeodatabases\\\\MyGeoDB.gdb\\\\MyTable 
     359 
     360Please review the ArcGIS documentation for complete documentation 
     361and examples of the paths expected by ArcGIS.""")) 
     362 
     363AddArgumentMetadata(ArcGIS91SelectCursor.__init__, u'selectFields', 
     364    typeMetadata=NoneTypeMetadata(), 
     365    description=_(u'This parameter is not supported. Do not provide a value for it.')) 
     366 
     367AddArgumentMetadata(ArcGIS91SelectCursor.__init__, u'whereClause', 
     368    typeMetadata=SelectCursor.__init__.__doc__.Obj.Arguments[4].Type, 
     369    description=_( 
     370u"""SQL WHERE clause that specifies the subset of rows to access. If 
     371this parameter is not provided, all of the rows will be accessed.""")) 
     372 
     373AddArgumentMetadata(ArcGIS91SelectCursor.__init__, u'orderByFields', 
     374    typeMetadata=NoneTypeMetadata(), 
     375    description=_(u'This parameter is not supported. Do not provide a value for it.')) 
     376 
     377AddArgumentMetadata(ArcGIS91SelectCursor.__init__, u'fieldOrders', 
     378    typeMetadata=NoneTypeMetadata(), 
     379    description=_(u'This parameter is not supported. Do not provide a value for it.')) 
     380 
     381AddArgumentMetadata(ArcGIS91SelectCursor.__init__, u'spatialReference', 
     382    typeMetadata=SelectCursor.__init__.__doc__.Obj.Arguments[7].Type, 
     383    description=_( 
     384u"""Coordinate system into which coordinate fields should be 
     385projected. Please see the ArcGIS documentation for more 
     386information.""")) 
     387 
     388AddResultMetadata(ArcGIS91SelectCursor.__init__, u'cursor', 
     389    typeMetadata=ClassInstanceTypeMetadata(cls=ArcGIS91SelectCursor), 
     390    description=_(u'New %s instance.') % ArcGIS91SelectCursor.__name__) 
     391 
     392# Private method: _Open 
     393 
     394AddMethodMetadata(ArcGIS91SelectCursor._Open, 
     395    shortDescription=_(u'Opens the cursor.'), 
     396    longDescription=_(u'This is a private method that is not intended to be called directly. Call Open instead.')) 
     397 
     398CopyArgumentMetadata(ArcGIS91SelectCursor.__init__, u'self', ArcGIS91SelectCursor._Open, u'self') 
     399 
     400AddArgumentMetadata(ArcGIS91SelectCursor._Open, u'connection', 
     401    typeMetadata=ClassInstanceTypeMetadata(cls=ArcGIS91DatabaseConnection), 
     402    description=_(u'%s instance.') % ArcGIS91DatabaseConnection.__name__) 
     403 
     404AddArgumentMetadata(ArcGIS91SelectCursor._Open, u'table', 
     405    typeMetadata=UnicodeStringTypeMetadata(minLength=1), 
     406    description=_(u'Database table to access.')) 
     407 
     408CopyArgumentMetadata(ArcGIS91SelectCursor.__init__, u'selectFields', ArcGIS91SelectCursor._Open, u'selectFields') 
     409CopyArgumentMetadata(ArcGIS91SelectCursor.__init__, u'whereClause', ArcGIS91SelectCursor._Open, u'whereClause') 
     410CopyArgumentMetadata(ArcGIS91SelectCursor.__init__, u'orderByFields', ArcGIS91SelectCursor._Open, u'orderByFields') 
     411CopyArgumentMetadata(ArcGIS91SelectCursor.__init__, u'fieldOrders', ArcGIS91SelectCursor._Open, u'fieldOrders') 
     412CopyArgumentMetadata(ArcGIS91SelectCursor.__init__, u'spatialReference', ArcGIS91SelectCursor._Open, u'spatialReference') 
     413 
     414# Private method: _Close 
     415 
     416AddMethodMetadata(ArcGIS91SelectCursor._Close, 
     417    shortDescription=_(u'Closes the cursor.'), 
     418    longDescription=_(u'This is a private method that is not intended to be called directly. Release all references to the cursor instead.')) 
     419 
     420CopyArgumentMetadata(ArcGIS91SelectCursor.__init__, u'self', ArcGIS91SelectCursor._Close, u'self') 
     421 
     422# Private method: _NextRow 
     423 
     424AddMethodMetadata(ArcGIS91SelectCursor._NextRow, 
     425    shortDescription=_(u'Moves the cursor to the next row.'), 
     426    longDescription=_(u'This is a private method that is not intended to be called directly. Call NextRow instead.')) 
     427 
     428CopyArgumentMetadata(ArcGIS91SelectCursor.__init__, u'self', ArcGIS91SelectCursor._NextRow, u'self') 
     429 
     430# Private method: _GetValue 
     431 
     432AddMethodMetadata(ArcGIS91SelectCursor._GetValue, 
     433    shortDescription=_(u'Gets the value of a field for the current row.'), 
     434    longDescription=_(u'This is a private method that is not intended to be called directly. Call GetValue instead.')) 
     435 
     436CopyArgumentMetadata(ArcGIS91SelectCursor.__init__, u'self', ArcGIS91SelectCursor._GetValue, u'self') 
     437CopyArgumentMetadata(ArcGIS91SelectCursor.GetValue, u'field', ArcGIS91SelectCursor._GetValue, u'field') 
     438 
     439CopyResultMetadata(ArcGIS91SelectCursor.GetValue, u'value', ArcGIS91SelectCursor._GetValue, u'value') 
     440 
     441############################################################################### 
     442# Metadata: ArcGIS91InsertCursor class 
     443############################################################################### 
     444 
     445AddClassMetadata(ArcGIS91InsertCursor, 
     446    shortDescription=_(u'Represents a cursor used to insert rows into a table using the ArcGIS geoprocessor, version 9.1 or later.'), 
     447    longDescription=_( 
     448u"""This class is not intended to be instantiated directly. Call 
     449OpenInsertCursor on the database connection object to obtain an 
     450instance. 
     451 
     452This class is forward-compatible with ArcGIS 9.x versions newer than 
     4539.1 (e.g. 9.2). 
     454 
     455**Important Note**: Unless you explicitly set the value of each field 
     456every time you insert a row, the unset fields take their default 
     457values from the last row that you inserted. For example, if you insert 
     458a row with field XYZ set to 10, and you insert a second row without 
     459setting XYZ to a value, XYZ will be 10 for the second row. 
     460 
     461This behavior appears to be a by-design characteristic of the ArcGIS 
     462geoprocessor. To defend your code from this problem, we recommend you 
     463explicitly set the values of all fields before inserting each 
     464row.""")) 
     465 
     466# Constructor 
     467 
     468AddMethodMetadata(ArcGIS91InsertCursor.__init__, 
     469    shortDescription=_(u'Constructs a new %s instance and, optionally, opens it.') % ArcGIS91InsertCursor.__name__, 
     470    longDescription=ArcGIS91InsertCursor.__doc__.Obj.LongDescription, 
     471    dependencies=[ArcGISDependency(9, 1)]) 
     472 
     473AddArgumentMetadata(ArcGIS91InsertCursor.__init__, u'self', 
     474    typeMetadata=ClassInstanceTypeMetadata(cls=ArcGIS91InsertCursor), 
     475    description=_(u'%s instance.') % ArcGIS91InsertCursor.__name__) 
     476 
     477CopyArgumentMetadata(ArcGIS91SelectCursor.__init__, u'connection', ArcGIS91InsertCursor.__init__, u'connection') 
     478CopyArgumentMetadata(ArcGIS91SelectCursor.__init__, u'table', ArcGIS91InsertCursor.__init__, u'table') 
     479CopyArgumentMetadata(ArcGIS91SelectCursor.__init__, u'spatialReference', ArcGIS91InsertCursor.__init__, u'spatialReference') 
     480 
     481AddResultMetadata(ArcGIS91InsertCursor.__init__, u'cursor', 
     482    typeMetadata=ClassInstanceTypeMetadata(cls=ArcGIS91InsertCursor), 
     483    description=_(u'New %s instance.') % ArcGIS91InsertCursor.__name__) 
     484 
     485# Private method: _Open 
     486 
     487AddMethodMetadata(ArcGIS91InsertCursor._Open, 
     488    shortDescription=ArcGIS91SelectCursor._Open.__doc__.Obj.ShortDescription, 
     489    longDescription=ArcGIS91SelectCursor._Open.__doc__.Obj.LongDescription) 
     490 
     491CopyArgumentMetadata(ArcGIS91InsertCursor.__init__, u'self', ArcGIS91InsertCursor._Open, u'self') 
     492CopyArgumentMetadata(ArcGIS91SelectCursor._Open, u'connection', ArcGIS91InsertCursor._Open, u'connection') 
     493CopyArgumentMetadata(ArcGIS91SelectCursor._Open, u'table', ArcGIS91InsertCursor._Open, u'table') 
     494CopyArgumentMetadata(ArcGIS91SelectCursor._Open, u'spatialReference', ArcGIS91InsertCursor._Open, u'spatialReference') 
     495 
     496# Private method: _Close 
     497 
     498AddMethodMetadata(ArcGIS91InsertCursor._Close, 
     499    shortDescription=ArcGIS91SelectCursor._Close.__doc__.Obj.ShortDescription, 
     500    longDescription=ArcGIS91SelectCursor._Close.__doc__.Obj.LongDescription) 
     501 
     502CopyArgumentMetadata(ArcGIS91InsertCursor.__init__, u'self', ArcGIS91InsertCursor._Close, u'self') 
     503 
     504# Private method: _SetValue 
     505 
     506AddMethodMetadata(ArcGIS91InsertCursor._SetValue, 
     507    shortDescription=_(u'Sets the value of a field for the row under construction.'), 
     508    longDescription=_(u'This is a private method that is not intended to be called directly. Call SetValue instead.')) 
     509 
     510CopyArgumentMetadata(ArcGIS91InsertCursor.__init__, u'self', ArcGIS91InsertCursor._SetValue, u'self') 
     511CopyArgumentMetadata(InsertCursor.SetValue, u'field', ArcGIS91InsertCursor._SetValue, u'field') 
     512CopyArgumentMetadata(InsertCursor.SetValue, u'value', ArcGIS91InsertCursor._SetValue, u'value') 
     513 
     514# Private method: _InsertRow 
     515 
     516AddMethodMetadata(ArcGIS91InsertCursor._InsertRow, 
     517    shortDescription=_(u'Inserts the row under construction into the table.'), 
     518    longDescription=_(u'This is a private method that is not intended to be called directly. Release all references to the cursor instead.')) 
     519 
     520CopyArgumentMetadata(ArcGIS91InsertCursor.__init__, u'self', ArcGIS91InsertCursor._InsertRow, u'self') 
     521 
     522############################################################################### 
     523# Metadata: ArcGIS91UpdateCursor class 
     524############################################################################### 
     525 
     526AddClassMetadata(ArcGIS91UpdateCursor, 
     527    shortDescription=_(u'Represents a cursor used to read, update, and delete rows of a table using the ArcGIS geoprocessor, version 9.1 or later.'), 
     528    longDescription=_( 
     529u"""This class is not intended to be instantiated directly. Call 
     530OpenUpdateCursor on the database connection object to obtain an 
     531instance. 
     532 
     533This class is forward-compatible with ArcGIS 9.x versions newer than 
     5349.1 (e.g. 9.2).""")) 
     535 
     536# Constructor 
     537 
     538AddMethodMetadata(ArcGIS91UpdateCursor.__init__, 
     539    shortDescription=_(u'Constructs a new %s instance and, optionally, opens it.') % ArcGIS91UpdateCursor.__name__, 
     540    longDescription=ArcGIS91UpdateCursor.__doc__.Obj.LongDescription, 
     541    dependencies=[ArcGISDependency(9, 1)]) 
     542 
     543AddArgumentMetadata(ArcGIS91UpdateCursor.__init__, u'self', 
     544    typeMetadata=ClassInstanceTypeMetadata(cls=ArcGIS91UpdateCursor), 
     545    description=_(u'%s instance.') % ArcGIS91UpdateCursor.__name__) 
     546 
     547CopyArgumentMetadata(ArcGIS91SelectCursor.__init__, u'connection', ArcGIS91UpdateCursor.__init__, u'connection') 
     548CopyArgumentMetadata(ArcGIS91SelectCursor.__init__, u'table', ArcGIS91UpdateCursor.__init__, u'table') 
     549CopyArgumentMetadata(ArcGIS91SelectCursor.__init__, u'selectFields', ArcGIS91UpdateCursor.__init__, u'selectFields') 
     550CopyArgumentMetadata(ArcGIS91SelectCursor.__init__, u'whereClause', ArcGIS91UpdateCursor.__init__, u'whereClause') 
     551CopyArgumentMetadata(ArcGIS91SelectCursor.__init__, u'orderByFields', ArcGIS91UpdateCursor.__init__, u'orderByFields') 
     552CopyArgumentMetadata(ArcGIS91SelectCursor.__init__, u'fieldOrders', ArcGIS91UpdateCursor.__init__, u'fieldOrders') 
     553CopyArgumentMetadata(ArcGIS91SelectCursor.__init__, u'spatialReference', ArcGIS91UpdateCursor.__init__, u'spatialReference') 
     554 
     555AddResultMetadata(ArcGIS91UpdateCursor.__init__, u'cursor', 
     556    typeMetadata=ClassInstanceTypeMetadata(cls=ArcGIS91UpdateCursor), 
     557    description=_(u'New %s instance.') % ArcGIS91UpdateCursor.__name__) 
     558 
     559# Private method: _Open 
     560 
     561AddMethodMetadata(ArcGIS91UpdateCursor._Open, 
     562    shortDescription=ArcGIS91SelectCursor._Open.__doc__.Obj.ShortDescription, 
     563    longDescription=ArcGIS91SelectCursor._Open.__doc__.Obj.LongDescription) 
     564 
     565CopyArgumentMetadata(ArcGIS91UpdateCursor.__init__, u'self', ArcGIS91UpdateCursor._Open, u'self') 
     566CopyArgumentMetadata(ArcGIS91SelectCursor._Open, u'connection', ArcGIS91UpdateCursor._Open, u'connection') 
     567CopyArgumentMetadata(ArcGIS91SelectCursor._Open, u'table', ArcGIS91UpdateCursor._Open, u'table') 
     568CopyArgumentMetadata(ArcGIS91SelectCursor._Open, u'selectFields', ArcGIS91UpdateCursor._Open, u'selectFields') 
     569CopyArgumentMetadata(ArcGIS91SelectCursor._Open, u'whereClause', ArcGIS91UpdateCursor._Open, u'whereClause') 
     570CopyArgumentMetadata(ArcGIS91SelectCursor._Open, u'orderByFields', ArcGIS91UpdateCursor._Open, u'orderByFields') 
     571CopyArgumentMetadata(ArcGIS91SelectCursor._Open, u'fieldOrders', ArcGIS91UpdateCursor._Open, u'fieldOrders') 
     572CopyArgumentMetadata(ArcGIS91SelectCursor._Open, u'spatialReference', ArcGIS91UpdateCursor._Open, u'spatialReference') 
     573 
     574# Private method: _Close 
     575 
     576AddMethodMetadata(ArcGIS91UpdateCursor._Close, 
     577    shortDescription=ArcGIS91SelectCursor._Close.__doc__.Obj.ShortDescription, 
     578    longDescription=ArcGIS91SelectCursor._Close.__doc__.Obj.LongDescription) 
     579 
     580CopyArgumentMetadata(ArcGIS91UpdateCursor.__init__, u'self', ArcGIS91UpdateCursor._Close, u'self') 
     581 
     582# Private method: _NextRow 
     583 
     584AddMethodMetadata(ArcGIS91UpdateCursor._NextRow, 
     585    shortDescription=_(u'Moves the cursor to the next row.'), 
     586    longDescription=_(u'This is a private method that is not intended to be called directly. Call NextRow instead.')) 
     587 
     588CopyArgumentMetadata(ArcGIS91UpdateCursor.__init__, u'self', ArcGIS91UpdateCursor._NextRow, u'self') 
     589 
     590# Private method: _GetValue 
     591 
     592AddMethodMetadata(ArcGIS91UpdateCursor._GetValue, 
     593    shortDescription=_(u'Gets the value of a field of the current row.'), 
     594    longDescription=_(u'This is a private method that is not intended to be called directly. Call GetValue instead.')) 
     595 
     596CopyArgumentMetadata(ArcGIS91UpdateCursor.__init__, u'self', ArcGIS91UpdateCursor._GetValue, u'self') 
     597CopyArgumentMetadata(UpdateCursor.GetValue, u'field', ArcGIS91UpdateCursor._GetValue, u'field') 
     598 
     599CopyResultMetadata(UpdateCursor.GetValue, u'value', ArcGIS91UpdateCursor._GetValue, u'value') 
     600 
     601# Private method: _SetValue 
     602 
     603AddMethodMetadata(ArcGIS91UpdateCursor._SetValue, 
     604    shortDescription=_(u'Sets the value of a field of the current row.'), 
     605    longDescription=_(u'This is a private method that is not intended to be called directly. Call SetValue instead.')) 
     606 
     607CopyArgumentMetadata(ArcGIS91UpdateCursor.__init__, u'self', ArcGIS91UpdateCursor._SetValue, u'self') 
     608CopyArgumentMetadata(UpdateCursor.SetValue, u'field', ArcGIS91UpdateCursor._SetValue, u'field') 
     609CopyArgumentMetadata(UpdateCursor.SetValue, u'value', ArcGIS91UpdateCursor._SetValue, u'value') 
     610 
     611# Private method: _UpdateRow 
     612 
     613AddMethodMetadata(ArcGIS91UpdateCursor._UpdateRow, 
     614    shortDescription=_(u'Updates the current row.'), 
     615    longDescription=_(u'This is a private method that is not intended to be called directly. Call UpdateRow instead.')) 
     616 
     617CopyArgumentMetadata(ArcGIS91UpdateCursor.__init__, u'self', ArcGIS91UpdateCursor._UpdateRow, u'self') 
     618 
     619# Private method: _DeleteRow 
     620 
     621AddMethodMetadata(ArcGIS91UpdateCursor._DeleteRow, 
     622    shortDescription=_(u'Deletes the current row.'), 
     623    longDescription=_(u'This is a private method that is not intended to be called directly. Call DeleteRow instead.')) 
     624 
     625CopyArgumentMetadata(ArcGIS91UpdateCursor.__init__, u'self', ArcGIS91UpdateCursor._DeleteRow, u'self') 
     626 
    63627############################################################################### 
    64628# Names exported by this module 
     
    66630 
    67631__all__ = ['ArcGIS91DatabaseConnection', 
    68            'ArcGIS91SelectCursor'] 
     632           'ArcGIS91SelectCursor', 
     633           'ArcGIS91InsertCursor', 
     634           'ArcGIS91UpdateCursor'] 
  • MGET/Branches/Jason/PythonPackage/src/GeoEco/DatabaseAccess/__init__.py

    r76 r77  
    2020 
    2121import logging 
     22import types 
    2223 
    2324from GeoEco.DynamicDocString import DynamicDocString 
     
    2930    __doc__ = DynamicDocString() 
    3031 
    31     # Property fget functions that the derived class should override when 
    32     # appropriate. 
    33  
     32    # Properties that describe the operations supported by this type of 
     33    # connection. The derived class should override these where appropriate. 
     34    # Note that you must override both the fget methods AND the property 
     35    # declarations. (Unfortunately, when you specify an fget method in a 
     36    # property declaration, Python immediately binds to that method's code and 
     37    # does not check for a derived class override.) 
     38     
    3439    def _GetSelectCursorSupported(self): 
    3540        return False 
     
    4146        return False 
    4247 
    43     def _GetDeleteCursorSupported(self): 
    44         return False 
    45  
    4648    def _GetSelectCursorClass(self): 
    4749        return None 
     
    5355        return None 
    5456 
    55     def _GetDeleteCursorClass(self): 
    56         return None 
    57  
    5857    def _GetSelectFieldsSupported(self): 
    5958        return False 
     
    6766    def _GetSpatialReferenceSupported(self): 
    6867        return False 
    69  
    70     # Base class properties - do not override.     
    7168 
    7269    SelectCursorSupported = property(_GetSelectCursorSupported, doc=DynamicDocString()) 
    7370    InsertCursorSupported = property(_GetInsertCursorSupported, doc=DynamicDocString()) 
    7471    UpdateCursorSupported = property(_GetUpdateCursorSupported, doc=DynamicDocString()) 
    75     DeleteCursorSupported = property(_GetDeleteCursorSupported, doc=DynamicDocString()) 
    7672 
    7773    SelectCursorClass = property(_GetSelectCursorClass, doc=DynamicDocString()) 
    7874    InsertCursorClass = property(_GetInsertCursorClass, doc=DynamicDocString()) 
    7975    UpdateCursorClass = property(_GetUpdateCursorClass, doc=DynamicDocString()) 
    80     DeleteCursorClass = property(_GetDeleteCursorClass, doc=DynamicDocString()) 
    8176 
    8277    SelectFieldsSupported = property(_GetSelectFieldsSupported, doc=DynamicDocString()) 
     
    8984    def OpenSelectCursor(self, table, selectFields=None, whereClause=None, orderByFields=None, fieldOrders=None, spatialReference=None): 
    9085        self.__class__.__doc__.Obj.ValidateMethodInvocation() 
    91         assert issubclass(self.SelectCursorClass, SelectCursor), u'%s must be a subclass of %s.' % (unicode(self.SelectCursorClass.__name__), unicode(self.__class__.__name__)) 
     86        assert issubclass(self.SelectCursorClass, SelectCursor), u'%s must be a subclass of %s.' % (self.SelectCursorClass.__name__, self.__class__.__name__) 
    9287        if not self.SelectCursorSupported: 
    93             Logger.RaiseException(NotImplementedError(_(u'%s does not support select cursors.') % unicode(self.__class__.__name__))) 
     88            Logger.RaiseException(NotImplementedError(_(u'%s does not support select cursors.') % self.__class__.__name__)) 
    9489             
    9590        return self.SelectCursorClass(self, table, selectFields, whereClause, orderByFields, fieldOrders, spatialReference) 
     
    9792    def OpenInsertCursor(self, table, spatialReference=None): 
    9893        self.__class__.__doc__.Obj.ValidateMethodInvocation() 
    99         assert issubclass(self.InsertCursorClass, InsertCursor), u'%s must be a subclass of %s.' % (unicode(self.InsertCursorClass.__name__), unicode(self.__class__.__name__)) 
     94        assert issubclass(self.InsertCursorClass, InsertCursor), u'%s must be a subclass of %s.' % (self.InsertCursorClass.__name__, self.__class__.__name__) 
    10095        if not self.InsertCursorSupported: 
    101             Logger.RaiseException(NotImplementedError(_(u'%s does not support insert cursors.') % unicode(self.__class__.__name__))) 
     96            Logger.RaiseException(NotImplementedError(_(u'%s does not support insert cursors.') % self.__class__.__name__)) 
    10297             
    10398        return self.InsertCursorClass(self, table, spatialReference) 
    10499 
    105     def OpenUpdateCursor(self, table, whereClause=None, orderByFields=None, fieldOrders=None, spatialReference=None): 
     100    def OpenUpdateCursor(self, table, selectFields=None, whereClause=None, orderByFields=None, fieldOrders=None, spatialReference=None): 
    106101        self.__class__.__doc__.Obj.ValidateMethodInvocation() 
    107         assert issubclass(self.UpdateCursorClass, UpdateCursor), u'%s must be a subclass of %s.' % (unicode(self.UpdateCursorClass.__name__), unicode(self.__class__.__name__)) 
     102        assert issubclass(self.UpdateCursorClass, UpdateCursor), u'%s must be a subclass of %s.' % (self.UpdateCursorClass.__name__, self.__class__.__name__) 
    108103        if not self.UpdateCursorSupported: 
    109             Logger.RaiseException(NotImplementedError(_(u'%s does not support update cursors.') % unicode(self.__class__.__name__))) 
     104            Logger.RaiseException(NotImplementedError(_(u'%s does not support update cursors.') % self.__class__.__name__)) 
    110105             
    111         return self.UpdateCursorClass(self, table, whereClause, orderByFields, fieldOrders, spatialReference) 
    112  
    113     def OpenDeleteCursor(self, table, whereClause=None, orderByFields=None, fieldOrders=None, spatialReference=None): 
    114         self.__class__.__doc__.Obj.ValidateMethodInvocation() 
    115         assert issubclass(self.DeleteCursorClass, DeleteCursor), u'%s must be a subclass of %s.' % (unicode(self.DeleteCursorClass.__name__), unicode(self.__class__.__name__)) 
    116         if not self.DeleteCursorSupported: 
    117             Logger.RaiseException(NotImplementedError(_(u'%s does not support delete cursors.') % unicode(self.__class__.__name__))) 
    118              
    119         return self.DeleteCursorClass(self, table, whereClause, orderByFields, fieldOrders, spatialReference) 
     106        return self.UpdateCursorClass(self, table, selectFields, whereClause, orderByFields, fieldOrders, spatialReference) 
    120107 
    121108    # Private base class methods - do not override. You should call these from 
     
    163150        self._FieldOrders = None 
    164151        self._SpatialReference = None 
    165         self._Row = None 
     152        self._RowIndex = None 
     153        self._AtEnd = False 
    166154         
    167155        if connection is not None or table is not None or selectFields is not None or whereClause is not None or orderByFields is not None or fieldOrders is not None or spatialReference is not None: 
     
    172160    def __del__(self): 
    173161        if self.IsOpen: 
    174             self.Connection._LogDebug(_u('%(conntype)s 0x%(connid)08X: Closing %(curtype)s 0x%(curid)08X.') % 
    175                                       {u'conntype': unicode(connection.__class__.__name__), u'connid': id(connection), u'curtype': unicode(self.__class__.__name__), u'curid': id(self)}) 
     162            self.Connection._LogInfo(_(u'%(curtype)s 0x%(curid)08X: closing cursor.') % {u'curtype': self.__class__.__name__, u'curid': id(self)}) 
    176163            try: 
    177164                self._Close() 
     
    185172 
    186173        if self.IsOpen: 
    187             Logger.RaiseException(RuntimeError(_(u'This %s is already open. To open another cursor, you must instantiate a new object.') % unicode(self.__class__.__name__))) 
     174            Logger.RaiseException(RuntimeError(_(u'This %s is already open. To open another cursor, you must instantiate a new object.') % self.__class__.__name__)) 
    188175        if connection is None or table is None: 
    189176            Logger.RaiseException(TypeError(_(u'To open a cursor, connection and table parameters must both be provided. Do not provide values for any other parameters unless you provide values for both connection and table.'))) 
    190         if connection.SelectCursorClass != self.__class__: 
    191             Logger.RaiseException(TypeError(_(u'A %(cur) may not be opened using a %(conn).') % {u'cur': unicode(self.__class__.__name__), u'con': unicode(connection.__class__.__name__)})) 
     177        if connection.SelectCursorClass != self.__class__ and connection.UpdateCursorClass != self.__class__: 
     178            Logger.RaiseException(TypeError(_(u'A %(cur)s may not be opened using a %(conn)s.') % {u'cur': self.__class__.__name__, u'conn': connection.__class__.__name__})) 
    192179        if selectFields is not None and not connection.SelectFieldsSupported: 
    193180            Logger.RaiseException(NotImpementedError(_(u'%s does not support the selectFields parameter. You must not provide a value for this parameter.') % self.__class__.__name__)) 
     
    205192            Logger.RaiseException(ValueError(_(u'If the orderByFields and fieldOrders parameters are provided, the two lists must have the same length.'))) 
    206193         
    207         connection._LogDebug(_u('%(conntype)s 0x%(connid)08X: Opening %(curtype)s 0x%(curid)08X: table = %(table)s, selectFields = %(sf)s, whereClause = %(wc)s, orderByFields = %(obf)s, fieldOrders = %(fo)s, spatialReference = %(sr)s') % 
    208                              {u'conntype': unicode(connection.__class__.__name__), u'connid': id(connection), u'curtype': unicode(self.__class__.__name__), u'curid': id(self), u'table': repr(table), u'sf': repr(selectFields), u'wc': repr(whereClause), u'obf': repr(orderByFields), u'fo': repr(fieldOrders), u'sr': repr(spatialReference)}) 
    209  
    210         self._Open(self, connection, table, selectFields, whereClause, orderByFields, fieldOrders, spatialReference) 
     194        connection._LogInfo(_(u'%(curtype)s 0x%(curid)08X: Opening cursor: connection = %(conntype)s 0x%(connid)08X, table = %(table)s, selectFields = %(sf)s, whereClause = %(wc)s, orderByFields = %(obf)s, fieldOrders = %(fo)s, spatialReference = %(sr)s') % 
     195                            {u'curtype': self.__class__.__name__, u'curid': id(self), u'conntype': connection.__class__.__name__, u'connid': id(connection), u'table': repr(table), u'sf': repr(selectFields), u'wc': repr(whereClause), u'obf': repr(orderByFields), u'fo': repr(fieldOrders), u'sr': repr(spatialReference)}) 
     196 
     197        self._Open(connection, table, selectFields, whereClause, orderByFields, fieldOrders, spatialReference) 
    211198         
    212199        self._IsOpen = True 
     
    218205        self._FieldOrders = fieldOrders 
    219206        self._SpatialReference = spatialReference 
    220  
    221     def Next(self): 
    222         pass 
    223 ##        assert self.IsOpen, u'The %s must be open before rows can be retrieved.' % unicode(self.__class__.__name__) 
    224 ##        rowRetrieved = self._Next() 
    225 ##        if rowRetrieved: 
    226 ##            self._Row = DatabaseRow(weakref. 
    227 ##        return rowRetrieved 
     207        self._RowIndex = None 
     208        self._AtEnd = False 
     209 
     210    def NextRow(self): 
     211        if not self.IsOpen: 
     212            Logger.RaiseException(RuntimeError(_(u'This %s must be open before rows can be retrieved.') % self.__class__.__name__)) 
     213        if self.AtEnd: 
     214            Logger.RaiseException(IndexError(_(u'No more rows can be retrieved from this %s.') % self.__class__.__name__)) 
     215 
     216        rowAvailable = self._NextRow() 
     217 
     218        if rowAvailable: 
     219            if self._RowIndex is None: 
     220                self._RowIndex = 0 
     221            else: 
     222                self._RowIndex += 1 
     223            self.Connection._LogDebug(_(u'%(curtype)s 0x%(curid)08X: Retrieved row %(row)i.') % {u'curtype': self.__class__.__name__, u'curid': id(self), u'row': self.RowIndex + 1}) 
     224        else: 
     225            self._AtEnd = True 
     226            self.Connection._LogDebug(_(u'%(curtype)s 0x%(curid)08X: No more rows available.') % {u'curtype': self.__class__.__name__, u'curid': id(self)}) 
     227 
     228        return rowAvailable 
     229 
     230    def GetValue(self, field): 
     231        self.__class__.__doc__.Obj.ValidateMethodInvocation() 
     232 
     233        if not self.IsOpen: 
     234            Logger.RaiseException(RuntimeError(_(u'This %s must be open before field values can be retrieved.') % self.__class__.__name__)) 
     235        if self.AtEnd: 
     236            Logger.RaiseException(IndexError(_(u'This %s has moved beyond the last row of the result set.') % self.__class__.__name__)) 
     237        if self.RowIndex is None: 
     238            Logger.RaiseException(RuntimeError(_(u'You must call NextRow to retrieve the first row before calling GetValue.'))) 
     239 
     240        value = self._GetValue(field) 
     241        self.Connection._LogDebug(_(u'%(curtype)s 0x%(curid)08X: Get field %(field)s returned %(value)s.') % {u'curtype': self.__class__.__name__, u'curid': id(self), u'field': field, u'value': repr(value)}) 
     242 
     243        return value 
    228244 
    229245    # Base class properties - do not override. 
     
    269285    SpatialReference = property(_GetSpatialReference, doc=DynamicDocString()) 
    270286 
    271     def _GetRow(self): 
    272         return self._Row 
    273  
    274     Row = property(_GetRow, doc=DynamicDocString()) 
     287    def _GetRowIndex(self): 
     288        if self.AtEnd: 
     289            return None 
     290        return self._RowIndex 
     291 
     292    RowIndex = property(_GetRowIndex, doc=DynamicDocString()) 
     293 
     294    def _GetAtEnd(self): 
     295        return self._AtEnd 
     296 
     297    AtEnd = property(_GetAtEnd, doc=DynamicDocString()) 
    275298 
    276299    # Methods that the derived class must override. 
     
    282305        Logger.RaiseException(NotImplementedError(u'The derived class must override this method.')) 
    283306 
    284 ##    def _GetNextRow(self): 
    285 ##        Logger.RaiseException(NotImplementedError(u'The derived class must override this method.')) 
     307    def _NextRow(self): 
     308        Logger.RaiseException(NotImplementedError(u'The derived class must override this method.')) 
     309 
     310    def _GetValue(self, field): 
     311        Logger.RaiseException(NotImplementedError(u'The derived class must override this method.')) 
    286312 
    287313 
     
    289315    __doc__ = DynamicDocString() 
    290316 
    291  
    292 class UpdateCursor(object): 
     317    # Constructor - be sure to call the base class if you override. 
     318 
     319    def __init__(self, connection=None, table=None, spatialReference=None): 
     320        self.__class__.__doc__.Obj.ValidateMethodInvocation() 
     321         
     322        self._IsOpen = False 
     323        self._Connection = None 
     324        self._Table = None 
     325        self._SpatialReference = None 
     326         
     327        if connection is not None or table is not None or spatialReference is not None: 
     328            self.Open(connection, table, spatialReference) 
     329 
     330    # Destructor - do not override. Put your cleanup in your _Close method. 
     331 
     332    def __del__(self): 
     333        if self.IsOpen: 
     334            self.Connection._LogInfo(_(u'%(curtype)s 0x%(curid)08X: closing cursor.') % {u'curtype': self.__class__.__name__, u'curid': id(self)}) 
     335            try: 
     336                self._Close() 
     337            finally: 
     338                self._Connection = None     # Release our reference to the connection, so that it will close if we are holding the last reference 
     339 
     340    # Base class methods - do not override. 
     341 
     342    def Open(self, connection, table, spatialReference=None): 
     343        self.__class__.__doc__.Obj.ValidateMethodInvocation() 
     344 
     345        if self.IsOpen: 
     346            Logger.RaiseException(RuntimeError(_(u'This %s is already open. To open another cursor, you must instantiate a new object.') % self.__class__.__name__)) 
     347        if connection is None or table is None: 
     348            Logger.RaiseException(TypeError(_(u'To open a cursor, connection and table parameters must both be provided. Do not provide values for any other parameters unless you provide values for both connection and table.'))) 
     349        if connection.InsertCursorClass != self.__class__: 
     350            Logger.RaiseException(TypeError(_(u'A %(cur)s may not be opened using a %(conn)s.') % {u'cur': self.__class__.__name__, u'conn': connection.__class__.__name__})) 
     351        if spatialReference is not None and not connection.SpatialReferenceSupported: 
     352            Logger.RaiseException(NotImpementedError(_(u'%s does not support the spatialReference parameter. You must not provide a value for this parameter.') % self.__class__.__name__)) 
     353         
     354        connection._LogInfo(_(u'%(curtype)s 0x%(curid)08X: Opening cursor: connection = %(conntype)s 0x%(connid)08X, table = %(table)s, spatialReference = %(sr)s') % 
     355                            {u'curtype': self.__class__.__name__, u'curid': id(self), u'conntype': connection.__class__.__name__, u'connid': id(connection), u'table': repr(table), u'sr': repr(spatialReference)}) 
     356 
     357        self._Open(connection, table, spatialReference) 
     358         
     359        self._IsOpen = True 
     360        self._Connection = connection 
     361        self._Table = table 
     362        self._SpatialReference = spatialReference 
     363 
     364    def SetValue(self, field, value): 
     365        self.__class__.__doc__.Obj.ValidateMethodInvocation() 
     366 
     367        if not self.IsOpen: 
     368            Logger.RaiseException(RuntimeError(_(u'This %s must be open before field values can be set.') % self.__class__.__name__)) 
     369 
     370        self._SetValue(field, value) 
     371        self.Connection._LogDebug(_(u'%(curtype)s 0x%(curid)08X: Set field %(field)s to %(value)s.') % {u'curtype': self.__class__.__name__, u'curid': id(self), u'field': field, u'value': repr(value)}) 
     372 
     373    def InsertRow(self): 
     374        if not self.IsOpen: 
     375            Logger.RaiseException(RuntimeError(_(u'This %s must be open before rows can be inserted.') % self.__class__.__name__)) 
     376             
     377        self._InsertRow() 
     378        self.Connection._LogDebug(_(u'%(curtype)s 0x%(curid)08X: Inserted row.') % {u'curtype': self.__class__.__name__, u'curid': id(self)}) 
     379 
     380    # Base class properties - do not override. 
     381 
     382    def _GetIsOpen(self): 
     383        return self._IsOpen 
     384 
     385    IsOpen = property(_GetIsOpen, doc=DynamicDocString()) 
     386 
     387    def _GetConnection(self): 
     388        return self._Connection 
     389 
     390    Connection = property(_GetConnection, doc=DynamicDocString()) 
     391 
     392    def _GetTable(self): 
     393        return self._Table 
     394 
     395    Table = property(_GetTable, doc=DynamicDocString()) 
     396 
     397    def _GetSpatialReference(self): 
     398        return self._SpatialReference 
     399 
     400    SpatialReference = property(_GetSpatialReference, doc=DynamicDocString()) 
     401 
     402    # Methods that the derived class must override. 
     403 
     404    def _Open(self, connection, table, spatialReference): 
     405        Logger.RaiseException(NotImplementedError(u'The derived class must override this method.')) 
     406 
     407    def _Close(self): 
     408        Logger.RaiseException(NotImplementedError(u'The derived class must override this method.')) 
     409 
     410    def _SetValue(self, field, value): 
     411        Logger.RaiseException(NotImplementedError(u'The derived class must override this method.')) 
     412 
     413    def _InsertRow(self): 
     414        Logger.RaiseException(NotImplementedError(u'The derived class must override this method.')) 
     415 
     416 
     417class UpdateCursor(SelectCursor):       # Note that this inherits SelectCursor 
    293418    __doc__ = DynamicDocString() 
    294419 
    295  
    296 class DeleteCursor(object): 
    297     __doc__ = DynamicDocString() 
     420    # Constructor. 
     421     
     422    def __init__(self, connection=None, table=None, selectFields=None, whereClause=None, orderByFields=None, fieldOrders=None, spatialReference=None): 
     423        self._RowUpdated = False 
     424        self._RowDeleted = False 
     425        super(UpdateCursor, self).__init__(connection, table, selectFields, whereClause, orderByFields, fieldOrders, spatialReference) 
     426 
     427    # Base class methods - do not override. 
     428 
     429    def NextRow(self): 
     430        rowAvailable = super(UpdateCursor, self).NextRow() 
     431        self._RowUpdated = False 
     432        self._RowDeleted = False 
     433        return rowAvailable 
     434 
     435    def GetValue(self, field): 
     436        if self.RowUpdated: 
     437            Logger.RaiseException(RuntimeError(_(u'UpdateRow was previously invoked for this row. After the row has been updated, you may no longer get the values of its fields.'))) 
     438        if self.RowDeleted: 
     439            Logger.RaiseException(RuntimeError(_(u'DeleteRow was previously invoked for this row. After the row has been deleted, you may no longer get the values of its fields.'))) 
     440 
     441        return super(UpdateCursor, self).GetValue(field) 
     442 
     443    def SetValue(self, field, value): 
     444        self.__class__.__doc__.Obj.ValidateMethodInvocation() 
     445 
     446        if not self.IsOpen: 
     447            Logger.RaiseException(RuntimeError(_(u'This %s must be open before field values can be set.') % self.__class__.__name__)) 
     448        if self.AtEnd: 
     449            Logger.RaiseException(IndexError(_(u'This %s has moved beyond the last row of the result set.') % self.__class__.__name__)) 
     450        if self.RowIndex is None: 
     451            Logger.RaiseException(RuntimeError(_(u'You must call NextRow to retrieve the first row before calling SetValue.'))) 
     452        if self.RowUpdated: 
     453            Logger.RaiseException(RuntimeError(_(u'UpdateRow was previously invoked for this row. After the row has been updated, you may no longer set the values of its fields.'))) 
     454        if self.RowDeleted: 
     455            Logger.RaiseException(RuntimeError(_(u'DeleteRow was previously invoked for this row. After the row has been deleted, you may no longer set the values of its fields.'))) 
     456 
     457        self._SetValue(field, value) 
     458        self.Connection._LogDebug(_(u'%(curtype)s 0x%(curid)08X: Set field %(field)s to %(value)s.') % {u'curtype': self.__class__.__name__, u'curid': id(self), u'field': field, u'value': repr(value)}) 
     459 
     460    def UpdateRow(self): 
     461        if not self.IsOpen: 
     462            Logger.RaiseException(RuntimeError(_(u'This %s must be open before rows can be updated.') % self.__class__.__name__)) 
     463        if self.AtEnd: 
     464            Logger.RaiseException(IndexError(_(u'This %s has moved beyond the last row of the result set.') % self.__class__.__name__)) 
     465        if self.RowIndex is None: 
     466            Logger.RaiseException(RuntimeError(_(u'You must call NextRow to retrieve the first row before calling UpdateRow.'))) 
     467        if self.RowUpdated: 
     468            Logger.RaiseException(RuntimeError(_(u'UpdateRow was previously invoked for this row. You cannot update it a second time.'))) 
     469        if self.RowDeleted: 
     470            Logger.RaiseException(RuntimeError(_(u'DeleteRow was previously invoked for this row. You cannot update it after it has been deleted.'))) 
     471             
     472        self._UpdateRow() 
     473        self.Connection._LogDebug(_(u'%(curtype)s 0x%(curid)08X: Updated row.') % {u'curtype': self.__class__.__name__, u'curid': id(self)}) 
     474        self._RowUpdated = True 
     475 
     476    def DeleteRow(self): 
     477        if not self.IsOpen: 
     478            Logger.RaiseException(RuntimeError(_(u'This %s must be open before rows can be deleted.') % self.__class__.__name__)) 
     479        if self.AtEnd: 
     480            Logger.RaiseException(IndexError(_(u'This %s has moved beyond the last row of the result set.') % self.__class__.__name__)) 
     481        if self.RowIndex is None: 
     482            Logger.RaiseException(RuntimeError(_(u'You must call NextRow to retrieve the first row before calling DeleteRow.'))) 
     483        if self.RowUpdated: 
     484            Logger.RaiseException(RuntimeError(_(u'UpdateRow was previously invoked for this row. You cannot delete it after it has been updated.'))) 
     485        if self.RowDeleted: 
     486            Logger.RaiseException(RuntimeError(_(u'DeleteRow was previously invoked for this row. You cannot delete it a second time.'))) 
     487             
     488        self._DeleteRow() 
     489        self.Connection._LogDebug(_(u'%(curtype)s 0x%(curid)08X: Deleted row.') % {u'curtype': self.__class__.__name__, u'curid': id(self)}) 
     490        self._RowDeleted = True 
     491 
     492    # Base class properties - do not override. 
     493 
     494    def _GetRowUpdated(self): 
     495        return self._RowUpdated 
     496 
     497    RowUpdated = property(_GetRowUpdated, doc=DynamicDocString()) 
     498 
     499    def _GetRowDeleted(self): 
     500        return self._RowDeleted 
     501 
     502    RowDeleted = property(_GetRowDeleted, doc=DynamicDocString()) 
     503 
     504    # Methods that the derived class must override, in addition to those defined 
     505    # by SelectCursor. 
     506 
     507    def _SetValue(self, field, value): 
     508        Logger.RaiseException(NotImplementedError(u'The derived class must override this method.')) 
     509 
     510    def _UpdateRow(self): 
     511        Logger.RaiseException(NotImplementedError(u'The derived class must override this method.')) 
     512 
     513    def _DeleteRow(self): 
     514        Logger.RaiseException(NotImplementedError(u'The derived class must override this method.')) 
    298515 
    299516 
     
    361578create a new derived class. 
    362579 
    363 You may notice that this class does not define a constructor or methods 
    364 for opening and closing the connection. This was done for two reasons: 
    365  
    366 * First, different low-level database access APIs require different 
     580This class does not define a constructor or methods for opening and 
     581closing the connection. This was done for two reasons: 
     582 
     583* Different low-level database access APIs require different 
    367584  parameters for establishing connections. Some APIs do not have a 
    368585  notion of connections at all. For example, the ArcGIS geoprocessor, 
     
    371588  cover all cases but not be clunky. 
    372589 
    373 Second, the design pattern used throughout GeoEco does not really 
    374 require a common abstraction for opening and closing connections. A 
    375 given GeoEco "tool" provides at least two implementations of itself. 
    376 The first accepts a DatabaseConnection instance for a connection that 
    377 is already open. This allows the caller to pass in any type of 
    378 connection that supports the options required by the tool (the tool 
    379 should check the properties of the DatabaseConnection and raise an 
    380 error if a required option is not supported). The second and 
    381 subsequent implementations are written for users of specific types of 
    382 databases. These accept connection parameters, establish the 
    383 connections, and invoke the first implementation.""")) 
    384  
    385 # Base class properties 
     590* The design pattern used throughout GeoEco does not really 
     591  require a common abstraction for opening and closing connections. 
     592  Most GeoEco functions intended for external callers provide are 
     593  available in at least two implementations. The first accepts a 
     594  DatabaseConnection instance for a connection that is already open. 
     595  This allows the caller to pass in any type of open connection 
     596  (providing it supports the required options). The second and 
     597  subsequent implementations are written for users of specific types 
     598  of databases. These accept connection information, establish the 
     599  connections, and invoke the first implementation.""")) 
     600 
     601# Properties 
    386602 
    387603AddPropertyMetadata(DatabaseConnection.SelectCursorSupported, 
    388604    typeMetadata=BooleanTypeMetadata(), 
    389     shortDescription=_(u'True if this connection supports select cursors for reading rows from tables.')) 
     605    shortDescription=_(u'True if this connection supports select cursors.'), 
     606    longDescription=_(u'If False, you cannot open select cursors using this connection.')) 
    390607 
    391608AddPropertyMetadata(DatabaseConnection.InsertCursorSupported, 
    392609    typeMetadata=BooleanTypeMetadata(), 
    393     shortDescription=_(u'True if this connection supports insert cursors for appending rows to tables.')) 
     610    shortDescription=_(u'True if this connection supports insert cursors.'), 
     611    longDescription=_(u'If False, you cannot open insert cursors using this connection.')) 
    394612 
    395613AddPropertyMetadata(DatabaseConnection.UpdateCursorSupported, 
    396614    typeMetadata=BooleanTypeMetadata(), 
    397     shortDescription=_(u'True if this connection supports update cursors for changing the values of fields of existing table rows.')) 
    398  
    399 AddPropertyMetadata(DatabaseConnection.DeleteCursorSupported, 
    400     typeMetadata=BooleanTypeMetadata(), 
    401     shortDescription=_(u'True if this connection supports delete cursors for deleting existing table rows.')) 
     615    shortDescription=_(u'True if this connection supports update cursors.'), 
     616    longDescription=_(u'If False, you cannot open update cursors using this connection.')) 
    402617 
    403618AddPropertyMetadata(DatabaseConnection.SelectCursorClass, 
     
    412627    typeMetadata=ClassTypeMetadata(cls=UpdateCursor), 
    413628    shortDescription=_(u'Subclass of %s that implements an update cursor for this type of database connection.') % UpdateCursor.__name__) 
    414  
    415 AddPropertyMetadata(DatabaseConnection.DeleteCursorClass, 
    416     typeMetadata=ClassTypeMetadata(cls=DeleteCursor), 
    417     shortDescription=_(u'Subclass of %s that implements a delete cursor for this type of database connection.') % DeleteCursor.__name__) 
    418629 
    419630AddPropertyMetadata(DatabaseConnection.SelectFieldsSupported, 
     
    424635AddPropertyMetadata(DatabaseConnection.WhereClauseSupported, 
    425636    typeMetadata=BooleanTypeMetadata(), 
    426     shortDescription=_(u'True if the select, update, and delete cursors for this connection support the whereClause parameter.'), 
    427     longDescription=_(u'If False, you may not provide a value for the whereClause parameter when opening select, update, or delete cursors.')) 
     637    shortDescription=_(u'True if the select and update cursors for this connection support the whereClause parameter.'), 
     638    longDescription=_(u'If False, you may not provide a value for the whereClause parameter when opening select or update cursors.')) 
    428639 
    429640AddPropertyMetadata(DatabaseConnection.OrderBySupported, 
    430641    typeMetadata=BooleanTypeMetadata(), 
    431     shortDescription=_(u'True if the select, update, and delete cursors for this connection support the orderByFields and fieldOrders parameters.'), 
    432     longDescription=_(u'If False, you may not provide values for the orderByFields and fieldOrders parameters when opening select, update, or delete cursors.')) 
     642    shortDescription=_(u'True if the select and delete cursors for this connection support the orderByFields and fieldOrders parameters.'), 
     643    longDescription=_(u'If False, you may not provide values for the orderByFields and fieldOrders parameters when opening select or update cursors.')) 
    433644 
    434645AddPropertyMetadata(DatabaseConnection.SpatialReferenceSupported, 
     
    440651 
    441652AddMethodMetadata(DatabaseConnection.OpenSelectCursor, 
    442     shortDescription=_(u'Opens a cursor for selecting (reading) rows from a table.'), 
     653    shortDescription=_(u'Opens a cursor for reading rows from a table.'), 
    443654    longDescription=_( 
    444655u"""This method will fail if the connection's SelectCursorSupported 
     
    476687simply omit this parameter when you call this method. 
    477688 
    478 If the connection's SelectFieldsSupported property is False, then this 
     689If the connection's SelectFieldsSupported property is False, this 
    479690method will fail if you provide a value for this parameter. 
    480691 
     
    490701If this parameter is not provided, all of the rows will be returned. 
    491702 
    492 If the connection's WhereClauseSupported property is False, then this 
     703If the connection's WhereClauseSupported property is False, this 
    493704method will fail if you provide a value for this parameter.""")) 
    494705 
     
    508719same number of elements as this one. 
    509720 
    510 If the connection's OrderBySupported property is False, then this 
    511 method will fail if you provide a value for this parameter.""")) 
     721If the connection's OrderBySupported property is False, this method 
     722will fail if you provide a value for this parameter.""")) 
    512723 
    513724AddArgumentMetadata(DatabaseConnection.OpenSelectCursor, u'fieldOrders', 
     
    523734access API. 
    524735 
    525 If the connection's OrderBySupported property is False, then this 
    526 method will fail if you provide a value for this parameter.""")) 
     736If the connection's OrderBySupported property is False, this method 
     737will fail if you provide a value for this parameter.""")) 
    527738 
    528739AddArgumentMetadata(DatabaseConnection.OpenSelectCursor, u'spatialReference', 
     
    530741    description=_( 
    531742u"""Coordinate system into which coordinate fields should be 
    532 projected. At the time of this writing, only the ArcGIS 9.2 
    533 geoprocessor supported this parameter. Please see the ArcGIS 
    534 documentation for more information. 
    535  
    536 If the connection's SpatialReferenceSupported property is False, then 
    537 this method will fail if you provide a value for this parameter.""")) 
     743projected. At the time of this writing, only the ArcGIS geoprocessor 
     744supported this parameter. Please see the ArcGIS documentation for more 
     745information. 
     746 
     747If the connection's SpatialReferenceSupported property is False, this 
     748method will fail if you provide a value for this parameter.""")) 
    538749 
    539750AddResultMetadata(DatabaseConnection.OpenSelectCursor, u'cursor', 
    540751    typeMetadata=ClassInstanceTypeMetadata(cls=SelectCursor), 
    541     description=_(u'The object representing the opened select cursor.')) 
     752    description=_(u'The object representing the opened cursor.')) 
     753 
     754# Base class method: OpenInsertCursor 
     755 
     756AddMethodMetadata(DatabaseConnection.OpenInsertCursor, 
     757    shortDescription=_(u'Opens a cursor for inserting rows into a table.'), 
     758    longDescription=_( 
     759u"""This method will fail if the connection's InsertCursorSupported 
     760property is False or if the connection is not open. 
     761 
     762table is the only required parameter. You may provide the other 
     763parameters if they underlying database access API supports them. To 
     764determine whether a particular parameter is supported, check the 
     765property specified by the parameter's documentation. This method will 
     766fail if you provide a value for an unsupported parameter. 
     767 
     768The cursor will be closed automatically when all references to the 
     769cursor object are released.""")) 
     770 
     771CopyArgumentMetadata(DatabaseConnection.OpenSelectCursor, u'self', DatabaseConnection.OpenInsertCursor, u'self') 
     772CopyArgumentMetadata(DatabaseConnection.OpenSelectCursor, u'table', DatabaseConnection.OpenInsertCursor, u'table') 
     773CopyArgumentMetadata(DatabaseConnection.OpenSelectCursor, u'spatialReference', DatabaseConnection.OpenInsertCursor, u'spatialReference') 
     774 
     775AddResultMetadata(DatabaseConnection.OpenInsertCursor, u'cursor', 
     776    typeMetadata=ClassInstanceTypeMetadata(cls=InsertCursor), 
     777    description=DatabaseConnection.OpenSelectCursor.__doc__.Obj.Results[0].Description) 
     778 
     779# Base class method: OpenUpdateCursor 
     780 
     781AddMethodMetadata(DatabaseConnection.OpenUpdateCursor, 
     782    shortDescription=_(u'Opens a cursor for reading, updating, and deleting the values of rows in a table.'), 
     783    longDescription=_( 
     784u"""This method will fail if the connection's UpdateCursorSupported 
     785property is False or if the connection is not open. 
     786 
     787table is the only required parameter. You may provide the other 
     788parameters if they underlying database access API supports them. To 
     789determine whether a particular parameter is supported, check the 
     790property specified by the parameter's documentation. This method will 
     791fail if you provide a value for an unsupported parameter. 
     792 
     793The cursor will be closed automatically when all references to the 
     794cursor object are released.""")) 
     795 
     796CopyArgumentMetadata(DatabaseConnection.OpenSelectCursor, u'self', DatabaseConnection.OpenUpdateCursor, u'self') 
     797CopyArgumentMetadata(DatabaseConnection.OpenSelectCursor, u'table', DatabaseConnection.OpenUpdateCursor, u'table') 
     798CopyArgumentMetadata(DatabaseConnection.OpenSelectCursor, u'selectFields', DatabaseConnection.OpenUpdateCursor, u'selectFields') 
     799CopyArgumentMetadata(DatabaseConnection.OpenSelectCursor, u'whereClause', DatabaseConnection.OpenUpdateCursor, u'whereClause') 
     800CopyArgumentMetadata(DatabaseConnection.OpenSelectCursor, u'orderByFields', DatabaseConnection.OpenUpdateCursor, u'orderByFields') 
     801CopyArgumentMetadata(DatabaseConnection.OpenSelectCursor, u'fieldOrders', DatabaseConnection.OpenUpdateCursor, u'fieldOrders') 
     802CopyArgumentMetadata(DatabaseConnection.OpenSelectCursor, u'spatialReference', DatabaseConnection.OpenUpdateCursor, u'spatialReference') 
     803 
     804AddResultMetadata(DatabaseConnection.OpenUpdateCursor, u'cursor', 
     805    typeMetadata=ClassInstanceTypeMetadata(cls=UpdateCursor), 
     806    description=DatabaseConnection.OpenSelectCursor.__doc__.Obj.Results[0].Description) 
    542807 
    543808############################################################################### 
     
    546811 
    547812AddClassMetadata(SelectCursor, 
    548     shortDescription=_(u'Represents a cursor used to select (read) rows from a table.'), 
     813    shortDescription=_(u'Represents a cursor used to read rows from a table.'), 
    549814    longDescription=_( 
    550815u"""This base class class defines the properties and methods that all 
     
    562827 
    563828AddMethodMetadata(SelectCursor.__init__, 
    564     shortDescription=_(u'Constructs a new %s instance.') % SelectCursor.__name__) 
     829    shortDescription=_(u'Constructs a new %s instance.') % SelectCursor.__name__, 
     830    longDescription=_( 
     831u"""This is an abstract class; do not instantiate it directly. The 
     832appropriate way to obtain an instance of this class is to call the 
     833OpenSelectCursor method of a DatabaseConnection instance. 
     834 
     835Derived classes that override this constructor should ensure they 
     836explicitly invoke it from their own implementation, so that the base 
     837class is properly initialized.""")) 
    565838 
    566839AddArgumentMetadata(SelectCursor.__init__, u'self', 
     
    582855    typeMetadata=UnicodeStringTypeMetadata(minLength=1, canBeNone=True), 
    583856    description=_( 
    584 u"""Name of the database table to query. 
     857u"""Database table to access. 
    585858 
    586859If this parameter is provided, the connection parameter must also be 
    587860provided, and the cursor will be opened immediately.""")) 
    588861 
    589 AddArgumentMetadata(SelectCursor.__init__, u'selectFields', 
    590     typeMetadata=DatabaseConnection.OpenSelectCursor.__doc__.Obj.Arguments[2].Type, 
    591     description=DatabaseConnection.OpenSelectCursor.__doc__.Obj.Arguments[2].Description) 
    592  
    593 AddArgumentMetadata(SelectCursor.__init__, u'whereClause', 
    594     typeMetadata=DatabaseConnection.OpenSelectCursor.__doc__.Obj.Arguments[3].Type, 
    595     description=DatabaseConnection.OpenSelectCursor.__doc__.Obj.Arguments[3].Description) 
    596  
    597 AddArgumentMetadata(SelectCursor.__init__, u'orderByFields', 
    598     typeMetadata=DatabaseConnection.OpenSelectCursor.__doc__.Obj.Arguments[4].Type, 
    599     description=DatabaseConnection.OpenSelectCursor.__doc__.Obj.Arguments[4].Description) 
    600  
    601 AddArgumentMetadata(SelectCursor.__init__, u'fieldOrders', 
    602     typeMetadata=DatabaseConnection.OpenSelectCursor.__doc__.Obj.Arguments[5].Type, 
    603     description=DatabaseConnection.OpenSelectCursor.__doc__.Obj.Arguments[5].Description) 
    604  
    605 AddArgumentMetadata(SelectCursor.__init__, u'spatialReference', 
    606     typeMetadata=DatabaseConnection.OpenSelectCursor.__doc__.Obj.Arguments[6].Type, 
    607     description=DatabaseConnection.OpenSelectCursor.__doc__.Obj.Arguments[6].Description) 
     862CopyArgumentMetadata(DatabaseConnection.OpenSelectCursor, u'selectFields', SelectCursor.__init__, u'selectFields') 
     863CopyArgumentMetadata(DatabaseConnection.OpenSelectCursor, u'whereClause', SelectCursor.__init__, u'whereClause') 
     864CopyArgumentMetadata(DatabaseConnection.OpenSelectCursor, u'orderByFields', SelectCursor.__init__, u'orderByFields') 
     865CopyArgumentMetadata(DatabaseConnection.OpenSelectCursor, u'fieldOrders', SelectCursor.__init__, u'fieldOrders') 
     866CopyArgumentMetadata(DatabaseConnection.OpenSelectCursor, u'spatialReference', SelectCursor.__init__, u'spatialReference') 
     867 
     868AddResultMetadata(SelectCursor.__init__, u'cursor', 
     869    typeMetadata=ClassInstanceTypeMetadata(cls=SelectCursor), 
     870    description=_(u'New %s instance.') % SelectCursor.__name__) 
    608871 
    609872# Destructor 
     
    613876    longDescription=_( 
    614877u"""This destructor is automatically called when all of the references 
    615 to the %s instance are released, either explicitly by the caller or 
    616 when the Python garbage collector releases them. In general, you do 
    617 not need to worry about explicitly releasing your database cursors 
    618 unless you are concerned about database locks. To explicitly release 
    619 your cursor, simply release all references to the %s instance."""  % 
    620 (SelectCursor.__name__, SelectCursor.__name__))) 
    621  
    622 AddArgumentMetadata(SelectCursor.__del__, u'self', 
    623     typeMetadata=ClassInstanceTypeMetadata(cls=SelectCursor), 
    624     description=_(u'%s instance.') % SelectCursor.__name__) 
     878to this instance are released, either explicitly by the caller or when 
     879the Python garbage collector releases them. In general, you do not 
     880need to worry about explicitly releasing your database cursors unless 
     881you are concerned about database locks. To explicitly release your 
     882cursor, simply release all references to this instance.""")) 
     883 
     884CopyArgumentMetadata(SelectCursor.__init__, u'self', SelectCursor.__del__, u'self') 
    625885 
    626886# Base class method: Open 
    627887 
    628888AddMethodMetadata(SelectCursor.Open, 
    629     shortDescription=_(u'Opens a cursor for selecting (reading) rows from a table.'), 
    630     longDescription=_(u'This method will fail if the database connection is not open.')) 
    631  
    632 AddArgumentMetadata(SelectCursor.Open, u'self', 
    633     typeMetadata=ClassInstanceTypeMetadata(cls=SelectCursor), 
    634     description=_(u'%s instance.') % SelectCursor.__name__) 
     889    shortDescription=_(u'Opens the cursor.'), 
     890    longDescription=_( 
     891u"""This method will fail if the database connection is not open. Once 
     892the cursor has been opened, it cannot be re-opened. To open another 
     893cursor, instantiate another cursor object.""")) 
     894 
     895CopyArgumentMetadata(SelectCursor.__init__, u'self', SelectCursor.Open, u'self') 
    635896 
    636897AddArgumentMetadata(SelectCursor.Open, u'connection', 
    637     typeMetadata=ClassInstanceTypeMetadata(cls=DatabaseConnection, canBeNone=True), 
     898    typeMetadata=ClassInstanceTypeMetadata(cls=DatabaseConnection), 
    638899    description=_( 
    639900u"""%s instance that manages the database connection that should be 
    640901used to open this cursor.""" % DatabaseConnection.__name__)) 
    641902 
    642 AddArgumentMetadata(SelectCursor.Open, u'table', 
    643     typeMetadata=UnicodeStringTypeMetadata(minLength=1, canBeNone=True), 
    644     description=_(u"""Name of the database table to query.""")) 
    645  
    646 AddArgumentMetadata(SelectCursor.Open, u'selectFields', 
    647     typeMetadata=SelectCursor.__init__.__doc__.Obj.Arguments[3].Type, 
    648     description=SelectCursor.__init__.__doc__.Obj.Arguments[3].Description) 
    649  
    650 AddArgumentMetadata(SelectCursor.Open, u'whereClause', 
    651     typeMetadata=SelectCursor.__init__.__doc__.Obj.Arguments[4].Type, 
    652     description=SelectCursor.__init__.__doc__.Obj.Arguments[4].Description) 
    653  
    654 AddArgumentMetadata(SelectCursor.Open, u'orderByFields', 
    655     typeMetadata=SelectCursor.__init__.__doc__.Obj.Arguments[5].Type, 
    656     description=SelectCursor.__init__.__doc__.Obj.Arguments[5].Description) 
    657  
    658 AddArgumentMetadata(SelectCursor.Open, u'fieldOrders', 
    659     typeMetadata=SelectCursor.__init__.__doc__.Obj.Arguments[6].Type, 
    660     description=SelectCursor.__init__.__doc__.Obj.Arguments[6].Description) 
    661  
    662 AddArgumentMetadata(SelectCursor.Open, u'spatialReference', 
    663     typeMetadata=SelectCursor.__init__.__doc__.Obj.Arguments[7].Type, 
    664     description=SelectCursor.__init__.__doc__.Obj.Arguments[7].Description) 
     903CopyArgumentMetadata(DatabaseConnection.OpenSelectCursor, u'table', SelectCursor.Open, u'table') 
     904CopyArgumentMetadata(DatabaseConnection.OpenSelectCursor, u'selectFields', SelectCursor.Open, u'selectFields') 
     905CopyArgumentMetadata(DatabaseConnection.OpenSelectCursor, u'whereClause', SelectCursor.Open, u'whereClause') 
     906CopyArgumentMetadata(DatabaseConnection.OpenSelectCursor, u'orderByFields', SelectCursor.Open, u'orderByFields') 
     907CopyArgumentMetadata(DatabaseConnection.OpenSelectCursor, u'fieldOrders', SelectCursor.Open, u'fieldOrders') 
     908CopyArgumentMetadata(DatabaseConnection.OpenSelectCursor, u'spatialReference', SelectCursor.Open, u'spatialReference') 
     909 
     910# Base class method: NextRow 
     911 
     912AddMethodMetadata(SelectCursor.NextRow, 
     913    shortDescription=_(u'Moves the cursor to the next row in the result set.'), 
     914    longDescription=_( 
     915u"""This method will fail if the cursor is not open or it has already 
     916moved beyond the last row in the result set.""")) 
     917 
     918CopyArgumentMetadata(SelectCursor.__init__, u'self', SelectCursor.NextRow, u'self') 
     919 
     920AddResultMetadata(SelectCursor.NextRow, u'rowAvailable', 
     921    typeMetadata=BooleanTypeMetadata(), 
     922    description=_( 
     923u"""True if a row was retrieved and the values of the row's fields can 
     924now be accessed using the GetValue method. 
     925 
     926False if a row was not retrieved. The cursor is now positioned beyond 
     927the last row and calling NextRow other cursor methods will fail.""")) 
     928 
     929# Base class method: GetValue 
     930 
     931AddMethodMetadata(SelectCursor.GetValue, 
     932    shortDescription=_(u'Gets the value of a field of the current row.'), 
     933    longDescription=_( 
     934u"""This method will fail if the cursor is not open or it has already 
     935moved beyond the last row in the result set.""")) 
     936 
     937CopyArgumentMetadata(SelectCursor.__init__, u'self', SelectCursor.GetValue, u'self') 
     938 
     939AddArgumentMetadata(SelectCursor.GetValue, u'field', 
     940    typeMetadata=UnicodeStringTypeMetadata(minLength=1), 
     941    description=_(u'Name of the field to get.')) 
     942 
     943AddResultMetadata(SelectCursor.GetValue, u'value', 
     944    typeMetadata=AnyObjectTypeMetadata(canBeNone=True), 
     945    description=_( 
     946u"""Value of the field. The data type of the returned value depends on 
     947the data type of the field in the database table. Database NULLs are 
     948typically returned as None in Python (usually called null in other 
     949languages).""")) 
     950 
     951# Base class properties 
     952 
     953AddPropertyMetadata(SelectCursor.IsOpen, 
     954    typeMetadata=BooleanTypeMetadata(), 
     955    shortDescription=_(u'True if this cursor is open. If False, the other methods of this object will fail until the cursor is opened.')) 
     956 
     957AddPropertyMetadata(SelectCursor.Connection, 
     958    typeMetadata=ClassInstanceTypeMetadata(cls=DatabaseConnection, canBeNone=True), 
     959    shortDescription=_(u'%s instance that this cursor is associated with.') % DatabaseConnection.__name__) 
     960 
     961AddPropertyMetadata(SelectCursor.Table, 
     962    typeMetadata=UnicodeStringTypeMetadata(canBeNone=True, minLength=1), 
     963    shortDescription=_(u'Database table that this cursor is accessing.')) 
     964 
     965AddPropertyMetadata(SelectCursor.SelectFields, 
     966    typeMetadata=SelectCursor.__init__.__doc__.Obj.GetArgumentByName(u'selectFields').Type, 
     967    shortDescription=_(u'List of field names provided by the caller when the cursor was opened.'), 
     968    longDescription=_( 
     969u"""This property will only return a value if one was provided by the 
     970caller when the cursor was opened. Please see the documentation for 
     971the Open method for more information about this property.""")) 
     972 
     973AddPropertyMetadata(SelectCursor.WhereClause, 
     974    typeMetadata=SelectCursor.__init__.__doc__.Obj.GetArgumentByName(u'whereClause').Type, 
     975    shortDescription=_(u'The WHERE clause provided by the caller when the cursor was opened.'), 
     976    longDescription=SelectCursor.SelectFields.__doc__.Obj.LongDescription) 
     977 
     978AddPropertyMetadata(SelectCursor.OrderByFields, 
     979    typeMetadata=SelectCursor.__init__.__doc__.Obj.GetArgumentByName(u'orderByFields').Type, 
     980    shortDescription=_(u'The list of ORDER BY field names provided by the caller when the cursor was opened.'), 
     981    longDescription=SelectCursor.SelectFields.__doc__.Obj.LongDescription) 
     982 
     983AddPropertyMetadata(SelectCursor.FieldOrders, 
     984    typeMetadata=SelectCursor.__init__.__doc__.Obj.GetArgumentByName(u'fieldOrders').Type, 
     985    shortDescription=_(u'The list of ORDER BY field orders provided by the caller when the cursor was opened.'), 
     986    longDescription=SelectCursor.SelectFields.__doc__.Obj.LongDescription) 
     987 
     988AddPropertyMetadata(SelectCursor.SpatialReference, 
     989    typeMetadata=SelectCursor.__init__.__doc__.Obj.GetArgumentByName(u'spatialReference').Type, 
     990    shortDescription=_(u'The spatial reference provided by the caller when the cursor was opened.'), 
     991    longDescription=SelectCursor.SelectFields.__doc__.Obj.LongDescription) 
     992 
     993AddPropertyMetadata(SelectCursor.RowIndex, 
     994    typeMetadata=IntegerTypeMetadata(canBeNone=True), 
     995    shortDescription=_(u'The zero-based row index of the cursor in the result set.'), 
     996    longDescription=_( 
     997u"""When the cursor is first opened, it will not be positioned on a 
     998row yet and this property will return None in Python (usually called 
     999null in other languages). If NextRow is called and a row is available, 
     1000this property will then return 0. If NextRow is called again and a 
     1001second row is available, this property will then return 1. This 
     1002behavior will continue until NextRow is called and no subsequent row 
     1003is available, at which time this property will return None.""")) 
     1004 
     1005AddPropertyMetadata(SelectCursor.AtEnd, 
     1006    typeMetadata=BooleanTypeMetadata(), 
     1007    shortDescription=_(u'True if the cursor has moved past the end of the result set.'), 
     1008    longDescription=_( 
     1009u"""When the cursor is first opened, it will not be positioned on a 
     1010row yet and this property will return False. If NextRow is called and 
     1011a row is available, this property will then return True. This behavior 
     1012will continue until NextRow is called and no subsequent row is 
     1013available, at which time this property will return False.""")) 
     1014 
     1015# Derived class method: _Open 
     1016 
     1017AddMethodMetadata(SelectCursor._Open, 
     1018    shortDescription=_(u'Implements the cursor\'s open operation.'), 
     1019    longDescription=_( 
     1020u"""Do not call this method directly; call Open instead. This method 
     1021should only be called by the base class itself. 
     1022 
     1023This method must be overridden by the derived class. The base class 
     1024implementation raises NotImplementedError. 
     1025 
     1026The base class maintains all of its own properties, including IsOpen 
     1027and Connection. The derived class should not set any of the base 
     1028class's properties.""")) 
     1029 
     1030CopyArgumentMetadata(SelectCursor.Open, u'self', SelectCursor._Open, u'self') 
     1031CopyArgumentMetadata(SelectCursor.Open, u'connection', SelectCursor._Open, u'connection') 
     1032CopyArgumentMetadata(SelectCursor.Open, u'table', SelectCursor._Open, u'table') 
     1033CopyArgumentMetadata(SelectCursor.Open, u'selectFields', SelectCursor._Open, u'selectFields') 
     1034CopyArgumentMetadata(SelectCursor.Open, u'whereClause', SelectCursor._Open, u'whereClause') 
     1035CopyArgumentMetadata(SelectCursor.Open, u'orderByFields', SelectCursor._Open, u'orderByFields') 
     1036CopyArgumentMetadata(SelectCursor.Open, u'fieldOrders', SelectCursor._Open, u'fieldOrders') 
     1037CopyArgumentMetadata(SelectCursor.Open, u'spatialReference', SelectCursor._Open, u'spatialReference') 
     1038 
     1039# Derived class method: _Close 
     1040 
     1041AddMethodMetadata(SelectCursor._Close, 
     1042    shortDescription=_(u'Implements the cursor\'s close operation.'), 
     1043    longDescription=_( 
     1044u"""Do not call this method directly. This method should only be 
     1045called by the base class itself. 
     1046 
     1047This method must be overridden by the derived class. The base class 
     1048implementation raises NotImplementedError. When this method is called, 
     1049the derived class should close the cursor and release all resources 
     1050associated with it.""")) 
     1051 
     1052CopyArgumentMetadata(SelectCursor.Open, u'self', SelectCursor._Close, u'self') 
     1053 
     1054# Derived class method: _NextRow 
     1055 
     1056AddMethodMetadata(SelectCursor._NextRow, 
     1057    shortDescription=_(u'Implements the cursor\'s row-advance operation.'), 
     1058    longDescription=_( 
     1059u"""Do not call this method directly; call NextRow instead. This method 
     1060should only be called by the base class itself. 
     1061 
     1062This method must be overridden by the derived class. The base class 
     1063implementation raises NotImplementedError.""")) 
     1064 
     1065CopyArgumentMetadata(SelectCursor.NextRow, u'self', SelectCursor._NextRow, u'self') 
     1066 
     1067AddResultMetadata(SelectCursor._NextRow, u'rowAvailable', 
     1068    typeMetadata=BooleanTypeMetadata(), 
     1069    description=_( 
     1070u"""The derived class should return True if a row was retrieved and 
     1071the values of the row's fields can now be accessed using the GetValue 
     1072method, or False if a row was not retrieved. 
     1073 
     1074The base class maintains all of its own properties, including RowIndex 
     1075and AtEnd. The derived class should not set any of the base class's 
     1076properties. Returning False tells the base class that the cursor has 
     1077moved beyond the last row of the result set.""")) 
     1078 
     1079# Derived class method: _GetValue 
     1080 
     1081AddMethodMetadata(SelectCursor._GetValue, 
     1082    shortDescription=_(u'Implements the cursor\'s get value operation.'), 
     1083    longDescription=_( 
     1084u"""Do not call this method directly; call GetValue instead. This 
     1085method should only be called by the base class itself. 
     1086 
     1087This method must be overridden by the derived class. The base class 
     1088implementation raises NotImplementedError.""")) 
     1089 
     1090CopyArgumentMetadata(SelectCursor.GetValue, u'self', SelectCursor._GetValue, u'self') 
     1091CopyArgumentMetadata(SelectCursor.GetValue, u'field', SelectCursor._GetValue, u'field') 
     1092 
     1093CopyResultMetadata(SelectCursor.GetValue, u'value', SelectCursor._GetValue, u'value') 
     1094 
     1095############################################################################### 
     1096# Metadata: InsertCursor class 
     1097############################################################################### 
     1098 
     1099AddClassMetadata(InsertCursor, 
     1100    shortDescription=_(u'Represents a cursor used to insert rows into a table.'), 
     1101    longDescription=_( 
     1102u"""This base class class defines the properties and methods that all 
     1103insert cursor classes must implement to be used within GeoEco. This is 
     1104an abstract class; do not instantiate it directly. The appropriate way 
     1105to obtain an instance of this class is to call the OpenInsertCursor 
     1106method of a DatabaseConnection instance. 
     1107 
     1108Each derived class wraps cursor execution calls for a specific 
     1109low-level database access API. For example, the ArcGIS91InsertCursor 
     1110class wraps the ArcGIS 9.1 geoprocessor's InsertCursor function. To 
     1111add support for a new low-level API, create a new derived class.""")) 
     1112 
     1113# Constructor 
     1114 
     1115AddMethodMetadata(InsertCursor.__init__, 
     1116    shortDescription=_(u'Constructs a new %s instance.') % InsertCursor.__name__, 
     1117    longDescription=_( 
     1118u"""This is an abstract class; do not instantiate it directly. The 
     1119appropriate way to obtain an instance of this class is to call the 
     1120OpenInsertCursor method of a DatabaseConnection instance. 
     1121 
     1122Derived classes that override this constructor should ensure they 
     1123explicitly invoke it from their own implementation, so that the base 
     1124class is properly initialized.""")) 
     1125 
     1126AddArgumentMetadata(InsertCursor.__init__, u'self', 
     1127    typeMetadata=ClassInstanceTypeMetadata(cls=InsertCursor), 
     1128    description=_(u'%s instance.') % InsertCursor.__name__) 
     1129 
     1130CopyArgumentMetadata(SelectCursor.__init__, u'connection', InsertCursor.__init__, u'connection') 
     1131CopyArgumentMetadata(SelectCursor.__init__, u'table', InsertCursor.__init__, u'table') 
     1132CopyArgumentMetadata(SelectCursor.__init__, u'spatialReference', InsertCursor.__init__, u'spatialReference') 
     1133 
     1134AddResultMetadata(InsertCursor.__init__, u'cursor', 
     1135    typeMetadata=ClassInstanceTypeMetadata(cls=InsertCursor), 
     1136    description=_(u'New %s instance.') % InsertCursor.__name__) 
     1137 
     1138# Destructor 
     1139 
     1140AddMethodMetadata(InsertCursor.__del__, 
     1141    shortDescription=SelectCursor.__del__.__doc__.Obj.ShortDescription, 
     1142    longDescription=SelectCursor.__del__.__doc__.Obj.LongDescription) 
     1143 
     1144CopyArgumentMetadata(InsertCursor.__init__, u'self', InsertCursor.__del__, u'self') 
     1145 
     1146# Base class method: Open 
     1147 
     1148AddMethodMetadata(InsertCursor.Open, 
     1149    shortDescription=SelectCursor.Open.__doc__.Obj.ShortDescription, 
     1150    longDescription=SelectCursor.Open.__doc__.Obj.LongDescription) 
     1151 
     1152CopyArgumentMetadata(InsertCursor.__init__, u'self', InsertCursor.Open, u'self') 
     1153CopyArgumentMetadata(SelectCursor.Open, u'connection', InsertCursor.Open, u'connection') 
     1154CopyArgumentMetadata(SelectCursor.Open, u'table', InsertCursor.Open, u'table') 
     1155CopyArgumentMetadata(SelectCursor.Open, u'spatialReference', InsertCursor.Open, u'spatialReference') 
     1156 
     1157# Base class method: SetValue 
     1158 
     1159AddMethodMetadata(InsertCursor.SetValue, 
     1160    shortDescription=_(u'Sets the value of a field of the row that is currently under construction.'), 
     1161    longDescription=_( 
     1162u"""This method will fail if the cursor is not open. 
     1163 
     1164After the cursor is opened, it waits for you to call SetValue. When 
     1165you do, it allocates a new row in memory. The SetValue calls operate 
     1166against this row until InsertRow is called, which inserts it into the 
     1167database. Subsequent calls to SetValue allocate a new row in memory. 
     1168If the cursor is closed before InsertRow is called, the in-memory row 
     1169is discarded. 
     1170 
     1171The low-level database access API controls where the row will be 
     1172inserted into the database. The insert position cannot be reliably 
     1173determined.""")) 
     1174 
     1175CopyArgumentMetadata(InsertCursor.__init__, u'self', InsertCursor.SetValue, u'self') 
     1176 
     1177AddArgumentMetadata(InsertCursor.SetValue, u'field', 
     1178    typeMetadata=UnicodeStringTypeMetadata(minLength=1), 
     1179    description=_(u'Name of the field to set.')) 
     1180 
     1181AddArgumentMetadata(InsertCursor.SetValue, u'value', 
     1182    typeMetadata=AnyObjectTypeMetadata(canBeNone=True), 
     1183    description=_( 
     1184u"""Value of the field. To set the field to NULL, pass in None in 
     1185Python (usually called null in other languages).""")) 
     1186 
     1187# Base class method: InsertRow 
     1188 
     1189AddMethodMetadata(InsertCursor.InsertRow, 
     1190    shortDescription=_(u'Inserts the row that is currently under construction into the table.'), 
     1191    longDescription=InsertCursor.SetValue.__doc__.Obj.LongDescription) 
     1192 
     1193CopyArgumentMetadata(InsertCursor.__init__, u'self', InsertCursor.InsertRow, u'self') 
     1194 
     1195# Base class properties 
     1196 
     1197CopyPropertyMetadata(SelectCursor.IsOpen, InsertCursor.IsOpen) 
     1198CopyPropertyMetadata(SelectCursor.Connection, InsertCursor.Connection) 
     1199CopyPropertyMetadata(SelectCursor.Table, InsertCursor.Table) 
     1200CopyPropertyMetadata(SelectCursor.SpatialReference, InsertCursor.SpatialReference) 
     1201 
     1202# Derived class method: _Open 
     1203 
     1204AddMethodMetadata(InsertCursor._Open, 
     1205    shortDescription=SelectCursor._Open.__doc__.Obj.ShortDescription, 
     1206    longDescription=SelectCursor._Open.__doc__.Obj.LongDescription) 
     1207 
     1208CopyArgumentMetadata(InsertCursor.Open, u'self', InsertCursor._Open, u'self') 
     1209CopyArgumentMetadata(InsertCursor.Open, u'connection', InsertCursor._Open, u'connection') 
     1210CopyArgumentMetadata(InsertCursor.Open, u'table', InsertCursor._Open, u'table') 
     1211CopyArgumentMetadata(InsertCursor.Open, u'spatialReference', InsertCursor._Open, u'spatialReference') 
     1212 
     1213# Derived class method: _Close 
     1214 
     1215AddMethodMetadata(InsertCursor._Close, 
     1216    shortDescription=SelectCursor._Close.__doc__.Obj.ShortDescription, 
     1217    longDescription=SelectCursor._Close.__doc__.Obj.LongDescription) 
     1218 
     1219CopyArgumentMetadata(InsertCursor.__init__, u'self', InsertCursor._Close, u'self') 
     1220 
     1221# Derived class method: _SetValue 
     1222 
     1223AddMethodMetadata(InsertCursor._SetValue, 
     1224    shortDescription=_(u'Implements the cursor\'s set value operation.'), 
     1225    longDescription=_( 
     1226u"""Do not call this method directly; call SetValue instead. This 
     1227method should only be called by the base class itself. 
     1228 
     1229This method must be overridden by the derived class. The base class 
     1230implementation raises NotImplementedError.""")) 
     1231 
     1232CopyArgumentMetadata(InsertCursor.SetValue, u'self', InsertCursor._SetValue, u'self') 
     1233CopyArgumentMetadata(InsertCursor.SetValue, u'field', InsertCursor._SetValue, u'field') 
     1234CopyArgumentMetadata(InsertCursor.SetValue, u'value', InsertCursor._SetValue, u'value') 
     1235 
     1236# Derived class method: _InsertRow 
     1237 
     1238AddMethodMetadata(InsertCursor._InsertRow, 
     1239    shortDescription=_(u'Implements the cursor\'s row insert operation.'), 
     1240    longDescription=_( 
     1241u"""Do not call this method directly; call InsertRow instead. This 
     1242method should only be called by the base class itself. 
     1243 
     1244This method must be overridden by the derived class. The base class 
     1245implementation raises NotImplementedError.""")) 
     1246 
     1247CopyArgumentMetadata(InsertCursor.InsertRow, u'self', InsertCursor._InsertRow, u'self') 
     1248 
     1249############################################################################### 
     1250# Metadata: UpdateCursor class 
     1251############################################################################### 
     1252 
     1253AddClassMetadata(UpdateCursor, 
     1254    shortDescription=_(u'Represents a cursor used to read, update, and delete rows into a table.'), 
     1255    longDescription=_( 
     1256u"""This base class class defines the properties and methods that all 
     1257update cursor classes must implement to be used within GeoEco. This is 
     1258an abstract class; do not instantiate it directly. The appropriate way 
     1259to obtain an instance of this class is to call the OpenUpdateCursor 
     1260method of a DatabaseConnection instance. 
     1261 
     1262Each derived class wraps cursor execution calls for a specific 
     1263low-level database access API. For example, the ArcGIS91UpdateCursor 
     1264class wraps the ArcGIS 9.1 geoprocessor's UpdateCursor function. To 
     1265add support for a new low-level API, create a new derived class.""")) 
     1266 
     1267# Constructor 
     1268 
     1269AddMethodMetadata(UpdateCursor.__init__, 
     1270    shortDescription=_(u'Constructs a new %s instance.') % UpdateCursor.__name__, 
     1271    longDescription=_( 
     1272u"""This is an abstract class; do not instantiate it directly. The 
     1273appropriate way to obtain an instance of this class is to call the 
     1274OpenUpdateCursor method of a DatabaseConnection instance. 
     1275 
     1276Derived classes that override this constructor should ensure they 
     1277explicitly invoke it from their own implementation, so that the base 
     1278class is properly initialized.""")) 
     1279 
     1280AddArgumentMetadata(UpdateCursor.__init__, u'self', 
     1281    typeMetadata=ClassInstanceTypeMetadata(cls=UpdateCursor), 
     1282    description=_(u'%s instance.') % UpdateCursor.__name__) 
     1283 
     1284CopyArgumentMetadata(SelectCursor.__init__, u'connection', UpdateCursor.__init__, u'connection') 
     1285CopyArgumentMetadata(SelectCursor.__init__, u'table', UpdateCursor.__init__, u'table') 
     1286CopyArgumentMetadata(SelectCursor.__init__, u'selectFields', UpdateCursor.__init__, u'selectFields') 
     1287CopyArgumentMetadata(SelectCursor.__init__, u'whereClause', UpdateCursor.__init__, u'whereClause') 
     1288CopyArgumentMetadata(SelectCursor.__init__, u'orderByFields', UpdateCursor.__init__, u'orderByFields') 
     1289CopyArgumentMetadata(SelectCursor.__init__, u'fieldOrders', UpdateCursor.__init__, u'fieldOrders') 
     1290CopyArgumentMetadata(SelectCursor.__init__, u'spatialReference', UpdateCursor.__init__, u'spatialReference') 
     1291 
     1292AddResultMetadata(UpdateCursor.__init__, u'cursor', 
     1293    typeMetadata=ClassInstanceTypeMetadata(cls=UpdateCursor), 
     1294    description=_(u'New %s instance.') % UpdateCursor.__name__) 
     1295 
     1296# Base class method: NextRow 
     1297 
     1298AddMethodMetadata(UpdateCursor.NextRow, 
     1299    shortDescription=SelectCursor.NextRow.__doc__.Obj.ShortDescription, 
     1300    longDescription=_( 
     1301u"""This method will fail if the cursor is not open or it has 
     1302already moved beyond the last row in the result set. 
     1303 
     1304After opening the update cursor, move it to a desired row by calling 
     1305NextRow. Call GetValue to read the values of the row's fields. To 
     1306update the values, call SetValue on each field you want to update and 
     1307then call UpdateRow to save the all of the row's changes to the table. 
     1308To delete the row, call DeleteRow. After calling UpdateRow or 
     1309DeleteRow, you cannot perform further operations on that row; you must 
     1310call NextRow to go on to the next row. If you go on to the next row 
     1311without calling UpdateRow or DeleteRow, that row is left 
     1312unchanged.""")) 
     1313 
     1314CopyArgumentMetadata(UpdateCursor.__init__, u'self', UpdateCursor.NextRow, u'self') 
     1315 
     1316CopyResultMetadata(SelectCursor.NextRow, u'rowAvailable', UpdateCursor.NextRow, u'rowAvailable') 
     1317 
     1318# Base class method: GetValue 
     1319 
     1320AddMethodMetadata(UpdateCursor.GetValue, 
     1321    shortDescription=SelectCursor.GetValue.__doc__.Obj.ShortDescription, 
     1322    longDescription=UpdateCursor.NextRow.__doc__.Obj.LongDescription) 
     1323 
     1324CopyArgumentMetadata(UpdateCursor.__init__, u'self', UpdateCursor.GetValue, u'self') 
     1325CopyArgumentMetadata(SelectCursor.GetValue, u'field', UpdateCursor.GetValue, u'field') 
     1326 
     1327CopyResultMetadata(SelectCursor.GetValue, u'value', UpdateCursor.GetValue, u'value') 
     1328 
     1329# Base class method: SetValue 
     1330 
     1331AddMethodMetadata(UpdateCursor.SetValue, 
     1332    shortDescription=_(u'Sets the value of a field of the current row.'), 
     1333    longDescription=UpdateCursor.NextRow.__doc__.Obj.LongDescription) 
     1334 
     1335CopyArgumentMetadata(UpdateCursor.__init__, u'self', UpdateCursor.SetValue, u'self') 
     1336CopyArgumentMetadata(InsertCursor.SetValue, u'field', UpdateCursor.SetValue, u'field') 
     1337CopyArgumentMetadata(InsertCursor.SetValue, u'value', UpdateCursor.SetValue, u'value') 
     1338 
     1339# Base class method: UpdateRow 
     1340 
     1341AddMethodMetadata(UpdateCursor.UpdateRow, 
     1342    shortDescription=_(u'Saves the changes to the current row\'s fields to the table.'), 
     1343    longDescription=UpdateCursor.NextRow.__doc__.Obj.LongDescription) 
     1344 
     1345CopyArgumentMetadata(UpdateCursor.__init__, u'self', UpdateCursor.UpdateRow, u'self') 
     1346 
     1347# Base class method: DeleteRow 
     1348 
     1349AddMethodMetadata(UpdateCursor.DeleteRow, 
     1350    shortDescription=_(u'Deletes the current row.'), 
     1351    longDescription=UpdateCursor.NextRow.__doc__.Obj.LongDescription) 
     1352 
     1353CopyArgumentMetadata(UpdateCursor.__init__, u'self', UpdateCursor.DeleteRow, u'self') 
     1354 
     1355# Base class properties 
     1356 
     1357AddPropertyMetadata(UpdateCursor.RowUpdated, 
     1358    typeMetadata=BooleanTypeMetadata(), 
     1359    shortDescription=_(u'True if UpdateRow was previously invoked on the current row.')) 
     1360 
     1361AddPropertyMetadata(UpdateCursor.RowDeleted, 
     1362    typeMetadata=BooleanTypeMetadata(), 
     1363    shortDescription=_(u'True if DeleteRow was previously invoked on the current row.')) 
     1364 
     1365# Derived class method: _SetValue 
     1366 
     1367AddMethodMetadata(UpdateCursor._SetValue, 
     1368    shortDescription=UpdateCursor.SetValue.__doc__.Obj.ShortDescription, 
     1369    longDescription=UpdateCursor.SetValue.__doc__.Obj.LongDescription) 
     1370 
     1371CopyArgumentMetadata(UpdateCursor.SetValue, u'self', UpdateCursor._SetValue, u'self') 
     1372CopyArgumentMetadata(UpdateCursor.SetValue, u'field', UpdateCursor._SetValue, u'field') 
     1373CopyArgumentMetadata(UpdateCursor.SetValue, u'value', UpdateCursor._SetValue, u'value') 
     1374 
     1375# Derived class method: _UpdateRow 
     1376 
     1377AddMethodMetadata(UpdateCursor._UpdateRow, 
     1378    shortDescription=_(u'Implements the cursor\'s row update operation.'), 
     1379    longDescription=_( 
     1380u"""Do not call this method directly; call UpdateRow instead. This 
     1381method should only be called by the base class itself. 
     1382 
     1383This method must be overridden by the derived class. The base class 
     1384implementation raises NotImplementedError.""")) 
     1385 
     1386CopyArgumentMetadata(UpdateCursor.UpdateRow, u'self', UpdateCursor._UpdateRow, u'self') 
     1387 
     1388# Derived class method: _DeleteRow 
     1389 
     1390AddMethodMetadata(UpdateCursor._DeleteRow, 
     1391    shortDescription=_(u'Implements the cursor\'s row delete operation.'), 
     1392    longDescription=_( 
     1393u"""Do not call this method directly; call DeleteRow instead. This 
     1394method should only be called by the base class itself. 
     1395 
     1396This method must be overridden by the derived class. The base class 
     1397implementation raises NotImplementedError.""")) 
     1398 
     1399CopyArgumentMetadata(UpdateCursor.DeleteRow, u'self', UpdateCursor._DeleteRow, u'self') 
    6651400 
    6661401############################################################################### 
     
    6691404 
    6701405__all__ = ['DatabaseConnection', 
    671            'SelectCursor'] 
     1406           'SelectCursor', 
     1407           'InsertCursor', 
     1408           'UpdateCursor'] 
  • MGET/Branches/Jason/PythonPackage/src/GeoEco/Metadata.py

    r74 r77  
    580580             
    581581            (args, varargs, varkw, _locals) = inspect.getargvalues(parentFrame) 
    582             assert len(args) > 0 and _locals.has_key(args[0]) and hasattr(_locals[args[0]], parentFrame.f_code.co_name) and inspect.ismethod(getattr(_locals[args[0]], parentFrame.f_code.co_name)) and getattr(_locals[args[0]], parentFrame.f_code.co_name).im_func.func_code == parentFrame.f_code, u'ValidateMethodInvocation should only be called from instance methods or classmethods.' 
     582            assert len(args) > 0 and _locals.has_key(args[0]) and (inspect.isclass(_locals[args[0]]) or hasattr(_locals[args[0]], u'__class__')) and hasattr(_locals[args[0]], parentFrame.f_code.co_name) and inspect.ismethod(getattr(_locals[args[0]], parentFrame.f_code.co_name)), u'ValidateMethodInvocation should only be called from instance methods or classmethods.' 
     583 
     584            # Traverse up the class hierarchy until we locate the actual method 
     585            # object that we were called from. 
     586 
     587            method = None 
     588            if inspect.isclass(_locals[args[0]]): 
     589                mro = inspect.getmro(_locals[args[0]]) 
     590            else: 
     591                mro = inspect.getmro(_locals[args[0]].__class__) 
     592            for mroClass in mro: 
     593                if mroClass.__dict__.has_key(parentFrame.f_code.co_name): 
     594                    if isinstance(mroClass.__dict__[parentFrame.f_code.co_name], classmethod): 
     595                        if mroClass.__dict__[parentFrame.f_code.co_name].__get__(_locals[args[0]]).im_func.func_code == parentFrame.f_code: 
     596                            method = mroClass.__dict__[parentFrame.f_code.co_name].__get__(_locals[args[0]]) 
     597                    elif inspect.isfunction(mroClass.__dict__[parentFrame.f_code.co_name]) and mroClass.__dict__[parentFrame.f_code.co_name].func_code == parentFrame.f_code: 
     598                        method = mroClass.__dict__[parentFrame.f_code.co_name] 
     599            assert method is not None, u'ValidateMethodInvocation failed to validate that the calling method is implemented in the first argument\'s class or any of its base classes.' 
    583600 
    584601            # Validate that the method's __doc__ attribute contains a 
    585602            # DynamicDocString with a MethodMetadata object inside. 
    586603 
    587             method = getattr(_locals[args[0]], parentFrame.f_code.co_name) 
    588604            assert isinstance(method.__doc__, DynamicDocString) and isinstance(method.__doc__.Obj, MethodMetadata), u'ValidateMethodInvocation should only be called instance methods or classmethods that have their __doc__ attribute set to an instance of DynamicDocString and the Obj property of DynamicDocString set to an instance of MethodMetadata.' 
    589605            methodMetadata = method.__doc__.Obj 
     
    12211237 
    12221238    def __init__(self, pythonType, canBeNone=False, allowedValues=None, comIDLType=None, canBeCOMParameter=False, arcGISType=None, arcGISAssembly=None, canBeArcGISInputParameter=False, canBeArcGISOutputParameter=False): 
    1223         assert isinstance(pythonType, (types.TypeType, types.ClassType)) and not issubclass(pythonType, types.NoneType), u'pythonType must be a type or old-style class, and it may not be types.NoneType or derived from it.' 
     1239        assert isinstance(pythonType, (types.TypeType, types.ClassType)), u'pythonType must be a type or old-style class.' 
    12241240        assert isinstance(canBeNone, types.BooleanType), u'canBeNone must be a boolean.' 
    12251241        assert isinstance(allowedValues, (types.NoneType, types.ListType, types.TupleType)), u'allowedValues must be a list or tuple of values, or None.' 
     
    14531469 
    14541470 
    1455 # Public helper functions for applying metadata to classes, properties and methods 
    1456  
    1457  
    1458 def AddModuleMetadata(shortDescription, longDescription=None, module=None): 
    1459     module = _GetModuleObject(module) 
    1460     assert not isinstance(module.__doc__, DynamicDocString) or module.__doc__.Obj is None, u'If %s.__doc__ is an instance of DynamicDocString, %s.__doc__.Obj must be None. Do not call AddModuleMetadata on a module that already has metadata.' % (module.__name__, module.__name__) 
    1461     module.__doc__ = DynamicDocString(ModuleMetadata(unicode(module.__name__), shortDescription, longDescription)) 
    1462     return module.__doc__ 
    1463  
    1464  
    1465 def AddClassMetadata(cls, shortDescription, longDescription=None, module=None, isExposedAsCOMServer=False, comIID=None, comCLSID=None, comVersionIndependentProgID=None, comVersionDependentProgID=None): 
    1466     module = _GetModuleObject(module) 
    1467     assert isinstance(module.__doc__, DynamicDocString) and isinstance(module.__doc__.Obj, ModuleMetadata), u'The __doc__ attribute of module %s must be an instance of GeoEco.Metadata.DynamicDocString, and __doc__.Obj must be an instance of GeoEco.Metadata.ModuleMetadata. Use the GeoEco.Metadata.AddModuleMetadata function to add the module\'s metadata before calling GeoEco.Metadata.AddClassMetadata.' % module.__name__ 
    1468     cls = _GetClassObject(cls, module) 
    1469     assert isinstance(cls.__doc__, DynamicDocString), u'The __doc__ attribute of class %s defined in module %s must be an instance of GeoEco.Metadata.DynamicDocString. You should place the line\n\n    __doc__ = GeoEco.Metadata.DynamicDocString()\n\nin your class definition.' % (cls.__name__, module.__name__) 
    1470     assert cls.__doc__.Obj is None, u'%s.__doc__.Obj must be None. Do not call AddClassMetadata on a class that already has metadata.' % cls.__name__ 
    1471     cls.__doc__.Obj = ClassMetadata(unicode(cls.__name__), module.__doc__.Obj, shortDescription, longDescription, isExposedAsCOMServer, comIID, comCLSID, comVersionIndependentProgID, comVersionDependentProgID) 
    1472  
    1473  
    1474 def AddPropertyMetadata(prop, typeMetadata, shortDescription=None, longDescription=None, isExposedToPythonCallers=False, isExposedByCOM=False, cls=None, module=None): 
    1475     module = _GetModuleObject(module) 
     1471def _ValidatePropertyInfo(prop, cls=None, module=None): 
    14761472    if cls is not None: 
    14771473        cls = _GetClassObject(cls, module) 
     
    14981494        assert cls is not None, u'If prop is a property object and cls is None, module %s must contain the class to which prop belongs.' % module.__name__ 
    14991495    assert isinstance(cls.__doc__, DynamicDocString), u'The __doc__ attribute of class %s defined in module %s must be an instance of GeoEco.Metadata.DynamicDocString. You should place the line\n\n    __doc__ = GeoEco.Metadata.DynamicDocString()\n\nin your class definition.' % (cls.__name__, module.__name__) 
    1500     assert isinstance(cls.__doc__.Obj, ClassMetadata), u'%s.__doc__.Obj must be an instance of GeoEco.Metadata.ClassMetadata. Before calling GeoEco.Metadata.AddPropertyMetadata, use GeoEco.Metadata.AddClassMetadata to add ClassMetadata to class %s.' % (cls.__name__, cls.__name__) 
     1496    assert isinstance(cls.__doc__.Obj, ClassMetadata), u'%s.__doc__.Obj must be an instance of GeoEco.Metadata.ClassMetadata. Before calling AddPropertyMetadata or CopyPropertyMetadata, use GeoEco.Metadata.AddClassMetadata to add ClassMetadata to class %s.' % (cls.__name__, cls.__name__) 
    15011497    assert isinstance(prop.__doc__, DynamicDocString), u'%s.%s.__doc__ must be an instance of GeoEco.Metadata.DynamicDocString. When defining the property, set the doc parameter to a new instance of DynamicDocString, like this:\n\n    %s = property(..., doc=DynamicDocString())' % (cls.__name__, propName, propName) 
    1502     assert prop.__doc__.Obj is None, u'%s.%s.__doc__.Obj must be None. Do not call AddPropertyMetadata on a property that already has metadata.' % (cls.__name__, propName) 
    1503     prop.__doc__.Obj = PropertyMetadata(unicode(propName), cls.__doc__.Obj, typeMetadata, shortDescription, longDescription, isExposedToPythonCallers, isExposedByCOM) 
    1504  
    1505  
    1506 def AddMethodMetadata(method, shortDescription=None, longDescription=None, isExposedToPythonCallers=False, isExposedByCOM=False, isExposedAsArcGISTool=False, arcGISDisplayName=None, arcGISToolCategory=None, cls=None, module=None, dependencies=[]): 
    1507     module = _GetModuleObject(module) 
     1498    return prop, propName, cls 
     1499 
     1500 
     1501def _ValidateMethodMetadata(method, cls=None, module=None): 
    15081502    if cls is not None: 
    15091503        cls = _GetClassObject(cls, module) 
    15101504    (method, cls) = _GetMethodObject(method, cls, module) 
    15111505    assert isinstance(cls.__doc__, DynamicDocString), u'The __doc__ attribute of class %s defined in module %s must be an instance of GeoEco.Metadata.DynamicDocString. You should place the line\n\n    __doc__ = GeoEco.Metadata.DynamicDocString()\n\nin your class definition.' % (cls.__name__, module.__name__) 
    1512     assert isinstance(cls.__doc__.Obj, ClassMetadata), u'%s.__doc__.Obj must be an instance of GeoEco.Metadata.ClassMetadata. Before calling GeoEco.Metadata.AddMethodMetadata, use GeoEco.Metadata.AddClassMetadata to add ClassMetadata to class %s.' % (cls.__name__, cls.__name__) 
    1513     assert not isinstance(method.__doc__, DynamicDocString) or method.__doc__.Obj is None, u'%s.%s.__doc__ must be None or an instance of DynamicDocString. If it is an instance of DynamicDocString, %s.%s.__doc__.Obj must be None. Do not call AddMethodMetadata on a method that already has metadata.' % (cls.__name__, method.__name__, cls.__name__, method.__name__) 
     1506    assert isinstance(cls.__doc__.Obj, ClassMetadata), u'%s.__doc__.Obj must be an instance of GeoEco.Metadata.ClassMetadata. Use GeoEco.Metadata.AddClassMetadata to add ClassMetadata to class %s.' % (cls.__name__, cls.__name__) 
     1507    return method, cls 
     1508 
     1509 
     1510# Public helper functions for applying metadata to classes, properties and methods 
     1511 
     1512 
     1513def AddModuleMetadata(shortDescription, longDescription=None, module=None): 
     1514    module = _GetModuleObject(module) 
     1515    assert not isinstance(module.__doc__, DynamicDocString) or module.__doc__.Obj is None, u'If %s.__doc__ is an instance of DynamicDocString, %s.__doc__.Obj must be None. Do not call AddModuleMetadata on a module that already has metadata.' % (module.__name__, module.__name__) 
     1516     
     1517    module.__doc__ = DynamicDocString(ModuleMetadata(unicode(module.__name__), shortDescription, longDescription)) 
     1518    return module.__doc__ 
     1519 
     1520 
     1521def AddClassMetadata(cls, shortDescription, longDescription=None, module=None, isExposedAsCOMServer=False, comIID=None, comCLSID=None, comVersionIndependentProgID=None, comVersionDependentProgID=None): 
     1522    module = _GetModuleObject(module) 
     1523    assert isinstance(module.__doc__, DynamicDocString) and isinstance(module.__doc__.Obj, ModuleMetadata), u'The __doc__ attribute of module %s must be an instance of GeoEco.Metadata.DynamicDocString, and __doc__.Obj must be an instance of GeoEco.Metadata.ModuleMetadata. Use the GeoEco.Metadata.AddModuleMetadata function to add the module\'s metadata before calling GeoEco.Metadata.AddClassMetadata.' % module.__name__ 
     1524    cls = _GetClassObject(cls, module) 
     1525    assert isinstance(cls.__doc__, DynamicDocString), u'The __doc__ attribute of class %s defined in module %s must be an instance of GeoEco.Metadata.DynamicDocString. You should place the line\n\n    __doc__ = GeoEco.Metadata.DynamicDocString()\n\nin your class definition.' % (cls.__name__, module.__name__) 
     1526    assert cls.__doc__.Obj is None, u'%s.__doc__.Obj must be None. Do not call AddClassMetadata on a class that already has metadata.' % cls.__name__ 
     1527     
     1528    cls.__doc__.Obj = ClassMetadata(unicode(cls.__name__), module.__doc__.Obj, shortDescription, longDescription, isExposedAsCOMServer, comIID, comCLSID, comVersionIndependentProgID, comVersionDependentProgID) 
     1529 
     1530 
     1531def AddPropertyMetadata(prop, typeMetadata, shortDescription=None, longDescription=None, isExposedToPythonCallers=False, isExposedByCOM=False, cls=None, module=None): 
     1532    module = _GetModuleObject(module) 
     1533    (prop, propName, cls) = _ValidatePropertyInfo(prop, cls, module) 
     1534    assert prop.__doc__.Obj is None, u'%s.%s.__doc__.Obj must be None. Do not call AddPropertyMetadata on a property that already has metadata.' % (cls.__name__, propName) 
     1535 
     1536    prop.__doc__.Obj = PropertyMetadata(unicode(propName), cls.__doc__.Obj, typeMetadata, shortDescription, longDescription, isExposedToPythonCallers, isExposedByCOM) 
     1537 
     1538 
     1539def CopyPropertyMetadata(fromProperty, toProperty, fromClass=None, fromModule=None, toClass=None, toModule=None): 
     1540    fromModule = _GetModuleObject(fromModule) 
     1541    (fromProperty, fromPropertyName, fromClass) = _ValidatePropertyInfo(fromProperty, fromClass, fromModule) 
     1542    assert fromProperty.__doc__.Obj is not None, u'%s.%s.__doc__.Obj must not be None. Before calling CopyPropertyMetadata, ensure that fromProperty already has metadata.' % (fromClass.__name__, fromPropertyName) 
     1543 
     1544    toModule = _GetModuleObject(toModule) 
     1545    (toProperty, toPropertyName, toClass) = _ValidatePropertyInfo(toProperty, toClass, toModule) 
     1546    assert toProperty.__doc__.Obj is None, u'%s.%s.__doc__.Obj must be None. Before calling CopyPropertyMetadata, ensure that toProperty does not have metadata already.' % (toClass.__name__, toPropertyName) 
     1547 
     1548    toProperty.__doc__.Obj = PropertyMetadata(unicode(toPropertyName), 
     1549                                              toClass.__doc__.Obj, 
     1550                                              typeMetadata=fromProperty.__doc__.Obj.Type, 
     1551                                              shortDescription=fromProperty.__doc__.Obj.ShortDescription, 
     1552                                              longDescription=fromProperty.__doc__.Obj.LongDescription, 
     1553                                              isExposedToPythonCallers=fromProperty.__doc__.Obj.IsExposedToPythonCallers, 
     1554                                              isExposedByCOM=fromProperty.__doc__.Obj.IsExposedByCOM) 
     1555 
     1556 
     1557def AddMethodMetadata(method, shortDescription=None, longDescription=None, isExposedToPythonCallers=False, isExposedByCOM=False, isExposedAsArcGISTool=False, arcGISDisplayName=None, arcGISToolCategory=None, cls=None, module=None, dependencies=[]): 
     1558    module = _GetModuleObject(module) 
     1559    (method, cls) = _ValidateMethodMetadata(method, cls, module) 
    15141560    if not isinstance(method.__doc__, DynamicDocString): 
    15151561        if hasattr(method, u'im_func'): 
     
    15171563        else: 
    15181564            method.func_doc = DynamicDocString() 
     1565    assert method.__doc__.Obj is None, u'%s.%s.__doc__.Obj must be None. Do not call AddMethodMetadata on a method that already has metadata.' % (cls.__name__, method.__name__) 
     1566     
    15191567    method.__doc__.Obj = MethodMetadata(unicode(method.__name__), cls.__doc__.Obj, shortDescription, longDescription, isExposedToPythonCallers, isExposedByCOM, isExposedAsArcGISTool, arcGISDisplayName, arcGISToolCategory, dependencies) 
     1568 
    15201569 
    15211570def AddArgumentMetadata(method, argumentName, typeMetadata, description=None, direction=u'Input', initializeToArcGISGeoprocessorVariable=None, arcGISDisplayName=None, arcGISCategory=None, arcGISParameterDependencies=None, cls=None, module=None): 
    15221571    module = _GetModuleObject(module) 
    1523     if cls is not None: 
    1524         cls = _GetClassObject(cls, module) 
    1525     (method, cls) = _GetMethodObject(method, cls, module) 
     1572    (method, cls) = _ValidateMethodMetadata(method, cls, module) 
    15261573    assert isinstance(method.__doc__, DynamicDocString) and isinstance(method.__doc__.Obj, MethodMetadata), u'The %s.%s.__doc__ must be an instance of GeoEco.Metadata.DynamicDocString, and %s.%s.__doc__.Obj must be an instance of GeoEco.Metadata.MethodMetadata. Before calling GeoEco.Metadata.AddArgumentMetadata, use GeoEco.Metadata.AddMethodMetadata to add MethodMetadata to %s.%s.' % (cls.__name__, method.__name__, cls.__name__, method.__name__, cls.__name__, method.__name__) 
    15271574    assert method.__doc__.Obj.GetArgumentByName(unicode(argumentName)) is None, u'%s.%s.__doc__.Obj.Arguments already has ArgumentMetadata for the %s argument. Do not call AddArgumentMetadata for arguments that already have metadata.' % (cls.__name__, method.__name__, argumentName) 
     1575     
    15281576    method.__doc__.Obj.Arguments.append(ArgumentMetadata(unicode(argumentName), method.__doc__.Obj, typeMetadata, description, direction, initializeToArcGISGeoprocessorVariable, arcGISDisplayName, arcGISCategory, arcGISParameterDependencies)) 
    15291577 
     
    15311579def AddResultMetadata(method, resultName, typeMetadata, description=None, arcGISDisplayName=None, arcGISParameterDependencies=None, cls=None, module=None): 
    15321580    module = _GetModuleObject(module) 
    1533     if cls is not None: 
    1534         cls = _GetClassObject(cls, module) 
    1535     (method, cls) = _GetMethodObject(method, cls, module) 
     1581    (method, cls) = _ValidateMethodMetadata(method, cls, module) 
    15361582    assert isinstance(method.__doc__, DynamicDocString) and isinstance(method.__doc__.Obj, MethodMetadata), u'The %s.%s.__doc__ must be an instance of GeoEco.Metadata.DynamicDocString, and %s.%s.__doc__.Obj must be an instance of GeoEco.Metadata.MethodMetadata. Before calling GeoEco.Metadata.AddArgumentMetadata, use GeoEco.Metadata.AddMethodMetadata to add MethodMetadata to %s.%s.' % (cls.__name__, method.__name__, cls.__name__, method.__name__, cls.__name__, method.__name__) 
    15371583    assert method.__doc__.Obj.GetResultByName(unicode(resultName)) is None, u'%s.%s.__doc__.Obj.Results already has ResultMetadata for the %s result. Do not call AddResultMetadata for results that already have metadata.' % (cls.__name__, method.__name__, resultName) 
     1584     
    15381585    method.__doc__.Obj.Results.append(ResultMetadata(unicode(resultName), method.__doc__.Obj, typeMetadata, description, arcGISDisplayName, arcGISParameterDependencies)) 
     1586 
     1587 
     1588def CopyArgumentMetadata(fromMethod, fromArgumentName, toMethod, toArgumentName, fromClass=None, fromModule=None, toClass=None, toModule=None): 
     1589    fromModule = _GetModuleObject(fromModule) 
     1590    (fromMethod, fromClass) = _ValidateMethodMetadata(fromMethod, fromClass, fromModule) 
     1591    assert isinstance(fromMethod.__doc__, DynamicDocString) and isinstance(fromMethod.__doc__.Obj, MethodMetadata), u'The %s.%s.__doc__ must be an instance of GeoEco.Metadata.DynamicDocString, and %s.%s.__doc__.Obj must be an instance of GeoEco.Metadata.MethodMetadata. Before calling GeoEco.Metadata.CopyArgumentMetadata, use GeoEco.Metadata.AddMethodMetadata to add MethodMetadata to %s.%s.' % (fromClass.__name__, fromMethod.__name__, fromClass.__name__, fromMethod.__name__, fromClass.__name__, fromMethod.__name__) 
     1592    assert fromMethod.__doc__.Obj.GetArgumentByName(unicode(fromArgumentName)) is not None, u'%s.%s.__doc__.Obj.Arguments does not have ArgumentMetadata for the %s argument. You must assign metadata to this argument before trying to copy it to another argument.' % (fromClass.__name__, fromMethod.__name__, fromArgumentName) 
     1593 
     1594    toModule = _GetModuleObject(toModule) 
     1595    (toMethod, toClass) = _ValidateMethodMetadata(toMethod, toClass, toModule) 
     1596    assert isinstance(toMethod.__doc__, DynamicDocString) and isinstance(toMethod.__doc__.Obj, MethodMetadata), u'The %s.%s.__doc__ must be an instance of GeoEco.Metadata.DynamicDocString, and %s.%s.__doc__.Obj must be an instance of GeoEco.Metadata.MethodMetadata. Before calling GeoEco.Metadata.CopyArgumentMetadata, use GeoEco.Metadata.AddMethodMetadata to add MethodMetadata to %s.%s.' % (toClass.__name__, toMethod.__name__, toClass.__name__, toMethod.__name__, toClass.__name__, toMethod.__name__) 
     1597    assert toMethod.__doc__.Obj.GetArgumentByName(unicode(toArgumentName)) is None, u'%s.%s.__doc__.Obj.Arguments already has ArgumentMetadata for the %s argument. Do not call CopyArgumentMetadata to copy metadata to an argument that already has metadata.' % (toClass.__name__, toMethod.__name__, toArgumentName) 
     1598 
     1599    fromArgument = fromMethod.__doc__.Obj.GetArgumentByName(unicode(fromArgumentName)) 
     1600    toMethod.__doc__.Obj.Arguments.append(ArgumentMetadata(unicode(toArgumentName), 
     1601                                                           toMethod.__doc__.Obj, 
     1602                                                           typeMetadata=fromArgument.Type, 
     1603                                                           description=fromArgument.Description, 
     1604                                                           direction=fromArgument.Direction, 
     1605                                                           initializeToArcGISGeoprocessorVariable=fromArgument.InitializeToArcGISGeoprocessorVariable, 
     1606                                                           arcGISDisplayName=fromArgument.ArcGISDisplayName, 
     1607                                                           arcGISCategory=fromArgument.ArcGISCategory, 
     1608                                                           arcGISParameterDependencies=fromArgument.ArcGISParameterDependencies)) 
     1609 
     1610 
     1611def CopyResultMetadata(fromMethod, fromResultName, toMethod, toResultName, fromClass=None, fromModule=None, toClass=None, toModule=None): 
     1612    fromModule = _GetModuleObject(fromModule) 
     1613    (fromMethod, fromClass) = _ValidateMethodMetadata(fromMethod, fromClass, fromModule) 
     1614    assert isinstance(fromMethod.__doc__, DynamicDocString) and isinstance(fromMethod.__doc__.Obj, MethodMetadata), u'The %s.%s.__doc__ must be an instance of GeoEco.Metadata.DynamicDocString, and %s.%s.__doc__.Obj must be an instance of GeoEco.Metadata.MethodMetadata. Before calling GeoEco.Metadata.CopyResultMetadata, use GeoEco.Metadata.AddMethodMetadata to add MethodMetadata to %s.%s.' % (fromClass.__name__, fromMethod.__name__, fromClass.__name__, fromMethod.__name__, fromClass.__name__, fromMethod.__name__) 
     1615    assert fromMethod.__doc__.Obj.GetResultByName(unicode(fromResultName)) is not None, u'%s.%s.__doc__.Obj.Results does not have ResultMetadata for the %s result. You must assign metadata to this result before trying to copy it to another result.' % (fromClass.__name__, fromMethod.__name__, fromResultName) 
     1616 
     1617    toModule = _GetModuleObject(toModule) 
     1618    (toMethod, toClass) = _ValidateMethodMetadata(toMethod, toClass, toModule) 
     1619    assert isinstance(toMethod.__doc__, DynamicDocString) and isinstance(toMethod.__doc__.Obj, MethodMetadata), u'The %s.%s.__doc__ must be an instance of GeoEco.Metadata.DynamicDocString, and %s.%s.__doc__.Obj must be an instance of GeoEco.Metadata.MethodMetadata. Before calling GeoEco.Metadata.CopyResultMetadata, use GeoEco.Metadata.AddMethodMetadata to add MethodMetadata to %s.%s.' % (toClass.__name__, toMethod.__name__, toClass.__name__, toMethod.__name__, toClass.__name__, toMethod.__name__) 
     1620    assert toMethod.__doc__.Obj.GetResultByName(unicode(toResultName)) is None, u'%s.%s.__doc__.Obj.Results already has ResultMetadata for the %s result. Do not call CopyResultMetadata to copy metadata to a result that already has metadata.' % (toClass.__name__, toMethod.__name__, toResultName) 
     1621 
     1622    fromResult = fromMethod.__doc__.Obj.GetResultByName(unicode(fromResultName)) 
     1623    toMethod.__doc__.Obj.Results.append(ResultMetadata(unicode(toResultName), 
     1624                                                       toMethod.__doc__.Obj, 
     1625                                                       typeMetadata=fromResult.Type, 
     1626                                                       description=fromResult.Description, 
     1627                                                       arcGISDisplayName=fromResult.ArcGISDisplayName, 
     1628                                                       arcGISParameterDependencies=fromResult.ArcGISParameterDependencies)) 
    15391629 
    15401630 
     
    20442134           'AddClassMetadata', 
    20452135           'AddPropertyMetadata', 
     2136           'CopyPropertyMetadata', 
    20462137           'AddMethodMetadata', 
    20472138           'AddArgumentMetadata', 
    2048            'AddResultMetadata'] 
     2139           'AddResultMetadata', 
     2140           'CopyArgumentMetadata', 
     2141           'CopyResultMetadata'] 
  • MGET/Branches/Jason/PythonPackage/src/GeoEco/Types.py

    r76 r77  
    5353                                                    canBeArcGISInputParameter=True, 
    5454                                                    canBeArcGISOutputParameter=True) 
     55 
     56 
     57class NoneTypeMetadata(TypeMetadata): 
     58 
     59    def __init__(self): 
     60        super(NoneTypeMetadata, self).__init__(pythonType=types.NoneType, canBeNone=True) 
     61 
     62    def ValidateValue(self, value, variableName, methodLocals=None): 
     63        if value is not None: 
     64            _RaiseException(TypeError(_(u'The %s must be None (also called null or empty in languages other than Python).') % variableName)) 
     65        return (False, value) 
    5566 
    5667 
     
    10761087 
    10771088__all__ = ['AnyObjectTypeMetadata', 
     1089           'NoneTypeMetadata', 
    10781090           'ClassTypeMetadata', 
    10791091           'ClassInstanceTypeMetadata', 
  • MGET/Branches/Jason/VisualStudioSolutions/CreateArcGISToolbox/Program.cs

    r76 r77  
    8282        [XmlElement(typeof(TypeMetadata)), 
    8383        XmlElement(typeof(AnyObjectTypeMetadata)), 
     84        XmlElement(typeof(NoneTypeMetadata)), 
    8485        XmlElement(typeof(ClassTypeMetadata)), 
    8586        XmlElement(typeof(ClassInstanceTypeMetadata)), 
     
    132133        [XmlElement(typeof(TypeMetadata)), 
    133134        XmlElement(typeof(AnyObjectTypeMetadata)), 
     135        XmlElement(typeof(NoneTypeMetadata)), 
    134136        XmlElement(typeof(ClassTypeMetadata)), 
    135137        XmlElement(typeof(ClassInstanceTypeMetadata)), 
     
    176178        [XmlElement(typeof(TypeMetadata)), 
    177179        XmlElement(typeof(AnyObjectTypeMetadata)), 
     180        XmlElement(typeof(NoneTypeMetadata)), 
    178181        XmlElement(typeof(ClassTypeMetadata)), 
    179182        XmlElement(typeof(ClassInstanceTypeMetadata)), 
     
    298301        public override object DeserializeValueFromXmlElement(XmlElement element) { throw new NotSupportedException(); } 
    299302        public override IGPValue GetIGPValueInstanceForDerivedOutput(Result result) { return GetIGPValueInstance(result.ArcGISDisplayName); } 
     303 
     304        #endregion 
     305    } 
     306 
     307    public class NoneTypeMetadata : TypeMetadata 
     308    { 
     309        #region Overridden TypeMetadata members 
     310 
     311        public override System.Type DotNetType { get { throw new NotSupportedException(); } } 
     312        public override string NameForSerializedXmlValue { get { throw new NotSupportedException(); } } 
     313        public override object DeserializeValueFromXmlElement(XmlElement element) { throw new NotSupportedException(); } 
     314        public override IGPDataType GetIGPDataTypeInstance() { throw new NotSupportedException(); } 
     315        public override IGPValue GetIGPValueInstance(object value) { throw new NotSupportedException(); } 
     316        public override IGPValue GetIGPValueInstanceForDerivedOutput(Result result) { throw new NotSupportedException(); } 
    300317 
    301318        #endregion