Index: branches/PublicaMundi_David-devel/docs/api/classes.rst =================================================================== --- branches/PublicaMundi_David-devel/docs/api/classes.rst (revision 659) +++ branches/PublicaMundi_David-devel/docs/api/classes.rst (revision 659) @@ -0,0 +1,14 @@ +.. _api-classes: + +ZOO-API Classes +============= + +The following classes are available in the ZOO API: + +.. toctree:: + :maxdepth: 2 + + zoo + zoo-format-wps + zoo-process + zoo-request Index: branches/PublicaMundi_David-devel/docs/api/classes.txt =================================================================== --- branches/PublicaMundi_David-devel/docs/api/classes.txt (revision 506) +++ (revision ) @@ -1,38 +1,0 @@ -.. _api-classes: - -Classes -======= - -:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna -:Last Updated: $Date$ - -The following classes are available in the ZOO API: - -.. toctree:: - :maxdepth: 2 - - zoo - zoo-bounds - zoo-feature - zoo-format - zoo-format-geojson - zoo-format-gml - zoo-format-json - zoo-format-kml - zoo-format-wkt - zoo-format-wps - zoo-geometry - zoo-geometry-collection - zoo-geometry-curve - zoo-geometry-linearring - zoo-geometry-linestring - zoo-geometry-multilinestring - zoo-geometry-multipoint - zoo-geometry-multipolygon - zoo-geometry-point - zoo-geometry-polygon - zoo-geometry-surface - zoo-process - zoo-projection - zoo-request - zoo-string Index: branches/PublicaMundi_David-devel/docs/api/description.rst =================================================================== --- branches/PublicaMundi_David-devel/docs/api/description.rst (revision 659) +++ branches/PublicaMundi_David-devel/docs/api/description.rst (revision 659) @@ -0,0 +1,19 @@ +.. _api-what: + +What is ZOO-API ? +============== + +ZOO-API is a server-side JavaScript library designed to make the WPS Process creation and chaining +easier. It works on the server-side using the Mozilla foundation `JavaScript `__ +engine, `SpiderMonkey `__. +It uses a `Proj4js `__ adaptation for server-side reprojection. It also allows to easily +convert vector formats (such as `GML `__, `KML `__, +`GeoJSON `__, etc). The API lets you orchestrate WPS +services simply and offers the ability to add logic and controls in the WPS chaining. + + +Server-side JavaScript WPS +--------------------- + + + Index: branches/PublicaMundi_David-devel/docs/api/description.txt =================================================================== --- branches/PublicaMundi_David-devel/docs/api/description.txt (revision 506) +++ (revision ) @@ -1,43 +1,0 @@ -.. _api-description: - -Description -=========== - -ZOO API is a Javascript library designed to make the WPS Process creation and chaining -easier. It works on the server-side using the Mozilla foundation `JavaScript `__ -engine, `SpiderMonkey `__. -It uses a `Proj4js `__ adaptation for server-side reprojection. It also allows to easily -convert vector formats (such as `GML `__, `KML `__, -`GeoJSON `__, etc). The API lets you orchestrate WPS -services simply and offers the ability to add logic and controls in the WPS chaining. - -Download ZOO API ----------------- - - * `zoo-api.js `__ - * `zoo-proj4js.js `__ - -ZOO API MIT/X-11 License ------------------------- - -:: - - Copyright (c) 2011 3LIZ - - Permission is hereby granted, free of charge, to any person obtaining a copy of this - software and associated documentation files (the "Software"), to deal in the Software - without restriction, including without limitation the rights to use, copy, modify, - merge, publish, distribute, sublicense, and/or sell copies of the Software, and to - permit persons to whom the Software is furnished to do so, subject to the following - conditions: - - The above copyright notice and this permission notice shall be included in all copies - or substantial portions of the Software. - - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, - INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR - PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE - LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE - OR OTHER DEALINGS IN THE SOFTWARE. - Index: branches/PublicaMundi_David-devel/docs/api/examples.rst =================================================================== --- branches/PublicaMundi_David-devel/docs/api/examples.rst (revision 659) +++ branches/PublicaMundi_David-devel/docs/api/examples.rst (revision 659) @@ -0,0 +1,53 @@ +.. _api-examples: + +Examples +======== + +This section gathers sample scripts using :ref:`ZOO-API `, the `ZOO-Project `__ server-side JavaScript API. + +ZOO-API contains many classes and functions. You can find the description list :ref:`here `. + +ZOO.Process example +-------------------------- + +:: + + function SampleService(conf,inputs,outputs){ + var myProcess = new ZOO.Process('http://localhost/cgi-bin-new1/zoo_loader_new1.cgi','Boundary'); + var myInputs = {InputPolygon: { type: 'complex', value: '{"type":"Polygon","coordinates":[[[-106.993853,35.998758],[-107.407233,35.997524],[-107.430525,35.997726],[-107.4824,35.99878],[-108.37013,35.999472],[-109.043633,35.996652],[-109.096265,35.997817],[-109.148763,36.001751],[-109.200981,36.008442],[-109.252775,36.017871],[-109.304,36.030014],[-109.354516,36.044835],[-106.468201,35.991497],[-106.855511,35.989504],[-106.90933,35.990676],[-106.963008,35.994743],[-106.993853,35.998758]]]}', mimeType: "application/json"} }; + var myExecuteResult=myProcess.Execute(myInputs); + return {result: ZOO.SERVICE_SUCCEEDED, outputs: [ {name:"Result", value: myExecuteResult} ] }; + } + +In this really short example you can see how to create ``ZOO.Process`` class instance and +call the Execute method on such an instance. Then you'll just need to return a JavaScript +object containing the attributes result and outputs, which I'm sure you already know +what is about. The first is about the status of the process (can be ``ZOO.SERVICE_SUCEEDED``, +``ZOO.SERVICE_FAILED`` and so on), the last is obviously the resulting maps (take a +look at the maps internal data structure used by ZOO Kernel in ``service.h``). + +ZOO.UpdateStatus example +----------------------- + +:: + + function SampleLongService(conf,inputs,outputs){ + var my_i=0; + while(my_i<100){ + try{ + conf["lenv"]["status"]=my_i; + } + catch(e){ + } + ZOOUpdateStatus(conf,my_i); + SampleService(conf,inputs,outputs); + my_i+=10; + } + return SampleService(conf,inputs,outputs); + } + +You can see in this sample code how to use the ``ZOOUpdateStatus`` function to update the +current status of your running process. This information will be really helpfull when the +ZOO Kernel will run your JavaScript Service in background mode (if the user set to ``true`` +the ``storeExecuteResponse`` parameter in his request). + Index: branches/PublicaMundi_David-devel/docs/api/examples.txt =================================================================== --- branches/PublicaMundi_David-devel/docs/api/examples.txt (revision 506) +++ (revision ) @@ -1,54 +1,0 @@ -.. _api-examples: - -Examples -======== - -In this page you can find some small examples on how to use the JavaScript ZOO-API -on the server side. - -ZOO-API contains many classes and functions. You can find the description list :ref:`here `. - -ZOO.Process example of use --------------------------- - -:: - - function SampleService(conf,inputs,outputs){ - var myProcess = new ZOO.Process('http://localhost/cgi-bin-new1/zoo_loader_new1.cgi','Boundary'); - var myInputs = {InputPolygon: { type: 'complex', value: '{"type":"Polygon","coordinates":[[[-106.993853,35.998758],[-107.407233,35.997524],[-107.430525,35.997726],[-107.4824,35.99878],[-108.37013,35.999472],[-109.043633,35.996652],[-109.096265,35.997817],[-109.148763,36.001751],[-109.200981,36.008442],[-109.252775,36.017871],[-109.304,36.030014],[-109.354516,36.044835],[-106.468201,35.991497],[-106.855511,35.989504],[-106.90933,35.990676],[-106.963008,35.994743],[-106.993853,35.998758]]]}', mimeType: "application/json"} }; - var myExecuteResult=myProcess.Execute(myInputs); - return {result: ZOO.SERVICE_SUCCEEDED, outputs: [ {name:"Result", value: myExecuteResult} ] }; - } - -In this really short example you can see how to create ``ZOO.Process`` class instance and -call the Execute method on such an instance. Then you'll just need to return a JavaScript -object containing the attributes result and outputs, which I'm sure you already know -what is about. The first is about the status of the process (can be ``ZOO.SERVICE_SUCEEDED``, -``ZOO.SERVICE_FAILED`` and so on), the last is obviously the resulting maps (take a -look at the maps internal data structure used by ZOO Kernel in ``service.h``). - -ZOO.UpdateStatus ----------------- - -:: - - function SampleLongService(conf,inputs,outputs){ - var my_i=0; - while(my_i<100){ - try{ - conf["lenv"]["status"]=my_i; - } - catch(e){ - } - ZOOUpdateStatus(conf,my_i); - SampleService(conf,inputs,outputs); - my_i+=10; - } - return SampleService(conf,inputs,outputs); - } - -You can see in this sample code how to use the ``ZOOUpdateStatus`` function to update the -current status of your running process. This information will be really helpfull when the -ZOO Kernel will run your JavaScript Service in background mode (if the user set to ``true`` -the ``storeExecuteResponse`` parameter in his request). - Index: branches/PublicaMundi_David-devel/docs/api/howto.rst =================================================================== --- branches/PublicaMundi_David-devel/docs/api/howto.rst (revision 659) +++ branches/PublicaMundi_David-devel/docs/api/howto.rst (revision 659) @@ -0,0 +1,42 @@ +.. _api-howto: + +Using ZOO-API +================== + +This section will help you to get started using :ref:`ZOO-API`. + +Prerequisites +---------------------- + +ZOO-API relies on the following software: + +- :ref:`kernel_index` (`http://zoo-project.org + `__), the ZOO-Project WPS Server. +- SpiderMonkey (`https://developer.mozilla.org/en/SpiderMonkey + `__ ), the Mozilla + `JavaScript `__ engine. + + +.. warning:: + + The ZOO-Kernel :ref:`optional JavaScript support ` is required for using ZOO-API + + +Download +----------------------- + + * `zoo-api.js `__ + * `zoo-proj4js.js `__ + + + +If you did not :ref:`download ` the ZOO-Project +source code already, please proceed to a svn checkout with the +following command: + +:: + + svn checkout http://svn.zoo-project.org/svn/trunk/zoo-project/zoo-api + + + Index: branches/PublicaMundi_David-devel/docs/api/index.rst =================================================================== --- branches/PublicaMundi_David-devel/docs/api/index.rst (revision 659) +++ branches/PublicaMundi_David-devel/docs/api/index.rst (revision 659) @@ -0,0 +1,17 @@ +.. _api-index: + +ZOO-API +===================== + + +This section provides information on **ZOO-API**, the `ZOO-Project +`__ server-side JavaScript API. + +.. toctree:: + :maxdepth: 2 + + what + howto + classes + examples + Index: branches/PublicaMundi_David-devel/docs/api/index.txt =================================================================== --- branches/PublicaMundi_David-devel/docs/api/index.txt (revision 506) +++ (revision ) @@ -1,14 +1,0 @@ -.. _api: - -ZOO API Documentation -===================== - -The following sections will assist you with the ZOO API: - -.. toctree:: - :maxdepth: 2 - - description - classes - examples - Index: branches/PublicaMundi_David-devel/docs/api/what.rst =================================================================== --- branches/PublicaMundi_David-devel/docs/api/what.rst (revision 659) +++ branches/PublicaMundi_David-devel/docs/api/what.rst (revision 659) @@ -0,0 +1,16 @@ +.. _api-what: + +What is ZOO-API ? +============== + +ZOO-API is a server-side Javascript library for creating and chaining :ref:`services_index`. It lets you script on the server-side to execute WPS *Processes*, and thus to use common JavaScript controls and logic for WPS chaining. + + +Server-side JavaScript WPS +--------------------- + +ZOO-API :ref:`js-support` works on the server-side using the Mozilla foundation `JavaScript `__ +engine, `SpiderMonkey `__. +It uses a `Proj4js `__ adaptation for server-side reprojection. It also allows to easily +convert vector formats (such as `GML `__, `KML `__, +`GeoJSON `__, etc). Index: branches/PublicaMundi_David-devel/docs/api/zoo-format-wps.rst =================================================================== --- branches/PublicaMundi_David-devel/docs/api/zoo-format-wps.rst (revision 659) +++ branches/PublicaMundi_David-devel/docs/api/zoo-format-wps.rst (revision 659) @@ -0,0 +1,120 @@ +.. _api-zoo-format-wps: + +ZOO.Format.WPS +============== + +Read/Write WPS. + +Inherits from + +- :ref:`ZOO.Format ` + +Functions and Properties +------------------------ + +.. list-table:: + :widths: 30 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`schemaLocation ` + - {String} Schema location for a particular minor version. + * - :ref:`namespaces ` + - {Object} Mapping of namespace aliases to namespace URIs. + * - :ref:`read ` + - + * - :ref:`parseExecuteResponse ` + - + * - :ref:`parseData ` + - Object containing methods to analyse data response. + * - :ref:`parseData.complexdata ` + - Given an Object representing the WPS complex data response. + * - :ref:`parseData.literaldata ` + - Given an Object representing the WPS literal data response. + * - :ref:`parseData.reference ` + - Given an Object representing the WPS reference response. + +.. _schemaLocation: + +schemaLocation + ``{String}`` Schema location for a particular minor version. + +.. _namespaces: + +namespaces + ``{Object}`` Mapping of namespace aliases to namespace URIs. + +.. _read: + +read + :: + + read:function(data) + + *Parameters* + + ``data {String}`` A WPS xml document + + *Returns* + + ``{Object}`` Execute response. + +.. _parseExecuteResponse: + +parseExecuteResponse + :: + + parseExecuteResponse: function(node) + + *Parameters* + + ``node {E4XElement}`` A WPS ExecuteResponse document + + *Returns* + + ``{Object}`` Execute response. + +.. _parseData: + +parseData + Object containing methods to analyse data response. + +.. _parseData.complexdata: + +parseData.complexdata + Given an Object representing the WPS complex data response. + + *Parameters* + + ``node {E4XElement}`` A WPS node. + + *Returns* + + ``{Object}`` A WPS complex data response. + +.. _parseData.literaldata: + +parseData.literaldata + Given an Object representing the WPS literal data response.\ + + *Parameters* + + ``node {E4XElement}`` A WPS node. + + *Returns* + + ``{Object}`` A WPS literal data response. + +.. _parseData.reference: + +parseData.reference + Given an Object representing the WPS reference response. + + *Parameters* + + ``node {E4XElement}`` A WPS node. + + *Returns* + + ``{Object}`` A WPS reference response. Index: branches/PublicaMundi_David-devel/docs/api/zoo-format-wps.txt =================================================================== --- branches/PublicaMundi_David-devel/docs/api/zoo-format-wps.txt (revision 506) +++ (revision ) @@ -1,120 +1,0 @@ -.. _api-zoo-format-wps: - -ZOO.Format.WPS -============== - -Read/Write WPS. - -Inherits from - -- :ref:`ZOO.Format ` - -Functions and Properties ------------------------- - -.. list-table:: - :widths: 30 50 - :header-rows: 1 - - * - NAME - - DESCRIPTION - * - :ref:`schemaLocation ` - - {String} Schema location for a particular minor version. - * - :ref:`namespaces ` - - {Object} Mapping of namespace aliases to namespace URIs. - * - :ref:`read ` - - - * - :ref:`parseExecuteResponse ` - - - * - :ref:`parseData ` - - Object containing methods to analyse data response. - * - :ref:`parseData.complexdata ` - - Given an Object representing the WPS complex data response. - * - :ref:`parseData.literaldata ` - - Given an Object representing the WPS literal data response. - * - :ref:`parseData.reference ` - - Given an Object representing the WPS reference response. - -.. _schemaLocation: - -schemaLocation - ``{String}`` Schema location for a particular minor version. - -.. _namespaces: - -namespaces - ``{Object}`` Mapping of namespace aliases to namespace URIs. - -.. _read: - -read - :: - - read:function(data) - - *Parameters* - - ``data {String}`` A WPS xml document - - *Returns* - - ``{Object}`` Execute response. - -.. _parseExecuteResponse: - -parseExecuteResponse - :: - - parseExecuteResponse: function(node) - - *Parameters* - - ``node {E4XElement}`` A WPS ExecuteResponse document - - *Returns* - - ``{Object}`` Execute response. - -.. _parseData: - -parseData - Object containing methods to analyse data response. - -.. _parseData.complexdata: - -parseData.complexdata - Given an Object representing the WPS complex data response. - - *Parameters* - - ``node {E4XElement}`` A WPS node. - - *Returns* - - ``{Object}`` A WPS complex data response. - -.. _parseData.literaldata: - -parseData.literaldata - Given an Object representing the WPS literal data response.\ - - *Parameters* - - ``node {E4XElement}`` A WPS node. - - *Returns* - - ``{Object}`` A WPS literal data response. - -.. _parseData.reference: - -parseData.reference - Given an Object representing the WPS reference response. - - *Parameters* - - ``node {E4XElement}`` A WPS node. - - *Returns* - - ``{Object}`` A WPS reference response. Index: branches/PublicaMundi_David-devel/docs/api/zoo-process.rst =================================================================== --- branches/PublicaMundi_David-devel/docs/api/zoo-process.rst (revision 659) +++ branches/PublicaMundi_David-devel/docs/api/zoo-process.rst (revision 659) @@ -0,0 +1,149 @@ +.. _api-zoo-process: + +ZOO.Process +=========== + +Used to query OGC WPS process defined by its URL and its identifier. Useful for chaining localhost process. + +Properties and Functions +------------------------ + +.. list-table:: + :widths: 15 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`schemaLocation ` + - {String} Schema location for a particular minor version. + * - :ref:`namespaces ` + - {Object} Mapping of namespace aliases to namespace URIs. + * - :ref:`url ` + - {String} The OGC's Web PRocessing Service URL, default is http://localhost/zoo. + * - :ref:`identifier ` + - {String} Process identifier in the OGC's Web Processing Service. + * - :ref:`ZOO.Process ` + - Create a new Process + * - :ref:`Execute ` + - Query the OGC's Web PRocessing Servcie to Execute the process. + * - :ref:`buildInput ` + - Object containing methods to build WPS inputs. + * - :ref:`buildInput.complex ` + - Given an E4XElement representing the WPS complex data input. + * - :ref:`buildInput.reference ` + - Given an E4XElement representing the WPS reference input. + * - :ref:`buildInput.literal ` + - Given an E4XElement representing the WPS literal data input. + * - :ref:`buildDataInputsNode ` + - Method to build the WPS DataInputs element. + +.. _schemaLocation: + +schemaLocation + ``{String}`` Schema location for a particular minor version. + +.. _namespaces: + +namespaces + ``{Object}`` Mapping of namespace aliases to namespace URIs. + +.. _url: + +url + ``{String}`` The OGC's Web PRocessing Service URL, default is http://localhost/zoo. + +.. _identifier: + +identifier + ``{String}`` Process identifier in the OGC's Web Processing Service. + +.. _ZOO.Process: + +ZOO.Process + Create a new Process + + *Parameters* + + | ``url {String}`` The OGC's Web Processing Service URL. + | ``identifier {String}`` The process identifier in the OGC's Web Processing Service. + +.. _Execute: + +Execute + :: + + Execute: function(inputs) + + Query the OGC's Web PRocessing Servcie to Execute the process. + + *Parameters* + + ``inputs {Object}`` + + *Returns* + + ``{String}`` The OGC's Web processing Service XML response. The result needs to be interpreted. + +.. _buildInput: + +buildInput + Object containing methods to build WPS inputs. + +.. _buildInput.complex: + +buildInput.complex + Given an E4XElement representing the WPS complex data input. + + *Parameters* + + | ``identifier {String}`` the input indetifier + | ``data {Object}`` A WPS complex data input. + + *Returns* + + ``{E4XElement}`` A WPS Input node. + +.. _buildInput.reference: + +buildInput.reference + Given an E4XElement representing the WPS reference input. + + *Parameters* + + | ``identifier {String}`` the input indetifier + | ``data {Object}`` A WPS reference input. + + *Returns* + + ``{E4XElement}`` A WPS Input node. + +.. _buildInput.literal: + +buildInput.literal + Given an E4XElement representing the WPS literal data input. + + *Parameters* + + | ``identifier {String}`` the input indetifier + | ``data {Object}`` A WPS literal data input. + + *Returns* + + ``{E4XElement}`` The WPS Input node. + +.. _buildDataInputsNode: + +buildDataInputsNode + :: + + buildDataInputsNode:function(inputs) + + Method to build the WPS DataInputs element. + + *Parameters* + + ``inputs {Object}`` + + *Returns* + + ``{E4XElement}`` The WPS DataInputs node for Execute query. Index: branches/PublicaMundi_David-devel/docs/api/zoo-process.txt =================================================================== --- branches/PublicaMundi_David-devel/docs/api/zoo-process.txt (revision 506) +++ (revision ) @@ -1,149 +1,0 @@ -.. _api-zoo-process: - -ZOO.Process -=========== - -Used to query OGC WPS process defined by its URL and its identifier. Useful for chaining localhost process. - -Properties and Functions ------------------------- - -.. list-table:: - :widths: 15 50 - :header-rows: 1 - - * - NAME - - DESCRIPTION - * - :ref:`schemaLocation ` - - {String} Schema location for a particular minor version. - * - :ref:`namespaces ` - - {Object} Mapping of namespace aliases to namespace URIs. - * - :ref:`url ` - - {String} The OGC's Web PRocessing Service URL, default is http://localhost/zoo. - * - :ref:`identifier ` - - {String} Process identifier in the OGC's Web Processing Service. - * - :ref:`ZOO.Process ` - - Create a new Process - * - :ref:`Execute ` - - Query the OGC's Web PRocessing Servcie to Execute the process. - * - :ref:`buildInput ` - - Object containing methods to build WPS inputs. - * - :ref:`buildInput.complex ` - - Given an E4XElement representing the WPS complex data input. - * - :ref:`buildInput.reference ` - - Given an E4XElement representing the WPS reference input. - * - :ref:`buildInput.literal ` - - Given an E4XElement representing the WPS literal data input. - * - :ref:`buildDataInputsNode ` - - Method to build the WPS DataInputs element. - -.. _schemaLocation: - -schemaLocation - ``{String}`` Schema location for a particular minor version. - -.. _namespaces: - -namespaces - ``{Object}`` Mapping of namespace aliases to namespace URIs. - -.. _url: - -url - ``{String}`` The OGC's Web PRocessing Service URL, default is http://localhost/zoo. - -.. _identifier: - -identifier - ``{String}`` Process identifier in the OGC's Web Processing Service. - -.. _ZOO.Process: - -ZOO.Process - Create a new Process - - *Parameters* - - | ``url {String}`` The OGC's Web Processing Service URL. - | ``identifier {String}`` The process identifier in the OGC's Web Processing Service. - -.. _Execute: - -Execute - :: - - Execute: function(inputs) - - Query the OGC's Web PRocessing Servcie to Execute the process. - - *Parameters* - - ``inputs {Object}`` - - *Returns* - - ``{String}`` The OGC's Web processing Service XML response. The result needs to be interpreted. - -.. _buildInput: - -buildInput - Object containing methods to build WPS inputs. - -.. _buildInput.complex: - -buildInput.complex - Given an E4XElement representing the WPS complex data input. - - *Parameters* - - | ``identifier {String}`` the input indetifier - | ``data {Object}`` A WPS complex data input. - - *Returns* - - ``{E4XElement}`` A WPS Input node. - -.. _buildInput.reference: - -buildInput.reference - Given an E4XElement representing the WPS reference input. - - *Parameters* - - | ``identifier {String}`` the input indetifier - | ``data {Object}`` A WPS reference input. - - *Returns* - - ``{E4XElement}`` A WPS Input node. - -.. _buildInput.literal: - -buildInput.literal - Given an E4XElement representing the WPS literal data input. - - *Parameters* - - | ``identifier {String}`` the input indetifier - | ``data {Object}`` A WPS literal data input. - - *Returns* - - ``{E4XElement}`` The WPS Input node. - -.. _buildDataInputsNode: - -buildDataInputsNode - :: - - buildDataInputsNode:function(inputs) - - Method to build the WPS DataInputs element. - - *Parameters* - - ``inputs {Object}`` - - *Returns* - - ``{E4XElement}`` The WPS DataInputs node for Execute query. Index: branches/PublicaMundi_David-devel/docs/api/zoo-request.rst =================================================================== --- branches/PublicaMundi_David-devel/docs/api/zoo-request.rst (revision 659) +++ branches/PublicaMundi_David-devel/docs/api/zoo-request.rst (revision 659) @@ -0,0 +1,49 @@ +.. _api-zoo-request: + +ZOO.Request +=========== + +Contains convenience methods for working with ZOORequest which replace XMLHttpRequest. + +Functions +--------- + +.. list-table:: + :widths: 30 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`GET ` + - Send an HTTP GET request. + * - :ref:`POST ` + - Send an HTTP POST request. + +.. _GET: + +GET + Send an HTTP GET request. + + *Parameters* + + | ``url {String}`` The URL to request. + | ``params {Object}`` Params to add to the url + + *Returns* + + ``{String}`` Request result. + +.. _POST: + +POST + Send an HTTP POST request. + + *Parameters* + + | ``url {String}`` The URL to request. + | ``body {String}`` The request's body to send. + | ``headers {Object}`` A key-value object of headers to push to the request's head + + *Returns* + + ``{String}`` Request result. Index: branches/PublicaMundi_David-devel/docs/api/zoo-request.txt =================================================================== --- branches/PublicaMundi_David-devel/docs/api/zoo-request.txt (revision 506) +++ (revision ) @@ -1,49 +1,0 @@ -.. _api-zoo-request: - -ZOO.Request -=========== - -Contains convenience methods for working with ZOORequest which replace XMLHttpRequest. - -Functions ---------- - -.. list-table:: - :widths: 30 50 - :header-rows: 1 - - * - NAME - - DESCRIPTION - * - :ref:`GET ` - - Send an HTTP GET request. - * - :ref:`POST ` - - Send an HTTP POST request. - -.. _GET: - -GET - Send an HTTP GET request. - - *Parameters* - - | ``url {String}`` The URL to request. - | ``params {Object}`` Params to add to the url - - *Returns* - - ``{String}`` Request result. - -.. _POST: - -POST - Send an HTTP POST request. - - *Parameters* - - | ``url {String}`` The URL to request. - | ``body {String}`` The request's body to send. - | ``headers {Object}`` A key-value object of headers to push to the request's head - - *Returns* - - ``{String}`` Request result. Index: branches/PublicaMundi_David-devel/docs/api/zoo.rst =================================================================== --- branches/PublicaMundi_David-devel/docs/api/zoo.rst (revision 659) +++ branches/PublicaMundi_David-devel/docs/api/zoo.rst (revision 659) @@ -0,0 +1,188 @@ +.. _api-zoo: + +ZOO +=== + +The following constants and functions are available for the ZOO class: + +Constants +--------- + +.. list-table:: + :widths: 30 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`SERVICE_ACCEPTED ` + - {Integer} used for + * - :ref:`SERVICE_STARTED ` + - {Integer} used for + * - :ref:`SERVICE_PAUSED ` + - {Integer} used for + * - :ref:`SERVICE_SUCCEEDED ` + - {Integer} used for + * - :ref:`SERVICE_FAILED ` + - {Integer} used for + +Functions +--------- + +.. list-table:: + :widths: 12 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`removeItem ` + - Remove an object from an array. + * - :ref:`indexOf ` + - + * - :ref:`extend ` + - Copy all properties of a source object to a destination object. + * - :ref:`rad ` + - + * - :ref:`distVincenty ` + - Given two objects representing points with geographic coordinates, + this calculates the distance between those points on the surface of an + ellipsoid. + * - :ref:`Class ` + - Method used to create ZOO classes. + * - :ref:`UpdateStatus ` + - Method used to update the status of the process + +**Constants** + +.. _service_accepted: + +SERVICE_ACCEPTED + ``{Integer}`` used for + +.. _service_started: + +SERVICE_STARTED + ``{Integer}`` used for + +.. _service_paused: + +SERVICE_PAUSED + ``{Integer}`` used for + +.. _service_succeeded: + +SERVICE_SUCCEEDED + ``{Integer}`` used for + +.. _service_failed: + +SERVICE_FAILED + ``{Integer}`` used for + +**Functions** + +.. _removeItem: + +removeItem + :: + + removeItem: function(array,item) + + Remove an object from an array. Iterates through the array to find the item, then removes it. + + *Parameters* + + | ``array {Array}`` + | ``item {Object}`` + + *Returns* + + ``{Array}`` A reference to the array + +.. _indexOf: + +indexOf + :: + + indexOf: function(array,obj) + + *Parameters* + + | ``array {Array}`` + | ``obj {Object}`` + + *Returns* + + ``{Integer}`` The index at, which the first object was found in the array. If not found, returns -1. + +.. _extend: + +extend + :: + + extend: function(destination,source) + + Copy all properties of a source object to a destination object. Modifies the passed in destination object. + Any properties on the source object that are set to undefined will not be (re)set on the destination object. + + *Parameters* + + | ``destination {Object}`` The object that will be modified + | ``source {Object}`` The object with properties to be set on the destination + + *Returns* + + ``{Object}`` The destination object. + +.. _rad: + +rad + :: + + rad: function(x) + + *Parameters* + + | ``x {Float}`` + + *Returns* + + ``{Float}`` + +.. _distVincenty: + +distVincenty + :: + + distVincenty: function(p1,p2) + + Given two objects representing points with geographic coordinates, this calculates the distance between + those points on the surface of an ellipsoid. + + *Parameters:* + + | ``p1`` :ref:`{ZOO.Geometry.Point} ` (or any object with both .x, .y properties) + | ``p2`` :ref:`{ZOO.Geometry.Point} ` (or any object with both .x, .y properties) + +.. _Class: + +Class + :: + + Class: function() + + Method used to create ZOO classes. Includes support for multiple inheritance. + +.. _UpdateStatus: + +UpdateStatus + :: + + UpdateStatus: function(env,value) + + Method used to update the status of the process + + *Parameters* + + | ``env {Object}`` The environment object + | ``value {Float}`` The status value between 0 to 100 + Index: branches/PublicaMundi_David-devel/docs/api/zoo.txt =================================================================== --- branches/PublicaMundi_David-devel/docs/api/zoo.txt (revision 506) +++ (revision ) @@ -1,188 +1,0 @@ -.. _api-zoo: - -ZOO -=== - -The following constants and functions are available for the ZOO class: - -Constants ---------- - -.. list-table:: - :widths: 30 50 - :header-rows: 1 - - * - NAME - - DESCRIPTION - * - :ref:`SERVICE_ACCEPTED ` - - {Integer} used for - * - :ref:`SERVICE_STARTED ` - - {Integer} used for - * - :ref:`SERVICE_PAUSED ` - - {Integer} used for - * - :ref:`SERVICE_SUCCEEDED ` - - {Integer} used for - * - :ref:`SERVICE_FAILED ` - - {Integer} used for - -Functions ---------- - -.. list-table:: - :widths: 12 50 - :header-rows: 1 - - * - NAME - - DESCRIPTION - * - :ref:`removeItem ` - - Remove an object from an array. - * - :ref:`indexOf ` - - - * - :ref:`extend ` - - Copy all properties of a source object to a destination object. - * - :ref:`rad ` - - - * - :ref:`distVincenty ` - - Given two objects representing points with geographic coordinates, - this calculates the distance between those points on the surface of an - ellipsoid. - * - :ref:`Class ` - - Method used to create ZOO classes. - * - :ref:`UpdateStatus ` - - Method used to update the status of the process - -**Constants** - -.. _service_accepted: - -SERVICE_ACCEPTED - ``{Integer}`` used for - -.. _service_started: - -SERVICE_STARTED - ``{Integer}`` used for - -.. _service_paused: - -SERVICE_PAUSED - ``{Integer}`` used for - -.. _service_succeeded: - -SERVICE_SUCCEEDED - ``{Integer}`` used for - -.. _service_failed: - -SERVICE_FAILED - ``{Integer}`` used for - -**Functions** - -.. _removeItem: - -removeItem - :: - - removeItem: function(array,item) - - Remove an object from an array. Iterates through the array to find the item, then removes it. - - *Parameters* - - | ``array {Array}`` - | ``item {Object}`` - - *Returns* - - ``{Array}`` A reference to the array - -.. _indexOf: - -indexOf - :: - - indexOf: function(array,obj) - - *Parameters* - - | ``array {Array}`` - | ``obj {Object}`` - - *Returns* - - ``{Integer}`` The index at, which the first object was found in the array. If not found, returns -1. - -.. _extend: - -extend - :: - - extend: function(destination,source) - - Copy all properties of a source object to a destination object. Modifies the passed in destination object. - Any properties on the source object that are set to undefined will not be (re)set on the destination object. - - *Parameters* - - | ``destination {Object}`` The object that will be modified - | ``source {Object}`` The object with properties to be set on the destination - - *Returns* - - ``{Object}`` The destination object. - -.. _rad: - -rad - :: - - rad: function(x) - - *Parameters* - - | ``x {Float}`` - - *Returns* - - ``{Float}`` - -.. _distVincenty: - -distVincenty - :: - - distVincenty: function(p1,p2) - - Given two objects representing points with geographic coordinates, this calculates the distance between - those points on the surface of an ellipsoid. - - *Parameters:* - - | ``p1`` :ref:`{ZOO.Geometry.Point} ` (or any object with both .x, .y properties) - | ``p2`` :ref:`{ZOO.Geometry.Point} ` (or any object with both .x, .y properties) - -.. _Class: - -Class - :: - - Class: function() - - Method used to create ZOO classes. Includes support for multiple inheritance. - -.. _UpdateStatus: - -UpdateStatus - :: - - UpdateStatus: function(env,value) - - Method used to update the status of the process - - *Parameters* - - | ``env {Object}`` The environment object - | ``value {Float}`` The status value between 0 to 100 -