Changeset 6980

Timestamp:

12/29/07 01:48:08 (8 months ago)

Author:

jbronn

Message:

gis: LayerMapping: Added the unique keyword parameter and tests for the transform keyword and geometry collection conversion.

Files:

• django/branches/gis/django/contrib/gis/tests/layermap/counties (added)
• django/branches/gis/django/contrib/gis/tests/layermap/counties/counties.dbf (added)
• django/branches/gis/django/contrib/gis/tests/layermap/counties/counties.shp (added)
• django/branches/gis/django/contrib/gis/tests/layermap/counties/counties.shx (added)
• django/branches/gis/django/contrib/gis/tests/layermap/models.py (modified) (3 diffs)
• django/branches/gis/django/contrib/gis/tests/layermap/tests.py (modified) (3 diffs)
• django/branches/gis/django/contrib/gis/utils/layermapping.py (modified) (7 diffs)

django/branches/gis/django/contrib/gis/tests/layermap/models.py

@@ -1 +1 @@
-from django.contrib.gis.db import models
+
+class County(models.Model):
+    name = models.CharField(max_length=25)
+    mpoly = models.MultiPolygonField(srid=4269) # Multipolygon in NAD83
+    objects = models.GeoManager()
+
+class CountyFeat(models.Model):
+    name = models.CharField(max_length=25)
+    poly = models.PolygonField(srid=4269)
+    objects = models.GeoManager()
-
-class City(models.Model):
@@ -14 +24 @@
-    path = models.LineStringField()
-    objects = models.GeoManager()
-
-
+
+
+
+
+
+
+
+
+
+
-city_mapping = {'name' : 'Name',
-                'population' : 'Population',
@@ -23 +41 @@
-                }
-
-# Mapping dictionary for the Interstate model.
-inter_mapping = {'name' : 'Name',
-                 'length' : 'Length',

django/branches/gis/django/contrib/gis/tests/layermap/tests.py

@@ -3 +3 @@
-from datetime import date
-from decimal import Decimal
-Interstate, city
+County, CountyFeat, Interstate, city_mapping, co_mapping, cofeat
-from django.contrib.gis.utils.layermapping import LayerMapping, LayerMapError, InvalidDecimal
-from django.contrib.gis.gdal import DataSource
@@ -9 +9 @@
-shp_path = os.path.dirname(__file__)
-city_shp = os.path.join(shp_path, 'cities/cities.shp')
+co_shp = os.path.join(shp_path, 'counties/counties.shp')
-inter_shp = os.path.join(shp_path, 'interstates/interstates.shp')
-
@@ -111 +112 @@
-                self.assertAlmostEqual(p1[1], p2[1], 6)
-
+    def test04_layermap_unique_multigeometry(self):
+        "Testing the `unique`, and `transform` keywords and geometry collection conversion."
+        # All the following should work.
+        try:
+            # Telling LayerMapping that we want no transformations performed on the data.
+            lm = LayerMapping(County, co_shp, co_mapping, transform=False)
+        
+            # Specifying the source spatial reference system via the `source_srs` keyword.
+            lm = LayerMapping(County, co_shp, co_mapping, source_srs=4269)
+            lm = LayerMapping(County, co_shp, co_mapping, source_srs='NAD83')
+
+            # Unique may take tuple or string parameters.
+            for arg in ('name', ('name', 'mpoly')):
+                lm = LayerMapping(County, co_shp, co_mapping, transform=False, unique=arg)
+        except:
+            self.fail('No exception should be raised for proper use of keywords.')
+            
+        # Testing invalid params for the `unique` keyword.
+        for e, arg in ((TypeError, 5.0), (ValueError, 'foobar'), (ValueError, ('name', 'mpolygon'))):
+            self.assertRaises(e, LayerMapping, County, co_shp, co_mapping, transform=False, unique=arg)
+
+        # No source reference system defined in the shapefile, should raise an error.
+        self.assertRaises(LayerMapError, LayerMapping, County, co_shp, co_mapping)
+
+        # If a mapping is specified as a collection, all OGR fields that
+        # are not collections will be converted into them.  For example,
+        # a Point column would be converted to MultiPoint. Other things being done
+        # w/the keyword args:
+        #  `transform=False`: Specifies that no transform is to be done; this 
+        #    has the effect of ignoring the spatial reference check (because the
+        #    county shapefile does not have implicit spatial reference info).
+        # 
+        #  `unique='name'`: Creates models on the condition that they have 
+        #    unique county names; geometries from each feature however will be
+        #    appended to the geometry collection of the unique model.  Thus,
+        #    all of the various islands in Honolulu county will be in in one
+        #    database record with a MULTIPOLYGON type.
+        lm = LayerMapping(County, co_shp, co_mapping, transform=False, unique='name', silent=True)
+        lm.save()
+
+        # A reference that doesn't use the unique keyword; a new database record will
+        # created for each polygon.
+        lm = LayerMapping(CountyFeat, co_shp, cofeat_mapping, transform=False, silent=True)
+        lm.save()
+
+        # Dictionary to hold what's expected in the shapefile.
+        exp = {'names' : ('Bexar', 'Galveston', 'Harris', 'Honolulu', 'Pueblo'),
+               'num' : (1, 2, 2, 19, 1), # Number of polygons for each.
+               }
+        for name, n in zip(exp['names'], exp['num']):
+            c = County.objects.get(name=name) # Should only be one record.
+            self.assertEqual(n, len(c.mpoly))
+            qs = CountyFeat.objects.filter(name=name)
+            self.assertEqual(n, qs.count())
+            
-def suite():
-    s = unittest.TestSuite()

django/branches/gis/django/contrib/gis/utils/layermapping.py

@@ -64 +64 @@
-  transform:
-   Setting this to False will disable all coordinate transformations.  
+
+  unique:
+   Setting this to the name, or a tuple of names, from the given
+   model will create models unique only to the given name(s).
+   Geometries will from each feature will be added into the collection
+   associated with the unique model.  Forces transaction mode to
+   be 'autocommit'.
-
-Example:
@@ -183 +190 @@
-                 source_srs=None, encoding=None, check=True, 
-                 progress=False, interval=1000, strict=False, silent=False,
-
+
+
-        "Takes the Django model, the data source, and the mapping (dictionary)"
-
@@ -209 +217 @@
-        # the coordinate transformation object (unless the `transform`
-        # keyword is set to False)
-
-
+
+
+
+
+
-
-        # Checking the layer -- intitialization of the object will fail if
@@ -232 +243 @@
-        else:
-            self.encoding = None
+
+        if unique:
+            self.check_unique(unique)
+            transaction_mode = 'autocommit' # Has to be set to autocommit.
+            self.unique = unique
+        else:
+            self.unique = None
-
-        # Setting the transaction decorator with the function in the 
@@ -314 +332 @@
-        else:
-            return sr
+
+    def check_unique(self, unique):
+        "Checks the `unique` keyword parameter -- may be a sequence or string."
+        # Getting the geometry field; only the first encountered GeometryField
+        # will be used.
+        self.geom_field = False
+        for model_field, ogr_fld in self.mapping.items():
+            if ogr_fld in self.OGC_TYPES:
+                self.geom_field = model_field
+                break
+
+        if isinstance(unique, (list, tuple)):
+            # List of fields to determine uniqueness with
+            for attr in unique: 
+                if not attr in self.mapping: raise ValueError
+        elif isinstance(unique, basestring):
+            # Only a single field passed in.
+            if unique not in self.mapping: raise ValueError
+        else:
+            raise TypeError('Unique keyword argument must be set with a tuple, list, or string.')
-
-    def coord_transform(self):
@@ -371 +409 @@
-            
-        return kwargs, all_prepped
+
+    def unique_kwargs(self, kwargs):
+        """
+        Given the feature keyword arguments (from `feature_kwargs`) this routine
+        will construct and return the uniqueness keyword arguments -- a subset
+        of the feature kwargs.
+        """
+        if isinstance(self.unique, basestring):
+            return {self.unique : kwargs[self.unique]}
+        else:
+            return dict((fld, kwargs[fld]) for fld in self.unique)
-
-    def verify_field(self, fld, model_field):
@@ -486 +535 @@
-                    # Constructing the model using the keyword args
-                    if all_prepped:
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-                        try:
+                            # Attempting to save.
-                            m.save()
-                            num_saved += 1