Index: /trunk/zoo-project/zoo-client/lib/js/wps-client/wps-payload.js =================================================================== --- /trunk/zoo-project/zoo-client/lib/js/wps-client/wps-payload.js (revision 516) +++ /trunk/zoo-project/zoo-client/lib/js/wps-client/wps-payload.js (revision 517) @@ -1,3 +1,2 @@ -// Filename: wps-payload.js /** * Author : Samuel Souk aloun @@ -23,18 +22,60 @@ * THE SOFTWARE. */ - + define([ - 'jquery', 'utils', - 'hgn!tpl/payload_GetCapabilities', - 'hgn!tpl/payload_DescribeProcess', - 'hgn!tpl/payload_Execute', + 'jquery', 'utils' +], function($, utils) { + /** + * The wpsPayload module is using the + * [Hogan.js]{@link http://twitter.github.io/hogan.js/} templating engine to + * generate XML requests to be sent to a WPS Server. + * In the ZOO-Client API, the Hogan.js templates have to be compiled before + * you can use them from you application. Please refer to the ZOO-Client + * installation documentation for more informations. + * + * @module wpsPayload + * @requires payloads + * @requires jquery + * @requires utils + */ -], function($, utils, tplGetCapabilities, tplDescribeProcess, tplExecute) { - - // return { + + /** @exports wpsPayload */ - // + /** + * The getPayload function uses the mustache + * templates and the parameters provided to generate a valid WPS XML + * request. + * + * @static + * @param {Object} params - The object representing the request. + * @returns {string} - The corresponding XML request + * @example + * // GetCapabilities + * var request_params = { + * request: 'GetCapabilities', + * language: 'en-US' + * }; + * console.wpsPayload.getPayload(request_params)); + * @example + * // DescribeProcess with Identifier value set to "all". + * var request_params = { + * request: 'DescribeProcess', + * identifier: ["all"] + * }; + * console.log(wpsPayload.getPayload(request_params)); + * @example + * // + * var request_params = { + * request: 'Execute', + * Identifier: "Buffer", + * DataInputs: [{"identifier":"InputPolygon","href":"http://features.org/toto.xml","mimeType":"text/xml"}], + * DataOutputs: [{"identifier":"Result","mimeType":"application/json"}], + * language: 'en-US' + * }; + * console.log(wpsPayload.getPayload(request_params)); + */ getPayload: function(params) { if (params.request == 'DescribeProcess') { @@ -48,13 +89,49 @@ } }, + + /** + * The getPayload_GetCapabilities function is used to generate a valid + * WPS XML GetCapabilities request using the + * [payload_GetCapabilities.mustache]{@link http://zoo-project.org/trac/browser/trunk/zoo-project/zoo-client/lib/tpl/payload_GetCapabilities.mustache} + * template. + * + * @static + * @param {Object} params - The object representing the request. + * @returns {string} - The corresponding XML request + * @example + * // log the XML request in console + * var request_params = { + * language: 'en-US' + * }; + * console.log(wpsPayload.getPayload_GetCapabilities(request_params)); + */ + getPayload_GetCapabilities: function(params) { + return templates["payload_GetCapabilities"].render(params); + }, - // + /** + * The getPayload_DescribeProcess function is used to generate a valid + * WPS XML DescribeProcess request using the + * [payload_DescribeProcess.mustache]{@link http://zoo-project.org/trac/browser/trunk/zoo-project/zoo-client/lib/tpl/payload_DescribeProcess.mustache} + * template. + * + * @static + * @param {Object} params - The object representing the request. + * @returns {string} - The corresponding XML request + * @example + * // log the XML request in console + * var request_params = { + * Identifier: ["Buffer","Centroid"], + * language: 'en-US' + * }; + * console.log(wpsPayload.getPayload_DescribeProcess(request_params)); + */ getPayload_DescribeProcess: function(params) { if (params.Identifier) { if ($.isArray(params.Identifier)) { - return tplDescribeProcess({identifiers: params.Identifier}); + return templates["payload_DescribeProcess"].render({identifiers: params.Identifier,language: params.language}); } else { - return tplDescribeProcess({identifiers: [params.Identifier]}); + return templates["payload_DescribeProcess"].render({identifiers: [params.Identifier],language: params.language}); } } @@ -62,38 +139,80 @@ }, - // - getPayload_GetCapabilities: function(params) { - return tplGetCapabilities(); - }, - - // + /** + * The getPayload_Execute function is used to generate a valid WPS XML + * Excute request using the + * [payload_Execute.mustache]{@link http://zoo-project.org/trac/browser/trunk/zoo-project/zoo-client/lib/tpl/payload_Execute.mustache} + * template. + * + * @static + * @param {Object} params - The object representing the request. + * @returns {string} - The corresponding XML request + * @example + * // log the XML request in console + * var request_params = { + * Identifier: "Buffer", + * DataInputs: [{"identifier":"InputPolygon","href":"http://features.org/toto.xml","mimeType":"text/xml"}], + * DataOutputs: [{"identifier":"Result","mimeType":"application/json"}], + * language: 'en-US' + * }; + * console.log(wpsPayload.getPayload_Execute(request_params)); + */ getPayload_Execute: function(params) { - //console.log(params); - //console.log("==== INPUTS ===="); if (params.DataInputs) { - //console.log(params.DataInputs); - for (var i = 0; i < params.DataInputs.length; i++) { - + /** + * Define inputs type depending on presence of mimeType, + * dataType and crs or dimension for ComplexData, + * LiteralData and BoundingBox data respectively + */ + var hasType=false; + var lp={"data":"literal","mime":"complex"}; + for(j in lp){ + if (params.DataInputs[i][j+"Type"]) { + params.DataInputs[i]['is_'+lp[j]] = true; + params.DataInputs[i].type=lp[j]; + if(j=="mime"){ + params.DataInputs[i].is_XML=(params.DataInputs[i][j+"Type"]=="text/xml"); + if(!params.DataInputs[i].is_XML){ + var tmp=params.DataInputs[i][j+"Type"].split(";"); + params.DataInputs[i].is_XML=(tmp[0]=="text/xml"); + } + } + hasType=true; + } + } + if(!hasType){ + if (params.DataInputs[i]["type"]=="bbox" || + params.DataInputs[i]["dimension"] || + params.DataInputs[i]["crs"]){ + + params.DataInputs[i]['is_bbox'] = true; + params.DataInputs[i].type='bbox'; + hasType=true; + + } + if(!hasType){ + params.DataInputs[i]['is_literal'] = true; + params.DataInputs[i].type = "literal"; + } + } /* - * Set some default values and flags. - */ - if (params.DataInputs[i].type == 'bbox') { - if (!params.DataInputs[i].crs) { - params.DataInputs[i].crs = "EPSG:4326"; + * Set some default values and flags. + */ + if (params.DataInputs[i].type == 'bbox') { + if (!params.DataInputs[i].crs) { + params.DataInputs[i].crs = "EPSG:4326"; } - if (!params.DataInputs[i].dimension) { - params.DataInputs[i].dimension = 2; + params.DataInputs[i].dimension = 2; } } - - if (params.DataInputs[i].type) { - params.DataInputs[i]['is_'+params.DataInputs[i].type] = true; - } // Complex data from payload callback. + console.log("CALLBACK"); + console.log(params.DataInputs[i]); if (params.DataInputs[i].complexPayload_callback) { - params.DataInputs[i].complexPayload = window[params.DataInputs[i].complexPayload_callback]; + params.DataInputs[i].value = window[params.DataInputs[i].complexPayload_callback]; + console.log(params.DataInputs[i].value); } @@ -116,5 +235,4 @@ //console.log("==== OUTPUTS ===="); if (params.DataOutputs || params.storeExecuteResponse || params.status || params.lineage) { - console.log(params.DataOutputs); for (var i = 0; i < params.DataOutputs.length; i++) { @@ -127,5 +245,5 @@ } - return tplExecute(params); + return templates["payload_Execute"].render(params); }, @@ -134,5 +252,2 @@ }); - - - Index: /trunk/zoo-project/zoo-client/lib/js/wps-client/zoo.js =================================================================== --- /trunk/zoo-project/zoo-client/lib/js/wps-client/zoo.js (revision 516) +++ /trunk/zoo-project/zoo-client/lib/js/wps-client/zoo.js (revision 517) @@ -1,3 +1,2 @@ -// Filename: zoo-process.js /** * Author : Samuel Souk aloun @@ -28,10 +27,23 @@ ], function(X2JS, qs, wpsPayload, utils) { + /** + * The ZooProcess Class + * @constructs ZooProcess + * @param {Object} params Parameters + * @example + * var myZooObject = new ZooProcess({ + * url: "http://localhost/cgi-bin/zoo_loader.cgi", + * delay: 2500 + * }); + */ var ZooProcess = function(params) { /** - * Private - */ - + * Object configuring the xml2json use. + * + * @access private + * @memberof ZooProcess# + * @var _x2js {x2js} + */ var _x2js = new X2JS({ arrayAccessFormPaths: [ @@ -44,18 +56,107 @@ }); - - /** - * Public - */ - + + /** + * @access public + * @memberof ZooProcess# + * @var debug {Boolean} true if verbose messages should be displayed on the console + * @default false + */ + this.debug = false; + /** + * @access public + * @memberof ZooProcess# + * @var url {String} The WPS Server URL + */ this.url = params.url; - + /** + * @access public + * @memberof ZooProcess# + * @var language {String} The language to be used to request the WPS Server + * @default "en-US" + */ + this.language = params.language?params.language:"en-US"; + /** + * @access public + * @memberof ZooProcess# + * @var statusLocation {Object} An object to store the statusLocation + * URLs when running request including both the storeExecuteResponse and + * the status parameters set to true. + */ this.statusLocation = {}; + /** + * @access public + * @memberof ZooProcess# + * @var launched {Object} An object to store the running asynchrone services. + */ this.launched = {}; + /** + * @access public + * @memberof ZooProcess# + * @var terminated {Object} An object to store the finished services. + */ this.terminated = {}; + /** + * @access public + * @memberof ZooProcess# + * @var percent {Object} An object to store the percentage of completude of services. + */ this.percent = {}; - this.delay = params.delay || 2000, - - // + /** + * @access public + * @memberof ZooProcess# + * @var delay {Integer} The time (in milliseconds) between each polling requests. + * @default 2000 + */ + this.delay = params.delay || 2000; + + /** + * The getCapabilities method run the GetCapabilities request by calling {@link ZooProcess#request}. + * + * @method getCapabilities + * @memberof ZooProcess# + * @param {Object} params The parameter for the request and callback functions to call on success or + * on failure. + * @example + * // Log the array of available processes in console + * myZooObject.getCapabilities({ + * type: 'POST', + * success: function(data){ + * console.log(data["Capabilities"]["ProcessOfferings"]["Process"]); + * } + * }); + */ + this.getCapabilities = function(params) { + var closure = this; + + if (!params.hasOwnProperty('type')) { + params.type = 'GET'; + } + + var zoo_request_params = { + request: 'GetCapabilities', + service: 'WPS', + version: '1.0.0', + } + + this.request(zoo_request_params, params.success, params.error, params.type); + }; + + /** + * The describeProcess method run the DescribeProcess request by calling {@link ZooProcess#request}. + * + * @method describeProcess + * @memberof ZooProcess# + * @param {Object} params + * @example + * // Log x2js representation of all available services in console + * myZooObject.describeProcess({ + * type: 'POST', + * identifier: "all" + * success: function(data){ + * console.log(data); + * } + * }); + */ this.describeProcess = function(params) { var closure = this; @@ -67,5 +168,4 @@ var zoo_request_params = { Identifier: params.identifier, - metapath: params.metapath ? params.metapath : '', request: 'DescribeProcess', service: 'WPS', @@ -76,29 +176,18 @@ }; - // - this.getCapabilities = function(params) { - var closure = this; - - if (!params.hasOwnProperty('type')) { - params.type = 'GET'; - } - - // http://zoo-server/cgi-bin/zoo_loader.cgi?ServiceProvider=&metapath=&Service=WPS&Request=GetCapabilities&Version=1.0.0 - var zoo_request_params = { - ServiceProvider: '', - metapath: params.metapath ? params.metapath : '', - request: 'GetCapabilities', - service: 'WPS', - version: '1.0.0', - } - - this.request(zoo_request_params, params.success, params.error, params.type); - }; - - // - this.execute = function(params) { - var closure = this; - console.log("======== Execute "+params.identifier); - console.log(params); + /** + * The convertParams method convert parameters for Execute requests + * + * @method convertParams + * @memberof ZooProcess# + * @param {Object} params The original object + * @returns {Object} The converted object + */ + this.convertParams = function(params){ + var closure = this; + if(closure.debug){ + console.log("======== Execute "+params.identifier); + console.log(params); + } if (!params.hasOwnProperty('type')) { @@ -113,7 +202,4 @@ DataInputs: params.dataInputs ? params.dataInputs : '', DataOutputs: params.dataOutputs ? params.dataOutputs : '', - - //storeExecuteResponse: params.storeExecuteResponse ? 'true' : 'false', - //status: params.status ? 'true' : 'false', } @@ -131,26 +217,45 @@ zoo_request_params.lineage = 'true'; } - - - this.request(zoo_request_params, params.success, params.error, params.type); - }; - - - // - this.request = function(params, onSuccess, onError, type) { + return zoo_request_params; + }; + + /** + * The buildRequest method is building the object expected by + * [jQuery.ajax]{@link http://api.jquery.com/jquery.ajax/}. + * In case of GET request, it will use {@link ZooProcess#getQueryString}. + * In case of POST request, it will use {@link module:wpsPayload} getPayload. + * + * @method buildRequest + * @memberof ZooProcess# + * @param {Object} params the request parameters + * @param {String} type the request method ("GET" or "POST") + * @returns {Object} The expected object to give as input for the + * [jQuery.ajax]{@link http://api.jquery.com/jquery.ajax/} function. + */ + this.buildRequest = function(params,type){ var closure = this; - console.log('======== REQUEST type='+type); - console.log(params); - + if(closure.debug){ + console.log('======== REQUEST method='+type); + console.log(params); + } var url = this.url; var payload; var headers; - + if(params.hasOwnProperty('DataOutputs')) + for(var i=0;i + {{#identifiers}} {{.}} Index: /trunk/zoo-project/zoo-client/lib/tpl/payload_Execute.mustache =================================================================== --- /trunk/zoo-project/zoo-client/lib/tpl/payload_Execute.mustache (revision 516) +++ /trunk/zoo-project/zoo-client/lib/tpl/payload_Execute.mustache (revision 517) @@ -1,4 +1,4 @@ +../wpsExecute_request.xsd" language="{{language}}"> {{Identifier}} @@ -29,5 +29,5 @@ {{identifier}} - + {{/is_get}} @@ -36,8 +36,8 @@ {{identifier}} -{{#mimeType}} - -{{/mimeType}} - {{{complexPayload}}} +{{#headers}} + +{{/headers}} + {{{value}}} @@ -48,6 +48,6 @@ {{identifier}} - - {{{complexPayload}}} + {{#is_XML}} + {{{value}}}{{/is_XML}}{{^is_XML}}{{/is_XML}} @@ -59,7 +59,9 @@ {{#RawDataOutput}} +{{#DataOutputs}} {{identifier}} +{{/DataOutputs}} {{/RawDataOutput}} {{^RawDataOutput}} @@ -67,5 +69,5 @@ {{#DataOutputs}} {{#is_literal}} - + {{identifier}} Index: /trunk/zoo-project/zoo-client/lib/tpl/payload_GetCapabilities.mustache =================================================================== --- /trunk/zoo-project/zoo-client/lib/tpl/payload_GetCapabilities.mustache (revision 516) +++ /trunk/zoo-project/zoo-client/lib/tpl/payload_GetCapabilities.mustache (revision 517) @@ -1,3 +1,3 @@ - + 1.0.0