From 7ebf97406d92e39750a0b8036faa0ea119245cc1 Mon Sep 17 00:00:00 2001 From: Bart van den Eijnden Date: Thu, 6 Mar 2014 09:24:39 +0100 Subject: [PATCH] Add support for writing WFS GetFeature --- src/objectliterals.jsdoc | 18 ++ src/ol/format/gmlformat.js | 5 +- src/ol/format/wfsformat.js | 177 +++++++++++++++ test/spec/ol/format/wfs/topp-states-wfs.xml | 233 ++++++++++++++++++++ test/spec/ol/format/wfsformat.test.js | 97 ++++++++ 5 files changed, 527 insertions(+), 3 deletions(-) create mode 100644 src/ol/format/wfsformat.js create mode 100644 test/spec/ol/format/wfs/topp-states-wfs.xml create mode 100644 test/spec/ol/format/wfsformat.test.js diff --git a/src/objectliterals.jsdoc b/src/objectliterals.jsdoc index 19ef7ded72..8d6b967eed 100644 --- a/src/objectliterals.jsdoc +++ b/src/objectliterals.jsdoc @@ -325,6 +325,24 @@ * when writing out the GML, this will override the default provided. */ +/** + * @typedef {Object} olx.format.WFSOptions + * @property {string} featureNS The namespace URI used for features. + * @property {string} featureType + */ + +/** + * @typedef {Object} olx.format.WFSWriteGetFeatureOptions + * @property {string} featureNS The namespace URI used for features. + * @property {string} featurePrefix The prefix for the feature namespace. + * @property {Array.} featureTypes The feature type names. + * @property {string|undefined} srsName SRS name. No srsName attribute will be + * set on geometries when this is not provided. + * @property {string|undefined} handle Handle. + * @property {string|undefined} outputFormat Output format. + * @property {number} maxFeatures Maximum number of features to fetch. + */ + /** * @typedef {Object} olx.interaction.DoubleClickZoomOptions * @property {number|undefined} duration Animation duration in milliseconds. Default is `250`. diff --git a/src/ol/format/gmlformat.js b/src/ol/format/gmlformat.js index 0eaeabf093..101fcf0f25 100644 --- a/src/ol/format/gmlformat.js +++ b/src/ol/format/gmlformat.js @@ -117,7 +117,7 @@ ol.format.GML.readFeatures_ = function(node, objectStack) { var features; if (localName == 'FeatureCollection') { features = ol.xml.pushParseAndPop(null, - ol.format.GML.FEATURE_COLLECTION_PARSERS_, node, objectStack); + ol.format.GML.FEATURE_COLLECTION_PARSERS, node, objectStack); } else if (localName == 'featureMembers') { var parsers = {}; var parsersNS = {}; @@ -134,9 +134,8 @@ ol.format.GML.readFeatures_ = function(node, objectStack) { /** * @type {Object.>} - * @private */ -ol.format.GML.FEATURE_COLLECTION_PARSERS_ = { +ol.format.GML.FEATURE_COLLECTION_PARSERS = { 'http://www.opengis.net/gml': { 'featureMembers': ol.xml.makeReplacer(ol.format.GML.readFeatures_) } diff --git a/src/ol/format/wfsformat.js b/src/ol/format/wfsformat.js new file mode 100644 index 0000000000..e4504ac911 --- /dev/null +++ b/src/ol/format/wfsformat.js @@ -0,0 +1,177 @@ +goog.provide('ol.format.WFS'); + +goog.require('goog.asserts'); +goog.require('goog.object'); +goog.require('ol.format.GML'); +goog.require('ol.format.XMLFeature'); +goog.require('ol.format.XSD'); +goog.require('ol.xml'); + + + +/** + * @constructor + * @param {olx.format.WFSOptions=} opt_options + * Optional configuration object. + * @extends {ol.format.XMLFeature} + * @todo stability experimental + */ +ol.format.WFS = function(opt_options) { + var options = /** @type {olx.format.WFSOptions} */ + (goog.isDef(opt_options) ? opt_options : {}); + + /** + * @private + * @type {string} + */ + this.featureType_ = options.featureType; + + /** + * @private + * @type {string} + */ + this.featureNS_ = options.featureNS; + + /** + * @private + * @type {string} + */ + this.schemaLocation_ = goog.isDef(options.schemaLocation) ? + options.schemaLocation : ('http://www.opengis.net/wfs ' + + 'http://schemas.opengis.net/wfs/1.1.0/wfs.xsd'); + + goog.base(this); +}; +goog.inherits(ol.format.WFS, ol.format.XMLFeature); + + +/** + * @inheritDoc + */ +ol.format.WFS.prototype.readFeaturesFromNode = function(node) { + var objectStack = [{ + 'featureType': this.featureType_, + 'featureNS': this.featureNS_ + }]; + var features = ol.xml.pushParseAndPop(null, + ol.format.GML.FEATURE_COLLECTION_PARSERS, node, objectStack); + if (!goog.isDef(features)) { + features = []; + } + return features; +}; + + +/** + * @type {Object.>} + * @private + */ +ol.format.WFS.QUERY_SERIALIZERS_ = { + 'http://www.opengis.net/wfs': { + 'PropertyName': ol.xml.makeChildAppender(ol.format.XSD.writeStringTextNode) + } +}; + + +/** + * @param {Node} node Node. + * @param {string} featureType Feature type. + * @param {Array.<*>} objectStack Node stack. + * @private + */ +ol.format.WFS.writeQuery_ = function(node, featureType, objectStack) { + var context = objectStack[objectStack.length - 1]; + goog.asserts.assert(goog.isObject(context)); + var featurePrefix = goog.object.get(context, 'featurePrefix'); + var featureNS = goog.object.get(context, 'featureNS'); + var propertyNames = goog.object.get(context, 'propertyNames'); + var srsName = goog.object.get(context, 'srsName'); + var prefix = goog.isDef(featurePrefix) ? featurePrefix + ':' : ''; + node.setAttribute('typeName', prefix + featureType); + node.setAttribute('srsName', srsName); + if (goog.isDef(featureNS)) { + node.setAttribute('xmlns:' + featurePrefix, featureNS); + } + var item = goog.object.clone(context); + goog.object.set(item, 'node', node); + ol.xml.pushSerializeAndPop(item, + ol.format.WFS.QUERY_SERIALIZERS_, + ol.xml.makeSimpleNodeFactory('PropertyName'), propertyNames, + objectStack); +}; + + +/** + * @type {Object.>} + * @private + */ +ol.format.WFS.GETFEATURE_SERIALIZERS_ = { + 'http://www.opengis.net/wfs': { + 'Query': ol.xml.makeChildAppender( + ol.format.WFS.writeQuery_) + } +}; + + +/** + * @param {Node} node Node. + * @param {Array.<{string}>} featureTypes Feature types. + * @param {Array.<*>} objectStack Node stack. + * @private + */ +ol.format.WFS.writeGetFeature_ = function(node, featureTypes, objectStack) { + var context = objectStack[objectStack.length - 1]; + goog.asserts.assert(goog.isObject(context)); + var item = goog.object.clone(context); + goog.object.set(item, 'node', node); + ol.xml.pushSerializeAndPop(item, + ol.format.WFS.GETFEATURE_SERIALIZERS_, + ol.xml.makeSimpleNodeFactory('Query'), featureTypes, + objectStack); +}; + + +/** + * @param {olx.format.WFSWriteGetFeatureOptions} options Options. + * @return {ArrayBuffer|Node|Object|string} Result. + */ +ol.format.WFS.prototype.writeGetFeature = function(options) { + var node = ol.xml.createElementNS('http://www.opengis.net/wfs', + 'GetFeature'); + node.setAttribute('service', 'WFS'); + node.setAttribute('version', '1.1.0'); + if (goog.isDef(options)) { + if (goog.isDef(options.handle)) { + node.setAttribute('handle', options.handle); + } + if (goog.isDef(options.outputFormat)) { + node.setAttribute('outputFormat', options.outputFormat); + } + if (goog.isDef(options.maxFeatures)) { + node.setAttribute('maxFeatures', options.maxFeatures); + } + if (goog.isDef(options.resultType)) { + node.setAttribute('resultType', options.resultType); + } + if (goog.isDef(options.startIndex)) { + node.setAttribute('startIndex', options.startIndex); + } + if (goog.isDef(options.count)) { + node.setAttribute('count', options.count); + } + } + ol.xml.setAttributeNS(node, 'http://www.w3.org/2001/XMLSchema-instance', + 'xsi:schemaLocation', this.schemaLocation_); + var context = { + node: node, + srsName: options.srsName, + featureNS: goog.isDef(options.featureNS) ? + options.featureNS : this.featureNS_, + featurePrefix: options.featurePrefix, + propertyNames: goog.isDef(options.propertyNames) ? + options.propertyNames : [] + }; + goog.asserts.assert(goog.isArray(options.featureTypes)); + ol.format.WFS.writeGetFeature_(node, options.featureTypes, [context]); + return node; +}; diff --git a/test/spec/ol/format/wfs/topp-states-wfs.xml b/test/spec/ol/format/wfs/topp-states-wfs.xml new file mode 100644 index 0000000000..352a01fa51 --- /dev/null +++ b/test/spec/ol/format/wfs/topp-states-wfs.xml @@ -0,0 +1,233 @@ + + + + + + + 36.986 -91.516 + 42.509 -87.507 + + + + + + + + + 37.511 -88.071 37.476 -88.087 37.442 -88.311 37.409 + -88.359 37.421 -88.419 37.401 -88.467 37.296 -88.511 37.257 + -88.501 37.205 -88.451 37.156 -88.422 37.098 -88.451 37.072 + -88.476 37.068 -88.491 37.064 -88.517 37.072 -88.559 37.109 + -88.614 37.135 -88.688 37.141 -88.739 37.152 -88.746 37.202 + -88.863 37.218 -88.932 37.221 -88.993 37.185 -89.065 37.112 + -89.116 37.093 -89.146 37.064 -89.169 37.025 -89.174 36.998 + -89.151 36.988 -89.129 36.986 -89.193 37.028 -89.211 37.041 + -89.237 37.087 -89.264 37.091 -89.284 37.085 -89.303 37.061 + -89.309 37.027 -89.264 37.008 -89.262 36.999 -89.282 37.009 + -89.311 37.049 -89.382 37.099 -89.379 37.137 -89.423 37.165 + -89.441 37.224 -89.468 37.253 -89.465 37.256 -89.489 37.276 + -89.513 37.304 -89.513 37.329 -89.501 37.339 -89.468 37.355 + -89.435 37.411 -89.427 37.453 -89.453 37.491 -89.494 37.571 + -89.524 37.615 -89.513 37.651 -89.519 37.679 -89.513 37.694 + -89.521 37.706 -89.581 37.745 -89.666 37.783 -89.675 37.804 + -89.691 37.841 -89.728 37.905 -89.851 37.905 -89.861 37.891 + -89.866 37.875 -89.901 37.878 -89.937 37.911 -89.978 37.963 + -89.958 37.969 -90.011 37.993 -90.041 38.032 -90.119 38.053 + -90.134 38.088 -90.207 38.122 -90.254 38.166 -90.289 38.188 + -90.336 38.234 -90.364 38.323 -90.369 38.365 -90.358 38.391 + -90.339 38.427 -90.301 38.518 -90.265 38.532 -90.261 38.562 + -90.241 38.611 -90.183 38.658 -90.183 38.701 -90.202 38.723 + -90.196 38.773 -90.163 38.785 -90.135 38.801 -90.121 38.831 + -90.113 38.853 -90.132 38.914 -90.243 38.924 -90.278 38.924 + -90.319 38.962 -90.413 38.959 -90.469 38.891 -90.531 38.871 + -90.571 38.881 -90.627 38.935 -90.668 39.037 -90.706 39.058 + -90.707 39.093 -90.691 39.144 -90.716 39.195 -90.718 39.224 + -90.732 39.247 -90.738 39.296 -90.779 39.351 -90.851 39.401 + -90.947 39.444 -91.036 39.473 -91.064 39.528 -91.093 39.552 + -91.156 39.601 -91.203 39.685 -91.317 39.724 -91.367 39.761 + -91.373 39.803 -91.381 39.863 -91.449 39.885 -91.451 39.901 + -91.434 39.921 -91.431 39.946 -91.447 40.005 -91.487 40.066 + -91.504 40.134 -91.516 40.201 -91.506 40.251 -91.498 40.309 + -91.486 40.371 -91.448 40.386 -91.418 40.392 -91.385 40.402 + -91.372 40.447 -91.385 40.503 -91.374 40.528 -91.382 40.547 + -91.412 40.572 -91.411 40.603 -91.375 40.639 -91.262 40.643 + -91.214 40.656 -91.162 40.682 -91.129 40.705 -91.119 40.761 + -91.092 40.833 -91.088 40.879 -91.049 40.923 -90.983 40.951 + -90.961 41.071 -90.954 41.104 -90.957 41.144 -90.991 41.165 + -91.018 41.176 -91.056 41.231 -91.101 41.267 -91.102 41.334 + -91.073 41.401 -91.055 41.423 -91.027 41.431 -91.001 41.421 + -90.949 41.444 -90.844 41.449 -90.779 41.451 -90.708 41.462 + -90.658 41.509 -90.601 41.525 -90.541 41.527 -90.454 41.543 + -90.434 41.567 -90.423 41.586 -90.348 41.602 -90.339 41.649 + -90.341 41.722 -90.326 41.756 -90.304 41.781 -90.255 41.806 + -90.195 41.931 -90.154 41.983 -90.142 42.033 -90.151 42.061 + -90.168 42.103 -90.166 42.121 -90.176 42.122 -90.191 42.159 + -90.231 42.197 -90.323 42.211 -90.367 42.242 -90.407 42.263 + -90.417 42.341 -90.427 42.361 -90.441 42.388 -90.491 42.421 + -90.563 42.461 -90.605 42.475 -90.648 42.494 -90.651 42.509 + -90.638 42.508 -90.419 42.504 -89.923 42.503 -89.834 42.497 + -89.401 42.497 -89.359 42.491 -88.939 42.491 -88.764 42.489 + -88.706 42.491 -88.297 42.489 -88.194 42.489 -87.797 42.314 + -87.836 42.156 -87.761 42.059 -87.671 41.847 -87.612 41.723 + -87.529 41.469 -87.532 41.301 -87.532 41.173 -87.531 41.009 + -87.532 40.745 -87.532 40.494 -87.537 40.483 -87.535 40.166 + -87.535 39.887 -87.535 39.609 -87.535 39.477 -87.538 39.351 + -87.541 39.338 -87.597 39.307 -87.625 39.297 -87.611 39.281 + -87.615 39.258 -87.606 39.248 -87.584 39.208 -87.588 39.198 + -87.594 39.196 -87.607 39.168 -87.644 39.146 -87.671 39.131 + -87.659 39.113 -87.662 39.103 -87.631 39.088 -87.631 39.084 + -87.612 39.062 -87.585 38.995 -87.581 38.994 -87.591 38.977 + -87.547 38.963 -87.533 38.931 -87.531 38.904 -87.539 38.869 + -87.559 38.857 -87.551 38.795 -87.507 38.776 -87.519 38.769 + -87.508 38.736 -87.508 38.685 -87.543 38.672 -87.588 38.642 + -87.625 38.622 -87.628 38.599 -87.619 38.593 -87.641 38.573 + -87.652 38.547 -87.672 38.515 -87.651 38.501 -87.653 38.504 + -87.679 38.481 -87.692 38.466 -87.756 38.457 -87.758 38.445 + -87.738 38.417 -87.748 38.378 -87.784 38.352 -87.834 38.286 + -87.851 38.285 -87.863 38.316 -87.874 38.315 -87.883 38.301 + -87.888 38.281 -87.914 38.302 -87.913 38.304 -87.925 38.241 + -87.981 38.234 -87.986 38.201 -87.977 38.171 -87.932 38.157 + -87.931 38.136 -87.951 38.131 -87.973 38.103 -88.018 38.092 + -88.012 38.096 -87.964 38.073 -87.975 38.054 -88.034 38.045 + -88.043 38.038 -88.041 38.033 -88.021 38.008 -88.029 37.975 + -88.021 37.956 -88.042 37.934 -88.041 37.929 -88.064 37.944 + -88.078 37.923 -88.084 37.917 -88.031 37.905 -88.026 37.896 + -88.044 37.906 -88.101 37.895 -88.101 37.867 -88.075 37.843 + -88.034 37.827 -88.042 37.831 -88.089 37.817 -88.086 37.805 + -88.035 37.735 -88.072 37.701 -88.133 37.661 -88.159 37.628 + -88.157 37.583 -88.134 37.511 -88.071 + + + + + + + Illinois + 17 + E N Cen + IL + 143986.61 + 1993.335 + 1.143E7 + 2924880.0 + 4202240.0 + 5552233.0 + 5878369.0 + 4199206.0 + 3741715.0 + 652603.0 + 538071.0 + 5417967.0 + 385040.0 + 1360159.0 + 828906.0 + 0.486 + 0.514 + 1747776.0 + + + + + 38.788 -77.122 + 38.993 -76.911 + + + + + + + + + 38.966 -77.008 38.889 -76.911 38.788 -77.045 38.813 + -77.035 38.829 -77.045 38.838 -77.041 38.862 -77.039 38.886 + -77.067 38.915 -77.078 38.932 -77.122 38.993 -77.042 38.966 + -77.008 + + + + + + + District of Columbia + 11 + S Atl + DC + 159.055 + 17.991 + 606900.0 + 122087.0 + 249634.0 + 282970.0 + 323930.0 + 229975.0 + 106694.0 + 36621.0 + 111422.0 + 303994.0 + 23442.0 + 65498.0 + 22407.0 + 0.466 + 0.534 + 72696.0 + + + + + 38.449 -75.791 + 39.841 -75.045 + + + + + + + + + 38.557 -75.707 38.649 -75.711 38.831 -75.724 39.141 + -75.752 39.247 -75.761 39.295 -75.764 39.383 -75.772 39.723 + -75.791 39.724 -75.775 39.774 -75.745 39.821 -75.695 39.838 + -75.644 39.841 -75.583 39.826 -75.471 39.798 -75.421 39.789 + -75.412 39.778 -75.428 39.763 -75.461 39.741 -75.475 39.719 + -75.476 39.714 -75.489 39.612 -75.611 39.566 -75.562 39.463 + -75.591 39.366 -75.515 39.257 -75.402 39.073 -75.397 39.012 + -75.324 38.945 -75.307 38.808 -75.191 38.799 -75.083 38.449 + -75.045 38.449 -75.068 38.451 -75.093 38.455 -75.351 38.463 + -75.699 38.557 -75.707 + + + + + + + Delaware + 10 + S Atl + DE + 5062.456 + 1385.022 + 666168.0 + 175867.0 + 247497.0 + 322968.0 + 343200.0 + 247566.0 + 258087.0 + 42968.0 + 8069.0 + 335147.0 + 13945.0 + 87973.0 + 44140.0 + 0.485 + 0.515 + 102776.0 + + + diff --git a/test/spec/ol/format/wfsformat.test.js b/test/spec/ol/format/wfsformat.test.js new file mode 100644 index 0000000000..78200336d5 --- /dev/null +++ b/test/spec/ol/format/wfsformat.test.js @@ -0,0 +1,97 @@ +goog.provide('ol.test.format.WFS'); + +describe('ol.format.WFS', function() { + + describe('when parsing TOPP states GML from WFS', function() { + + var features, feature; + before(function(done) { + afterLoadText('spec/ol/format/wfs/topp-states-wfs.xml', function(xml) { + try { + var config = { + 'featureNS': 'http://www.openplans.org/topp', + 'featureType': 'states' + }; + features = new ol.format.WFS(config).readFeatures(xml); + } catch (e) { + done(e); + } + done(); + }); + }); + + it('creates 3 features', function() { + expect(features).to.have.length(3); + }); + + it('creates a polygon for Illinois', function() { + feature = features[0]; + expect(feature.getId()).to.equal('states.1'); + expect(feature.get('STATE_NAME')).to.equal('Illinois'); + expect(feature.getGeometry()).to.be.an(ol.geom.MultiPolygon); + }); + + }); + + describe('when writing out a GetFeature request', function() { + + it('creates the expected output', function() { + var text = + '' + + ' ' + + ' STATE_NAME' + + ' STATE_FIPS' + + ' STATE_ABBR' + + ' ' + + ''; + var serialized = new ol.format.WFS().writeGetFeature({ + resultType: 'hits', + featureTypes: ['states'], + featureNS: 'http://www.openplans.org/topp', + featurePrefix: 'topp', + srsName: 'urn:ogc:def:crs:EPSG::4326', + propertyNames: ['STATE_NAME', 'STATE_FIPS', 'STATE_ABBR'] + }); + expect(serialized).to.xmleql(ol.xml.load(text)); + }); + + it('creates paging headers', function() { + var text = + '' + + ' ' + + ' ' + + ''; + var serialized = new ol.format.WFS().writeGetFeature({ + count: 10, + startIndex: 20, + srsName: 'urn:ogc:def:crs:EPSG::4326', + featureNS: 'http://www.openplans.org/topp', + featurePrefix: 'topp', + featureTypes: ['states'] + }); + expect(serialized).to.xmleql(ol.xml.load(text)); + }); + }); + +}); + + +goog.require('ol.xml'); +goog.require('ol.geom.MultiPolygon'); +goog.require('ol.format.WFS');