Merge pull request #697 from ahocevar/describelayer

Applying VersionedOGC pattern to WMSDescribeLayer format. r=@bartvde

examples/WMSDescribeLayerParser.html

@@ -12,11 +12,12 @@
           format = new OpenLayers.Format.WMSDescribeLayer();
           html = "<br>";
           resp = format.read(req.responseText);
-          for(var i = 0; i < resp.length; i++) {
+          var layerDescriptions = resp.layerDescriptions;
-            html += "Layer: typeName: "+ resp[i].typeName+",";
+          for(var i = 0; i < layerDescriptions.length; i++) {
+            html += "Layer: typeName: "+layerDescriptions[i].typeName+",";
                 html += "<ul>";
-                html += "<li>owsURL: "+resp[i].owsURL+"</li>";
+                html += "<li>owsURL: "+layerDescriptions[i].owsURL+"</li>";
-                html += "<li>owsType: "+resp[i].owsType+"</li>";
+                html += "<li>owsType: "+layerDescriptions[i].owsType+"</li>";
                 html += "</ul>"
           }
           document.getElementById('output').innerHTML = html;

lib/OpenLayers/Format/WMSDescribeLayer.js

@@ -23,28 +23,6 @@ OpenLayers.Format.WMSDescribeLayer = OpenLayers.Class(OpenLayers.Format.XML.Vers
      */
     defaultVersion: "1.1.1",
    
-    /**
-     * Method: getVersion
-     * Returns the version to use. Subclasses can override this function
-     * if a different version detection is needed.
-     *
-     * Parameters:
-     * root - {DOMElement}
-     * options - {Object} Optional configuration object.
-     *
-     * Returns:
-     * {String} The version to use.
-     */
-    getVersion: function(root, options) {
-        var version = OpenLayers.Format.XML.VersionedOGC.prototype.getVersion.apply(
-            this, arguments);
-        // these are identical to us, but some WMS use 1.1.1 and some use 1.1.0
-        if (version == "1.1.1" || version == "1.1.0") {
-            version = "1.1";
-        }
-        return version;
-    },
-
     /**
      * Constructor: OpenLayers.Format.WMSDescribeLayer
      * Create a new parser for WMS DescribeLayer responses.

lib/OpenLayers/Format/WMSDescribeLayer/v1_1.js

@@ -9,7 +9,7 @@
  */
 
 /**
- * Class: OpenLayers.Format.WMSDescribeLayer.v1_1
+ * Class: OpenLayers.Format.WMSDescribeLayer.v1_1_1
  * Read SLD WMS DescribeLayer response for WMS 1.1.X
  * WMS 1.1.X is tightly coupled to SLD 1.0.0
  *
@@ -19,7 +19,7 @@
  * Inherits from:
  *  - <OpenLayers.Format.WMSDescribeLayer>
  */
-OpenLayers.Format.WMSDescribeLayer.v1_1 = OpenLayers.Class(
+OpenLayers.Format.WMSDescribeLayer.v1_1_1 = OpenLayers.Class(
     OpenLayers.Format.WMSDescribeLayer, {
     
     /**
@@ -45,10 +45,12 @@ OpenLayers.Format.WMSDescribeLayer.v1_1 = OpenLayers.Class(
      * data - {String} or {DOMElement} data to read/parse.
      *
      * Returns:
-     * {Array} Array of {<LayerDescription>} objects which have:
+     * {Object} Object with a layerDescriptions property, which holds an Array
+     * of {<LayerDescription>} objects which have:
      * - {String} owsType: WFS/WCS
      * - {String} owsURL: the online resource
-     * - {String} typeName: the name of the typename on the service
+     * - {String} typeName: the name of the typename on the owsType service
+     * - {String} layerName: the name of the WMS layer we did a lookup for
      */
     read: function(data) {
         if(typeof data == "string") {
@@ -56,7 +58,7 @@ OpenLayers.Format.WMSDescribeLayer.v1_1 = OpenLayers.Class(
         }
         var root = data.documentElement;
         var children = root.childNodes; 
-        var describelayer = [];
+        var describelayer = {layerDescriptions: []};
         var childNode, nodeName;
         for(var i=0; i<children.length; ++i) { 
             childNode = children[i];
@@ -89,8 +91,17 @@ OpenLayers.Format.WMSDescribeLayer.v1_1 = OpenLayers.Class(
                         typeName = query[0].getAttribute('typename');
                     }
                 }
-                describelayer.push({layerName: layerName, owsType: owsType, 
+                var layerDescription = {
-                    owsURL: owsURL, typeName: typeName}); 
+                    layerName: layerName, owsType: owsType, 
+                    owsURL: owsURL, typeName: typeName
+                };
+                describelayer.layerDescriptions.push(layerDescription);
+                
+                //TODO do this in deprecated.js instead:
+                // array style index for backwards compatibility
+                describelayer.length = describelayer.layerDescriptions.length;
+                describelayer[describelayer.length - 1] = layerDescription; 
+                
             } else if (nodeName == 'ServiceException') {
                 // an exception must have occurred, so parse it
                 var parser = new OpenLayers.Format.OGCExceptionReport();
@@ -102,6 +113,10 @@ OpenLayers.Format.WMSDescribeLayer.v1_1 = OpenLayers.Class(
         return describelayer;
     },
     
-    CLASS_NAME: "OpenLayers.Format.WMSDescribeLayer.v1_1" 
+    CLASS_NAME: "OpenLayers.Format.WMSDescribeLayer.v1_1_1"
 
 });
+
+// Version alias - workaround for http://trac.osgeo.org/mapserver/ticket/2257
+OpenLayers.Format.WMSDescribeLayer.v1_1_0 =
+    OpenLayers.Format.WMSDescribeLayer.v1_1_1;

notes/2.13.md

@@ -45,3 +45,7 @@ run 'build.py -h' for more details
 Corresponding issue/pull requests:
 
 * https://github.com/openlayers/openlayers/pull/528
+
+# Different return type for OpenLayers.Format.WMSDescribeLayer
+
+The return type of WMSDescribeLayer format's `read` method was different from the one of the VersionedOGC format superclass. So it was changed from an array to an object with a layerDescriptions property that holds the array. For backwards compatibility, the object still has a length property and 0, ..., n properties with the previous array values.

tests/Format/WMSDescribeLayer.html

@@ -4,7 +4,7 @@
     <script type="text/javascript">
     
     function test_read_WMSDescribeLayer(t) {
-        t.plan(5);
+        t.plan(10);
        
         var parser = new OpenLayers.Format.WMSDescribeLayer();
 
@@ -17,18 +17,30 @@
 
         var res = parser.read(text);
 
-        t.eq(res.length, 1,
+        t.eq(res.layerDescriptions.length, 1,
             "Only one LayerDescription in data, so only one parsed");
 
-        t.eq(res[0].owsType, "WFS",
+        t.eq(res.layerDescriptions[0].owsType, "WFS",
             "Properly parses owsType as WFS");
 
-        t.eq(res[0].owsURL, "http://geo.openplans.org:80/geoserver/wfs/WfsDispatcher?",
+        t.eq(res.layerDescriptions[0].owsURL, "http://geo.openplans.org:80/geoserver/wfs/WfsDispatcher?",
             "Properly parses owsURL");
 
-        t.eq(res[0].typeName, "topp:states",
+        t.eq(res.layerDescriptions[0].typeName, "topp:states",
             "Properly parses typeName");
 
+        t.eq(res.layerDescriptions[0].layerName, "topp:states",
+            "Properly parses name");
+        
+        //TODO remove the 5 tests below when we deprecate the old structure
+        t.eq(res.length, 1,
+            "Only one LayerDescription in data, so only one parsed");
+        t.eq(res[0].owsType, "WFS",
+            "Properly parses owsType as WFS");
+        t.eq(res[0].owsURL, "http://geo.openplans.org:80/geoserver/wfs/WfsDispatcher?",
+            "Properly parses owsURL");
+        t.eq(res[0].typeName, "topp:states",
+            "Properly parses typeName");
         t.eq(res[0].layerName, "topp:states",
             "Properly parses name");