From 61b5293692dd5f0af554d3ad7fa1660ecadbcd4e Mon Sep 17 00:00:00 2001 From: ahocevar Date: Tue, 31 Mar 2009 15:06:02 +0000 Subject: [PATCH] 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 --- examples/WMSDescribeLayerParser.html | 41 ++++++++ examples/xml/wmsdescribelayer.xml | 5 + lib/OpenLayers.js | 2 + lib/OpenLayers/Format/WMSDescribeLayer.js | 90 +++++++++++++++++ .../Format/WMSDescribeLayer/v1_1.js | 96 +++++++++++++++++++ tests/Format/WMSDescribeLayer.html | 40 ++++++++ tests/list-tests.html | 1 + 7 files changed, 275 insertions(+) create mode 100644 examples/WMSDescribeLayerParser.html create mode 100644 examples/xml/wmsdescribelayer.xml create mode 100644 lib/OpenLayers/Format/WMSDescribeLayer.js create mode 100644 lib/OpenLayers/Format/WMSDescribeLayer/v1_1.js create mode 100644 tests/Format/WMSDescribeLayer.html diff --git a/examples/WMSDescribeLayerParser.html b/examples/WMSDescribeLayerParser.html new file mode 100644 index 0000000000..1ef78c3861 --- /dev/null +++ b/examples/WMSDescribeLayerParser.html @@ -0,0 +1,41 @@ + + + OpenLayers WMSDescribeLayer Parser Example + + + + + +

WMSDescribeLayer Parser Example

+ +
+ +

+ Demonstrate the operation of the WMSDescribeLayer parser. +

+ +
+ +
+ 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. +
+ + diff --git a/examples/xml/wmsdescribelayer.xml b/examples/xml/wmsdescribelayer.xml new file mode 100644 index 0000000000..d9bb8113c8 --- /dev/null +++ b/examples/xml/wmsdescribelayer.xml @@ -0,0 +1,5 @@ + + + + + diff --git a/lib/OpenLayers.js b/lib/OpenLayers.js index 20395f8cdb..9835c78b69 100644 --- 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", diff --git a/lib/OpenLayers/Format/WMSDescribeLayer.js b/lib/OpenLayers/Format/WMSDescribeLayer.js new file mode 100644 index 0000000000..44bf233564 --- /dev/null +++ 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.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 {} 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" + +}); diff --git a/lib/OpenLayers/Format/WMSDescribeLayer/v1_1.js b/lib/OpenLayers/Format/WMSDescribeLayer/v1_1.js new file mode 100644 index 0000000000..cc951af348 --- /dev/null +++ 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.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 {} 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 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" + +}); diff --git a/tests/Format/WMSDescribeLayer.html b/tests/Format/WMSDescribeLayer.html new file mode 100644 index 0000000000..d89a156ae1 --- /dev/null +++ b/tests/Format/WMSDescribeLayer.html @@ -0,0 +1,40 @@ + + + + + + + + diff --git a/tests/list-tests.html b/tests/list-tests.html index 5b5feaa978..8693e0f0c3 100644 --- a/tests/list-tests.html +++ b/tests/list-tests.html @@ -59,6 +59,7 @@
  • Format/Filter/v1_0_0.html
  • Format/Filter/v1_1_0.html
  • Format/WFSDescribeFeatureType.html
    • +
  • Format/WMSDescribeLayer.html
  • Format/WFS.html
  • Format/WFST.html
  • Format/WFST/v1.html