Changes between Version 2 and Version 3 of GeoDjangoDatabaseAPI

Timestamp:

Jul 14, 2007, 11:54:50 AM (17 years ago)

Author:

jbronn

Comment:

updated with info about deprecated extra instance methods

GeoDjangoDatabaseAPI

@@ -100 +100 @@
 = Extra Instance Methods =
 
-A model with geometry fields will get the following methods, substitute {{{GEOM}}} with the name of the geometry field:
+A model with geometry fields will get the following methods, substitute {{{GEOM}}} with the name of the geometry field.
+
+'''Update:''' All of the extra instance methods below (except {{{get_GEOM_ogr}}} and {{{get_GEOM_srs}}}) have been deprecated in r5657 due to lazy geometry support.  In other words, these properties may be directly accessed as attributes from the geometry field.  As part of the deprecation process, [http://docs.python.org/lib/module-warnings.html warnings] are issued when such methods are invoked so that users have notice to change their code before these methods disappear in the future.
 
 == get_GEOM_ogr ==
@@ -124 +126 @@
 (10.0, 10.0)
 }}}
-
-== get_GEOM_geos ==
-Returns a {{{GEOSGeometry}}} instance for the geometry.  For example (using the {{{District}}} model from the [wiki:GeoDjango#Example example]):
-
-{{{
-#!python
->>> from django.contrib.gis.geos import GEOSGeometry # Where to import from
->>> dist = District.objects.get(name='Houston ISD')
->>> geom = dist.get_poly_geos()
->>> print geom.centroid.wkt
-POINT(-95.231713 29.723235)
->>> print geom.area
-0.08332
->>> print geom.geom_type
-Polygon
->>> print geom.centroid.geom_type
-Point
->>> print geom.intersects(GEOSGeometry('POINT(-95.395223 29.798088)'))
-False
-}}}
-
-== get_GEOM_srid ==
-
-Returns the SRID (source reference identifier) for the geometry.
 
 == get_GEOM_srs ==
@@ -176 +154 @@
 }}}
 
+== get_GEOM_geos ==
+'''Update:''' This extra instance method was deprecated in r5657 -- and may now be accessed directly through the attribute name of the geometry field -- ''e.g.'', {{{dist.poly}}} returns a {{{GEOSGeometry}}} instance for the {{{PolygonField}}} of the {{{District}}} model.
+
+Returns a {{{GEOSGeometry}}} instance for the geometry.  For example (using the {{{District}}} model from the [wiki:GeoDjango#Example example]):
+
+{{{
+#!python
+>>> from django.contrib.gis.geos import GEOSGeometry # Where to import from
+>>> dist = District.objects.get(name='Houston ISD')
+>>> geom = dist.get_poly_geos()
+>>> print geom.centroid.wkt
+POINT(-95.231713 29.723235)
+>>> print geom.area
+0.08332
+>>> print geom.geom_type
+Polygon
+>>> print geom.centroid.geom_type
+Point
+>>> print geom.intersects(GEOSGeometry('POINT(-95.395223 29.798088)'))
+False
+}}}
+
+== get_GEOM_srid ==
+
+'''Update:''' This extra instance method was deprecated in r5657 -- and may now be accessed directly through the attribute name of the geometry field -- ''e.g.'', {{{dist.poly.srid}}}.
+
+Returns the SRID (source reference identifier) for the geometry.
+
 == get_GEOM_wkt ==
+
+'''Update:''' This extra instance method was deprecated in r5657 -- and may now be accessed directly through the attribute name of the geometry field -- ''e.g.'', {{{skool.point.wkt}}}, or simply {{{str(skool.point)}}}.
 
 Returns the OGC WKT (Well Known Text) for the geometry.  For example (using the {{{School}}} model from the [wiki:GeoDjango#Example example]):
@@ -189 +197 @@
 == get_GEOM_centroid ==
 
+'''Update:''' This extra instance method was deprecated in r5657 -- and may now be accessed directly through the attribute name of the geometry field -- ''e.g.'', {{{dist.poly.centroid.wkt}}}.
+
 This routine will return the centroid of the geometry.  For example (using the {{{District}}} model from above):
 
@@ -200 +210 @@
 == get_GEOM_area ==
 
+'''Update:''' This extra instance method was deprecated in r5657 -- and may now be accessed directly through the attribute name of the geometry field -- ''e.g.'', {{{dist.poly.area}}}.
+
 This routine will return the area of the geometry field.