1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 | /* Copyright (c) 2006-2010 by OpenLayers Contributors (see authors.txt for * full list of contributors). Published under the Clear BSD license. * See http://svn.openlayers.org/trunk/openlayers/license.txt for the * full text of the license. */ /** * @requires OpenLayers/Protocol/WFS.js */ /** * Class: OpenLayers.Protocol.WFS.v1 * Abstract class for for v1.0.0 and v1.1.0 protocol. * * Inherits from: * - <OpenLayers.Protocol> */ OpenLayers.Protocol.WFS.v1 = OpenLayers.Class(OpenLayers.Protocol, { /** * Property: version * {String} WFS version number. */ version: null, /** * Property: srsName * {String} Name of spatial reference system. Default is "EPSG:4326". */ srsName: "EPSG:4326", /** * Property: featureType * {String} Local feature typeName. */ featureType: null, /** * Property: featureNS * {String} Feature namespace. */ featureNS: null, /** * Property: geometryName * {String} Name of the geometry attribute for features. Default is * "the_geom". */ geometryName: "the_geom", /** * Property: schema * {String} Optional schema location that will be included in the * schemaLocation attribute value. Note that the feature type schema * is required for a strict XML validator (on transactions with an * insert for example), but is *not* required by the WFS specification * (since the server is supposed to know about feature type schemas). */ schema: null, /** * Property: featurePrefix * {String} Namespace alias for feature type. Default is "feature". */ featurePrefix: "feature", /** * Property: formatOptions * {Object} Optional options for the format. If a format is not provided, * this property can be used to extend the default format options. */ formatOptions: null, /** * Property: readFormat * {<OpenLayers.Format>} For WFS requests it is possible to get a * different output format than GML. In that case, we cannot parse * the response with the default format (WFST) and we need a different * format for reading. */ readFormat: null, /** * Constructor: OpenLayers.Protocol.WFS * A class for giving layers WFS protocol. * * Parameters: * options - {Object} Optional object whose properties will be set on the * instance. * * Valid options properties: * url - {String} URL to send requests to (required). * featureType - {String} Local (without prefix) feature typeName (required). * featureNS - {String} Feature namespace (required, but can be autodetected * for reading if featurePrefix is provided and identical to the prefix * in the server response). * featurePrefix - {String} Feature namespace alias (optional - only used * for writing if featureNS is provided). Default is 'feature'. * geometryName - {String} Name of geometry attribute. Default is 'the_geom'. */ initialize: function(options) { OpenLayers.Protocol.prototype.initialize.apply(this, [options]); if(!options.format) { this.format = OpenLayers.Format.WFST(OpenLayers.Util.extend({ version: this.version, featureType: this.featureType, featureNS: this.featureNS, featurePrefix: this.featurePrefix, geometryName: this.geometryName, srsName: this.srsName, schema: this.schema }, this.formatOptions)); } if(!this.featureNS && this.featurePrefix) { // featureNS autodetection var readNode = this.format.readNode; this.format.readNode = function(node, obj) { if(!this.featureNS && node.prefix == this.featurePrefix) { this.featureNS = node.namespaceURI; this.setNamespace("feature", this.featureNS); } return readNode.apply(this, arguments); }; } }, /** * APIMethod: destroy * Clean up the protocol. */ destroy: function() { if(this.options && !this.options.format) { this.format.destroy(); } this.format = null; OpenLayers.Protocol.prototype.destroy.apply(this); }, /** * Method: read * Construct a request for reading new features. Since WFS splits the * basic CRUD operations into GetFeature requests (for read) and * Transactions (for all others), this method does not make use of the * format's read method (that is only about reading transaction * responses). */ read: function(options) { OpenLayers.Protocol.prototype.read.apply(this, arguments); options = OpenLayers.Util.extend({}, options); OpenLayers.Util.applyDefaults(options, this.options || {}); var response = new OpenLayers.Protocol.Response({requestType: "read"}); var data = OpenLayers.Format.XML.prototype.write.apply( this.format, [this.format.writeNode("wfs:GetFeature", options)] ); response.priv = OpenLayers.Request.POST({ url: options.url, callback: this.createCallback(this.handleRead, response, options), params: options.params, headers: options.headers, data: data }); return response; }, /** * Method: handleRead * Deal with response from the read request. * * Parameters: * response - {<OpenLayers.Protocol.Response>} The response object to pass * to the user callback. * options - {Object} The user options passed to the read call. */ handleRead: function(response, options) { if(options.callback) { var request = response.priv; if(request.status >= 200 && request.status < 300) { // success response.features = this.parseFeatures(request); response.code = OpenLayers.Protocol.Response.SUCCESS; } else { // failure response.code = OpenLayers.Protocol.Response.FAILURE; } options.callback.call(options.scope, response); } }, /** * Method: parseFeatures * Read HTTP response body and return features * * Parameters: * request - {XMLHttpRequest} The request object * * Returns: * {Array({<OpenLayers.Feature.Vector>})} or * {<OpenLayers.Feature.Vector>} Array of features or a single feature. */ parseFeatures: function(request) { var doc = request.responseXML; if(!doc || !doc.documentElement) { doc = request.responseText; } if(!doc || doc.length <= 0) { return null; } return (this.readFormat !== null) ? this.readFormat.read(doc) : this.format.read(doc); }, /** * Method: commit * Given a list of feature, assemble a batch request for update, create, * and delete transactions. A commit call on the prototype amounts * to writing a WFS transaction - so the write method on the format * is used. * * Parameters: * features - {Array(<OpenLayers.Feature.Vector>} * * Returns: * {<OpenLayers.Protocol.Response>} A response object with a features * property containing any insertIds and a priv property referencing * the XMLHttpRequest object. */ commit: function(features, options) { options = OpenLayers.Util.extend({}, options); OpenLayers.Util.applyDefaults(options, this.options); var response = new OpenLayers.Protocol.Response({ requestType: "commit", reqFeatures: features }); response.priv = OpenLayers.Request.POST({ url: options.url, data: this.format.write(features, options), callback: this.createCallback(this.handleCommit, response, options) }); return response; }, /** * Method: handleCommit * Called when the commit request returns. * * Parameters: * response - {<OpenLayers.Protocol.Response>} The response object to pass * to the user callback. * options - {Object} The user options passed to the commit call. */ handleCommit: function(response, options) { if(options.callback) { var request = response.priv; // ensure that we have an xml doc var data = request.responseXML; if(!data || !data.documentElement) { data = request.responseText; } var obj = this.format.read(data) || {}; response.insertIds = obj.insertIds || []; response.code = (obj.success) ? OpenLayers.Protocol.Response.SUCCESS : OpenLayers.Protocol.Response.FAILURE; options.callback.call(options.scope, response); } }, /** * Method: filterDelete * Send a request that deletes all features by their filter. * * Parameters: * filter - {OpenLayers.Filter} filter */ filterDelete: function(filter, options) { options = OpenLayers.Util.extend({}, options); OpenLayers.Util.applyDefaults(options, this.options); var response = new OpenLayers.Protocol.Response({ requestType: "commit" }); var root = this.format.createElementNSPlus("wfs:Transaction", { attributes: { service: "WFS", version: this.version } }); var deleteNode = this.format.createElementNSPlus("wfs:Delete", { attributes: { typeName: (options.featureNS ? this.featurePrefix + ":" : "") + options.featureType } }); if(options.featureNS) { deleteNode.setAttribute("xmlns:" + this.featurePrefix, options.featureNS); } var filterNode = this.format.writeNode("ogc:Filter", filter); deleteNode.appendChild(filterNode); root.appendChild(deleteNode); var data = OpenLayers.Format.XML.prototype.write.apply( this.format, [root] ); return OpenLayers.Request.POST({ url: this.url, callback : options.callback || function(){}, data: data }); }, /** * Method: abort * Abort an ongoing request, the response object passed to * this method must come from this protocol (as a result * of a read, or commit operation). * * Parameters: * response - {<OpenLayers.Protocol.Response>} */ abort: function(response) { if (response) { response.priv.abort(); } }, CLASS_NAME: "OpenLayers.Protocol.WFS.v1" }); |