| 1 | .. _api-zoo-format-wps: |
|---|
| 2 | |
|---|
| 3 | ZOO.Format.WPS |
|---|
| 4 | ============== |
|---|
| 5 | |
|---|
| 6 | Read/Write WPS. |
|---|
| 7 | |
|---|
| 8 | Functions and Properties |
|---|
| 9 | ------------------------ |
|---|
| 10 | |
|---|
| 11 | .. list-table:: |
|---|
| 12 | :widths: 30 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:`read <read>` |
|---|
| 22 | - |
|---|
| 23 | * - :ref:`parseExecuteResponse <parseExecuteResponse>` |
|---|
| 24 | - |
|---|
| 25 | * - :ref:`parseData <parseData>` |
|---|
| 26 | - Object containing methods to analyse data response. |
|---|
| 27 | * - :ref:`parseData.complexdata <parseData.complexdata>` |
|---|
| 28 | - Given an Object representing the WPS complex data response. |
|---|
| 29 | * - :ref:`parseData.literaldata <parseData.literaldata>` |
|---|
| 30 | - Given an Object representing the WPS literal data response. |
|---|
| 31 | * - :ref:`parseData.reference <parseData.reference>` |
|---|
| 32 | - Given an Object representing the WPS reference response. |
|---|
| 33 | |
|---|
| 34 | .. _schemaLocation: |
|---|
| 35 | |
|---|
| 36 | schemaLocation |
|---|
| 37 | ``{String}`` Schema location for a particular minor version. |
|---|
| 38 | |
|---|
| 39 | .. _namespaces: |
|---|
| 40 | |
|---|
| 41 | namespaces |
|---|
| 42 | ``{Object}`` Mapping of namespace aliases to namespace URIs. |
|---|
| 43 | |
|---|
| 44 | .. _read: |
|---|
| 45 | |
|---|
| 46 | read |
|---|
| 47 | :: |
|---|
| 48 | |
|---|
| 49 | read:function(data) |
|---|
| 50 | |
|---|
| 51 | *Parameters* |
|---|
| 52 | |
|---|
| 53 | ``data {String}`` A WPS xml document |
|---|
| 54 | |
|---|
| 55 | *Returns* |
|---|
| 56 | |
|---|
| 57 | ``{Object}`` Execute response. |
|---|
| 58 | |
|---|
| 59 | .. _parseExecuteResponse: |
|---|
| 60 | |
|---|
| 61 | parseExecuteResponse |
|---|
| 62 | :: |
|---|
| 63 | |
|---|
| 64 | parseExecuteResponse: function(node) |
|---|
| 65 | |
|---|
| 66 | *Parameters* |
|---|
| 67 | |
|---|
| 68 | ``node {E4XElement}`` A WPS ExecuteResponse document |
|---|
| 69 | |
|---|
| 70 | *Returns* |
|---|
| 71 | |
|---|
| 72 | ``{Object}`` Execute response. |
|---|
| 73 | |
|---|
| 74 | .. _parseData: |
|---|
| 75 | |
|---|
| 76 | parseData |
|---|
| 77 | Object containing methods to analyse data response. |
|---|
| 78 | |
|---|
| 79 | .. _parseData.complexdata: |
|---|
| 80 | |
|---|
| 81 | parseData.complexdata |
|---|
| 82 | Given an Object representing the WPS complex data response. |
|---|
| 83 | |
|---|
| 84 | *Parameters* |
|---|
| 85 | |
|---|
| 86 | ``node {E4XElement}`` A WPS node. |
|---|
| 87 | |
|---|
| 88 | *Returns* |
|---|
| 89 | |
|---|
| 90 | ``{Object}`` A WPS complex data response. |
|---|
| 91 | |
|---|
| 92 | .. _parseData.literaldata: |
|---|
| 93 | |
|---|
| 94 | parseData.literaldata |
|---|
| 95 | Given an Object representing the WPS literal data response.\ |
|---|
| 96 | |
|---|
| 97 | *Parameters* |
|---|
| 98 | |
|---|
| 99 | ``node {E4XElement}`` A WPS node. |
|---|
| 100 | |
|---|
| 101 | *Returns* |
|---|
| 102 | |
|---|
| 103 | ``{Object}`` A WPS literal data response. |
|---|
| 104 | |
|---|
| 105 | .. _parseData.reference: |
|---|
| 106 | |
|---|
| 107 | parseData.reference |
|---|
| 108 | Given an Object representing the WPS reference response. |
|---|
| 109 | |
|---|
| 110 | *Parameters* |
|---|
| 111 | |
|---|
| 112 | ``node {E4XElement}`` A WPS node. |
|---|
| 113 | |
|---|
| 114 | *Returns* |
|---|
| 115 | |
|---|
| 116 | ``{Object}`` A WPS reference response. |
|---|
