EncodedPolyline: Added geometryType attribute

This makes it possible to read polygons or multipoints too. Since the
encoded format is just a list of points the reader needs to be told what
Feature to create from the encoded list.

The example code is edited to reflect that API extension.

lib/OpenLayers/Format/EncodedPolyline.js

@@ -18,6 +18,13 @@
  */
 OpenLayers.Format.EncodedPolyline = OpenLayers.Class(OpenLayers.Format, {
 
+    /**
+     * APIProperty: geometryType
+     * {String} Geometry type to output. One of: linestring (default),
+     *     linearring, multipoint or polygon
+     */
+    geometryType: "linestring",
+
     /**
      * Constructor: OpenLayers.Format.EncodedPolyline
      * Create a new parser for encoded polylines
@@ -44,6 +51,16 @@ OpenLayers.Format.EncodedPolyline = OpenLayers.Class(OpenLayers.Format, {
      * {<OpenLayers.Feature.Vector>} A vector feature with a linestring.
      */
     read: function(encoded) {
+        var geomType;
+        if (this.geometryType == "linestring")
+            geomType = OpenLayers.Geometry.LineString;
+        else if (this.geometryType == "linearring")
+            geomType = OpenLayers.Geometry.LinearRing;
+        else if (this.geometryType == "multipoint")
+            geomType = OpenLayers.Geometry.MultiPoint;
+        else if (this.geometryType != "polygon")
+            return null;
+
         var points = new Array();
 
         var lat = 0;
@@ -76,8 +93,15 @@ OpenLayers.Format.EncodedPolyline = OpenLayers.Class(OpenLayers.Format, {
             points.push(new OpenLayers.Geometry.Point(lon * 1e-5, lat * 1e-5));
         }
 
+        if (this.geometryType == "polygon")
+            return new OpenLayers.Feature.Vector(
+                new OpenLayers.Geometry.Polygon([
+                    new OpenLayers.Geometry.LinearRing(points)
+                ])
+            );
+
         return new OpenLayers.Feature.Vector(
-            new OpenLayers.Geometry.LineString(points)
+            new geomType(points)
         );
     },
 

tests/Format/EncodedPolyline.html

@@ -3,11 +3,27 @@
     <script src="../OLLoader.js"></script>
     <script type="text/javascript">
 
+    var points = [
+        new OpenLayers.Geometry.Point(-120.2, 38.5),
+        new OpenLayers.Geometry.Point(-120.95, 40.7),
+        new OpenLayers.Geometry.Point(-126.45300000000002, 43.252)
+    ];
+
     var linestring = new OpenLayers.Feature.Vector(
-        new OpenLayers.Geometry.LineString([
-            new OpenLayers.Geometry.Point(-120.2, 38.5),
-            new OpenLayers.Geometry.Point(-120.95, 40.7),
-            new OpenLayers.Geometry.Point(-126.45300000000002, 43.252)
+        new OpenLayers.Geometry.LineString(points)
+    );
+
+    var multipoint = new OpenLayers.Feature.Vector(
+        new OpenLayers.Geometry.MultiPoint(points)
+    );
+
+    var linearring = new OpenLayers.Feature.Vector(
+        new OpenLayers.Geometry.LinearRing(points)
+    );
+
+    var polygon = new OpenLayers.Feature.Vector(
+        new OpenLayers.Geometry.Polygon([
+            new OpenLayers.Geometry.LinearRing(points)
         ])
     );
 
@@ -26,12 +42,25 @@
     }
 
     function test_Format_EncodedPolyline_read(t) {
-        t.plan(1);
+        t.plan(4);
 
         var format = new OpenLayers.Format.EncodedPolyline();
-
         t.ok(linestring.geometry.equals(format.read(encoded).geometry),
              "format correctly reads encoded polyline");
+
+        format = new OpenLayers.Format.EncodedPolyline({
+            geometryType: "multipoint"
+        });
+        t.ok(multipoint.geometry.equals(format.read(encoded).geometry),
+             "format correctly reads encoded multipoint");
+
+        format.geometryType = "linearring";
+        t.ok(linearring.geometry.equals(format.read(encoded).geometry),
+             "format correctly reads encoded linearring");
+
+        format.geometryType = "polygon";
+        t.ok(polygon.geometry.equals(format.read(encoded).geometry),
+             "format correctly reads encoded polygon");
     }
 
     </script>