source: branches/PublicaMundi_David-devel/docs/_build/html/client/what.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: 16.9 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>What is ZOO-Client ? &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-Client" href="index.html"/>
36        <link rel="next" title="Using ZOO-Client" href="howto.html"/>
37        <link rel="prev" title="ZOO-Client" href="index.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"><a class="reference internal" href="../api/index.html">ZOO-API</a><ul>
111<li class="toctree-l2"><a class="reference internal" href="../api/what.html">What is ZOO-API ?</a></li>
112<li class="toctree-l2"><a class="reference internal" href="../api/howto.html">Using ZOO-API</a></li>
113<li class="toctree-l2"><a class="reference internal" href="../api/classes.html">ZOO-API Classes</a></li>
114<li class="toctree-l2"><a class="reference internal" href="../api/examples.html">Examples</a></li>
115</ul>
116</li>
117<li class="toctree-l1 current"><a class="reference internal" href="index.html">ZOO-Client</a><ul class="current">
118<li class="toctree-l2 current"><a class="current reference internal" href="">What is ZOO-Client ?</a></li>
119<li class="toctree-l2"><a class="reference internal" href="howto.html">Using ZOO-Client</a></li>
120<li class="toctree-l2"><a class="reference internal" href="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-Client</a> &#8725; &#160;</li>
154     
155    <li>What is ZOO-Client ?</li>
156      <li class="wy-breadcrumbs-aside">
157       
158          <a href="../_sources/client/what.txt" rel="nofollow"> View page source</a>
159       
160      </li>
161  </ul>
162  <hr/>
163</div>
164          <div role="main" class="document">
165           
166  <div class="section" id="what-is-zoo-client">
167<span id="client-what"></span><h1>What is ZOO-Client ?<a class="headerlink" href="#what-is-zoo-client" title="Permalink to this headline"></a></h1>
168<p>ZOO-Client is a client-side JavaScript API which provides simple methods
169for interacting with <a class="reference external" href="http://www.opengeospatial.org/standards/wps/">WPS</a> server from web
170applications. It is helpful for sending requests to any WPS compliant
171server (such as <a class="reference internal" href="../kernel/index.html#kernel-index"><span>ZOO-Kernel</span></a>) and to parse the output responses
172using simple JavaScript.</p>
173<div class="section" id="javascript">
174<h2>JavaScript<a class="headerlink" href="#javascript" title="Permalink to this headline"></a></h2>
175<p>ZOO-Client relies on modern JavaScript libraries and can be seamlessly
176integrated in new or existing web platforms or applications. ZOO-Client works by expanding the tags available in WPS specific
177templates using values provided by a JavaScript hash or object. It
178allows to build valid WPS requests and to send them to a WPS server. It
179also provides functions to easily parse and reuse the output XML
180responses. Read the <a class="reference internal" href="howto.html#client-howto"><span>next section</span></a> to get started.</p>
181</div>
182<div class="section" id="templates">
183<h2>Templates<a class="headerlink" href="#templates" title="Permalink to this headline"></a></h2>
184<p>ZOO-Client uses logic-less <a class="reference external" href="http://mustache.github.io/">Mustache</a>
185templates for creating well-formed WPS requests. Templates are called
186<em>logic-less</em> because they do not contain any <em>if</em> statements, <em>else</em>
187clauses, or <em>for</em> loops, but only <strong>tags</strong>. Some tags are dynamically replaced by a
188value or a series of values.</p>
189<div class="section" id="getcapabilities">
190<h3>GetCapabilities<a class="headerlink" href="#getcapabilities" title="Permalink to this headline"></a></h3>
191<p><em>GetCapabilities</em> requests are created using the following template:</p>
192<div class="highlight-python"><div class="highlight"><pre>&lt;wps:GetCapabilities xmlns:ows=&quot;http://www.opengis.net/ows/1.1&quot; xmlns:wps=&quot;http://www.opengis.net/wps/1.0.0&quot; xmlns:xlink=&quot;http://www.w3.org/1999/xlink&quot; xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; xsi:schemaLocation=&quot;http://www.opengis.net/wps/1.0.0 ../wpsGetCapabilities_request.xsd&quot; language=&quot;{{language}}&quot; service=&quot;WPS&quot;&gt;
193 &lt;wps:AcceptVersions&gt;
194     &lt;ows:Version&gt;1.0.0&lt;/ows:Version&gt;
195 &lt;/wps:AcceptVersions&gt;
196&lt;/wps:GetCapabilities&gt;
197</pre></div>
198</div>
199</div>
200<div class="section" id="describeprocess">
201<h3>DescribeProcess<a class="headerlink" href="#describeprocess" title="Permalink to this headline"></a></h3>
202<p><em>DescribeProcess</em> requests are created using the following template:</p>
203<div class="highlight-python"><div class="highlight"><pre>&lt;DescribeProcess xmlns=&quot;http://www.opengis.net/wps/1.0.0&quot; xmlns:ows=&quot;http://www.opengis.net/ows/1.1&quot; xmlns:xlink=&quot;http://www.w3.org/1999/xlink&quot; xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; xsi:schemaLocation=&quot;http://www.opengis.net/wps/1.0.0 ../wpsDescribeProcess_request.xsd&quot; service=&quot;WPS&quot; version=&quot;1.0.0&quot; language=&quot;{{language}}&quot;&gt;
204{{#identifiers}}
205&lt;ows:Identifier&gt;{{.}}&lt;/ows:Identifier&gt;
206{{/identifiers}}
207&lt;/DescribeProcess&gt;
208</pre></div>
209</div>
210</div>
211<div class="section" id="execute">
212<h3>Execute<a class="headerlink" href="#execute" title="Permalink to this headline"></a></h3>
213<p><em>Execute</em> requests are created using a more complex template, as shown bellow:</p>
214<div class="highlight-python"><div class="highlight"><pre>&lt;wps:Execute service=&quot;WPS&quot; version=&quot;1.0.0&quot; xmlns:wps=&quot;http://www.opengis.net/wps/1.0.0&quot; xmlns:ows=&quot;http://www.opengis.net/ows/1.1&quot; xmlns:xlink=&quot;http://www.w3.org/1999/xlink&quot; xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; xsi:schemaLocation=&quot;http://www.opengis.net/wps/1.0.0../wpsExecute_request.xsd&quot; language=&quot;{{language}}&quot;&gt;
215&lt;!-- template-version: 0.21 --&gt;
216     &lt;ows:Identifier&gt;{{Identifier}}&lt;/ows:Identifier&gt;
217     &lt;wps:DataInputs&gt;
218     {{#DataInputs}}
219     {{#is_literal}}
220             &lt;wps:Input&gt;
221                     &lt;ows:Identifier&gt;{{identifier}}&lt;/ows:Identifier&gt;
222                     &lt;wps:Data&gt;
223                             &lt;wps:LiteralData{{#dataType}} dataType=&quot;{{dataType}}&quot;{{/dataType}}&gt;{{value}}&lt;/wps:LiteralData&gt;
224                     &lt;/wps:Data&gt;
225             &lt;/wps:Input&gt;
226             {{/is_literal}}
227             {{#is_bbox}}
228             &lt;wps:Input&gt;
229                     &lt;ows:Identifier&gt;{{identifier}}&lt;/ows:Identifier&gt;
230                     &lt;wps:Data&gt;
231                             &lt;wps:BoundingBoxData ows:crs=&quot;{{crs}}&quot; ows:dimensions=&quot;{{dimension}}&quot;&gt;
232         &lt;ows:LowerCorner&gt;{{lowerCorner}}&lt;/ows:LowerCorner&gt;
233         &lt;ows:UpperCorner&gt;{{upperCorner}}&lt;/ows:UpperCorner&gt;
234      &lt;/wps:BoundingBoxData&gt;
235                     &lt;/wps:Data&gt;
236             &lt;/wps:Input&gt;
237             {{/is_bbox}}
238             {{#is_complex}}
239             {{#is_reference}}
240             {{#is_get}}
241             &lt;wps:Input&gt;
242                     &lt;ows:Identifier&gt;{{identifier}}&lt;/ows:Identifier&gt;
243                     &lt;wps:Reference xlink:href=&quot;{{href}}&quot;{{#schema}} schema=&quot;{{shema}}&quot;{{/schema}}{{#mimeType}} mimeType=&quot;{{mimeType}}&quot;{{/mimeType}}{{#encoding}} encoding=&quot;{{encoding}}&quot;{{/encoding}}/&gt;
244             &lt;/wps:Input&gt;
245             {{/is_get}}
246             {{#is_post}}
247             &lt;wps:Input&gt;
248                     &lt;ows:Identifier&gt;{{identifier}}&lt;/ows:Identifier&gt;
249                     &lt;wps:Reference xlink:href=&quot;{{href}}&quot; method=&quot;{{method}}&quot;&gt;
250                     {{#headers}}
251                       &lt;wps:Header key=&quot;{{key}}&quot; value=&quot;{{value}}&quot; /&gt;
252                       {{/headers}}
253                       &lt;wps:Body&gt;{{{value}}}&lt;/wps:Body&gt;
254                     &lt;/wps:Reference&gt;
255             &lt;/wps:Input&gt;
256             {{/is_post}}
257             {{/is_reference}}
258             {{^is_reference}}
259             &lt;wps:Input&gt;
260   &lt;ows:Identifier&gt;{{identifier}}&lt;/ows:Identifier&gt;
261   &lt;wps:Data&gt;
262     &lt;wps:ComplexData{{#schema}} schema=&quot;{{shema}}&quot;{{/schema}}{{#mimeType}} mimeType=&quot;{{mimeType}}&quot;{{/mimeType}}{{#encoding}} encoding=&quot;{{encoding}}&quot;{{/encoding}}&gt;{{#is_XML}}
263      {{{value}}}{{/is_XML}}{{^is_XML}}&lt;![CDATA[{{{value}}}]]&gt;{{/is_XML}}
264     &lt;/wps:ComplexData&gt;
265   &lt;/wps:Data&gt;
266 &lt;/wps:Input&gt;
267 {{/is_reference}}
268 {{/is_complex}}
269 {{/DataInputs}}
270     &lt;/wps:DataInputs&gt;
271     &lt;wps:ResponseForm&gt;
272     {{#RawDataOutput}}
273     {{#DataOutputs}}
274 &lt;wps:RawDataOutput mimeType=&quot;{{mimeType}}&quot;&gt;
275   &lt;ows:Identifier&gt;{{identifier}}&lt;/ows:Identifier&gt;
276 &lt;/wps:RawDataOutput&gt;
277 {{/DataOutputs}}
278 {{/RawDataOutput}}
279 {{^RawDataOutput}}
280 &lt;wps:ResponseDocument{{#storeExecuteResponse}} storeExecuteResponse=&quot;{{storeExecuteResponse}}&quot;{{/storeExecuteResponse}}{{#lineage}} lineage=&quot;{{lineage}}&quot;{{/lineage}}{{#status}} status=&quot;{{status}}&quot;{{/status}}&gt;
281 {{#DataOutputs}}
282 {{#is_literal}}
283   &lt;wps:Output{{#dataType}} dataType=&quot;{{dataType}}&quot;{{/dataType}}{{#uom}} uom=&quot;{{uom}}&quot;{{/uom}}&gt;
284     &lt;ows:Identifier&gt;{{identifier}}&lt;/ows:Identifier&gt;
285   &lt;/wps:Output&gt;
286   {{/is_literal}}
287   {{^is_literal}}
288   &lt;wps:Output{{#asReference}} asReference=&quot;{{asReference}}&quot;{{/asReference}}{{#schema}} schema=&quot;{{schema}}&quot;{{/schema}}{{#mimeType}} mimeType=&quot;{{mimeType}}&quot;{{/mimeType}}{{#encoding}} encoding=&quot;{{encoding}}&quot;{{/encoding}}&gt;
289     &lt;ows:Identifier&gt;{{identifier}}&lt;/ows:Identifier&gt;
290   &lt;/wps:Output&gt;
291   {{/is_literal}}
292   {{/DataOutputs}}
293 &lt;/wps:ResponseDocument&gt;
294 {{/RawDataOutput}}
295 &lt;/wps:ResponseForm&gt;
296 &lt;/wps:Execute&gt;
297</pre></div>
298</div>
299</div>
300</div>
301</div>
302
303
304          </div>
305          <footer>
306 
307    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
308     
309        <a href="howto.html" class="btn btn-neutral float-right" title="Using ZOO-Client">Next <span class="fa fa-arrow-circle-right"></span></a>
310     
311     
312        <a href="index.html" class="btn btn-neutral" title="ZOO-Client"><span class="fa fa-arrow-circle-left"></span> Previous</a>
313     
314    </div>
315 
316
317  <hr/>
318  <div class="pfoot">
319  <div role="contentinfo">
320    <p>
321        &copy; Copyright 2009-2015, ZOO-Project team.
322    </p>
323  </div>
324  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>.
325</div>
326</footer>
327
328        </div>
329      </div>
330
331    </section>
332
333  </div>
334 
335
336
337 
338
339    <script type="text/javascript">
340        var DOCUMENTATION_OPTIONS = {
341            URL_ROOT:'../',
342            VERSION:'1.4a0',
343            COLLAPSE_INDEX:false,
344            FILE_SUFFIX:'.html',
345            HAS_SOURCE:  true
346        };
347    </script>
348      <script type="text/javascript" src="../_static/jquery.js"></script>
349      <script type="text/javascript" src="../_static/underscore.js"></script>
350      <script type="text/javascript" src="../_static/doctools.js"></script>
351
352 
353
354 
355 
356    <script type="text/javascript" src="../_static/js/theme.js"></script>
357 
358
359 
360 
361  <script type="text/javascript">
362      jQuery(function () {
363          SphinxRtdTheme.StickyNav.enable();
364      });
365  </script>
366   
367
368</body>
369</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