source: branches/PublicaMundi_David-devel/docs/_build/html/api/zoo-format-wps.html @ 659

Last change on this file since 659 was 659, checked in by nbozon, 9 years ago

Massive update of zoo docs

File size: 13.7 KB
Line 
1
2
3<!DOCTYPE html>
4<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
5<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
6<head>
7  <meta charset="utf-8">
8  <meta name="viewport" content="width=device-width, initial-scale=1.0">
9 
10  <title>ZOO.Format.WPS &mdash; ZOO-Project 1.4a0 documentation</title>
11 
12  <link href="http://fonts.googleapis.com/css?family=Days+One" rel="stylesheet" type="text/css">
13 
14 
15
16 
17
18 
19 
20   
21      <link rel="search" type="application/opensearchdescription+xml" title="Search within ZOO-Project 1.4a0 documentation" href="../_static/opensearch.xml"/>
22   
23
24 
25
26 
27 
28    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
29 
30
31 
32
33 
34    <link rel="top" title="ZOO-Project 1.4a0 documentation" href="../index.html"/>
35        <link rel="up" title="ZOO-API Classes" href="classes.html"/>
36        <link rel="next" title="ZOO.Process" href="zoo-process.html"/>
37        <link rel="prev" title="ZOO" href="zoo.html"/> 
38
39 
40  <script src="_static/js/modernizr.min.js"></script>
41
42</head>
43
44<body class="wy-body-for-nav" role="document">
45
46  <div class="wy-grid-for-nav">
47
48   
49    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
50      <div class="wy-side-nav-search">
51       
52
53       
54          <a class="shrink" href="http://zoo-project.org"><img src="http://zoo-project.org/img/zoo-sun-logo.png" class="img-responsive sun" style="display: inline;"> ZOO</a>
55       
56
57       
58        </a>
59
60       
61<div role="search">
62  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
63    <input type="text" name="q" placeholder="Search docs" />
64    <input type="hidden" name="check_keywords" value="yes" />
65    <input type="hidden" name="area" value="default" />
66  </form>
67</div>
68
69       
70      </div>
71
72      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
73       
74         
75         
76              <ul class="current">
77<li class="toctree-l1"><a class="reference internal" href="../intro.html">Introduction</a><ul>
78<li class="toctree-l2"><a class="reference internal" href="../intro.html#what-is-zoo-project">What is ZOO-Project ?</a></li>
79<li class="toctree-l2"><a class="reference internal" href="../intro.html#zoo-project-components">ZOO-Project components</a></li>
80<li class="toctree-l2"><a class="reference internal" href="../intro.html#open-source">Open Source</a></li>
81</ul>
82</li>
83<li class="toctree-l1"><a class="reference internal" href="../install/index.html">ZOO-Project installation</a><ul>
84<li class="toctree-l2"><a class="reference internal" href="../install/install-prerequisites.html">Prerequisites</a></li>
85<li class="toctree-l2"><a class="reference internal" href="../install/install-download.html">Download</a></li>
86<li class="toctree-l2"><a class="reference internal" href="../install/install-confoptions.html">Configure options</a></li>
87<li class="toctree-l2"><a class="reference internal" href="../install/install-installation.html">Installation on Unix/Linux</a></li>
88<li class="toctree-l2"><a class="reference internal" href="../install/install-onwindows.html">Installation on Windows ™</a></li>
89<li class="toctree-l2"><a class="reference internal" href="../install/install-onmacos.html">Installation on MacOSX ™</a></li>
90</ul>
91</li>
92<li class="toctree-l1"><a class="reference internal" href="../kernel/index.html">ZOO-Kernel</a><ul>
93<li class="toctree-l2"><a class="reference internal" href="../kernel/what.html">What is ZOO-Kernel ?</a></li>
94<li class="toctree-l2"><a class="reference internal" href="../kernel/configuration.html">ZOO-Kernel configuration</a></li>
95<li class="toctree-l2"><a class="reference internal" href="../kernel/mapserver.html">Optional MapServer support</a></li>
96<li class="toctree-l2"><a class="reference internal" href="../kernel/orfeotoolbox.html">Optional Orfeo Toolbox support</a></li>
97<li class="toctree-l2"><a class="reference internal" href="../kernel/sagagis.html">Optional SAGA GIS support</a></li>
98</ul>
99</li>
100<li class="toctree-l1"><a class="reference internal" href="../services/index.html">ZOO-Services</a><ul>
101<li class="toctree-l2"><a class="reference internal" href="../services/what.html">What are ZOO-Services ?</a></li>
102<li class="toctree-l2"><a class="reference internal" href="../services/zcfg-reference.html">ZOO-Service configuration file</a></li>
103<li class="toctree-l2"><a class="reference internal" href="../services/process-profiles.html">Process profiles registry</a></li>
104<li class="toctree-l2"><a class="reference internal" href="../services/howtos.html">Create your own ZOO-Services</a></li>
105<li class="toctree-l2"><a class="reference internal" href="../services/status.html">ZOO Status Service</a></li>
106<li class="toctree-l2"><a class="reference internal" href="../services/debug.html">Debugging ZOO Services</a></li>
107<li class="toctree-l2"><a class="reference internal" href="../services/zoo-services.html">Available ZOO-Services</a></li>
108</ul>
109</li>
110<li class="toctree-l1 current"><a class="reference internal" href="index.html">ZOO-API</a><ul class="current">
111<li class="toctree-l2"><a class="reference internal" href="what.html">What is ZOO-API ?</a></li>
112<li class="toctree-l2"><a class="reference internal" href="howto.html">Using ZOO-API</a></li>
113<li class="toctree-l2 current"><a class="reference internal" href="classes.html">ZOO-API Classes</a></li>
114<li class="toctree-l2"><a class="reference internal" href="examples.html">Examples</a></li>
115</ul>
116</li>
117<li class="toctree-l1"><a class="reference internal" href="../client/index.html">ZOO-Client</a><ul>
118<li class="toctree-l2"><a class="reference internal" href="../client/what.html">What is ZOO-Client ?</a></li>
119<li class="toctree-l2"><a class="reference internal" href="../client/howto.html">Using ZOO-Client</a></li>
120<li class="toctree-l2"><a class="reference internal" href="../client/example.html">Example application</a></li>
121</ul>
122</li>
123<li class="toctree-l1"><a class="reference internal" href="../contribute/index.html">Contributor Guide</a><ul>
124<li class="toctree-l2"><a class="reference internal" href="../contribute/howto.html">How to contribute ?</a></li>
125<li class="toctree-l2"><a class="reference internal" href="../contribute/code.html">Contribute code</a></li>
126</ul>
127</li>
128</ul>
129
130         
131       
132      </div>
133      &nbsp;
134    </nav>
135
136    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
137
138     
139      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
140        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
141        <a href="../contents.html">ZOO-Project</a>
142      </nav>
143
144
145     
146      <div class="wy-nav-content">
147        <div class="rst-content">
148          <div role="navigation" aria-label="breadcrumbs navigation">
149  <ul class="wy-breadcrumbs">
150
151    <li><a href="../contents.html"> Docs</a> &#8725; &#160;</li>
152     
153          <li><a href="index.html">ZOO-API</a> &#8725; &#160;</li>
154     
155          <li><a href="classes.html">ZOO-API Classes</a> &#8725; &#160;</li>
156     
157    <li>ZOO.Format.WPS</li>
158      <li class="wy-breadcrumbs-aside">
159       
160          <a href="../_sources/api/zoo-format-wps.txt" rel="nofollow"> View page source</a>
161       
162      </li>
163  </ul>
164  <hr/>
165</div>
166          <div role="main" class="document">
167           
168  <div class="section" id="zoo-format-wps">
169<span id="api-zoo-format-wps"></span><h1>ZOO.Format.WPS<a class="headerlink" href="#zoo-format-wps" title="Permalink to this headline"></a></h1>
170<p>Read/Write WPS.</p>
171<p>Inherits from</p>
172<ul class="simple">
173<li><span class="xref std std-ref">ZOO.Format</span></li>
174</ul>
175<div class="section" id="functions-and-properties">
176<h2>Functions and Properties<a class="headerlink" href="#functions-and-properties" title="Permalink to this headline"></a></h2>
177<table border="1" class="docutils">
178<colgroup>
179<col width="38%" />
180<col width="63%" />
181</colgroup>
182<thead valign="bottom">
183<tr class="row-odd"><th class="head">NAME</th>
184<th class="head">DESCRIPTION</th>
185</tr>
186</thead>
187<tbody valign="top">
188<tr class="row-even"><td><a class="reference internal" href="zoo-process.html#schemalocation"><span>schemaLocation</span></a></td>
189<td>{String} Schema location for a particular minor version.</td>
190</tr>
191<tr class="row-odd"><td><a class="reference internal" href="zoo-process.html#namespaces"><span>namespaces</span></a></td>
192<td>{Object} Mapping of namespace aliases to namespace URIs.</td>
193</tr>
194<tr class="row-even"><td><a class="reference internal" href="#read"><span>read</span></a></td>
195<td>&nbsp;</td>
196</tr>
197<tr class="row-odd"><td><a class="reference internal" href="#parseexecuteresponse"><span>parseExecuteResponse</span></a></td>
198<td>&nbsp;</td>
199</tr>
200<tr class="row-even"><td><a class="reference internal" href="#parsedata"><span>parseData</span></a></td>
201<td>Object containing methods to analyse data response.</td>
202</tr>
203<tr class="row-odd"><td><a class="reference internal" href="#parsedata-complexdata"><span>parseData.complexdata</span></a></td>
204<td>Given an Object representing the WPS complex data response.</td>
205</tr>
206<tr class="row-even"><td><a class="reference internal" href="#parsedata-literaldata"><span>parseData.literaldata</span></a></td>
207<td>Given an Object representing the WPS literal data response.</td>
208</tr>
209<tr class="row-odd"><td><a class="reference internal" href="#parsedata-reference"><span>parseData.reference</span></a></td>
210<td>Given an Object representing the WPS reference response.</td>
211</tr>
212</tbody>
213</table>
214<dl class="docutils" id="schemalocation">
215<dt>schemaLocation</dt>
216<dd><code class="docutils literal"><span class="pre">{String}</span></code> Schema location for a particular minor version.</dd>
217</dl>
218<dl class="docutils" id="namespaces">
219<dt>namespaces</dt>
220<dd><code class="docutils literal"><span class="pre">{Object}</span></code> Mapping of namespace aliases to namespace URIs.</dd>
221</dl>
222<dl class="docutils" id="read">
223<dt>read</dt>
224<dd><div class="first highlight-python"><div class="highlight"><pre>read:function(data)
225</pre></div>
226</div>
227<p><em>Parameters</em></p>
228<p><code class="docutils literal"><span class="pre">data</span> <span class="pre">{String}</span></code> A WPS xml document</p>
229<p><em>Returns</em></p>
230<p class="last"><code class="docutils literal"><span class="pre">{Object}</span></code> Execute response.</p>
231</dd>
232</dl>
233<dl class="docutils" id="parseexecuteresponse">
234<dt>parseExecuteResponse</dt>
235<dd><div class="first highlight-python"><div class="highlight"><pre>parseExecuteResponse: function(node)
236</pre></div>
237</div>
238<p><em>Parameters</em></p>
239<p><code class="docutils literal"><span class="pre">node</span> <span class="pre">{E4XElement}</span></code> A WPS ExecuteResponse document</p>
240<p><em>Returns</em></p>
241<p class="last"><code class="docutils literal"><span class="pre">{Object}</span></code> Execute response.</p>
242</dd>
243</dl>
244<dl class="docutils" id="parsedata">
245<dt>parseData</dt>
246<dd>Object containing methods to analyse data response.</dd>
247</dl>
248<dl class="docutils" id="parsedata-complexdata">
249<dt>parseData.complexdata</dt>
250<dd><p class="first">Given an Object representing the WPS complex data response.</p>
251<p><em>Parameters</em></p>
252<p><code class="docutils literal"><span class="pre">node</span> <span class="pre">{E4XElement}</span></code> A WPS node.</p>
253<p><em>Returns</em></p>
254<p class="last"><code class="docutils literal"><span class="pre">{Object}</span></code> A WPS complex data response.</p>
255</dd>
256</dl>
257<dl class="docutils" id="parsedata-literaldata">
258<dt>parseData.literaldata</dt>
259<dd><p class="first">Given an Object representing the WPS literal data response.</p>
260<p><em>Parameters</em></p>
261<p><code class="docutils literal"><span class="pre">node</span> <span class="pre">{E4XElement}</span></code> A WPS node.</p>
262<p><em>Returns</em></p>
263<p class="last"><code class="docutils literal"><span class="pre">{Object}</span></code> A WPS literal data response.</p>
264</dd>
265</dl>
266<dl class="docutils" id="parsedata-reference">
267<dt>parseData.reference</dt>
268<dd><p class="first">Given an Object representing the WPS reference response.</p>
269<p><em>Parameters</em></p>
270<p><code class="docutils literal"><span class="pre">node</span> <span class="pre">{E4XElement}</span></code> A WPS node.</p>
271<p><em>Returns</em></p>
272<p class="last"><code class="docutils literal"><span class="pre">{Object}</span></code> A WPS reference response.</p>
273</dd>
274</dl>
275</div>
276</div>
277
278
279          </div>
280          <footer>
281 
282    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
283     
284        <a href="zoo-process.html" class="btn btn-neutral float-right" title="ZOO.Process">Next <span class="fa fa-arrow-circle-right"></span></a>
285     
286     
287        <a href="zoo.html" class="btn btn-neutral" title="ZOO"><span class="fa fa-arrow-circle-left"></span> Previous</a>
288     
289    </div>
290 
291
292  <hr/>
293  <div class="pfoot">
294  <div role="contentinfo">
295    <p>
296        &copy; Copyright 2009-2015, ZOO-Project team.
297    </p>
298  </div>
299  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> inspired by <a href="https://readthedocs.org">Read the Docs</a>.
300</div>
301</footer>
302
303        </div>
304      </div>
305
306    </section>
307
308  </div>
309 
310
311
312 
313
314    <script type="text/javascript">
315        var DOCUMENTATION_OPTIONS = {
316            URL_ROOT:'../',
317            VERSION:'1.4a0',
318            COLLAPSE_INDEX:false,
319            FILE_SUFFIX:'.html',
320            HAS_SOURCE:  true
321        };
322    </script>
323      <script type="text/javascript" src="../_static/jquery.js"></script>
324      <script type="text/javascript" src="../_static/underscore.js"></script>
325      <script type="text/javascript" src="../_static/doctools.js"></script>
326
327 
328
329 
330 
331    <script type="text/javascript" src="../_static/js/theme.js"></script>
332 
333
334 
335 
336  <script type="text/javascript">
337      jQuery(function () {
338          SphinxRtdTheme.StickyNav.enable();
339      });
340  </script>
341   
342
343</body>
344</html>
Note: See TracBrowser for help on using the repository browser.

Search

Context Navigation

ZOO Sponsors

http://www.zoo-project.org/trac/chrome/site/img/geolabs-logo.pnghttp://www.zoo-project.org/trac/chrome/site/img/neogeo-logo.png http://www.zoo-project.org/trac/chrome/site/img/apptech-logo.png http://www.zoo-project.org/trac/chrome/site/img/3liz-logo.png http://www.zoo-project.org/trac/chrome/site/img/gateway-logo.png

Become a sponsor !

Knowledge partners

http://www.zoo-project.org/trac/chrome/site/img/ocu-logo.png http://www.zoo-project.org/trac/chrome/site/img/gucas-logo.png http://www.zoo-project.org/trac/chrome/site/img/polimi-logo.png http://www.zoo-project.org/trac/chrome/site/img/fem-logo.png http://www.zoo-project.org/trac/chrome/site/img/supsi-logo.png http://www.zoo-project.org/trac/chrome/site/img/cumtb-logo.png

Become a knowledge partner

Related links

http://zoo-project.org/img/ogclogo.png http://zoo-project.org/img/osgeologo.png