zoo-process.txt @ 400

Last change on this file since 400 was 348, checked in by neteler, 13 years ago
set correctly svn propset
Property svn:eol-style set to `native` Property svn:keywords set to `HeadURL Date Author Id Rev` Property svn:mime-type set to `text/plain`
File size: 3.6 KB

Line
1	.. _api-zoo-process:
2
3	ZOO.Process
4	===========
5
6	Used to query OGC WPS process defined by its URL and its identifier. Usefull for chaining localhost process.
7
8	Properties and Functions
9	------------------------
10
11	.. list-table::
12	:widths: 15 50
13	:header-rows: 1
14
15	* - NAME
16	- DESCRIPTION
17	* - :ref:`schemaLocation <schemaLocation>`
18	- {String} Schema location for a particular minor version.
19	* - :ref:`namespaces <namespaces>`
20	- {Object} Mapping of namespace aliases to namespace URIs.
21	* - :ref:`url <url>`
22	- {String} The OGC's Web PRocessing Service URL, default is http://localhost/zoo.
23	* - :ref:`identifier <identifier>`
24	- {String} Process identifier in the OGC's Web Processing Service.
25	* - :ref:`ZOO.Process <ZOO.Process>`
26	- Create a new Process
27	* - :ref:`Execute <Execute>`
28	- Query the OGC's Web PRocessing Servcie to Execute the process.
29	* - :ref:`buildInput <buildInput>`
30	- Object containing methods to build WPS inputs.
31	* - :ref:`buildInput.complex <buildInput.complex>`
32	- Given an E4XElement representing the WPS complex data input.
33	* - :ref:`buildInput.reference <buildInput.reference>`
34	- Given an E4XElement representing the WPS reference input.
35	* - :ref:`buildInput.literal <buildInput.literal>`
36	- Given an E4XElement representing the WPS literal data input.
37	* - :ref:`buildDataInputsNode <buildDataInputsNode>`
38	- Method to build the WPS DataInputs element.
39
40	.. _schemaLocation:
41
42	schemaLocation
43	``{String}`` Schema location for a particular minor version.
44
45	.. _namespaces:
46
47	namespaces
48	``{Object}`` Mapping of namespace aliases to namespace URIs.
49
50	.. _url:
51
52	url
53	``{String}`` The OGC's Web PRocessing Service URL, default is http://localhost/zoo.
54
55	.. _identifier:
56
57	identifier
58	``{String}`` Process identifier in the OGC's Web Processing Service.
59
60	.. _ZOO.Process:
61
62	ZOO.Process
63	Create a new Process
64
65	Parameters
66
67	\| ``url {String}`` The OGC's Web Processing Service URL.
68	\| ``identifier {String}`` The process identifier in the OGC's Web Processing Service.
69
70	.. _Execute:
71
72	Execute
73	::
74
75	Execute: function(inputs)
76
77	Query the OGC's Web PRocessing Servcie to Execute the process.
78
79	Parameters
80
81	``inputs {Object}``
82
83	Returns
84
85	``{String}`` The OGC's Web processing Service XML response. The result needs to be interpreted.
86
87	.. _buildInput:
88
89	buildInput
90	Object containing methods to build WPS inputs.
91
92	.. _buildInput.complex:
93
94	buildInput.complex
95	Given an E4XElement representing the WPS complex data input.
96
97	Parameters
98
99	\| ``identifier {String}`` the input indetifier
100	\| ``data {Object}`` A WPS complex data input.
101
102	Returns
103
104	``{E4XElement}`` A WPS Input node.
105
106	.. _buildInput.reference:
107
108	buildInput.reference
109	Given an E4XElement representing the WPS reference input.
110
111	Parameters
112
113	\| ``identifier {String}`` the input indetifier
114	\| ``data {Object}`` A WPS reference input.
115
116	Returns
117
118	``{E4XElement}`` A WPS Input node.
119
120	.. _buildInput.literal:
121
122	buildInput.literal
123	Given an E4XElement representing the WPS literal data input.
124
125	Parameters
126
127	\| ``identifier {String}`` the input indetifier
128	\| ``data {Object}`` A WPS literal data input.
129
130	Returns
131
132	``{E4XElement}`` The WPS Input node.
133
134	.. _buildDataInputsNode:
135
136	buildDataInputsNode
137	::
138
139	buildDataInputsNode:function(inputs)
140
141	Method to build the WPS DataInputs element.
142
143	Parameters
144
145	``inputs {Object}``
146
147	Returns
148
149	``{E4XElement}`` The WPS DataInputs node for Execute query.