Added WMSDescribeLayer format. Thanks bartvde and sbenthall for the patch. I made some minor modifications:

* changed file structure to match other formats (i.e. put version 1.1 parser in a WMSDescribeLayer subfolder) * fixed a type in the example which showed owsURL instead of owsType r=me (closes #1201) git-svn-id: http://svn.openlayers.org/trunk/openlayers@9146 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
2009-03-31 15:06:02 +00:00
parent cf5aa98cce
commit 61b5293692
7 changed files with 275 additions and 0 deletions
--- a/examples/WMSDescribeLayerParser.html
+++ b/examples/WMSDescribeLayerParser.html
@@ -0,0 +1,41 @@
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <title>OpenLayers WMSDescribeLayer Parser Example</title>
+    <link rel="stylesheet" href="style.css" type="text/css" />
+    <script src="../lib/OpenLayers.js"></script>
+    <script type="text/javascript">
+        function parseData(req) {
+          format =  new OpenLayers.Format.WMSDescribeLayer();
+          html = "<br />"
+          resp = format.read(req.responseText);
+          for(var i = 0; i < resp.length; i++) {
+            html += "Layer: typeName: "+ resp[i].typeName+",";
+                html += "<ul>";
+                html += "<li>owsURL: "+resp[i].owsURL+"</li>";
+                html += "<li>owsType: "+resp[i].owsType+"</li>";
+                html += "</ul>"
+          }
+          document.getElementById('output').innerHTML = html;
+        }
+        function load() {
+            OpenLayers.loadURL("xml/wmsdescribelayer.xml", "", null, parseData);
+        }
+    </script>
+  </head>
+  <body onload="load()">
+      <h1 id="title">WMSDescribeLayer Parser Example</h1>
+
+      <div id="tags"></div>
+
+      <p id="shortdesc">
+          Demonstrate the operation of the WMSDescribeLayer parser.
+      </p>
+
+      <div id="output"></div>
+
+      <div id="docs">
+          This script reads data from a file and parses out the coordinates, appending them to a HTML string with markup tags.
+          This markup is dumped to an element in the page.
+    </div>
+  </body>
+</html>
--- a/examples/xml/wmsdescribelayer.xml
+++ b/examples/xml/wmsdescribelayer.xml
@@ -0,0 +1,5 @@
+<WMS_DescribeLayerResponse version="1.1.1">
+  <LayerDescription name="topp:states" wfs="http://demo.opengeo.org:80/geoserver/wfs/WfsDispatcher?">
+    <Query typeName="topp:states"/>
+  </LayerDescription>
+</WMS_DescribeLayerResponse>
--- a/lib/OpenLayers.js
+++ b/lib/OpenLayers.js
@@ -216,6 +216,8 @@
            "OpenLayers/Format/GeoRSS.js",
            "OpenLayers/Format/WFS.js",
            "OpenLayers/Format/WFSDescribeFeatureType.js",
+            "OpenLayers/Format/WMSDescribeLayer.js",
+            "OpenLayers/Format/WMSDescribeLayer/v1_1.js",
            "OpenLayers/Format/WKT.js",
            "OpenLayers/Format/OSM.js",
            "OpenLayers/Format/GPX.js",
--- a/lib/OpenLayers/Format/WMSDescribeLayer.js
+++ b/lib/OpenLayers/Format/WMSDescribeLayer.js
@@ -0,0 +1,90 @@
+/* Copyright (c) 2006-2008 MetaCarta, Inc., published under the Clear BSD
+ * license.  See http://svn.openlayers.org/trunk/openlayers/license.txt for the
+ * full text of the license. */
+
+/**
+ * @requires OpenLayers/Format/XML.js
+ */
+
+/**
+ * Class: OpenLayers.Format.WMSDescribeLayer
+ * Read SLD WMS DescribeLayer response
+ * DescribeLayer is meant to couple WMS to WFS and WCS
+ * 
+ * Inherits from:
+ *  - <OpenLayers.Format.XML>
+ */
+OpenLayers.Format.WMSDescribeLayer = OpenLayers.Class(OpenLayers.Format.XML, {
+
+    /**
+     * APIProperty: defaultVersion
+     * {String} Version number to assume if none found.  Default is "1.1.1".
+     */
+    defaultVersion: "1.1.1",
+   
+    /**
+     * APIProperty: version
+     * {String} Specify a version string if one is known.
+     */
+    version: null,
+
+    /**
+     * Constructor: OpenLayers.Format.WMSDescribeLayer
+     * Create a new parser for WMS DescribeLayer responses.
+     *
+     * Parameters:
+     * options - {Object} An optional object whose properties will be set on
+     *     this instance.
+     */
+    initialize: function(options) {
+        OpenLayers.Format.XML.prototype.initialize.apply(this, [options]);
+        this.options = options;
+    },
+
+    /**
+     * APIMethod: read
+     * Read DescribeLayer data from a string, and return the response. 
+     * The OGC currently defines 2 formats which are allowed for output,
+     * so we need to parse these 2 types
+     * 
+     * Parameters: 
+     * data - {String} or {DOMElement} data to read/parse.
+     *
+     * Returns:
+     * {Array} 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
+     */
+    read: function(data) {
+        if(typeof data == "string") {
+            data = OpenLayers.Format.XML.prototype.read.apply(this, [data]);
+        }
+        var root = data.documentElement;
+        var version = this.version;
+        if(!version) {
+            version = root.getAttribute("version");
+            if(!version) {
+                version = this.defaultVersion;
+            }
+        }
+        // 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";
+        }
+        var constructor = OpenLayers.Format.WMSDescribeLayer[
+            "v" + version.replace(/\./g, "_")
+        ];
+        if(!constructor) {
+            throw "Can't find a WMS DescribeLayer parser for version " + 
+                version;
+        }
+        var parser = new constructor(this.options);
+        var describelayer = parser.read(data);
+        describelayer.version = version;
+        return describelayer;
+    },
+    
+    CLASS_NAME: "OpenLayers.Format.WMSDescribeLayer" 
+
+});
--- a/lib/OpenLayers/Format/WMSDescribeLayer/v1_1.js
+++ b/lib/OpenLayers/Format/WMSDescribeLayer/v1_1.js
@@ -0,0 +1,96 @@
+/* Copyright (c) 2006-2008 MetaCarta, Inc., published under the Clear BSD
+ * license.  See http://svn.openlayers.org/trunk/openlayers/license.txt for the
+ * full text of the license. */
+
+/**
+ * @requires OpenLayers/Format/WMSDescribeLayer.js
+ */
+
+/**
+ * Class: OpenLayers.Format.WMSDescribeLayer.v1_1
+ * Read SLD WMS DescribeLayer response for WMS 1.1.X
+ * WMS 1.1.X is tightly coupled to SLD 1.0.0
+ *
+ * Example DescribeLayer request: 
+ * http://demo.opengeo.org/geoserver/wms?request=DescribeLayer&version=1.1.1&layers=topp:states
+ *
+ * Inherits from:
+ *  - <OpenLayers.Format.WMSDescribeLayer>
+ */
+OpenLayers.Format.WMSDescribeLayer.v1_1 = OpenLayers.Class(
+    OpenLayers.Format.WMSDescribeLayer, {
+    
+    /**
+     * Constructor: OpenLayers.Format.WMSDescribeLayer
+     * Create a new parser for WMS DescribeLayer responses.
+     *
+     * Parameters:
+     * options - {Object} An optional object whose properties will be set on
+     *     this instance.
+     */
+    initialize: function(options) {
+        OpenLayers.Format.WMSDescribeLayer.prototype.initialize.apply(this, 
+            [options]);
+    },
+
+    /**
+     * APIMethod: read
+     * Read DescribeLayer data from a string, and return the response. 
+     * The OGC defines 2 formats which are allowed for output,
+     * so we need to parse these 2 types for version 1.1.X
+     * 
+     * Parameters: 
+     * data - {String} or {DOMElement} data to read/parse.
+     *
+     * Returns:
+     * {Array} 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
+     */
+    read: function(data) {
+        if(typeof data == "string") {
+            data = OpenLayers.Format.XML.prototype.read.apply(this, [data]);
+        }
+        var root = data.documentElement;
+        var children = root.childNodes; 
+        var describelayer = [];
+        for(var i=0; i<children.length; ++i) { 
+            childNode = children[i];
+            nodeName = childNode.nodeName; 
+            if (nodeName == 'LayerDescription') {
+                var owsType = '';
+                var owsURL = '';
+                var typeName = '';
+                // check for owsType and owsURL attributes
+                if (childNode.getAttribute('owsType')) {
+                  owsType = childNode.getAttribute('owsType');
+                  owsURL = childNode.getAttribute('owsURL');
+                } else {
+                    // look for wfs or wcs attribute
+                    if (childNode.getAttribute('wfs') != '') {
+                        owsType = 'WFS';
+                        owsURL = childNode.getAttribute('wfs');
+                    } else if (childNode.getAttribute('wcs') != '') {
+                        owsType = 'WCS';
+                        owsURL = childNode.getAttribute('wcs');
+                    }
+                }
+                // look for Query child
+                query = childNode.getElementsByTagName('Query');
+                if(query.length > 0) {
+                    typeName = query[0].getAttribute('typeName');
+                    if (!typeName) {
+                        // because of Ionic bug
+                        typeName = query[0].getAttribute('typename');
+                    }
+                }
+                describelayer.push({owsType: owsType, owsURL: owsURL, typeName: typeName}); 
+            }
+        }
+        return describelayer;
+    },
+    
+    CLASS_NAME: "OpenLayers.Format.WMSDescribeLayer.v1_1" 
+
+});
--- a/tests/Format/WMSDescribeLayer.html
+++ b/tests/Format/WMSDescribeLayer.html
@@ -0,0 +1,40 @@
+<html> 
+<head> 
+    <script src="../../lib/OpenLayers.js"></script>
+    <script type="text/javascript">
+    
+    function test_read_WMSDescribeLayer(t) {
+        t.plan(4);
+       
+        var parser = new OpenLayers.Format.WMSDescribeLayer();
+
+        var text =
+            '<WMS_DescribeLayerResponse version="1.1.1">' +
+            '  <LayerDescription name="topp:states" wfs="http://geo.openplans.org:80/geoserver/wfs/WfsDispatcher?">' +
+            '    <Query typeName="topp:states"/>' +
+            '  </LayerDescription>' +
+            '</WMS_DescribeLayerResponse>';
+
+        var res = parser.read(text);
+
+        console.log(res);
+
+        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");
+
+    }
+
+    </script> 
+</head> 
+<body>
+</body> 
+</html>
--- a/tests/list-tests.html
+++ b/tests/list-tests.html
@@ -59,6 +59,7 @@
    <li>Format/Filter/v1_0_0.html</li>
    <li>Format/Filter/v1_1_0.html</li>
    <li>Format/WFSDescribeFeatureType.html</li>
+    <li>Format/WMSDescribeLayer.html</li>
    <li>Format/WFS.html</li>
    <li>Format/WFST.html</li>
    <li>Format/WFST/v1.html</li>