Addressing review suggestions and fixing asynchronous function calls.
This commit addresses @bartvde's review comments, adds more documentation, and fixes asynchronous function calls. Previously, when creating multiple processes with the same identifier, the describe callback would only have been called for the first process. This was fixed to move DescribeProcess handling from WPSProcess to WPSClient.
This commit is contained in:
ahocevar
@@ -8,16 +8,19 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @requires OpenLayers/Events.js
|
||||
* @requires OpenLayers/WPSProcess.js
|
||||
* @requires OpenLayers/Format/WKT.js
|
||||
* @requires OpenLayers/Format/GeoJSON.js
|
||||
* @requires OpenLayers/Format/WPSDescribeProcess.js
|
||||
* @requires OpenLayers/Format/WPSExecute.js
|
||||
* @requires OpenLayers/Request.js
|
||||
*/
|
||||
|
||||
/**
|
||||
* Class: OpenLayers.WPSClient
|
||||
* High level API for interaction with Web Processing Services (WPS).
|
||||
* An <OpenLayers.WPSClient> instance is used to create <OpenLayers.WPSProcess>
|
||||
* instances for servers known to the WPSClient. The WPSClient also caches
|
||||
* DescribeProcess responses to reduce the number of requests sent to servers
|
||||
* when processes are created.
|
||||
*/
|
||||
OpenLayers.WPSClient = OpenLayers.Class({
|
||||
|
||||
@@ -28,11 +31,18 @@ OpenLayers.WPSClient = OpenLayers.Class({
|
||||
* Properties:
|
||||
* url - {String} the url of the server
|
||||
* version - {String} WPS version of the server
|
||||
* describeProcessResponse - {Object} Cache of raw DescribeProcess
|
||||
* processDescription - {Object} Cache of raw DescribeProcess
|
||||
* responses, keyed by process identifier.
|
||||
*/
|
||||
servers: null,
|
||||
|
||||
/**
|
||||
* Property: version
|
||||
* {String} The default WPS version to use if none is configured. Default
|
||||
* is '1.0.0'.
|
||||
*/
|
||||
version: '1.0.0',
|
||||
|
||||
/**
|
||||
* Property: lazy
|
||||
* {Boolean} Should the DescribeProcess be deferred until a process is
|
||||
@@ -40,6 +50,18 @@ OpenLayers.WPSClient = OpenLayers.Class({
|
||||
*/
|
||||
lazy: false,
|
||||
|
||||
/**
|
||||
* Property: events
|
||||
* {<OpenLayers.Events>}
|
||||
*
|
||||
* Supported event types:
|
||||
* describeprocess - Fires when the process description is available.
|
||||
* Listeners receive an object with a 'raw' property holding the raw
|
||||
* DescribeProcess response, and an 'identifier' property holding the
|
||||
* process identifier of the described process.
|
||||
*/
|
||||
events: null,
|
||||
|
||||
/**
|
||||
* Constructor: OpenLayers.WPSClient
|
||||
*
|
||||
@@ -67,18 +89,22 @@ OpenLayers.WPSClient = OpenLayers.Class({
|
||||
*/
|
||||
initialize: function(options) {
|
||||
OpenLayers.Util.extend(this, options);
|
||||
this.events = new OpenLayers.Events(this);
|
||||
this.servers = {};
|
||||
for (var s in options.servers) {
|
||||
this.servers[s] = typeof options.servers[s] == 'string' ? {
|
||||
url: options.servers[s],
|
||||
version: '1.0.0',
|
||||
describeProcessResponse: {}
|
||||
version: this.version,
|
||||
processDescription: {}
|
||||
} : options.servers[s];
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* APIMethod: execute
|
||||
* Shortcut to execute a process with a single function call. This is
|
||||
* equivalent to using <getProcess> and then calling execute on the
|
||||
* process.
|
||||
*
|
||||
* Parameters:
|
||||
* options - {Object} Options for the execute operation.
|
||||
@@ -92,12 +118,14 @@ OpenLayers.WPSClient = OpenLayers.Class({
|
||||
* For spatial data inputs, the value of an input is usually an
|
||||
* <OpenLayers.Geometry>, an <OpenLayers.Feature.Vector> or an array of
|
||||
* geometries or features.
|
||||
* output - {String} The identifier of an output to parse. Optional. If not
|
||||
* provided, the first output will be parsed.
|
||||
* success - {Function} Callback to call when the process is complete.
|
||||
* This function is called with an outputs object as argument, which
|
||||
* will have a property with the name of the requested output (e.g.
|
||||
* 'result'). For processes that generate spatial output, the value
|
||||
* will either be a single <OpenLayers.Feature.Vector> or an array of
|
||||
* features.
|
||||
* will have a property with the identifier of the requested output
|
||||
* (e.g. 'result'). For processes that generate spatial output, the
|
||||
* value will either be a single <OpenLayers.Feature.Vector> or an
|
||||
* array of features.
|
||||
* scope - {Object} Optional scope for the success callback.
|
||||
*/
|
||||
execute: function(options) {
|
||||
@@ -114,18 +142,18 @@ OpenLayers.WPSClient = OpenLayers.Class({
|
||||
* Creates an <OpenLayers.WPSProcess>.
|
||||
*
|
||||
* Parameters:
|
||||
* server - {String} Local identifier from the servers that this instance
|
||||
* serverID - {String} Local identifier from the servers that this instance
|
||||
* was constructed with.
|
||||
* identifier - {String} Process identifier known to the server.
|
||||
* processID - {String} Process identifier known to the server.
|
||||
*
|
||||
* Returns:
|
||||
* {<OpenLayers.WPSProcess>}
|
||||
*/
|
||||
getProcess: function(server, identifier) {
|
||||
getProcess: function(serverID, processID) {
|
||||
var process = new OpenLayers.WPSProcess({
|
||||
client: this,
|
||||
server: server,
|
||||
identifier: identifier
|
||||
server: serverID,
|
||||
identifier: processID
|
||||
});
|
||||
if (!this.lazy) {
|
||||
process.describe();
|
||||
@@ -133,6 +161,54 @@ OpenLayers.WPSClient = OpenLayers.Class({
|
||||
return process;
|
||||
},
|
||||
|
||||
/**
|
||||
* Method: describeProcess
|
||||
*
|
||||
* Parameters:
|
||||
* serverID - {String} Identifier of the server
|
||||
* processID - {String} Identifier of the requested process
|
||||
* callback - {Function} Callback to call when the description is available
|
||||
* scope - {Object} Optional execution scope for the callback function
|
||||
*/
|
||||
describeProcess: function(serverID, processID, callback, scope) {
|
||||
var server = this.servers[serverID];
|
||||
if (!server.processDescription[processID]) {
|
||||
if (!(processID in server.processDescription)) {
|
||||
// set to null so we know a describeFeature request is pending
|
||||
server.processDescription[processID] = null;
|
||||
OpenLayers.Request.GET({
|
||||
url: server.url,
|
||||
params: {
|
||||
SERVICE: 'WPS',
|
||||
VERSION: server.version,
|
||||
REQUEST: 'DescribeProcess',
|
||||
IDENTIFIER: processID
|
||||
},
|
||||
success: function(response) {
|
||||
server.processDescription[processID] = response.responseText;
|
||||
this.events.triggerEvent('describeprocess', {
|
||||
identifier: processID,
|
||||
raw: response.responseText
|
||||
});
|
||||
},
|
||||
scope: this
|
||||
});
|
||||
} else {
|
||||
// pending request
|
||||
this.events.register('describeprocess', this, function describe(evt) {
|
||||
if (evt.identifier === processID) {
|
||||
this.events.unregister('describeprocess', this, describe);
|
||||
callback.call(scope, evt);
|
||||
}
|
||||
});
|
||||
}
|
||||
} else {
|
||||
window.setTimeout(function() {
|
||||
callback.call(scope, server.processDescription[processID]);
|
||||
}, 0);
|
||||
}
|
||||
},
|
||||
|
||||
CLASS_NAME: 'OpenLayers.WPSClient'
|
||||
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user