1
=== modified file 'doc/cxx/examples/context.cpp'
2
--- doc/cxx/examples/context.cpp	2013-09-17 21:12:49 +0000
3
+++ doc/cxx/examples/context.cpp	2013-10-17 02:02:41 +0000
4
@@ -375,7 +375,7 @@
5
375
      std::unique_ptr<std::stringstream> lQuery(new std::stringstream());
375
      std::unique_ptr<std::stringstream> lQuery(new std::stringstream());
6
376
      (*lQuery)
376
      (*lQuery)
7
377
        << "module namespace mymodule = 'http://zorba.io/mymodule';" << std::endl
377
        << "module namespace mymodule = 'http://zorba.io/mymodule';" << std::endl
9
378
        << "import module namespace dml = 'http://www.zorba-xquery.com/modules/store/static/collections/dml';" << std::endl
378
        << "import module namespace dml = 'http://zorba.io/modules/store/static/collections/dml';" << std::endl
10
379
        << "declare namespace an = 'http://zorba.io/annotations';" << std::endl
379
        << "declare namespace an = 'http://zorba.io/annotations';" << std::endl
11
380
        << "declare variable $mymodule:var  := 'myvar';" << std::endl
380
        << "declare variable $mymodule:var  := 'myvar';" << std::endl
12
381
        << "declare collection mymodule:collection;" << std::endl
381
        << "declare collection mymodule:collection;" << std::endl
13
@@ -409,7 +409,7 @@
14
409
    Zorba_CompilerHints_t hints;
409
    Zorba_CompilerHints_t hints;
15
410
    std::stringstream lProlog;
410
    std::stringstream lProlog;
16
411
    lProlog << "import module namespace mymodule = 'http://zorba.io/mymodule';" << std::endl
411
    lProlog << "import module namespace mymodule = 'http://zorba.io/mymodule';" << std::endl
18
412
            << "import module namespace ddl = 'http://www.zorba-xquery.com/modules/store/static/collections/ddl';"
412
            << "import module namespace ddl = 'http://zorba.io/modules/store/static/collections/ddl';"
19
413
            << std::endl
413
            << std::endl
20
414
            << "declare function local:collections() { " << std::endl
414
            << "declare function local:collections() { " << std::endl
21
415
            << "  ddl:declared-collections()" << std::endl
415
            << "  ddl:declared-collections()" << std::endl
22
416
416
23
=== modified file 'doc/zorba/data_lifecycle.dox'
24
--- doc/zorba/data_lifecycle.dox	2013-09-17 03:48:02 +0000
25
+++ doc/zorba/data_lifecycle.dox	2013-10-17 02:02:41 +0000
26
@@ -39,32 +39,32 @@
27
39
  <tr>
39
  <tr>
28
40
    <td>Collections</td>
40
    <td>Collections</td>
29
41
    <td>DDL</td>
41
    <td>DDL</td>
31
42
    <td><a href="../modules/www.zorba-xquery.com_modules_store_static_collections_ddl.html">http://www.zorba-xquery.com/modules/store/static/collections/ddl</a></td>
42
    <td><a href="../modules/zorba.io_modules_store_static_collections_ddl.html">http://zorba.io/modules/store/static/collections/ddl</a></td>
32
43
  </tr>
43
  </tr>
33
44
  <tr>
44
  <tr>
34
45
    <td>Collections</td>
45
    <td>Collections</td>
35
46
    <td>DML</td>
46
    <td>DML</td>
57
47
    <td><a href="../modules/www.zorba-xquery.com_modules_store_static_collections_dml.html">http://www.zorba-xquery.com/modules/store/static/collections/dml</a></td>
47
    <td><a href="../modules/zorba.io_modules_store_static_collections_dml.html">http://zorba.io/modules/store/static/collections/dml</a></td>
58
48
  </tr>
48
  </tr>
59
49
  <tr>
49
  <tr>
60
50
    <td>Indexes</td>
50
    <td>Indexes</td>
61
51
    <td>DDL</td>
51
    <td>DDL</td>
62
52
    <td><a href="../modules/www.zorba-xquery.com_modules_store_static_indexes_ddl.html">http://www.zorba-xquery.com/modules/store/static/indexes/ddl</a></td>
52
    <td><a href="../modules/zorba.io_modules_store_static_indexes_ddl.html">http://zorba.io/modules/store/static/indexes/ddl</a></td>
63
53
  </tr>
53
  </tr>
64
54
  <tr>
54
  <tr>
65
55
    <td>Indexes</td>
55
    <td>Indexes</td>
66
56
    <td>DML</td>
56
    <td>DML</td>
67
57
    <td><a href="../modules/www.zorba-xquery.com_modules_store_static_indexes_dml.html">http://www.zorba-xquery.com/modules/store/static/indexes/dml</a></td>
57
    <td><a href="../modules/zorba.io_modules_store_static_indexes_dml.html">http://zorba.io/modules/store/static/indexes/dml</a></td>
68
58
  </tr>
58
  </tr>
69
59
  <tr>
59
  <tr>
70
60
    <td>Integrity Constraints</td>
60
    <td>Integrity Constraints</td>
71
61
    <td>DDL</td>
61
    <td>DDL</td>
72
62
    <td><a href="../modules/www.zorba-xquery.com_modules_store_static_integrity_constraints_ddl.html">http://www.zorba-xquery.com/modules/store/static/integrity_constraints/ddl</a></td>
62
    <td><a href="../modules/zorba.io_modules_store_static_integrity_constraints_ddl.html">http://zorba.io/modules/store/static/integrity_constraints/ddl</a></td>
73
63
  </tr>
63
  </tr>
74
64
  <tr>
64
  <tr>
75
65
    <td>Integrity Constraints</td>
65
    <td>Integrity Constraints</td>
76
66
    <td>DML</td>
66
    <td>DML</td>
77
67
    <td><a href="../modules/www.zorba-xquery.com_modules_store_static_integrity_constraints_dml.html">http://www.zorba-xquery.com/modules/store/static/integrity_constraints/dml</a></td>
67
    <td><a href="../modules/zorba.io_modules_store_static_integrity_constraints_dml.html">http://zorba.io/modules/store/static/integrity_constraints/dml</a></td>
78
68
  </tr>
68
  </tr>
79
69
</table>
69
</table>
80
70
70
81
@@ -83,27 +83,27 @@
82
83
  <tr>
83
  <tr>
83
84
    <td>Collections</td>
84
    <td>Collections</td>
84
85
    <td>DDL</td>
85
    <td>DDL</td>
86
86
    <td><a href="../modules/www.zorba-xquery.com_modules_store_dynamic_collections_ddl.html">http://www.zorba-xquery.com/modules/store/dynamic/collections/ddl</a></td>
86
    <td><a href="../modules/zorba.io_modules_store_dynamic_collections_ddl.html">http://zorba.io/modules/store/dynamic/collections/ddl</a></td>
87
87
  </tr>
87
  </tr>
88
88
  <tr>
88
  <tr>
89
89
    <td>Collections</td>
89
    <td>Collections</td>
90
90
    <td>DML</td>
90
    <td>DML</td>
92
91
    <td><a href="../modules/www.zorba-xquery.com_modules_store_dynamic_collections_dml.html">http://www.zorba-xquery.com/modules/store/dynamic/collections/dml</a></td>
91
    <td><a href="../modules/zorba.io_modules_store_dynamic_collections_dml.html">http://zorba.io/modules/store/dynamic/collections/dml</a></td>
93
92
  </tr>
92
  </tr>
94
93
  <tr>
93
  <tr>
95
94
    <td>W3C Collections</td>
94
    <td>W3C Collections</td>
96
95
    <td>DDL</td>
95
    <td>DDL</td>
98
96
    <td><a href="../modules/www.zorba-xquery.com_modules_store_dynamic_collections_w3c_ddl.html">http://www.zorba-xquery.com/modules/store/dynamic/collections/w3c/ddl</a></td>
96
    <td><a href="../modules/zorba.io_modules_store_dynamic_collections_w3c_ddl.html">http://zorba.io/modules/store/dynamic/collections/w3c/ddl</a></td>
99
97
  </tr>
97
  </tr>
100
98
  <tr>
98
  <tr>
101
99
    <td>W3C Collections</td>
99
    <td>W3C Collections</td>
102
100
    <td>DML</td>
100
    <td>DML</td>
104
101
    <td><a href="../modules/www.zorba-xquery.com_modules_store_dynamic_collections_w3c_dml.html">http://www.zorba-xquery.com/modules/store/dynamic/collections/w3c/dml</a></td>
101
    <td><a href="../modules/zorba.io_modules_store_dynamic_collections_w3c_dml.html">http://zorba.io/modules/store/dynamic/collections/w3c/dml</a></td>
105
102
  </tr>
102
  </tr>
106
103
  <tr>
103
  <tr>
107
104
    <td>Documents</td>
104
    <td>Documents</td>
108
105
    <td>DDL / DML</td>
105
    <td>DDL / DML</td>
110
106
    <td><a href="../modules/www.zorba-xquery.com_modules_store_dynamic_documents.html">http://www.zorba-xquery.com/modules/store/dynamic/documents</a></td>
106
    <td><a href="../modules/zorba.io_modules_store_dynamic_documents.html">http://zorba.io/modules/store/documents</a></td>
111
107
  </tr>
107
  </tr>
112
108
  <tr>
108
  <tr>
113
109
    <td>Unordered Maps</td>
109
    <td>Unordered Maps</td>
114
110
110
115
=== modified file 'doc/zorba/link_crawler2.dox'
116
--- doc/zorba/link_crawler2.dox	2013-08-09 09:04:36 +0000
117
+++ doc/zorba/link_crawler2.dox	2013-10-17 02:02:41 +0000
118
@@ -18,7 +18,7 @@
119
18
:)
18
:)
120
19
19
121
20
import module namespace http = "http://www.zorba-xquery.com/modules/http-client";
20
import module namespace http = "http://www.zorba-xquery.com/modules/http-client";
123
21
import module namespace map = "http://www.zorba-xquery.com/modules/store/data-structures/unordered-map";
21
import module namespace map = "http://zorba.io/modules/store/data-structures/unordered-map";
124
22
import module namespace html = "http://www.zorba-xquery.com/modules/converters/html";
22
import module namespace html = "http://www.zorba-xquery.com/modules/converters/html";
125
23
import module namespace parse-xml = "http://www.zorba-xquery.com/modules/xml";
23
import module namespace parse-xml = "http://www.zorba-xquery.com/modules/xml";
126
24
import module namespace file = "http://expath.org/ns/file";
24
import module namespace file = "http://expath.org/ns/file";
127
25
25
128
=== modified file 'doc/zorba/modules_top.dox'
129
--- doc/zorba/modules_top.dox	2013-09-17 03:48:02 +0000
130
+++ doc/zorba/modules_top.dox	2013-10-17 02:02:41 +0000
131
@@ -13,7 +13,7 @@
132
13
13
133
14
   - <a href="../modules/www.w3.org_2005_xpath-functions.html">xpath</a>
14
   - <a href="../modules/www.w3.org_2005_xpath-functions.html">xpath</a>
134
15
   - <a href="../modules/zorba.io_modules_node.html">XDM</a>
15
   - <a href="../modules/zorba.io_modules_node.html">XDM</a>
136
16
   - <a href="../modules/www.zorba-xquery.com_modules_store_dynamic_collections_ddl.html">store</a>
16
   - <a href="../modules/zorba.io_modules_store_dynamic_collections_ddl.html">store</a>
137
17
   - <a href="../modules/www.zorba-xquery.com_modules_introspection_sctx.html">introspection</a>
17
   - <a href="../modules/www.zorba-xquery.com_modules_introspection_sctx.html">introspection</a>
138
18
   - <a href="../modules/www.zorba-xquery.com_modules_reflection.html">reflection</a>
18
   - <a href="../modules/www.zorba-xquery.com_modules_reflection.html">reflection</a>
139
19
   - <a href="../modules/expath.org_ns_file.html">file</a>
19
   - <a href="../modules/expath.org_ns_file.html">file</a>
140
20
20
141
=== modified file 'doc/zorba/options.dox'
142
--- doc/zorba/options.dox	2013-08-23 11:15:04 +0000
143
+++ doc/zorba/options.dox	2013-10-17 02:02:41 +0000
144
@@ -348,7 +348,7 @@
145
348
\paragraph variadic_annotation Variadic Functions
348
\paragraph variadic_annotation Variadic Functions
146
349
A function annotated with the <tt>%an:variadic</tt> annotation is a function of indefinite arity, i.e. one that accepts a variable number of arguments.  
349
A function annotated with the <tt>%an:variadic</tt> annotation is a function of indefinite arity, i.e. one that accepts a variable number of arguments.  
147
350
350
149
351
For example, the function to create an unordered map with an arbitrary number of key types (see module <a href="/documentation/zorba/2.9/modules/www.zorba-xquery.com_modules_store_data-structures_unordered-map.html">http://www.zorba-xquery.com/modules/store/data-structures/unordered-map</a>) is declared as follow:
351
For example, the function to create an unordered map with an arbitrary number of key types (see module <a href="/documentation/zorba/2.9/modules/zorba.io_modules_store_data-structures_unordered-map.html">http://zorba.io/modules/store/data-structures/unordered-map</a>) is declared as follow:
150
352
352
151
353
\code
353
\code
152
354
declare %an:variadic %an:sequential function map:create(
354
declare %an:variadic %an:sequential function map:create(
153
@@ -517,7 +517,7 @@
154
517
<ul>
517
<ul>
155
518
  <li><b>no-copy</b> In order to indicate that a node that should be inserted into a collection does not need to be copied before inserting it. Not copying a node improves performance. However, the user needs to make sure that the node does not have a parent and is not modified in any other expression. For example, in the following example snippet, the node refered to by <tt>$n</tt> will not be copied before insertion into the collection.
518
  <li><b>no-copy</b> In order to indicate that a node that should be inserted into a collection does not need to be copied before inserting it. Not copying a node improves performance. However, the user needs to make sure that the node does not have a parent and is not modified in any other expression. For example, in the following example snippet, the node refered to by <tt>$n</tt> will not be copied before insertion into the collection.
156
519
\code
519
\code
158
520
import module namespace db = "http://www.zorba-xquery.com/modules/store/dynamic/collections/dml";
520
import module namespace db = "http://zorba.io/modules/store/dynamic/collections/dml";
159
521
521
160
522
declare namespace ext = "http://zorba.io/extensions";
522
declare namespace ext = "http://zorba.io/extensions";
161
523
523
162
524
524
163
=== modified file 'doc/zorba/web_crawler.dox'
164
--- doc/zorba/web_crawler.dox	2013-08-09 09:04:36 +0000
165
+++ doc/zorba/web_crawler.dox	2013-10-17 02:02:41 +0000
166
@@ -14,7 +14,7 @@
167
14
14
168
15
\code
15
\code
169
16
import module namespace http = "http://www.zorba-xquery.com/modules/http-client";
16
import module namespace http = "http://www.zorba-xquery.com/modules/http-client";
171
17
import module namespace map = "http://www.zorba-xquery.com/modules/store/data-structures/unordered-map";
17
import module namespace map = "http://zorba.io/modules/store/data-structures/unordered-map";
172
18
import module namespace html = "http://www.zorba-xquery.com/modules/converters/html";
18
import module namespace html = "http://www.zorba-xquery.com/modules/converters/html";
173
19
import module namespace parse-xml = "http://www.zorba-xquery.com/modules/xml";
19
import module namespace parse-xml = "http://www.zorba-xquery.com/modules/xml";
174
20
import module namespace file = "http://expath.org/ns/file";
20
import module namespace file = "http://expath.org/ns/file";
175
21
21
176
=== modified file 'doc/zorba/xqddf.dox'
177
--- doc/zorba/xqddf.dox	2013-09-17 16:14:45 +0000
178
+++ doc/zorba/xqddf.dox	2013-10-17 02:02:41 +0000
179
@@ -14,12 +14,12 @@
180
14
14
181
15
15
182
16
<ul>
16
<ul>
189
17
  <li><a href="../modules/www.zorba-xquery.com_modules_store_static_collections_dml.html">http://www.zorba-xquery.com/modules/store/static/collections/dml</a> (prefix: cdml)</li>
17
  <li><a href="../modules/zorba.io_modules_store_static_collections_dml.html">http://zorba.io/modules/store/static/collections/dml</a> (prefix: cdml)</li>
190
18
  <li><a href="../modules/www.zorba-xquery.com_modules_store_static_collections_ddl.html">http://www.zorba-xquery.com/modules/store/static/collections/ddl</a> (prefix: cddl)</li>
18
  <li><a href="../modules/zorba.io_modules_store_static_collections_ddl.html">http://zorba.io/modules/store/static/collections/ddl</a> (prefix: cddl)</li>
191
19
  <li><a href="../modules/www.zorba-xquery.com_modules_store_static_indexes_dml.html">http://www.zorba-xquery.com/modules/store/static/indexes/dml</a> (prefix: idml)</li>
19
  <li><a href="../modules/zorba.io_modules_store_static_indexes_dml.html">http://zorba.io/modules/store/static/indexes/dml</a> (prefix: idml)</li>
192
20
  <li><a href="../modules/www.zorba-xquery.com_modules_store_static_indexes_ddl.html">http://www.zorba-xquery.com/modules/store/static/indexes/ddl</a> (prefix: iddl)</li>
20
  <li><a href="../modules/zorba.io_modules_store_static_indexes_ddl.html">http://zorba.io/modules/store/static/indexes/ddl</a> (prefix: iddl)</li>
193
21
  <li><a href="../modules/www.zorba-xquery.com_modules_store_static_integrity_constraints_dml.html">http://www.zorba-xquery.com/modules/store/static/integrity_constraints/dml</a> (prefix: icdml)</li>
21
  <li><a href="../modules/zorba.io_modules_store_static_integrity_constraints_dml.html">http://zorba.io/modules/store/static/integrity_constraints/dml</a> (prefix: icdml)</li>
194
22
  <li><a href="../modules/www.zorba-xquery.com_modules_store_static_integrity_constraints_ddl.html">http://www.zorba-xquery.com/modules/store/static/integrity_constraints/ddl</a> (prefix: icddl)</li>
22
  <li><a href="../modules/zorba.io_modules_store_static_integrity_constraints_ddl.html">http://zorba.io/modules/store/static/integrity_constraints/ddl</a> (prefix: icddl)</li>
195
23
</ul>
23
</ul>
196
24
24
197
25
As usual, these modules must be imported by any other module that wants to invoke any of the functions.
25
As usual, these modules must be imported by any other module that wants to invoke any of the functions.
198
@@ -55,7 +55,7 @@
199
55
For brevity, in the remaining of this document we will use the term "collection" to
55
For brevity, in the remaining of this document we will use the term "collection" to
200
56
mean <a href="#collection">collection</a>. For backward compatibility with
56
mean <a href="#collection">collection</a>. For backward compatibility with
201
57
the W3C XQuery specification, Zorba retains some basic support for W3C
57
the W3C XQuery specification, Zorba retains some basic support for W3C
203
58
collections (see <a href="../modules/www.zorba-xquery.com_modules_store_dynamic_collections_w3c_dml.html">http://www.zorba-xquery.com/modules/store/dynamic/collections/w3c/dml</a> and <a href="../modules/www.zorba-xquery.com_modules_store_dynamic_collections_w3c_ddl.html">http://www.zorba-xquery.com/modules/store/dynamic/collections/w3c/ddl</a>).
58
collections (see <a href="../modules/zorba.io_modules_store_dynamic_collections_w3c_dml.html">http://zorba.io/modules/store/dynamic/collections/w3c/dml</a> and <a href="../modules/zorba.io_modules_store_dynamic_collections_w3c_ddl.html">http://zorba.io/modules/store/dynamic/collections/w3c/ddl</a>).
204
59
However, users are encouraged to use <a href="#collection">collections</a> instead.
59
However, users are encouraged to use <a href="#collection">collections</a> instead.
205
60
60
206
61
Zorba supports five kinds of operations on collections: <a
61
Zorba supports five kinds of operations on collections: <a
207
@@ -161,7 +161,7 @@
208
161
\code
161
\code
209
162
  (: "admin-script-1" :)
162
  (: "admin-script-1" :)
210
163
163
212
164
  import module namespace cddl = "http://www.zorba-xquery.com/modules/store/static/collections/ddl";
164
  import module namespace cddl = "http://zorba.io/modules/store/static/collections/ddl";
213
165
165
214
166
  import module namespace news-data = "http://www.news.org/data";
166
  import module namespace news-data = "http://www.news.org/data";
215
167
167
216
@@ -222,7 +222,7 @@
217
222
\code
222
\code
218
223
  (: "user-script-1":)
223
  (: "user-script-1":)
219
224
224
221
225
  import module namespace cdml = "http://www.zorba-xquery.com/modules/store/static/collections/dml";
225
  import module namespace cdml = "http://zorba.io/modules/store/static/collections/dml";
222
226
226
223
227
  import module namespace http = "http://www.zorba-xquery.com/modules/http-client";
227
  import module namespace http = "http://www.zorba-xquery.com/modules/http-client";
224
228
228
225
@@ -257,7 +257,7 @@
226
257
\code
257
\code
227
258
  (: admin-script2 :)
258
  (: admin-script2 :)
228
259
259
230
260
  import module namespace cddl = "http://www.zorba-xquery.com/modules/store/static/collections/ddl";
260
  import module namespace cddl = "http://zorba.io/modules/store/static/collections/ddl";
231
261
261
232
262
  import module namespace news-data = "http://www.news.org/data";
262
  import module namespace news-data = "http://www.news.org/data";
233
263
263
234
@@ -1010,7 +1010,7 @@
235
1010
1010
236
1011
  module namespace news-data = "http://www.news.org/data";
1011
  module namespace news-data = "http://www.news.org/data";
237
1012
1012
239
1013
  import module namespace cdml = "http://www.zorba-xquery.com/modules/store/static/collections/dml";
1013
  import module namespace cdml = "http://zorba.io/modules/store/static/collections/dml";
240
1014
1014
241
1015
  import schema namespace news-schemas = "http://www.news.org/schemas";
1015
  import schema namespace news-schemas = "http://www.news.org/schemas";
242
1016
1016
243
@@ -1078,7 +1078,7 @@
244
1078
\code
1078
\code
245
1079
  (: The "admin-script-3" script :)
1079
  (: The "admin-script-3" script :)
246
1080
1080
248
1081
  import module namespace iddf = "http://www.zorba-xquery.com/modules/store/static/indexes/ddl";
1081
  import module namespace iddf = "http://zorba.io/modules/store/static/indexes/ddl";
249
1082
1082
250
1083
  import module namespace news-data = "http://www.news.org/data" at "news_data.xqlib";
1083
  import module namespace news-data = "http://www.news.org/data" at "news_data.xqlib";
251
1084
1084
252
@@ -1156,7 +1156,7 @@
253
1156
\code
1156
\code
254
1157
  (: The "probe-1" query :)
1157
  (: The "probe-1" query :)
255
1158
1158
257
1159
  import module namespace idml = "http://www.zorba-xquery.com/modules/store/static/indexes/dml";
1159
  import module namespace idml = "http://zorba.io/modules/store/static/indexes/dml";
258
1160
1160
259
1161
  import module namespace news-data = "http://www.news.org/data" at "news_data.xqlib";
1161
  import module namespace news-data = "http://www.news.org/data" at "news_data.xqlib";
260
1162
1162
261
@@ -1167,7 +1167,7 @@
262
1167
\code
1167
\code
263
1168
  (: The "probe-2" query :)
1168
  (: The "probe-2" query :)
264
1169
1169
266
1170
  import module namespace idml = "http://www.zorba-xquery.com/modules/store/static/indexes/dml";
1170
  import module namespace idml = "http://zorba.io/modules/store/static/indexes/dml";
267
1171
1171
268
1172
  import module namespace news-data = "http://www.news.org/data" at "news_data.xqlib";
1172
  import module namespace news-data = "http://www.news.org/data" at "news_data.xqlib";
269
1173
1173
270
@@ -1178,7 +1178,7 @@
271
1178
\code
1178
\code
272
1179
  (: The "probe-3" query :)
1179
  (: The "probe-3" query :)
273
1180
1180
275
1181
  import module namespace idml = "http://www.zorba-xquery.com/modules/store/static/indexes/dml";
1181
  import module namespace idml = "http://zorba.io/modules/store/static/indexes/dml";
276
1182
1182
277
1183
  import module namespace news-data = "http://www.news.org/data" at "news_data.xqlib";
1183
  import module namespace news-data = "http://www.news.org/data" at "news_data.xqlib";
278
1184
1184
279
@@ -1189,7 +1189,7 @@
280
1189
\code
1189
\code
281
1190
  (: The "no-probe-1" query :)
1190
  (: The "no-probe-1" query :)
282
1191
1191
284
1192
  import module namespace cdml = "http://www.zorba-xquery.com/modules/store/static/collections/dml";
1192
  import module namespace cdml = "http://zorba.io/modules/store/static/collections/dml";
285
1193
1193
286
1194
  import module namespace news-data = "http://www.news.org/data" at "news_data.xqlib";
1194
  import module namespace news-data = "http://www.news.org/data" at "news_data.xqlib";
287
1195
1195
288
@@ -1200,7 +1200,7 @@
289
1200
\code
1200
\code
290
1201
  (: The "no-probe-2" query :)
1201
  (: The "no-probe-2" query :)
291
1202
1202
293
1203
  import module namespace cdml = "http://www.zorba-xquery.com/modules/store/static/collections/dml";
1203
  import module namespace cdml = "http://zorba.io/modules/store/static/collections/dml";
294
1204
1204
295
1205
  import module namespace news-data = "http://www.news.org/data" at "news_data.xqlib";
1205
  import module namespace news-data = "http://www.news.org/data" at "news_data.xqlib";
296
1206
1206
297
@@ -1215,7 +1215,7 @@
298
1215
\code
1215
\code
299
1216
  (: The "probe-3" query :)
1216
  (: The "probe-3" query :)
300
1217
1217
302
1218
  import module namespace cdml = "http://www.zorba-xquery.com/modules/store/static/collections/dml";
1218
  import module namespace cdml = "http://zorba.io/modules/store/static/collections/dml";
303
1219
1219
304
1220
  import module namespace news-data = "http://www.news.org/data" at "news_data.xqlib";
1220
  import module namespace news-data = "http://www.news.org/data" at "news_data.xqlib";
305
1221
1221
306
@@ -1265,7 +1265,7 @@
307
1265
\code
1265
\code
308
1266
  (: The "index-maintenance" query :)
1266
  (: The "index-maintenance" query :)
309
1267
1267
311
1268
  import module namespace cdml = "http://www.zorba-xquery.com/modules/store/static/collections/dml";
1268
  import module namespace cdml = "http://zorba.io/modules/store/static/collections/dml";
312
1269
1269
313
1270
  import module namespace news-data = "http://www.news.org/data" at "news_data.xqlib";
1270
  import module namespace news-data = "http://www.news.org/data" at "news_data.xqlib";
314
1271
1271
315
@@ -1286,7 +1286,7 @@
316
1286
\code
1286
\code
317
1287
  (: The "admin-script-4" query :)
1287
  (: The "admin-script-4" query :)
318
1288
1288
320
1289
  import module namespace iddl = "http://www.zorba-xquery.com/modules/store/static/indexes/ddl";
1289
  import module namespace iddl = "http://zorba.io/modules/store/static/indexes/ddl";
321
1290
1290
322
1291
  import module namespace news-data = "http://www.news.org/data" at "news_data.xqlib";
1291
  import module namespace news-data = "http://www.news.org/data" at "news_data.xqlib";
323
1292
1292
324
@@ -1978,7 +1978,7 @@
325
1978
Each node in the sequence represents one key contained in the index and has the following structure:
1978
Each node in the sequence represents one key contained in the index and has the following structure:
326
1979
1979
327
1980
\code
1980
\code
329
1981
 <key xmlns="http://www.zorba-xquery.com/modules/store/static/indexes/dml">
1981
 <key xmlns="http://zorba.io/modules/store/static/indexes/dml">
330
1982
   <attribute value="key_1"/>
1982
   <attribute value="key_1"/>
331
1983
   ...
1983
   ...
332
1984
   <attribute value="key_n"/>
1984
   <attribute value="key_n"/>
333
@@ -2461,4 +2461,4 @@
334
2461
\n <a name="ERRZDDY0034" id="ERRZDDY0034"></a>zerr:ZDDY0034, Index range-value
2461
\n <a name="ERRZDDY0034" id="ERRZDDY0034"></a>zerr:ZDDY0034, Index range-value
335
2462
 probe has search keys with incompatible types
2462
 probe has search keys with incompatible types
336
2463
</strong>
2463
</strong>
337
2464
*/
338
2465
\ No newline at end of file
2464
\ No newline at end of file
339
2465
*/
340
2466
2466
341
=== modified file 'doc/zorba/xqdoc/images/modules.svg'
342
--- doc/zorba/xqdoc/images/modules.svg	2013-10-16 21:47:22 +0000
343
+++ doc/zorba/xqdoc/images/modules.svg	2013-10-17 02:02:41 +0000
344
@@ -1364,63 +1364,63 @@
345
1364
</g>
1364
</g>
346
1365
<!-- 14 -->
1365
<!-- 14 -->
347
1366
<g id="node86" class="node"><title>14</title>
1366
<g id="node86" class="node"><title>14</title>
349
1367
<a xlink:href="../www.zorba-xquery.com_modules_store_dynamic_collections_ddl.html" xlink:title="(Zorba-core) module uri=http://www.zorba-xquery.com/modules/store/dynamic/collections/ddl">
1367
<a xlink:href="../zorba.io_modules_store_dynamic_collections_ddl.html" xlink:title="(Zorba-core) module uri=http://zorba.io/modules/store/dynamic/collections/ddl">
350
1368
<ellipse fill="white" stroke="white" cx="4258" cy="-385" rx="27" ry="18"/>
1368
<ellipse fill="white" stroke="white" cx="4258" cy="-385" rx="27" ry="18"/>
351
1369
<text text-anchor="middle" x="4258" y="-381.3" font-family="Times,serif" font-size="14.00" fill="red">ddl</text>
1369
<text text-anchor="middle" x="4258" y="-381.3" font-family="Times,serif" font-size="14.00" fill="red">ddl</text>
352
1370
</a>
1370
</a>
353
1371
</g>
1371
</g>
354
1372
<!-- 15 -->
1372
<!-- 15 -->
355
1373
<g id="node88" class="node"><title>15</title>
1373
<g id="node88" class="node"><title>15</title>
357
1374
<a xlink:href="../www.zorba-xquery.com_modules_store_dynamic_collections_dml.html" xlink:title="(Zorba-core) module uri=http://www.zorba-xquery.com/modules/store/dynamic/collections/dml">
1374
<a xlink:href="../zorba.io_modules_store_dynamic_collections_dml.html" xlink:title="(Zorba-core) module uri=http://zorba.io/modules/store/dynamic/collections/dml">
358
1375
<ellipse fill="white" stroke="white" cx="4258" cy="-538" rx="27" ry="18"/>
1375
<ellipse fill="white" stroke="white" cx="4258" cy="-538" rx="27" ry="18"/>
359
1376
<text text-anchor="middle" x="4258" y="-534.3" font-family="Times,serif" font-size="14.00" fill="red">dml</text>
1376
<text text-anchor="middle" x="4258" y="-534.3" font-family="Times,serif" font-size="14.00" fill="red">dml</text>
360
1377
</a>
1377
</a>
361
1378
</g>
1378
</g>
362
1379
<!-- 18 -->
1379
<!-- 18 -->
363
1380
<g id="node90" class="node"><title>18</title>
1380
<g id="node90" class="node"><title>18</title>
365
1381
<a xlink:href="../www.zorba-xquery.com_modules_store_static_collections_ddl.html" xlink:title="(Zorba-core) module uri=http://www.zorba-xquery.com/modules/store/static/collections/ddl">
1381
<a xlink:href="../zorba.io_modules_store_static_collections_ddl.html" xlink:title="(Zorba-core) module uri=http://zorba.io/modules/store/static/collections/ddl">
366
1382
<ellipse fill="white" stroke="white" cx="4613" cy="-660" rx="27" ry="18"/>
1382
<ellipse fill="white" stroke="white" cx="4613" cy="-660" rx="27" ry="18"/>
367
1383
<text text-anchor="middle" x="4613" y="-656.3" font-family="Times,serif" font-size="14.00" fill="red">ddl</text>
1383
<text text-anchor="middle" x="4613" y="-656.3" font-family="Times,serif" font-size="14.00" fill="red">ddl</text>
368
1384
</a>
1384
</a>
369
1385
</g>
1385
</g>
370
1386
<!-- 19 -->
1386
<!-- 19 -->
371
1387
<g id="node92" class="node"><title>19</title>
1387
<g id="node92" class="node"><title>19</title>
373
1388
<a xlink:href="../www.zorba-xquery.com_modules_store_static_collections_dml.html" xlink:title="(Zorba-core) module uri=http://www.zorba-xquery.com/modules/store/static/collections/dml">
1388
<a xlink:href="../zorba.io_modules_store_static_collections_dml.html" xlink:title="(Zorba-core) module uri=http://zorba.io/modules/store/static/collections/dml">
374
1389
<ellipse fill="white" stroke="white" cx="4460" cy="-660" rx="27" ry="18"/>
1389
<ellipse fill="white" stroke="white" cx="4460" cy="-660" rx="27" ry="18"/>
375
1390
<text text-anchor="middle" x="4460" y="-656.3" font-family="Times,serif" font-size="14.00" fill="red">dml</text>
1390
<text text-anchor="middle" x="4460" y="-656.3" font-family="Times,serif" font-size="14.00" fill="red">dml</text>
376
1391
</a>
1391
</a>
377
1392
</g>
1392
</g>
378
1393
<!-- 16 -->
1393
<!-- 16 -->
379
1394
<g id="node94" class="node"><title>16</title>
1394
<g id="node94" class="node"><title>16</title>
381
1395
<a xlink:href="../www.zorba-xquery.com_modules_store_dynamic_collections_w3c_ddl.html" xlink:title="(Zorba-core) module uri=http://www.zorba-xquery.com/modules/store/dynamic/collections/w3c/ddl">
1395
<a xlink:href="../zorba.io_modules_store_dynamic_collections_w3c_ddl.html" xlink:title="(Zorba-core) module uri=http://zorba.io/modules/store/dynamic/collections/w3c/ddl">
382
1396
<ellipse fill="white" stroke="white" cx="4439" cy="-538" rx="27" ry="18"/>
1396
<ellipse fill="white" stroke="white" cx="4439" cy="-538" rx="27" ry="18"/>
383
1397
<text text-anchor="middle" x="4439" y="-534.3" font-family="Times,serif" font-size="14.00" fill="red">ddl</text>
1397
<text text-anchor="middle" x="4439" y="-534.3" font-family="Times,serif" font-size="14.00" fill="red">ddl</text>
384
1398
</a>
1398
</a>
385
1399
</g>
1399
</g>
386
1400
<!-- 16&#45;&gt;14 -->
1400
<!-- 16&#45;&gt;14 -->
387
1401
<g id="edge176" class="edge"><title>16-&gt;14</title>
1401
<g id="edge176" class="edge"><title>16-&gt;14</title>
389
1402
<a xlink:title="FROM: http://www.zorba-xquery.com/modules/store/dynamic/collections/w3c/ddl, TO: http://www.zorba-xquery.com/modules/store/dynamic/collections/ddl">
1402
<a xlink:title="FROM: http://zorba.io/modules/store/dynamic/collections/w3c/ddl, TO: http://zorba.io/modules/store/dynamic/collections/ddl">
390
1403
<path fill="none" stroke="black" d="M4422.71,-523.159C4415.73,-517.243 4407.48,-510.269 4400,-504 4358.64,-469.321 4310.26,-429.213 4281.98,-405.82"/>
1403
<path fill="none" stroke="black" d="M4422.71,-523.159C4415.73,-517.243 4407.48,-510.269 4400,-504 4358.64,-469.321 4310.26,-429.213 4281.98,-405.82"/>
391
1404
<polygon fill="black" stroke="black" points="4284.16,-403.079 4274.22,-399.403 4279.7,-408.473 4284.16,-403.079"/>
1404
<polygon fill="black" stroke="black" points="4284.16,-403.079 4274.22,-399.403 4279.7,-408.473 4284.16,-403.079"/>
392
1405
</a>
1405
</a>
393
1406
</g>
1406
</g>
394
1407
<!-- 17 -->
1407
<!-- 17 -->
395
1408
<g id="node96" class="node"><title>17</title>
1408
<g id="node96" class="node"><title>17</title>
397
1409
<a xlink:href="../www.zorba-xquery.com_modules_store_dynamic_collections_w3c_dml.html" xlink:title="(Zorba-core) module uri=http://www.zorba-xquery.com/modules/store/dynamic/collections/w3c/dml">
1409
<a xlink:href="../zorba.io_modules_store_dynamic_collections_w3c_dml.html" xlink:title="(Zorba-core) module uri=http://zorba.io/modules/store/dynamic/collections/w3c/dml">
398
1410
<ellipse fill="white" stroke="white" cx="4299" cy="-660" rx="27" ry="18"/>
1410
<ellipse fill="white" stroke="white" cx="4299" cy="-660" rx="27" ry="18"/>
399
1411
<text text-anchor="middle" x="4299" y="-656.3" font-family="Times,serif" font-size="14.00" fill="red">dml</text>
1411
<text text-anchor="middle" x="4299" y="-656.3" font-family="Times,serif" font-size="14.00" fill="red">dml</text>
400
1412
</a>
1412
</a>
401
1413
</g>
1413
</g>
402
1414
<!-- 17&#45;&gt;15 -->
1414
<!-- 17&#45;&gt;15 -->
403
1415
<g id="edge180" class="edge"><title>17-&gt;15</title>
1415
<g id="edge180" class="edge"><title>17-&gt;15</title>
405
1416
<a xlink:title="FROM: http://www.zorba-xquery.com/modules/store/dynamic/collections/w3c/dml, TO: http://www.zorba-xquery.com/modules/store/dynamic/collections/dml">
1416
<a xlink:title="FROM: http://zorba.io/modules/store/dynamic/collections/w3c/dml, TO: http://zorba.io/modules/store/dynamic/collections/dml">
406
1417
<path fill="none" stroke="black" d="M4293.3,-642.315C4286.51,-622.456 4275.1,-589.042 4267.09,-565.604"/>
1417
<path fill="none" stroke="black" d="M4293.3,-642.315C4286.51,-622.456 4275.1,-589.042 4267.09,-565.604"/>
407
1418
<polygon fill="black" stroke="black" points="4270.33,-564.262 4263.78,-555.931 4263.71,-566.525 4270.33,-564.262"/>
1418
<polygon fill="black" stroke="black" points="4270.33,-564.262 4263.78,-555.931 4263.71,-566.525 4270.33,-564.262"/>
408
1419
</a>
1419
</a>
409
1420
</g>
1420
</g>
410
1421
<!-- 17&#45;&gt;16 -->
1421
<!-- 17&#45;&gt;16 -->
411
1422
<g id="edge178" class="edge"><title>17-&gt;16</title>
1422
<g id="edge178" class="edge"><title>17-&gt;16</title>
413
1423
<a xlink:title="FROM: http://www.zorba-xquery.com/modules/store/dynamic/collections/w3c/dml, TO: http://www.zorba-xquery.com/modules/store/dynamic/collections/w3c/ddl">
1423
<a xlink:title="FROM: http://zorba.io/modules/store/dynamic/collections/w3c/dml, TO: http://zorba.io/modules/store/dynamic/collections/w3c/ddl">
414
1424
<path fill="none" stroke="black" d="M4321.35,-649.59C4337.36,-642.897 4359.45,-633.755 4379,-626 4388.28,-622.318 4392.61,-624.721 4400,-618 4415.27,-604.107 4425.28,-582.901 4431.33,-565.957"/>
1424
<path fill="none" stroke="black" d="M4321.35,-649.59C4337.36,-642.897 4359.45,-633.755 4379,-626 4388.28,-622.318 4392.61,-624.721 4400,-618 4415.27,-604.107 4425.28,-582.901 4431.33,-565.957"/>
415
1425
<polygon fill="black" stroke="black" points="4434.79,-566.654 4434.6,-556.061 4428.14,-564.459 4434.79,-566.654"/>
1425
<polygon fill="black" stroke="black" points="4434.79,-566.654 4434.6,-556.061 4428.14,-564.459 4434.79,-566.654"/>
416
1426
</a>
1426
</a>
417
@@ -1434,14 +1434,14 @@
418
1434
</g>
1434
</g>
419
1435
<!-- 70&#45;&gt;14 -->
1435
<!-- 70&#45;&gt;14 -->
420
1436
<g id="edge246" class="edge"><title>70-&gt;14</title>
1436
<g id="edge246" class="edge"><title>70-&gt;14</title>
422
1437
<a xlink:title="FROM: http://zorba.io/modules/queue, TO: http://www.zorba-xquery.com/modules/store/dynamic/collections/ddl">
1437
<a xlink:title="FROM: http://zorba.io/modules/queue, TO: http://zorba.io/modules/store/dynamic/collections/ddl">
423
1438
<path fill="none" stroke="black" d="M4087.04,-642.54C4104.5,-614.043 4141.78,-553.788 4175,-504 4197.06,-470.931 4223.68,-433.508 4240.71,-409.841"/>
1438
<path fill="none" stroke="black" d="M4087.04,-642.54C4104.5,-614.043 4141.78,-553.788 4175,-504 4197.06,-470.931 4223.68,-433.508 4240.71,-409.841"/>
424
1439
<polygon fill="black" stroke="black" points="4243.73,-411.64 4246.74,-401.483 4238.05,-407.544 4243.73,-411.64"/>
1439
<polygon fill="black" stroke="black" points="4243.73,-411.64 4246.74,-401.483 4238.05,-407.544 4243.73,-411.64"/>
425
1440
</a>
1440
</a>
426
1441
</g>
1441
</g>
427
1442
<!-- 70&#45;&gt;15 -->
1442
<!-- 70&#45;&gt;15 -->
428
1443
<g id="edge248" class="edge"><title>70-&gt;15</title>
1443
<g id="edge248" class="edge"><title>70-&gt;15</title>
430
1444
<a xlink:title="FROM: http://zorba.io/modules/queue, TO: http://www.zorba-xquery.com/modules/store/dynamic/collections/dml">
1444
<a xlink:title="FROM: http://zorba.io/modules/queue, TO: http://zorba.io/modules/store/dynamic/collections/dml">
431
1445
<path fill="none" stroke="black" d="M4095.18,-644.869C4103.02,-638.903 4112.36,-631.971 4121,-626 4157.86,-600.53 4201.79,-573.132 4229.78,-556.03"/>
1445
<path fill="none" stroke="black" d="M4095.18,-644.869C4103.02,-638.903 4112.36,-631.971 4121,-626 4157.86,-600.53 4201.79,-573.132 4229.78,-556.03"/>
432
1446
<polygon fill="black" stroke="black" points="4231.91,-558.832 4238.63,-550.642 4228.27,-552.853 4231.91,-558.832"/>
1446
<polygon fill="black" stroke="black" points="4231.91,-558.832 4238.63,-550.642 4228.27,-552.853 4231.91,-558.832"/>
433
1447
</a>
1447
</a>
434
@@ -1455,14 +1455,14 @@
435
1455
</g>
1455
</g>
436
1456
<!-- 72&#45;&gt;14 -->
1456
<!-- 72&#45;&gt;14 -->
437
1457
<g id="edge250" class="edge"><title>72-&gt;14</title>
1457
<g id="edge250" class="edge"><title>72-&gt;14</title>
439
1458
<a xlink:title="FROM: http://zorba.io/modules/stack, TO: http://www.zorba-xquery.com/modules/store/dynamic/collections/ddl">
1458
<a xlink:title="FROM: http://zorba.io/modules/stack, TO: http://zorba.io/modules/store/dynamic/collections/ddl">
440
1459
<path fill="none" stroke="black" d="M4167.86,-642.334C4184,-596.452 4229.16,-468.005 4248.75,-412.312"/>
1459
<path fill="none" stroke="black" d="M4167.86,-642.334C4184,-596.452 4229.16,-468.005 4248.75,-412.312"/>
441
1460
<polygon fill="black" stroke="black" points="4252.08,-413.39 4252.09,-402.795 4245.47,-411.068 4252.08,-413.39"/>
1460
<polygon fill="black" stroke="black" points="4252.08,-413.39 4252.09,-402.795 4245.47,-411.068 4252.08,-413.39"/>
442
1461
</a>
1461
</a>
443
1462
</g>
1462
</g>
444
1463
<!-- 72&#45;&gt;15 -->
1463
<!-- 72&#45;&gt;15 -->
445
1464
<g id="edge252" class="edge"><title>72-&gt;15</title>
1464
<g id="edge252" class="edge"><title>72-&gt;15</title>
447
1465
<a xlink:title="FROM: http://zorba.io/modules/stack, TO: http://www.zorba-xquery.com/modules/store/dynamic/collections/dml">
1465
<a xlink:title="FROM: http://zorba.io/modules/stack, TO: http://zorba.io/modules/store/dynamic/collections/dml">
448
1466
<path fill="none" stroke="black" d="M4174.55,-643.312C4191.1,-622.626 4220.35,-586.063 4239.45,-562.183"/>
1466
<path fill="none" stroke="black" d="M4174.55,-643.312C4191.1,-622.626 4220.35,-586.063 4239.45,-562.183"/>
449
1467
<polygon fill="black" stroke="black" points="4242.24,-564.307 4245.75,-554.312 4236.77,-559.935 4242.24,-564.307"/>
1467
<polygon fill="black" stroke="black" points="4242.24,-564.307 4245.75,-554.312 4236.77,-559.935 4242.24,-564.307"/>
450
1468
</a>
1468
</a>
451
@@ -1476,35 +1476,35 @@
452
1476
</g>
1476
</g>
453
1477
<!-- 13 -->
1477
<!-- 13 -->
454
1478
<g id="node105" class="node"><title>13</title>
1478
<g id="node105" class="node"><title>13</title>
456
1479
<a xlink:href="../www.zorba-xquery.com_modules_store_dynamic_documents.html" xlink:title="(Zorba-core) module uri=http://www.zorba-xquery.com/modules/store/dynamic/documents">
1479
<a xlink:href="../zorba.io_modules_store_dynamic_documents.html" xlink:title="(Zorba-core) module uri=http://zorba.io/modules/store/documents">
457
1480
<ellipse fill="white" stroke="white" cx="3804" cy="-660" rx="49.0941" ry="18"/>
1480
<ellipse fill="white" stroke="white" cx="3804" cy="-660" rx="49.0941" ry="18"/>
458
1481
<text text-anchor="middle" x="3804" y="-656.3" font-family="Times,serif" font-size="14.00" fill="red">documents</text>
1481
<text text-anchor="middle" x="3804" y="-656.3" font-family="Times,serif" font-size="14.00" fill="red">documents</text>
459
1482
</a>
1482
</a>
460
1483
</g>
1483
</g>
461
1484
<!-- 20 -->
1484
<!-- 20 -->
462
1485
<g id="node108" class="node"><title>20</title>
1485
<g id="node108" class="node"><title>20</title>
464
1486
<a xlink:href="../www.zorba-xquery.com_modules_store_static_indexes_ddl.html" xlink:title="(Zorba-core) module uri=http://www.zorba-xquery.com/modules/store/static/indexes/ddl">
1486
<a xlink:href="../zorba.io_modules_store_static_indexes_ddl.html" xlink:title="(Zorba-core) module uri=http://zorba.io/modules/store/static/indexes/ddl">
465
1487
<ellipse fill="white" stroke="white" cx="3663" cy="-660" rx="27" ry="18"/>
1487
<ellipse fill="white" stroke="white" cx="3663" cy="-660" rx="27" ry="18"/>
466
1488
<text text-anchor="middle" x="3663" y="-656.3" font-family="Times,serif" font-size="14.00" fill="red">ddl</text>
1488
<text text-anchor="middle" x="3663" y="-656.3" font-family="Times,serif" font-size="14.00" fill="red">ddl</text>
467
1489
</a>
1489
</a>
468
1490
</g>
1490
</g>
469
1491
<!-- 21 -->
1491
<!-- 21 -->
470
1492
<g id="node110" class="node"><title>21</title>
1492
<g id="node110" class="node"><title>21</title>
472
1493
<a xlink:href="../www.zorba-xquery.com_modules_store_static_indexes_dml.html" xlink:title="(Zorba-core) module uri=http://www.zorba-xquery.com/modules/store/static/indexes/dml">
1493
<a xlink:href="../zorba.io_modules_store_static_indexes_dml.html" xlink:title="(Zorba-core) module uri=http://zorba.io/modules/store/static/indexes/dml">
473
1494
<ellipse fill="white" stroke="white" cx="3510" cy="-660" rx="27" ry="18"/>
1494
<ellipse fill="white" stroke="white" cx="3510" cy="-660" rx="27" ry="18"/>
474
1495
<text text-anchor="middle" x="3510" y="-656.3" font-family="Times,serif" font-size="14.00" fill="red">dml</text>
1495
<text text-anchor="middle" x="3510" y="-656.3" font-family="Times,serif" font-size="14.00" fill="red">dml</text>
475
1496
</a>
1496
</a>
476
1497
</g>
1497
</g>
477
1498
<!-- 22 -->
1498
<!-- 22 -->
478
1499
<g id="node113" class="node"><title>22</title>
1499
<g id="node113" class="node"><title>22</title>
480
1500
<a xlink:href="../www.zorba-xquery.com_modules_store_static_integrity_constraints_ddl.html" xlink:title="(Zorba-core) module uri=http://www.zorba-xquery.com/modules/store/static/integrity_constraints/ddl">
1500
<a xlink:href="../zorba.io_modules_store_static_integrity_constraints_ddl.html" xlink:title="(Zorba-core) module uri=http://zorba.io/modules/store/static/integrity_constraints/ddl">
481
1501
<ellipse fill="white" stroke="white" cx="3341" cy="-660" rx="27" ry="18"/>
1501
<ellipse fill="white" stroke="white" cx="3341" cy="-660" rx="27" ry="18"/>
482
1502
<text text-anchor="middle" x="3341" y="-656.3" font-family="Times,serif" font-size="14.00" fill="red">ddl</text>
1502
<text text-anchor="middle" x="3341" y="-656.3" font-family="Times,serif" font-size="14.00" fill="red">ddl</text>
483
1503
</a>
1503
</a>
484
1504
</g>
1504
</g>
485
1505
<!-- 23 -->
1505
<!-- 23 -->
486
1506
<g id="node115" class="node"><title>23</title>
1506
<g id="node115" class="node"><title>23</title>
488
1507
<a xlink:href="../www.zorba-xquery.com_modules_store_static_integrity_constraints_dml.html" xlink:title="(Zorba-core) module uri=http://www.zorba-xquery.com/modules/store/static/integrity_constraints/dml">
1507
<a xlink:href="../zorba.io_modules_store_static_integrity_constraints_dml.html" xlink:title="(Zorba-core) module uri=http://zorba.io/modules/store/static/integrity_constraints/dml">
489
1508
<ellipse fill="white" stroke="white" cx="3188" cy="-660" rx="27" ry="18"/>
1508
<ellipse fill="white" stroke="white" cx="3188" cy="-660" rx="27" ry="18"/>
490
1509
<text text-anchor="middle" x="3188" y="-656.3" font-family="Times,serif" font-size="14.00" fill="red">dml</text>
1509
<text text-anchor="middle" x="3188" y="-656.3" font-family="Times,serif" font-size="14.00" fill="red">dml</text>
491
1510
</a>
1510
</a>
492
@@ -2166,4 +2166,4 @@
493
2166
</a>
2166
</a>
494
2167
</g>
2167
</g>
495
2168
</g>
2168
</g>
496
2169
</svg>
497
2170
\ No newline at end of file
2169
\ No newline at end of file
498
2170
</svg>
499
2171
2171
500
=== modified file 'doc/zorba/xqdoc/images/modules_new.svg'
501
--- doc/zorba/xqdoc/images/modules_new.svg	2013-10-16 22:24:04 +0000
502
+++ doc/zorba/xqdoc/images/modules_new.svg	2013-10-17 02:02:41 +0000
503
@@ -1370,63 +1370,63 @@
504
1370
</g>
1370
</g>
505
1371
<!-- 6 -->
1371
<!-- 6 -->
506
1372
<g id="node86" class="node"><title>6</title>
1372
<g id="node86" class="node"><title>6</title>
508
1373
<a xlink:href="../www.zorba-xquery.com_modules_store_dynamic_collections_ddl.html" xlink:title="(Zorba-core) module uri=http://www.zorba-xquery.com/modules/store/dynamic/collections/ddl">
1373
<a xlink:href="../zorba.io_modules_store_dynamic_collections_ddl.html" xlink:title="(Zorba-core) module uri=http://zorba.io/modules/store/dynamic/collections/ddl">
509
1374
<ellipse fill="white" stroke="white" cx="6457" cy="-407" rx="27" ry="18.3848"/>
1374
<ellipse fill="white" stroke="white" cx="6457" cy="-407" rx="27" ry="18.3848"/>
510
1375
<text text-anchor="middle" x="6457" y="-403.4" font-family="Times Roman,serif" font-size="14.00" fill="red">ddl</text>
1375
<text text-anchor="middle" x="6457" y="-403.4" font-family="Times Roman,serif" font-size="14.00" fill="red">ddl</text>
511
1376
</a>
1376
</a>
512
1377
</g>
1377
</g>
513
1378
<!-- 7 -->
1378
<!-- 7 -->
514
1379
<g id="node88" class="node"><title>7</title>
1379
<g id="node88" class="node"><title>7</title>
516
1380
<a xlink:href="../www.zorba-xquery.com_modules_store_dynamic_collections_dml.html" xlink:title="(Zorba-core) module uri=http://www.zorba-xquery.com/modules/store/dynamic/collections/dml">
1380
<a xlink:href="../zorba.io_modules_store_dynamic_collections_dml.html" xlink:title="(Zorba-core) module uri=http://zorba.io/modules/store/dynamic/collections/dml">
517
1381
<ellipse fill="white" stroke="white" cx="6459" cy="-571" rx="28.9914" ry="18.3848"/>
1381
<ellipse fill="white" stroke="white" cx="6459" cy="-571" rx="28.9914" ry="18.3848"/>
518
1382
<text text-anchor="middle" x="6459" y="-567.4" font-family="Times Roman,serif" font-size="14.00" fill="red">dml</text>
1382
<text text-anchor="middle" x="6459" y="-567.4" font-family="Times Roman,serif" font-size="14.00" fill="red">dml</text>
519
1383
</a>
1383
</a>
520
1384
</g>
1384
</g>
521
1385
<!-- 10 -->
1385
<!-- 10 -->
522
1386
<g id="node90" class="node"><title>10</title>
1386
<g id="node90" class="node"><title>10</title>
524
1387
<a xlink:href="../www.zorba-xquery.com_modules_store_static_collections_ddl.html" xlink:title="(Zorba-core) module uri=http://www.zorba-xquery.com/modules/store/static/collections/ddl">
1387
<a xlink:href="../zorba.io_modules_store_static_collections_ddl.html" xlink:title="(Zorba-core) module uri=http://zorba.io/modules/store/static/collections/ddl">
525
1388
<ellipse fill="white" stroke="white" cx="6891" cy="-701" rx="27" ry="18.3848"/>
1388
<ellipse fill="white" stroke="white" cx="6891" cy="-701" rx="27" ry="18.3848"/>
526
1389
<text text-anchor="middle" x="6891" y="-697.4" font-family="Times Roman,serif" font-size="14.00" fill="red">ddl</text>
1389
<text text-anchor="middle" x="6891" y="-697.4" font-family="Times Roman,serif" font-size="14.00" fill="red">ddl</text>
527
1390
</a>
1390
</a>
528
1391
</g>
1391
</g>
529
1392
<!-- 11 -->
1392
<!-- 11 -->
530
1393
<g id="node92" class="node"><title>11</title>
1393
<g id="node92" class="node"><title>11</title>
532
1394
<a xlink:href="../www.zorba-xquery.com_modules_store_static_collections_dml.html" xlink:title="(Zorba-core) module uri=http://www.zorba-xquery.com/modules/store/static/collections/dml">
1394
<a xlink:href="../zorba.io_modules_store_static_collections_dml.html" xlink:title="(Zorba-core) module uri=http://zorba.io/modules/store/static/collections/dml">
533
1395
<ellipse fill="white" stroke="white" cx="6706" cy="-701" rx="28.9914" ry="18.3848"/>
1395
<ellipse fill="white" stroke="white" cx="6706" cy="-701" rx="28.9914" ry="18.3848"/>
534
1396
<text text-anchor="middle" x="6706" y="-697.4" font-family="Times Roman,serif" font-size="14.00" fill="red">dml</text>
1396
<text text-anchor="middle" x="6706" y="-697.4" font-family="Times Roman,serif" font-size="14.00" fill="red">dml</text>
535
1397
</a>
1397
</a>
536
1398
</g>
1398
</g>
537
1399
<!-- 8 -->
1399
<!-- 8 -->
538
1400
<g id="node94" class="node"><title>8</title>
1400
<g id="node94" class="node"><title>8</title>
540
1401
<a xlink:href="../www.zorba-xquery.com_modules_store_dynamic_collections_w3c_ddl.html" xlink:title="(Zorba-core) module uri=http://www.zorba-xquery.com/modules/store/dynamic/collections/w3c/ddl">
1401
<a xlink:href="../zorba.io_modules_store_dynamic_collections_w3c_ddl.html" xlink:title="(Zorba-core) module uri=http://zorba.io/modules/store/dynamic/collections/w3c/ddl">
541
1402
<ellipse fill="white" stroke="white" cx="6674" cy="-571" rx="27" ry="18.3848"/>
1402
<ellipse fill="white" stroke="white" cx="6674" cy="-571" rx="27" ry="18.3848"/>
542
1403
<text text-anchor="middle" x="6674" y="-567.4" font-family="Times Roman,serif" font-size="14.00" fill="red">ddl</text>
1403
<text text-anchor="middle" x="6674" y="-567.4" font-family="Times Roman,serif" font-size="14.00" fill="red">ddl</text>
543
1404
</a>
1404
</a>
544
1405
</g>
1405
</g>
545
1406
<!-- 8&#45;&gt;6 -->
1406
<!-- 8&#45;&gt;6 -->
546
1407
<g id="edge173" class="edge"><title>8-&gt;6</title>
1407
<g id="edge173" class="edge"><title>8-&gt;6</title>
548
1408
<a xlink:title="FROM: http://www.zorba-xquery.com/modules/store/dynamic/collections/w3c/ddl, TO: http://www.zorba-xquery.com/modules/store/dynamic/collections/ddl">
1408
<a xlink:title="FROM: http://zorba.io/modules/store/dynamic/collections/w3c/ddl, TO: http://zorba.io/modules/store/dynamic/collections/ddl">
549
1409
<path fill="none" stroke="black" d="M6658.01,-555.967C6651.08,-549.633 6642.79,-542.287 6635,-536 6583.67,-494.557 6520.51,-450.268 6484.89,-425.87"/>
1409
<path fill="none" stroke="black" d="M6658.01,-555.967C6651.08,-549.633 6642.79,-542.287 6635,-536 6583.67,-494.557 6520.51,-450.268 6484.89,-425.87"/>
550
1410
<polygon fill="black" stroke="black" points="6486.69,-422.858 6476.45,-420.11 6482.74,-428.639 6486.69,-422.858"/>
1410
<polygon fill="black" stroke="black" points="6486.69,-422.858 6476.45,-420.11 6482.74,-428.639 6486.69,-422.858"/>
551
1411
</a>
1411
</a>
552
1412
</g>
1412
</g>
553
1413
<!-- 9 -->
1413
<!-- 9 -->
554
1414
<g id="node96" class="node"><title>9</title>
1414
<g id="node96" class="node"><title>9</title>
556
1415
<a xlink:href="../www.zorba-xquery.com_modules_store_dynamic_collections_w3c_dml.html" xlink:title="(Zorba-core) module uri=http://www.zorba-xquery.com/modules/store/dynamic/collections/w3c/dml">
1415
<a xlink:href="../zorba.io_modules_store_dynamic_collections_w3c_dml.html" xlink:title="(Zorba-core) module uri=http://zorba.io/modules/store/dynamic/collections/w3c/dml">
557
1416
<ellipse fill="white" stroke="white" cx="6513" cy="-701" rx="28.9914" ry="18.3848"/>
1416
<ellipse fill="white" stroke="white" cx="6513" cy="-701" rx="28.9914" ry="18.3848"/>
558
1417
<text text-anchor="middle" x="6513" y="-697.4" font-family="Times Roman,serif" font-size="14.00" fill="red">dml</text>
1417
<text text-anchor="middle" x="6513" y="-697.4" font-family="Times Roman,serif" font-size="14.00" fill="red">dml</text>
559
1418
</a>
1418
</a>
560
1419
</g>
1419
</g>
561
1420
<!-- 9&#45;&gt;7 -->
1420
<!-- 9&#45;&gt;7 -->
562
1421
<g id="edge177" class="edge"><title>9-&gt;7</title>
1421
<g id="edge177" class="edge"><title>9-&gt;7</title>
564
1422
<a xlink:title="FROM: http://www.zorba-xquery.com/modules/store/dynamic/collections/w3c/dml, TO: http://www.zorba-xquery.com/modules/store/dynamic/collections/dml">
1422
<a xlink:title="FROM: http://zorba.io/modules/store/dynamic/collections/w3c/dml, TO: http://zorba.io/modules/store/dynamic/collections/dml">
565
1423
<path fill="none" stroke="black" d="M6505.49,-682.924C6496.38,-660.998 6480.94,-623.818 6470.37,-598.372"/>
1423
<path fill="none" stroke="black" d="M6505.49,-682.924C6496.38,-660.998 6480.94,-623.818 6470.37,-598.372"/>
566
1424
<polygon fill="black" stroke="black" points="6473.51,-596.815 6466.44,-588.922 6467.05,-599.5 6473.51,-596.815"/>
1424
<polygon fill="black" stroke="black" points="6473.51,-596.815 6466.44,-588.922 6467.05,-599.5 6473.51,-596.815"/>
567
1425
</a>
1425
</a>
568
1426
</g>
1426
</g>
569
1427
<!-- 9&#45;&gt;8 -->
1427
<!-- 9&#45;&gt;8 -->
570
1428
<g id="edge175" class="edge"><title>9-&gt;8</title>
1428
<g id="edge175" class="edge"><title>9-&gt;8</title>
572
1429
<a xlink:title="FROM: http://www.zorba-xquery.com/modules/store/dynamic/collections/w3c/dml, TO: http://www.zorba-xquery.com/modules/store/dynamic/collections/w3c/ddl">
1429
<a xlink:title="FROM: http://zorba.io/modules/store/dynamic/collections/w3c/dml, TO: http://zorba.io/modules/store/dynamic/collections/w3c/ddl">
573
1430
<path fill="none" stroke="black" d="M6537.85,-691.343C6556.92,-684.052 6583.98,-673.974 6608,-666 6619.88,-662.057 6625.58,-666.241 6635,-658 6652.42,-642.757 6662.45,-618.201 6667.96,-599.059"/>
1430
<path fill="none" stroke="black" d="M6537.85,-691.343C6556.92,-684.052 6583.98,-673.974 6608,-666 6619.88,-662.057 6625.58,-666.241 6635,-658 6652.42,-642.757 6662.45,-618.201 6667.96,-599.059"/>
574
1431
<polygon fill="black" stroke="black" points="6671.36,-599.908 6670.51,-589.347 6664.59,-598.13 6671.36,-599.908"/>
1431
<polygon fill="black" stroke="black" points="6671.36,-599.908 6670.51,-589.347 6664.59,-598.13 6671.36,-599.908"/>
575
1432
</a>
1432
</a>
576
@@ -1440,14 +1440,14 @@
577
1440
</g>
1440
</g>
578
1441
<!-- 53&#45;&gt;6 -->
1441
<!-- 53&#45;&gt;6 -->
579
1442
<g id="edge227" class="edge"><title>53-&gt;6</title>
1442
<g id="edge227" class="edge"><title>53-&gt;6</title>
581
1443
<a xlink:title="FROM: http://zorba.io/modules/queue, TO: http://www.zorba-xquery.com/modules/store/dynamic/collections/ddl">
1443
<a xlink:title="FROM: http://zorba.io/modules/queue, TO: http://zorba.io/modules/store/dynamic/collections/ddl">
582
1444
<path fill="none" stroke="black" d="M6263.39,-683.153C6284.43,-652.861 6328.51,-589.462 6366,-536 6391.34,-499.867 6420.8,-458.155 6439.18,-432.176"/>
1444
<path fill="none" stroke="black" d="M6263.39,-683.153C6284.43,-652.861 6328.51,-589.462 6366,-536 6391.34,-499.867 6420.8,-458.155 6439.18,-432.176"/>
583
1445
<polygon fill="black" stroke="black" points="6442.27,-433.862 6445.19,-423.678 6436.56,-429.819 6442.27,-433.862"/>
1445
<polygon fill="black" stroke="black" points="6442.27,-433.862 6445.19,-423.678 6436.56,-429.819 6442.27,-433.862"/>
584
1446
</a>
1446
</a>
585
1447
</g>
1447
</g>
586
1448
<!-- 53&#45;&gt;7 -->
1448
<!-- 53&#45;&gt;7 -->
587
1449
<g id="edge229" class="edge"><title>53-&gt;7</title>
1449
<g id="edge229" class="edge"><title>53-&gt;7</title>
589
1450
<a xlink:title="FROM: http://zorba.io/modules/queue, TO: http://www.zorba-xquery.com/modules/store/dynamic/collections/dml">
1450
<a xlink:title="FROM: http://zorba.io/modules/queue, TO: http://zorba.io/modules/store/dynamic/collections/dml">
590
1451
<path fill="none" stroke="black" d="M6274.11,-685.496C6283.36,-679.355 6294.14,-672.275 6304,-666 6347.14,-638.547 6397.75,-607.795 6429.1,-588.913"/>
1451
<path fill="none" stroke="black" d="M6274.11,-685.496C6283.36,-679.355 6294.14,-672.275 6304,-666 6347.14,-638.547 6397.75,-607.795 6429.1,-588.913"/>
591
1452
<polygon fill="black" stroke="black" points="6431.04,-591.837 6437.8,-583.683 6427.43,-585.838 6431.04,-591.837"/>
1452
<polygon fill="black" stroke="black" points="6431.04,-591.837 6437.8,-583.683 6427.43,-585.838 6431.04,-591.837"/>
592
1453
</a>
1453
</a>
593
@@ -1461,14 +1461,14 @@
594
1461
</g>
1461
</g>
595
1462
<!-- 51&#45;&gt;6 -->
1462
<!-- 51&#45;&gt;6 -->
596
1463
<g id="edge223" class="edge"><title>51-&gt;6</title>
1463
<g id="edge223" class="edge"><title>51-&gt;6</title>
598
1464
<a xlink:title="FROM: http://zorba.io/modules/stack, TO: http://www.zorba-xquery.com/modules/store/dynamic/collections/ddl">
1464
<a xlink:title="FROM: http://zorba.io/modules/stack, TO: http://zorba.io/modules/store/dynamic/collections/ddl">
599
1465
<path fill="none" stroke="black" d="M6359.51,-682.609C6377.2,-632.579 6426.29,-493.805 6447.28,-434.475"/>
1465
<path fill="none" stroke="black" d="M6359.51,-682.609C6377.2,-632.579 6426.29,-493.805 6447.28,-434.475"/>
600
1466
<polygon fill="black" stroke="black" points="6450.59,-435.603 6450.63,-425.009 6443.99,-433.269 6450.59,-435.603"/>
1466
<polygon fill="black" stroke="black" points="6450.59,-435.603 6450.63,-425.009 6443.99,-433.269 6450.59,-435.603"/>
601
1467
</a>
1467
</a>
602
1468
</g>
1468
</g>
603
1469
<!-- 51&#45;&gt;7 -->
1469
<!-- 51&#45;&gt;7 -->
604
1470
<g id="edge225" class="edge"><title>51-&gt;7</title>
1470
<g id="edge225" class="edge"><title>51-&gt;7</title>
606
1471
<a xlink:title="FROM: http://zorba.io/modules/stack, TO: http://www.zorba-xquery.com/modules/store/dynamic/collections/dml">
1471
<a xlink:title="FROM: http://zorba.io/modules/stack, TO: http://zorba.io/modules/store/dynamic/collections/dml">
607
1472
<path fill="none" stroke="black" d="M6367.08,-683.737C6385.57,-661.052 6418.17,-621.077 6439.16,-595.331"/>
1472
<path fill="none" stroke="black" d="M6367.08,-683.737C6385.57,-661.052 6418.17,-621.077 6439.16,-595.331"/>
608
1473
<polygon fill="black" stroke="black" points="6441.93,-597.474 6445.54,-587.512 6436.5,-593.05 6441.93,-597.474"/>
1473
<polygon fill="black" stroke="black" points="6441.93,-597.474 6445.54,-587.512 6436.5,-593.05 6441.93,-597.474"/>
609
1474
</a>
1474
</a>
610
@@ -1482,35 +1482,35 @@
611
1482
</g>
1482
</g>
612
1483
<!-- 5 -->
1483
<!-- 5 -->
613
1484
<g id="node105" class="node"><title>5</title>
1484
<g id="node105" class="node"><title>5</title>
615
1485
<a xlink:href="../www.zorba-xquery.com_modules_store_dynamic_documents.html" xlink:title="(Zorba-core) module uri=http://www.zorba-xquery.com/modules/store/dynamic/documents">
1485
<a xlink:href="../zorba.io_modules_store_dynamic_documents.html" xlink:title="(Zorba-core) module uri=http://zorba.io/modules/store/documents">
616
1486
<ellipse fill="white" stroke="white" cx="5907" cy="-701" rx="65.0538" ry="18.3848"/>
1486
<ellipse fill="white" stroke="white" cx="5907" cy="-701" rx="65.0538" ry="18.3848"/>
617
1487
<text text-anchor="middle" x="5907" y="-697.4" font-family="Times Roman,serif" font-size="14.00" fill="red">documents</text>
1487
<text text-anchor="middle" x="5907" y="-697.4" font-family="Times Roman,serif" font-size="14.00" fill="red">documents</text>
618
1488
</a>
1488
</a>
619
1489
</g>
1489
</g>
620
1490
<!-- 12 -->
1490
<!-- 12 -->
621
1491
<g id="node108" class="node"><title>12</title>
1491
<g id="node108" class="node"><title>12</title>
623
1492
<a xlink:href="../www.zorba-xquery.com_modules_store_static_indexes_ddl.html" xlink:title="(Zorba-core) module uri=http://www.zorba-xquery.com/modules/store/static/indexes/ddl">
1492
<a xlink:href="../zorba.io_modules_store_static_indexes_ddl.html" xlink:title="(Zorba-core) module uri=http://zorba.io/modules/store/static/indexes/ddl">
624
1493
<ellipse fill="white" stroke="white" cx="5734" cy="-701" rx="27" ry="18.3848"/>
1493
<ellipse fill="white" stroke="white" cx="5734" cy="-701" rx="27" ry="18.3848"/>
625
1494
<text text-anchor="middle" x="5734" y="-697.4" font-family="Times Roman,serif" font-size="14.00" fill="red">ddl</text>
1494
<text text-anchor="middle" x="5734" y="-697.4" font-family="Times Roman,serif" font-size="14.00" fill="red">ddl</text>
626
1495
</a>
1495
</a>
627
1496
</g>
1496
</g>
628
1497
<!-- 13 -->
1497
<!-- 13 -->
629
1498
<g id="node110" class="node"><title>13</title>
1498
<g id="node110" class="node"><title>13</title>
631
1499
<a xlink:href="../www.zorba-xquery.com_modules_store_static_indexes_dml.html" xlink:title="(Zorba-core) module uri=http://www.zorba-xquery.com/modules/store/static/indexes/dml">
1499
<a xlink:href="../zorba.io_modules_store_static_indexes_dml.html" xlink:title="(Zorba-core) module uri=http://zorba.io/modules/store/static/indexes/dml">
632
1500
<ellipse fill="white" stroke="white" cx="5549" cy="-701" rx="28.9914" ry="18.3848"/>
1500
<ellipse fill="white" stroke="white" cx="5549" cy="-701" rx="28.9914" ry="18.3848"/>
633
1501
<text text-anchor="middle" x="5549" y="-697.4" font-family="Times Roman,serif" font-size="14.00" fill="red">dml</text>
1501
<text text-anchor="middle" x="5549" y="-697.4" font-family="Times Roman,serif" font-size="14.00" fill="red">dml</text>
634
1502
</a>
1502
</a>
635
1503
</g>
1503
</g>
636
1504
<!-- 14 -->
1504
<!-- 14 -->
637
1505
<g id="node113" class="node"><title>14</title>
1505
<g id="node113" class="node"><title>14</title>
639
1506
<a xlink:href="../www.zorba-xquery.com_modules_store_static_integrity_constraints_ddl.html" xlink:title="(Zorba-core) module uri=http://www.zorba-xquery.com/modules/store/static/integrity_constraints/ddl">
1506
<a xlink:href="../zorba.io_modules_store_static_integrity_constraints_ddl.html" xlink:title="(Zorba-core) module uri=http://zorba.io/modules/store/static/integrity_constraints/ddl">
640
1507
<ellipse fill="white" stroke="white" cx="5347" cy="-701" rx="27" ry="18.3848"/>
1507
<ellipse fill="white" stroke="white" cx="5347" cy="-701" rx="27" ry="18.3848"/>
641
1508
<text text-anchor="middle" x="5347" y="-697.4" font-family="Times Roman,serif" font-size="14.00" fill="red">ddl</text>
1508
<text text-anchor="middle" x="5347" y="-697.4" font-family="Times Roman,serif" font-size="14.00" fill="red">ddl</text>
642
1509
</a>
1509
</a>
643
1510
</g>
1510
</g>
644
1511
<!-- 15 -->
1511
<!-- 15 -->
645
1512
<g id="node115" class="node"><title>15</title>
1512
<g id="node115" class="node"><title>15</title>
647
1513
<a xlink:href="../www.zorba-xquery.com_modules_store_static_integrity_constraints_dml.html" xlink:title="(Zorba-core) module uri=http://www.zorba-xquery.com/modules/store/static/integrity_constraints/dml">
1513
<a xlink:href="../zorba.io_modules_store_static_integrity_constraints_dml.html" xlink:title="(Zorba-core) module uri=http://zorba.io/modules/store/static/integrity_constraints/dml">
648
1514
<ellipse fill="white" stroke="white" cx="5162" cy="-701" rx="28.9914" ry="18.3848"/>
1514
<ellipse fill="white" stroke="white" cx="5162" cy="-701" rx="28.9914" ry="18.3848"/>
649
1515
<text text-anchor="middle" x="5162" y="-697.4" font-family="Times Roman,serif" font-size="14.00" fill="red">dml</text>
1515
<text text-anchor="middle" x="5162" y="-697.4" font-family="Times Roman,serif" font-size="14.00" fill="red">dml</text>
650
1516
</a>
1516
</a>
651
@@ -2210,4 +2210,4 @@
652
2210
</a>
2210
</a>
653
2211
</g>
2211
</g>
654
2212
</g>
2212
</g>
655
2213
</svg>
656
2214
\ No newline at end of file
2213
\ No newline at end of file
657
2214
</svg>
658
2215
2215
659
=== modified file 'doc/zorba/xqdoc/src/zorba_module_dependencies.xqy'
660
--- doc/zorba/xqdoc/src/zorba_module_dependencies.xqy	2013-10-16 21:47:22 +0000
661
+++ doc/zorba/xqdoc/src/zorba_module_dependencies.xqy	2013-10-17 02:02:41 +0000
662
@@ -29,8 +29,8 @@
663
29
import module namespace dot   = "http://www.zorba-xquery.com/modules/image/graphviz";
29
import module namespace dot   = "http://www.zorba-xquery.com/modules/image/graphviz";
664
30
import module namespace xqd   = "http://zorba.io/modules/xqdoc";
30
import module namespace xqd   = "http://zorba.io/modules/xqdoc";
665
31
import module namespace fetch = "http://zorba.io/modules/fetch";
31
import module namespace fetch = "http://zorba.io/modules/fetch";
668
32
import module namespace dml   = "http://www.zorba-xquery.com/modules/store/static/collections/dml";
32
import module namespace dml   = "http://zorba.io/modules/store/static/collections/dml";
669
33
import module namespace ddl   = "http://www.zorba-xquery.com/modules/store/static/collections/ddl";
33
import module namespace ddl   = "http://zorba.io/modules/store/static/collections/ddl";
670
34
import module namespace menu  = "http://www.zorba-xquery.com/modules/xqdoc/menu";
34
import module namespace menu  = "http://www.zorba-xquery.com/modules/xqdoc/menu";
671
35
import module namespace xqdoc-html  = "http://www.zorba-xquery.com/xqdoc-html" at "xqdoc-html.xqy";
35
import module namespace xqdoc-html  = "http://www.zorba-xquery.com/xqdoc-html" at "xqdoc-html.xqy";
672
36
36
673
@@ -116,7 +116,7 @@
674
116
        insert node <module uri="{$moduleURI}"
116
        insert node <module uri="{$moduleURI}"
675
117
                            isCore="{data($module/@isCore)}"/> as last into $z:ZorbaManifest;
117
                            isCore="{data($module/@isCore)}"/> as last into $z:ZorbaManifest;
676
118
        
118
        
678
119
        dml:apply-insert-nodes($z:collection, $xqdoc);
119
        dml:apply-insert($z:collection, $xqdoc);
679
120
        
120
        
680
121
      }
121
      }
681
122
    }
122
    }
682
@@ -136,7 +136,7 @@
683
136
136
684
137
declare %an:sequential function z:delete-collections()
137
declare %an:sequential function z:delete-collections()
685
138
{ 
138
{ 
687
139
  dml:delete-nodes(dml:collection(xs:QName("z:collection")));
139
  dml:delete(dml:collection(xs:QName("z:collection")));
688
140
  ddl:delete(xs:QName("z:collection"));
140
  ddl:delete(xs:QName("z:collection"));
689
141
};
141
};
690
142
142
691
@@ -481,4 +481,4 @@
692
481
  z:edges_modules(),"
481
  z:edges_modules(),"
693
482
  }"
482
  }"
694
483
  )
483
  )
695
484
};
696
485
\ No newline at end of file
484
\ No newline at end of file
697
485
};
698
486
486
699
=== modified file 'modules/com/zorba-xquery/www/modules/CMakeLists.txt'
700
--- modules/com/zorba-xquery/www/modules/CMakeLists.txt	2013-10-16 21:47:22 +0000
701
+++ modules/com/zorba-xquery/www/modules/CMakeLists.txt	2013-10-17 02:02:41 +0000
702
@@ -14,28 +14,6 @@
703
14
14
704
15
# Subdirectories
15
# Subdirectories
705
16
16
706
17
DECLARE_ZORBA_MODULE(FILE store/documents/dynamic.xq VERSION 2.0
707
18
  URI "http://www.zorba-xquery.com/modules/store/dynamic/documents")
708
19
DECLARE_ZORBA_MODULE(FILE store/dynamic/collections/ddl.xq VERSION 2.0
709
20
  URI "http://www.zorba-xquery.com/modules/store/dynamic/collections/ddl")
710
21
DECLARE_ZORBA_MODULE(FILE store/dynamic/collections/dml.xq VERSION 2.0
711
22
  URI "http://www.zorba-xquery.com/modules/store/dynamic/collections/dml")
712
23
DECLARE_ZORBA_MODULE(FILE store/dynamic/collections/w3c/ddl.xq VERSION 2.0
713
24
  URI "http://www.zorba-xquery.com/modules/store/dynamic/collections/w3c/ddl")
714
25
DECLARE_ZORBA_MODULE(FILE store/dynamic/collections/w3c/dml.xq VERSION 2.0
715
26
  URI "http://www.zorba-xquery.com/modules/store/dynamic/collections/w3c/dml")
716
27
DECLARE_ZORBA_MODULE(FILE store/static/collections/ddl.xq VERSION 2.0
717
28
  URI "http://www.zorba-xquery.com/modules/store/static/collections/ddl")
718
29
DECLARE_ZORBA_MODULE(FILE store/static/collections/dml.xq VERSION 2.0
719
30
  URI "http://www.zorba-xquery.com/modules/store/static/collections/dml")
720
31
DECLARE_ZORBA_MODULE(FILE store/static/indexes/ddl.xq VERSION 2.0
721
32
  URI "http://www.zorba-xquery.com/modules/store/static/indexes/ddl")
722
33
DECLARE_ZORBA_MODULE(FILE store/static/indexes/dml.xq VERSION 2.0
723
34
  URI "http://www.zorba-xquery.com/modules/store/static/indexes/dml")
724
35
DECLARE_ZORBA_MODULE(FILE store/static/integrity_constraints/ddl.xq VERSION 2.0
725
36
  URI "http://www.zorba-xquery.com/modules/store/static/integrity_constraints/ddl")
726
37
DECLARE_ZORBA_MODULE(FILE store/static/integrity_constraints/dml.xq VERSION 2.0
727
38
  URI "http://www.zorba-xquery.com/modules/store/static/integrity_constraints/dml")
728
39
DECLARE_ZORBA_MODULE(FILE xqdoc/batch.xq VERSION 2.0
17
DECLARE_ZORBA_MODULE(FILE xqdoc/batch.xq VERSION 2.0
729
40
  URI "http://www.zorba-xquery.com/modules/xqdoc/batch")
18
  URI "http://www.zorba-xquery.com/modules/xqdoc/batch")
730
41
DECLARE_ZORBA_MODULE(FILE xqdoc/html.xq VERSION 2.0
19
DECLARE_ZORBA_MODULE(FILE xqdoc/html.xq VERSION 2.0
731
42
20
732
=== removed directory 'modules/com/zorba-xquery/www/modules/store'
733
=== removed directory 'modules/com/zorba-xquery/www/modules/store/data-structures'
734
=== removed directory 'modules/com/zorba-xquery/www/modules/store/documents'
735
=== modified file 'modules/store/CMakeLists.txt'
736
--- modules/store/CMakeLists.txt	2013-08-24 23:44:26 +0000
737
+++ modules/store/CMakeLists.txt	2013-10-17 02:02:41 +0000
738
@@ -14,3 +14,29 @@
739
14
14
740
15
DECLARE_ZORBA_MODULE(FILE unordered-maps.xq VERSION 1.0
15
DECLARE_ZORBA_MODULE(FILE unordered-maps.xq VERSION 1.0
741
16
  URI "http://zorba.io/modules/unordered-maps")
16
  URI "http://zorba.io/modules/unordered-maps")
742
17
743
18
DECLARE_ZORBA_MODULE(FILE documents.xq VERSION 2.0
744
19
  URI "http://zorba.io/modules/store/documents")
745
20
746
21
DECLARE_ZORBA_MODULE(FILE dynamic/collections/ddl.xq VERSION 2.0
747
22
  URI "http://zorba.io/modules/store/dynamic/collections/ddl")
748
23
DECLARE_ZORBA_MODULE(FILE dynamic/collections/dml.xq VERSION 2.0
749
24
  URI "http://zorba.io/modules/store/dynamic/collections/dml")
750
25
DECLARE_ZORBA_MODULE(FILE dynamic/collections/w3c/ddl.xq VERSION 2.0
751
26
  URI "http://zorba.io/modules/store/dynamic/collections/w3c/ddl")
752
27
DECLARE_ZORBA_MODULE(FILE dynamic/collections/w3c/dml.xq VERSION 2.0
753
28
  URI "http://zorba.io/modules/store/dynamic/collections/w3c/dml")
754
29
DECLARE_ZORBA_MODULE(FILE static/collections/ddl.xq VERSION 2.0
755
30
  URI "http://zorba.io/modules/store/static/collections/ddl")
756
31
DECLARE_ZORBA_MODULE(FILE static/collections/dml.xq VERSION 2.0
757
32
  URI "http://zorba.io/modules/store/static/collections/dml")
758
33
DECLARE_ZORBA_MODULE(FILE static/indexes/ddl.xq VERSION 2.0
759
34
  URI "http://zorba.io/modules/store/static/indexes/ddl")
760
35
DECLARE_ZORBA_MODULE(FILE static/indexes/dml.xq VERSION 2.0
761
36
  URI "http://zorba.io/modules/store/static/indexes/dml")
762
37
DECLARE_ZORBA_MODULE(FILE static/integrity-constraints/ddl.xq VERSION 2.0
763
38
  URI "http://zorba.io/modules/store/static/integrity-constraints/ddl")
764
39
DECLARE_ZORBA_MODULE(FILE static/integrity-constraints/dml.xq VERSION 2.0
765
40
  URI "http://zorba.io/modules/store/static/integrity-constraints/dml")
766
41
767
42
# vim:set et sw=2 ts=2:
768
17
43
769
=== renamed file 'modules/com/zorba-xquery/www/modules/store/documents/dynamic.xq' => 'modules/store/documents.xq'
770
--- modules/com/zorba-xquery/www/modules/store/documents/dynamic.xq	2013-09-26 23:15:11 +0000
771
+++ modules/store/documents.xq	2013-10-17 02:02:41 +0000
772
@@ -1,7 +1,7 @@
773
1
xquery version "3.0";
1
xquery version "3.0";
774
2
2
775
3
(:
3
(:
777
4
 : Copyright 2006-2009 The FLWOR Foundation.
4
 : Copyright 2006-2013 The FLWOR Foundation.
778
5
 :
5
 :
779
6
 : Licensed under the Apache License, Version 2.0 (the "License");
6
 : Licensed under the Apache License, Version 2.0 (the "License");
780
7
 : you may not use this file except in compliance with the License.
7
 : you may not use this file except in compliance with the License.
781
@@ -20,100 +20,114 @@
782
20
 : This module defines a set of functions which manage documents that
20
 : This module defines a set of functions which manage documents that
783
21
 : are persisted in the store. Specifically, it contains functions
21
 : are persisted in the store. Specifically, it contains functions
784
22
 : to put, remove, list, or retrieve documents.
22
 : to put, remove, list, or retrieve documents.
788
23
 :
23
 : <p/>
789
24
 : <p>Please refer to <a href="../zorba/data_lifecycle.html">our documentation</a> for 
24
 : Please refer to <a href="../zorba/data_lifecycle.html">our documentation</a>
790
25
 : more information about the lifecycle management and manipulation of documents.</p>
25
 : for more information about the lifecycle management and manipulation of
791
26
 : documents.
792
26
 :
27
 :
793
27
 : @see <a href="../zorba/data_lifecycle.html">Data Lifecycle</a>
28
 : @see <a href="../zorba/data_lifecycle.html">Data Lifecycle</a>
794
28
 : @see http://zorba.io/errors
29
 : @see http://zorba.io/errors
795
29
 :
796
30
 : @author Matthias Brantner, David Graf, Till Westmann, Markos Zaharioudakis
30
 : @author Matthias Brantner, David Graf, Till Westmann, Markos Zaharioudakis
797
31
 :
798
32
 : @project Zorba/Data Store/Documents
31
 : @project Zorba/Data Store/Documents
799
33
 :)
32
 :)
801
34
module namespace doc = "http://www.zorba-xquery.com/modules/store/dynamic/documents";
33
module namespace doc = "http://zorba.io/modules/store/documents";
802
35
34
803
36
declare namespace zerr = "http://zorba.io/errors";
35
declare namespace zerr = "http://zorba.io/errors";
804
37
declare namespace err = "http://www.w3.org/2005/xqt-errors";
36
declare namespace err = "http://www.w3.org/2005/xqt-errors";
805
38
declare namespace ver = "http://zorba.io/options/versioning";
37
declare namespace ver = "http://zorba.io/options/versioning";
806
39
declare option ver:module-version "2.0";
38
declare option ver:module-version "2.0";
807
40
39
852
41
(:~
40
(:===========================================================================:)
853
42
 : Adds a document to the store. The document is bound to the URI
41
854
43
 : given as first parameter. This URI is the name of the document and
42
(:~
855
44
 : can be used by the doc:document() function to retrieve
43
 : Retrieves a sequence of URIs of documents bound in the store.
856
45
 : the document from the store.
44
 :
857
46
 :
45
 : @return The list of URIs of the available documents in the store or the
858
47
 : The semantics of the function is similar to the fn:put function. The difference
46
 : empty sequence if none.
859
48
 : is that this function accepts only document nodes as parameters.
47
 :)
860
49
 : Please note that this function does not try to fetch the document from the
48
declare function doc:available-documents()
861
50
 : external resource identified by $uri. Instead, the file or http-client
49
  as xs:string* external;
862
51
 : modules can be used to retrieve the resource as string and fn:parse-xml can be used
50
863
52
 : to parse the string returning a document.
51
(:~
864
53
 :
52
 : Gets the document with the given URI from the store.
821
54
 : @param $uri The URI of the document. If a relative URI is given, the URI
822
55
 :        is made absolute using the static base URI of the module.
823
56
 : @param $doc The document node to be added to the store.
824
57
 :
825
58
 : @return an empty XDM instance and a pending update list which, when
826
59
 :         applied, adds the given document to the store.
827
60
 :
828
61
 : @error zerr:ZAPI0020 if the store already contains a document for the given $uri.
829
62
 : @error err:FODC0004 if the given URI is not valid or couldn't be absolutized.
830
63
 :
831
64
 :)
832
65
declare updating function doc:put(
833
66
  $uri as xs:string,
834
67
  $doc as document-node()) external;
835
68
836
69
(:~
837
70
 : Removes the document with the given URI from the store.
838
71
 :
839
72
 : @param $uri The URI of the document to remove. If a relative URI is given,
840
73
 : the URI is made absolute using the static base URI of the module.
841
74
842
75
 : @return Returns an empty XDM instance and a pending update list which, when
843
76
 :         applied, removes the document bound to the given URI.
844
77
 :
845
78
 : @error zerr:ZXQD0002 if no document with the given URI exists in the store.
846
79
 : @error err:FODC0004 if the given URI is not valid or couldn't be absolutized.
847
80
 :)
848
81
declare updating function doc:remove($uri as xs:string) external;
849
82
850
83
(:~
851
84
 : Returns the document with the given URI from the store.
865
85
 :
53
 :
866
86
 : The difference to fn:doc is that this function does not attempt to retrieve
54
 : The difference to fn:doc is that this function does not attempt to retrieve
867
87
 : the resource from the file system or the web before returning it.
55
 : the resource from the file system or the web before returning it.
868
88
 : Its only responsibility is to return the document from the store that was
56
 : Its only responsibility is to return the document from the store that was
869
89
 : bound using fn:put or doc:put.
57
 : bound using fn:put or doc:put.
870
90
 :
58
 :
874
91
 : @param $uri The URI of the document to retrieve. If a relative URI is given,
59
 : @param $uri The URI of the document to retrieve.
875
92
 : the URI is made absolute using the static base URI of the module.
60
 : If a relative URI is given, the URI is made absolute using the static base
876
93
 :
61
 : URI of the module.
877
94
 : @return Returns the document bound to the given URI.
62
 : @return Returns the document bound to the given URI.
878
95
 :
879
96
 : @error zerr:ZXQD0002 if no document with the given URI exists in the store.
63
 : @error zerr:ZXQD0002 if no document with the given URI exists in the store.
891
97
 : @error err:FODC0004 if the given URI is not valid or couldn't be absolutized.
64
 : @error err:FODC0004 if the given URI is not valid or couldn't be made
892
98
 :)
65
 : absolute.
893
99
declare function doc:document($uri as xs:string) as document-node() external;
66
 :)
894
100
67
declare function doc:document( $uri as xs:string )
895
101
(:~
68
  as document-node() external;
885
102
 : Retrieves a sequence of URIs of documents bound in the store.
886
103
 :
887
104
 : @return The list of URIs of the available documents in the store. The empty
888
105
 :         sequence is returned if not document exists in the store.
889
106
 :)
890
107
declare function doc:available-documents() as xs:string* external;
896
108
69
897
109
(:~
70
(:~
898
110
 : Returns true if a document with the given URI exists in the store.
71
 : Returns true if a document with the given URI exists in the store.
899
111
 :
72
 :
901
112
 : @param $uri The URI of the document to check for. If a relative URI is given,
73
 : @param $uri The URI of the document to check for.
902
74
 : If a relative URI is given, the URI is made absolute using the static base
903
75
 : URI of the module.
904
76
 :
905
77
 : @return Returns true if a document with the given URI exists in the store or
906
78
 : false otherwise.
907
79
 : @error err:FODC0004 if the given URI is not valid or couldn't be made
908
80
 : absolute.
909
81
 :)
910
82
declare function doc:is-available-document( $uri as xs:string )
911
83
  as xs:boolean external;
912
84
913
85
(:~
914
86
 : Adds a document to the store.
915
87
 : The document is bound to the URI given as first parameter.
916
88
 : This URI is the name of the document and can be used by the
917
89
 : <code>doc:document()</code> function to retrieve the document from the
918
90
 : store.
919
91
 : <p/>
920
92
 : The semantics of the function is similar to the <code>fn:put()</code>
921
93
 : function.
922
94
 : The difference is that this function accepts only document nodes as
923
95
 : parameters.
924
96
 : Please note that this function does not try to fetch the document from the
925
97
 : external resource identified by the URI.
926
98
 : Instead, the file or http-client modules can be used to retrieve the
927
99
 : resource as string and <code>fn:parse-xml()</code> can be used to parse the
928
100
 : string returning a document.
929
101
 :
930
102
 : @param $uri The URI of the document.
931
103
 : If a relative URI is given, the URI is made absolute using the static base
932
104
 : URI of the module.
933
105
 : @param $doc The document node to be added to the store.
934
106
 : @return An empty XDM instance and a pending update list that, when applied,
935
107
 : adds the given document to the store.
936
108
 : @error zerr:ZAPI0020 if the store already contains a document for the given
937
109
 : URI.
938
110
 : @error err:FODC0004 if the given URI is not valid or couldn't be made
939
111
 : absolute.
940
112
 :)
941
113
declare updating function doc:put( $uri as xs:string,
942
114
                                   $doc as document-node() )
943
115
  external;
944
116
945
117
(:~
946
118
 : Removes the document with the given URI from the store.
947
119
 :
948
120
 : @param $uri The URI of the document to remove. If a relative URI is given,
949
113
 : the URI is made absolute using the static base URI of the module.
121
 : the URI is made absolute using the static base URI of the module.
954
114
 :
122
 : @return Returns an empty XDM instance and a pending update list that, when
955
115
 : @return Returns true if a document with the given URI exists in the store or false otherwise.
123
 : applied, removes the document bound to the given URI.
956
116
 :
124
 : @error zerr:ZXQD0002 if no document with the given URI exists in the store.
957
117
 : @error err:FODC0004 if the given URI is not valid or couldn't be absolutized.
125
 : @error err:FODC0004 if the given URI is not valid or couldn't be made
958
126
 : absolute.
959
118
 :)
127
 :)
961
119
declare function doc:is-available-document($uri as xs:string) as xs:boolean external;
128
declare updating function doc:remove( $uri as xs:string )
962
129
  external;
963
130
964
131
(:===========================================================================:)
965
132
966
133
(: vim:set et sw=2 ts=2: :)
967
120
134
968
=== renamed directory 'modules/com/zorba-xquery/www/modules/store/dynamic' => 'modules/store/dynamic'
969
=== modified file 'modules/store/dynamic/collections/ddl.xq'
970
--- modules/com/zorba-xquery/www/modules/store/dynamic/collections/ddl.xq	2013-09-26 23:15:11 +0000
971
+++ modules/store/dynamic/collections/ddl.xq	2013-10-17 02:02:41 +0000
972
@@ -1,7 +1,7 @@
973
1
xquery version "3.0";
1
xquery version "3.0";
974
2
2
975
3
(:
3
(:
977
4
 : Copyright 2006-2009 The FLWOR Foundation.
4
 : Copyright 2006-2013 The FLWOR Foundation.
978
5
 :
5
 :
979
6
 : Licensed under the Apache License, Version 2.0 (the "License");
6
 : Licensed under the Apache License, Version 2.0 (the "License");
980
7
 : you may not use this file except in compliance with the License.
7
 : you may not use this file except in compliance with the License.
981
@@ -17,103 +17,89 @@
982
17
:)
17
:)
983
18
18
984
19
(:~
19
(:~
991
20
 : This modules defines a set of functions for managing persistent, ordered, and
20
 : This modules defines a set of functions for managing persistent, ordered,
992
21
 : updatable collections.
21
 : and updatable collections.
993
22
 :
22
 : <p/>
994
23
 : <p>Please refer to our documentation for <a href="../zorba/data_lifecycle.html">
23
 : Please refer to our documentation for
995
24
 : more information</a> about the lifecycle management and the manipulation of such
24
 : <a href="../zorba/data_lifecycle.html">more information</a>
996
25
 : collections.</p>
25
 : about the lifecycle management and the manipulation of such collections.
997
26
 :
26
 :
998
27
 : @see <a href="../zorba/data_lifecycle.html">Data Lifecycle</a>
27
 : @see <a href="../zorba/data_lifecycle.html">Data Lifecycle</a>
1000
28
 : @see http://www.zorba-xquery.com/modules/store/dynamic/collections/dml
28
 : @see http://zorba.io/modules/store/dynamic/collections/dml
1001
29
 : @see http://zorba.io/errors
29
 : @see http://zorba.io/errors
1002
30
 :
30
 :
1003
31
 : @author Matthias Brantner, David Graf, Till Westmann, Markos Zaharioudakis
31
 : @author Matthias Brantner, David Graf, Till Westmann, Markos Zaharioudakis
1004
32
 :
1005
33
 : @project Zorba/Data Store/Collections/Dynamic Data Definition
32
 : @project Zorba/Data Store/Collections/Dynamic Data Definition
1006
34
 :
1007
35
 :)
33
 :)
1009
36
module namespace ddl = "http://www.zorba-xquery.com/modules/store/dynamic/collections/ddl";
34
module namespace ddl = "http://zorba.io/modules/store/dynamic/collections/ddl";
1010
37
35
1011
38
declare namespace zerr = "http://zorba.io/errors";
36
declare namespace zerr = "http://zorba.io/errors";
1012
39
declare namespace ver = "http://zorba.io/options/versioning";
37
declare namespace ver = "http://zorba.io/options/versioning";
1013
40
declare option ver:module-version "2.0";
38
declare option ver:module-version "2.0";
1014
41
39
1049
42
40
(:===========================================================================:)
1050
43
(:~
41
1051
44
 : The create function is an updating function which creates
42
(:~
1052
45
 : the collection with the given expanded QName.
43
 : Gets the QNames of the collections that are available, if any.
1053
46
 :
44
 :
1054
47
 : @param $name The QName of the collection to create.
45
 : @return A sequence comprising one QName for each available collection
1055
48
 :
46
 : or an emtpy sequence if no collections are available.
1056
49
 : @return The result of the function is an empty XDM instance and a 
47
 :)
1057
50
 :         pending update list which, once applied, creates a collection
48
declare function ddl:available-collections()
1058
51
 :         with the given name.
49
  as xs:QName* external;
1059
52
 :
50
1060
53
 : @error zerr:ZDDY0002 if a collection with the given expanded QName already
51
(:~
1061
54
 :        exists.
52
 : Creates a collection.
1062
55
 :
53
 :
1063
56
 :)
54
 : @param $name The name of the collection to create.
1064
57
declare updating function ddl:create($name as xs:QName) external;
55
 : @return An empty XDM instance and a pending update list that, once applied,
1065
58
56
 : creates a collection with the given name.
1066
59
57
 : @error zerr:ZDDY0002 if a collection with <code>$name</code> already exists.
1067
60
(:~
58
 :)
1068
61
 : The create function is an updating function which creates
59
declare updating function ddl:create( $name as xs:QName )
1069
62
 : the collection with the given expanded QName. Moreover, it adds copies
60
  external;
1070
63
 : of the sequence $content to the new collection.
61
1071
64
 :
62
(:~
1072
65
 : @param $name The QName of the collection to create.
63
 : Creates a collection and adds the given sequence as content to the new
1073
66
 : @param $content The sequences of items (nodes and/or json items) that should
64
 : collection.
1074
67
 :        be added to the new collection.
65
 :
1075
68
 :
66
 : @param $name The name of the collection to create.
1076
69
 : @return The result of the function is an empty XDM instance and a 
67
 : @param $content The sequence of items (nodes or JSON items)
1077
70
 :         pending update list which, once applied, creates a collection
68
 : to be added to the new collection.
1078
71
 :         with the given name and inserts the given items into it.
69
 : @return An empty XDM instance and a pending update list that, once applied,
1079
72
 :
70
 : creates a collection with the given name and inserts the given items into
1080
73
 : @error zerr:ZDDY0002 if a collection with the given expanded QName already
71
 : it.
1081
74
 :        exists.
72
 : @error zerr:ZDDY0002 if a collection with the given name already exists.
1048
75
 :
1082
76
 : @see ddl:create
73
 : @see ddl:create
1109
77
 : @see ddl:insert-nodes-last
74
 : @see ddl:insert-last
1110
78
 :
75
 :)
1111
79
 :)
76
declare updating function ddl:create( $name as xs:QName,
1112
80
declare updating function ddl:create($name as xs:QName, $content as item()*) external;
77
                                      $content as item()* )
1113
81
78
  external;
1114
82
79
1115
83
(:~
80
(:~
1116
84
 : The delete function is an updating function that removes
81
 : Deletes the collection having the given name.
1117
85
 : the collection with the given expanded QName.
82
 :
1118
86
 :
83
 : @param $name The name of the collection to delete.
1119
87
 : @param $name The QName of the collection to delete.
84
 : @return An empty XDM instance and a pending update list that, once applied,
1120
88
 :
85
 : deletes the collection with the given name.
1121
89
 : @return The result of the function is an empty XDM instance and a pending
86
 : @error zerr:ZDDY0003 if the collection identified by <code>$name</code> is
1122
90
 :         update list which, once applied, deletes the collection with the given
87
 : not available.
1123
91
 :         name.
88
 : @error zerr:ZDDY0015 if any of the in-scope variables references an item
1124
92
 :
89
 : that belongs to the collection with QName <code>$name</code>.
1125
93
 : @error zerr:ZDDY0003 if the collection with the given name does not exist.
90
 :)
1126
94
 : @error zerr:ZDDY0015 if any of the in-scope variables references an item that
91
declare updating function ddl:delete( $name as xs:QName )
1127
95
 :        belongs to the collection with QName $name.
92
  external;
1128
96
 :
93
1129
97
 :)
94
(:~
1130
98
declare updating function ddl:delete($coll as xs:QName) external;
95
 : Gets whether a collection with the given name is available.
1105
99
1106
100
1107
101
(:~
1108
102
 : The function returns true if a collection with the given QName is available.
1131
103
 :
96
 :
1132
104
 : @param $name The QName of the collection that is being checked.
97
 : @param $name The QName of the collection that is being checked.
1133
105
 :
1134
106
 : @return true if the collection is available and false otherwise.
98
 : @return true if the collection is available and false otherwise.
1148
107
 :
99
 :)
1149
108
 :)
100
declare function ddl:is-available-collection( $name as xs:QName )
1150
109
declare function ddl:is-available-collection($name as xs:QName) as xs:boolean external;
101
  as xs:boolean external;
1151
110
102
1152
111
103
(:===========================================================================:)
1153
112
(:~
104
1154
113
 : The function returns a sequence of QNames of the collections that are
105
(: vim:set et sw=2 ts=2: :)
1142
114
 : available. The sequence will be empty if there are no collections.
1143
115
 :
1144
116
 : @return A sequence of QNames, one for each available collection, or an emtpy sequence.
1145
117
 :
1146
118
 :)
1147
119
declare function ddl:available-collections() as xs:QName* external;
1155
120
106
1156
=== modified file 'modules/store/dynamic/collections/dml.xq'
1157
--- modules/com/zorba-xquery/www/modules/store/dynamic/collections/dml.xq	2013-09-26 23:15:11 +0000
1158
+++ modules/store/dynamic/collections/dml.xq	2013-10-17 02:02:41 +0000
1159
@@ -1,7 +1,7 @@
1160
1
xquery version "3.0";
1
xquery version "3.0";
1161
2
2
1162
3
(:
3
(:
1164
4
 : Copyright 2006-2009 The FLWOR Foundation.
4
 : Copyright 2006-2013 The FLWOR Foundation.
1165
5
 :
5
 :
1166
6
 : Licensed under the Apache License, Version 2.0 (the "License");
6
 : Licensed under the Apache License, Version 2.0 (the "License");
1167
7
 : you may not use this file except in compliance with the License.
7
 : you may not use this file except in compliance with the License.
1168
@@ -17,22 +17,21 @@
1169
17
:)
17
:)
1170
18
18
1171
19
(:~
19
(:~
1178
20
 : This modules provides a set of functions to modify a collection and retrieve the items
20
 : This modules provides a set of functions to modify a collection
1179
21
 : contained in a particular collection.
21
 : and retrieve the items contained in a particular collection.
1180
22
 :
22
 : <p/>
1181
23
 : <p>Please refer to our documentation for <a href="../zorba/data_lifecycle.html">
23
 : Please refer to our documentation for
1182
24
 : more information</a> about the lifecycle management and the manipulation of such
24
 : <a href="../zorba/data_lifecycle.html">more information</a>
1183
25
 : collections.</p>
25
 : about the lifecycle management and the manipulation of such collections.
1184
26
 : 
26
 : 
1185
27
 : @see <a href="../zorba/data_lifecycle.html">Data Lifecycle</a>
27
 : @see <a href="../zorba/data_lifecycle.html">Data Lifecycle</a>
1187
28
 : @see http://www.zorba-xquery.com/modules/store/dynamic/collections/ddl
28
 : @see http://zorba.io/modules/store/dynamic/collections/ddl
1188
29
 : @see http://zorba.io/errors
29
 : @see http://zorba.io/errors
1189
30
 :
30
 :
1190
31
 : @author Matthias Brantner, David Graf, Till Westmann, Markos Zaharioudakis
31
 : @author Matthias Brantner, David Graf, Till Westmann, Markos Zaharioudakis
1191
32
 :
1192
33
 : @project Zorba/Data Store/Collections/Dynamic Data Manipulation
32
 : @project Zorba/Data Store/Collections/Dynamic Data Manipulation
1193
34
 :)
33
 :)
1195
35
module namespace dml = "http://www.zorba-xquery.com/modules/store/dynamic/collections/dml";
34
module namespace dml = "http://zorba.io/modules/store/dynamic/collections/dml";
1196
36
35
1197
37
declare namespace zerr = "http://zorba.io/errors";
36
declare namespace zerr = "http://zorba.io/errors";
1198
38
declare namespace an = "http://zorba.io/annotations";
37
declare namespace an = "http://zorba.io/annotations";
1199
@@ -40,675 +39,306 @@
1200
40
declare namespace ver = "http://zorba.io/options/versioning";
39
declare namespace ver = "http://zorba.io/options/versioning";
1201
41
declare option ver:module-version "2.0";
40
declare option ver:module-version "2.0";
1202
42
41
1405
43
42
(:===========================================================================:)
1406
44
(:~
43
1407
45
 : The insert-nodes-first function is an updating function that inserts copies of the
44
(:~
1408
46
 : given nodes at the beginning of the collection.
45
 : Inserts copies of the given items (nodes or JSON items)
1409
47
 :
46
 : into a collection at the position directly preceding the given target item.
1410
48
 : @param $name The name of the collection to which the nodes should be added.
47
 :
1411
49
 : @param $content The sequences of nodes whose copies should be added to the collection.
48
 : @param $name The name of the collection to insert into.
1412
50
 :
49
 : @param $target The item in the collection before which <code>$content</code>
1413
51
 : @return The result of the function is an empty XDM instance and a pending update list
50
 : will be inserted.
1414
52
 :         which, once applied, inserts the nodes into the collection.
51
 : @param $content The sequence of items whose copies to insert.
1415
53
 :
52
 : @return An empty XDM instance and a pending update list that, once applied,
1416
54
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
53
 : inserts the items into the collection.
1417
55
 :
54
 : @error zerr:ZDDY0003 if the collection is not available.
1418
56
 : @deprecated please use the cdml:insert-first#2 function
55
 : @error zerr:ZDDY0011 if <code>$target</code> is not in the collection.
1419
57
 :
56
 :)
1420
58
 :)
57
declare updating function dml:insert-before( $name as xs:QName,
1421
59
declare updating function 
58
                                             $target as item(),
1422
60
dml:insert-nodes-first($name as xs:QName, $content as node()*) external;
59
                                             $content as item()* )
1423
61
60
  external;
1424
62
61
1425
63
(:~
62
(:~
1426
64
 : The insert-first function is an updating function that inserts copies of the
63
 : Inserts copies of the given items (nodes or JSON items)
1427
65
 : given items (nodes or json items) at the beginning of the collection.
64
 : at the beginning of the collection.
1428
66
 :
65
 :
1429
67
 : @param $name The name of the collection to which the items should be added.
66
 : @param $name The name of the collection to insert into.
1430
68
 : @param $content The sequences of items whose copies should be added to the collection.
67
 : @param $content The sequence of items whose copies to insert.
1431
69
 :
68
 : @return An empty XDM instance and a pending update list that, once applied,
1432
70
 : @return The result of the function is an empty XDM instance and a pending update
69
 : inserts the items into the collection.
1433
71
 :         list which, once applied, inserts the items into the collection.
70
 : @error zerr:ZDDY0003 if the collection is not available.
1434
72
 :
71
 :)
1435
73
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
72
declare updating function dml:insert-first( $name as xs:QName,
1436
74
 :
73
                                            $content as item()* )
1437
75
 :)
74
  external;
1438
76
declare updating function 
75
1439
77
dml:insert-first($name as xs:QName, $content as item()*) external;
76
(:~
1440
78
77
 : Inserts copies of the given items (nodes or JSON items)
1441
79
78
 : at the end of the collection.
1442
80
(:~
79
 :
1443
81
 : The insert-nodes-last function is an updating function that inserts copies of the
80
 : @param $name The name of the collection to insert into.
1444
82
 : given nodes at the end of the collection.
81
 : @param $content The sequence of items whose copies to insert.
1445
83
 :
82
 : @return An empty XDM instance and a pending update list that, once applied,
1446
84
 : @param $name The name of the collection to which the nodes should  be added.
83
 : inserts the items into the collection.
1447
85
 : @param $content The sequences of nodes whose copies should be added to the collection.
84
 : @error zerr:ZDDY0003 if the collection is not available.
1448
86
 :
85
 :)
1449
87
 : @return The result of the function is an empty XDM instance and a pending update list
86
declare updating function dml:insert-last( $name as xs:QName,
1450
88
 :         which, once applied, inserts the nodes into the collection.
87
                                           $content as item()* )
1451
89
 :
88
  external;
1452
90
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
89
1453
91
 :
90
(:~
1454
92
 : @deprecated please use the cdml:insert-last#2 function
91
 : Inserts copies of the given items (nodes or JSON items)
1455
93
 :
92
 : into a collection at the position directly following the given target item.
1456
94
 :)
93
 :
1457
95
declare updating function 
94
 : @param $name The name of the collection to insert into.
1458
96
dml:insert-nodes-last($name as xs:QName, $content as node()*) external;
95
 : @param $target The item in the collection after which <code>$content</code>
1459
97
96
 : will be inserted.
1460
98
97
 : @param $content The sequence of items whose copies to insert.
1461
99
(:~
98
 : @return An empty XDM instance and a pending update list that, once applied,
1462
100
 : The insert-last function is an updating function that inserts copies of the
99
 : inserts the items into the collection.
1463
101
 : given items (nodes or json items) at the end of the collection.
100
 : @error zerr:ZDDY0003 if the collection is not available.
1464
102
 :
101
 : @error zerr:ZDDY0011 if <code>$target</code> is not in the collection.
1465
103
 : @param $name The name of the collection to which the items should  be added.
102
 :)
1466
104
 : @param $content The sequences of items whose copies should be added to the collection.
103
declare updating function dml:insert-after( $name as xs:QName,
1467
105
 :
104
                                            $pos as item(),
1468
106
 : @return The result of the function is an empty XDM instance and a pending update list
105
                                            $content as item()* )
1469
107
 :         which, once applied, inserts the items into the collection.
106
  external;
1470
108
 :
107
1471
109
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
108
(:~
1472
110
 :
109
 : This function does the same thing as <code>insert-first()</code> except it
1473
111
 :)
110
 : immediately applies the resulting pending updates and returns the items that
1474
112
declare updating function 
111
 : have been inserted.
1475
113
dml:insert-last($name as xs:QName, $content as item()*) external;
112
 :
1476
114
113
 : @param $name The name of the collection to insert into.
1477
115
114
 : @param $content The sequence of items whose copies to insert.
1478
116
(:~
115
 : @return The sequence of items that have been inserted.
1479
117
 : The insert-nodes-before function is an updating function that inserts
116
 : @error zerr:ZDDY0003 if the collection is not available.
1278
118
 : copies of the given nodes into a collection at the position directly preceding the
1279
119
 : given target node.
1280
120
 :
1281
121
 : @param $name The name of the collection to which the nodes should  be added.
1282
122
 : @param $target The node in the collection before which the $content
1283
123
 :        sequence should be inserted.
1284
124
 : @param $content The sequences of nodes whose copies should be added to the collection.
1285
125
 :
1286
126
 : @return The result of the function is an empty XDM instance and a pending update list
1287
127
 :         which, once applied, inserts the nodes into the collection.
1288
128
 :
1289
129
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
1290
130
 : @error zerr:ZDDY0011 if the target node is not contained in the collection.
1291
131
 :
1292
132
 : @deprecated please use the cdml:insert-before#3 function
1293
133
 :
1294
134
 :)
1295
135
declare updating function 
1296
136
dml:insert-nodes-before(
1297
137
  $name as xs:QName,
1298
138
  $target as node(),
1299
139
  $content as node()*) external;
1300
140
1301
141
(:~
1302
142
 : The insert-before function is an updating function that inserts copies of
1303
143
 : the given items (nodes or json items) into a collection at the position 
1304
144
 : directly preceding the given target item.
1305
145
 :
1306
146
 : @param $name The name of the collection to which the items should  be added.
1307
147
 : @param $target The item in the collection before which the $content
1308
148
 :        sequence should be inserted.
1309
149
 : @param $content The sequences of items whose copies should be added to the collection.
1310
150
 :
1311
151
 : @return The result of the function is an empty XDM instance and a pending update list
1312
152
 :         which, once applied, inserts the items into the collection.
1313
153
 :
1314
154
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
1315
155
 : @error zerr:ZDDY0011 if the target item is not contained in the collection.
1316
156
 :
1317
157
 :)
1318
158
declare updating function 
1319
159
dml:insert-before($name as xs:QName, $target as item(), $content as item()*) external;
1320
160
1321
161
1322
162
(:~
1323
163
 : The insert-nodes-after function is an updating function that inserts
1324
164
 : copies of the given nodes into a collection at the position directly following the
1325
165
 : given target node.
1326
166
 :
1327
167
 : @param $name The name of the collection to which the nodes should be added.
1328
168
 : @param $target The node in the collection after which the $content
1329
169
 :        sequence should be inserted.
1330
170
 : @param $content The sequences of nodes whose copies should be added to the collection.
1331
171
 :
1332
172
 : @return The result of the function is an empty XDM instance and a pending update list
1333
173
 :         which, once applied, inserts the nodes into the collection.
1334
174
 :
1335
175
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
1336
176
 : @error zerr:ZDDY0011 if the target node is not contained in the collection.
1337
177
 :
1338
178
 : @deprecated please use the cdml:insert-after#3 function
1339
179
 :
1340
180
 :)
1341
181
declare updating function 
1342
182
dml:insert-nodes-after(
1343
183
  $name as xs:QName,
1344
184
  $pos as node(),
1345
185
  $content as node()*) external;
1346
186
1347
187
1348
188
(:~
1349
189
 : The insert-after function is an updating function that inserts copies of
1350
190
 : the given items (nodes and/or json items) into a collection at the position
1351
191
 : directly following the given target item.
1352
192
 :
1353
193
 : @param $name The name of the collection to which the items should be added.
1354
194
 : @param $target The item in the collection after which the $content
1355
195
 :        sequence should be inserted.
1356
196
 : @param $content The sequences of items whose copies should be added to the collection.
1357
197
 :
1358
198
 : @return The result of the function is an empty XDM instance and a pending update list
1359
199
 :         which, once applied, inserts the items into the collection.
1360
200
 :
1361
201
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
1362
202
 : @error zerr:ZDDY0011 if the target node is not contained in the collection.
1363
203
 :
1364
204
 :)
1365
205
declare updating function 
1366
206
dml:insert-after($name as xs:QName, $pos as item(), $content as item()*) external;
1367
207
1368
208
1369
209
(:~
1370
210
 : This function does the same as the insert-nodes-first function except
1371
211
 : it immediately applies the resulting pending updates and returns the
1372
212
 : nodes that have been inserted.
1373
213
 :
1374
214
 : @param $name The name of the collection to which the nodes should be added.
1375
215
 : @param $content The sequences of nodes whose copies should be added to the collection.
1376
216
 :
1377
217
 : @return The result of the function is the sequence of nodes that have been
1378
218
 :         inserted into the collection.
1379
219
 :
1380
220
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
1381
221
 :
1382
222
 : @see dml:insert-nodes-first
1383
223
 :
1384
224
 : @deprecated please use the cdml:apply-insert-first#2 function
1385
225
 :
1386
226
 :)
1387
227
declare %an:sequential function 
1388
228
dml:apply-insert-nodes-first(
1389
229
  $name as xs:QName,
1390
230
  $content as node()*) as node()* external;
1391
231
1392
232
1393
233
(:~
1394
234
 : This function does the same as the insert-first function except it immediately
1395
235
 : applies the resulting pending updates and returns the items that have been inserted.
1396
236
 :
1397
237
 : @param $name The name of the collection to which the items should be added.
1398
238
 : @param $content The sequences of items whose copies should be added to the collection.
1399
239
 :
1400
240
 : @return The result of the function is the sequence of items that have been
1401
241
 :         inserted into the collection.
1402
242
 :
1403
243
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
1404
244
 :
1480
245
 : @see dml:insert-first
117
 : @see dml:insert-first
1523
246
 :
118
 :)
1524
247
 :)
119
declare %an:sequential function dml:apply-insert-first( $name as xs:QName,
1525
248
declare %an:sequential function 
120
                                                        $content as item()* )
1526
249
dml:apply-insert-first($name as xs:QName, $content as item()*) as item()* external;
121
  as item()* external;
1527
250
122
1528
251
123
(:~
1529
252
(:~
124
 : This function does the same thing as <code>insert-last()</code> except it
1530
253
 : This function does the same as the insert-nodes-last function except
125
 : immediately applies the resulting pending updates and returns the items that
1531
254
 : it immediately applies the resulting pending updates and returns the
126
 : have been inserted.
1532
255
 : nodes that have been inserted.
127
 :
1533
256
 :
128
 : @param $name The name of the collection to insert into.
1534
257
 : @param $name The name of the collection to which the nodes should be added.
129
 : @param $content The sequence of items whose copies to insert.
1535
258
 : @param $content The sequences of nodes whose copies should be added to the collection.
130
 : @return The sequence of items that have been inserted.
1536
259
 :
131
 : @error zerr:ZDDY0003 if the collection is not available.
1495
260
 : @return The result of the function is the sequence of nodes that have been
1496
261
 :         inserted into the collection.
1497
262
 :
1498
263
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
1499
264
 :
1500
265
 : @see dml:insert-nodes-last
1501
266
 :
1502
267
 : @deprecated please use the cdml:apply-insert-last#2 function
1503
268
 :
1504
269
 :)
1505
270
declare %an:sequential function dml:apply-insert-nodes-last(
1506
271
  $name as xs:QName,
1507
272
  $content as node()*) as node()* external;
1508
273
1509
274
1510
275
(:~
1511
276
 : This function does the same as the insert-last function except it immediately
1512
277
 : applies the resulting pending updates and returns the items that have been 
1513
278
 : inserted.
1514
279
 :
1515
280
 : @param $name The name of the collection to which the items should be added.
1516
281
 : @param $content The sequences of items whose copies should be added to the collection.
1517
282
 :
1518
283
 : @return The result of the function is the sequence of items that have been
1519
284
 :         inserted into the collection.
1520
285
 :
1521
286
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
1522
287
 :
1537
288
 : @see dml:insert-last
132
 : @see dml:insert-last
1587
289
 :
133
 :)
1588
290
 :)
134
declare %an:sequential function dml:apply-insert-last( $name as xs:QName,
1589
291
declare %an:sequential function dml:apply-insert-last(
135
                                                       $content as item()* )
1590
292
  $name as xs:QName,
136
  as item()* external;
1591
293
  $content as item()*) as item()* external;
137
1592
294
138
(:~
1593
295
139
 : This function does the same thing as <code>insert-before()</code> except it
1594
296
(:~
140
 : immediately applies the resulting pending updates and returns the items that
1595
297
 : This function does the same as the insert-nodes-before function except
141
 : have been inserted.
1596
298
 : it immediately applies the resulting pending updates and returns the
142
 :
1597
299
 : nodes that have been inserted.
143
 : @param $name The name of the collection to insert into.
1598
300
 :
144
 : @param $target The item in the collection before which <code>$content</code>
1599
301
 : @param $name The name of the collection to which the nodes should be added.
145
 : will be inserted.
1600
302
 : @param $target The node in the collection before which the $content
146
 : @param $content The sequence of items whose copies to insert.
1601
303
 :        sequence should be inserted.
147
 : @return The sequence of items that have been inserted.
1602
304
 : @param $content The sequences of nodes whose copies should be added to the collection.
148
 : @error zerr:ZDDY0003 if the collection is not available.
1554
305
 :
1555
306
 : @return The result of the function is the sequence of nodes that have been
1556
307
 :         inserted into the collection.
1557
308
 :
1558
309
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
1559
310
 :
1560
311
 : @see dml:insert-nodes-before
1561
312
 :
1562
313
 : @deprecated please use the cdml:apply-insert-before#3 function
1563
314
 :
1564
315
 :)
1565
316
declare %an:sequential function 
1566
317
dml:apply-insert-nodes-before(
1567
318
  $name as xs:QName,
1568
319
  $target as node(),
1569
320
  $content as node()*) as node()* external;
1570
321
1571
322
1572
323
(:~
1573
324
 : This function does the same as the insert-before function except it immediately
1574
325
 : applies the resulting pending updates and returns the items that have been 
1575
326
 : inserted.
1576
327
 :
1577
328
 : @param $name The name of the collection to which the items should be added.
1578
329
 : @param $target The item in the collection before which the $content
1579
330
 :        sequence should be inserted.
1580
331
 : @param $content The sequences of items whose copies should be added to the collection.
1581
332
 :
1582
333
 : @return The result of the function is the sequence of items that have been
1583
334
 :         inserted into the collection.
1584
335
 :
1585
336
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
1586
337
 :
1603
338
 : @see dml:insert-before
149
 : @see dml:insert-before
1655
339
 :
150
 :)
1656
340
 :)
151
declare %an:sequential function dml:apply-insert-before( $name as xs:QName,
1657
341
declare %an:sequential function 
152
                                                         $target as item(),
1658
342
dml:apply-insert-before(
153
                                                         $content as item()* )
1659
343
  $name as xs:QName,
154
  as item()* external;
1660
344
  $target as item(),
155
1661
345
  $content as item()*) as item()* external;
156
(:~
1662
346
157
 : This function does the same thing as <code>insert-after()</code> except it
1663
347
158
 : immediately applies the resulting pending updates and returns the items that
1664
348
(:~
159
 : have been inserted.
1665
349
 : This function does the same as the insert-nodes-after function except
160
 :
1666
350
 : it immediately applies the resulting pending updates and returns the
161
 : @param $name The name of the collection to insert into.
1667
351
 : nodes that have been inserted.
162
 : @param $target The item in the collection after which <code>$content</code>
1668
352
 :
163
 : will be inserted.
1669
353
 : @param $name The name of the collection to which the nodes should be added.
164
 : @param $content The sequence of items whose copies to insert.
1670
354
 : @param $target The node in the collection after which the $content
165
 : @return The sequence of items that have been inserted.
1671
355
 :        sequence should be inserted.
166
 : @error zerr:ZDDY0003 if the collection is not available.
1672
356
 : @param $content The sequences of nodes whose copies should be added to the collection.
167
 : @error zerr:ZDDY0011 if <code>$target</code> is not in the collection.
1622
357
 :
1623
358
 : @return The result of the function is the sequence of nodes that have been
1624
359
 :         inserted into the collection.
1625
360
 :
1626
361
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
1627
362
 :
1628
363
 : @see dml:insert-nodes-after
1629
364
 :
1630
365
 : @deprecated please use the cdml:apply-insert-after#3 function
1631
366
 :
1632
367
 :)
1633
368
declare %an:sequential function 
1634
369
dml:apply-insert-nodes-after(
1635
370
  $name as xs:QName,
1636
371
  $pos as node(),
1637
372
  $content as node()*) as node()* external;
1638
373
1639
374
1640
375
(:~
1641
376
 : This function does the same as the insert-after function except it immediately
1642
377
 : applies the resulting pending updates and returns the items that have been 
1643
378
 : inserted.
1644
379
 :
1645
380
 : @param $name The name of the collection to which the items should be added.
1646
381
 : @param $target The item in the collection after which the $content
1647
382
 :        sequence should be inserted.
1648
383
 : @param $content The sequences of items whose copies should be added to the collection.
1649
384
 :
1650
385
 : @return The result of the function is the sequence of items that have been
1651
386
 :         inserted into the collection.
1652
387
 :
1653
388
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
1654
389
 :
1673
390
 : @see dml:insert-after
168
 : @see dml:insert-after
1886
391
 :
169
 :)
1887
392
 :)
170
declare %an:sequential function dml:apply-insert-after( $name as xs:QName,
1888
393
declare %an:sequential function 
171
                                                        $target as item(),
1889
394
dml:apply-insert-after(
172
                                                        $content as item()* )
1890
395
  $name as xs:QName,
173
  as item()* external;
1891
396
  $pos as item(),
174
1892
397
  $content as item()*) as item()* external;
175
(:~
1893
398
176
 : Gets the sequence of nodes or JSON items from a collection.
1894
399
177
 :
1895
400
(:~
178
 : @param $name The name of the collection.
1896
401
 : The delete-nodes function is an updating function that deletes zero of more
179
 : @return The sequence contained in the given collection.
1897
402
 : nodes from a collection. 
180
 : @error zerr:ZDDY0003 if the collection is not available.
1898
403
 :
181
 :)
1899
404
 : @param $target the nodes in the collection that should be deleted.
182
declare function dml:collection( $name as xs:QName )
1900
405
 :
183
  as item()* external;
1901
406
 : @return The result of this function is an empty XDM instance and a pending update
184
1902
407
 :         list which, once applied, deletes the nodes from their collections.
185
(:~
1903
408
 :
186
 : Gets the sequence of items (nodes or JSON items) from a collection.
1904
409
 : @error zerr:ZDDY0011 if any nodes in the $target sequence is not a member of
187
 :
1905
410
 :        a collection or not all nodes of the $target sequence belong to the same
188
 : @param $name The name of the collection.
1906
411
 :        collection.
189
 : @param $skip The number of collection items to skip.
1907
412
 :
190
 : @return The sub-sequence contained in the given collection.
1908
413
 : @deprecated please use the cdml:delete#1 function
191
 : @error zerr:ZDDY0003 if the collection is not available.
1909
414
 :
192
 :)
1910
415
 :)
193
declare function dml:collection( $name as xs:QName,
1911
416
declare updating function 
194
                                 $skip as xs:integer )
1912
417
dml:delete-nodes($target as node()*) external;
195
  as item()* external;
1913
418
196
1914
419
197
(:~
1915
420
(:~
198
 : Gets the sequence of items (nodes or JSON items) from a collection.
1916
421
 : The delete function is an updating function that deletes zero of more items
199
 : The parameters <code>$start</code> and <code>$skip</code> can be used to
1917
422
 : (nodes and/or json items) from a collection. 
200
 : skip over items at the beginning of the collection.
1918
423
 :
201
 : If both are given, both are applied: first, <code>$start</code> to skip to
1919
424
 : @param $target the items in the collection that should be deleted.
202
 : that item and then <code>$skip</code> to skip that additional number of
1920
425
 :
203
 : items.
1921
426
 : @return The result of this function is an empty XDM instance and a pending update
204
 :
1922
427
 :         list which, once applied, deletes the items from their collections.
205
 : @param $name The name of the collection.
1923
428
 :
206
 : @param $start A reference to the first item to return.
1924
429
 : @error zerr:ZDDY0011 if any item in the $target sequence is not a member of
207
 : @param $skip The additional number of items to skip.
1925
430
 :        a collection or not all items of the $target sequence belong to the
208
 : @return The sub-sequence from the given collection.
1926
431
 :        same collection.
209
 : @error zerr:ZAPI0028 If the given URI is not a valid node position computed
1927
432
 :
210
 : by the <code>np:node-position</code> function.
1928
433
 :)
211
 : @error zerr:ZDDY0003 if the collection is not available.
1929
434
declare updating function 
212
 : @error zerr:ZSTR0066 If <code>$start</code> does not reference a node from
1930
435
dml:delete($target as item()*) external;
213
 : the collection <code>$name</code>.
1931
436
214
 :)
1932
437
215
declare function dml:collection( $name as xs:QName, 
1933
438
(:~
216
                                 $start as xs:anyURI,
1934
439
 : The delete-node-first function is an updating function that deletes the
217
                                 $skip as xs:integer )
1935
440
 : first node from a collection.
218
  as item()* external;
1936
441
 :
219
1937
442
 : @param $name The name of the collection from which the first node should be deleted.
220
(:~
1938
443
 :
221
 : Gets the name of the collection the given item (node or JSON item) belongs
1939
444
 : @return The result of this function is an empty XDM instance and a pending update
222
 : to.
1940
445
 :         list which, once applied, deletes the first node from the collection.
223
 :
1941
446
 :
224
 : @param $item The item for which to get the name of the collection.
1942
447
 : @error zerr:ZDDY0011 if the collection doesn't contain any node.
225
 : @return The name of the collection to which <code>$item</code> belongs.
1943
448
 :
226
 : @error zerr:ZDDY0011 if <code>$item</code> does not belong to a collection.
1944
449
 : @deprecated please use the cdml:delete-first#1 function
227
 :)
1945
450
 :
228
declare function dml:collection-name( $item as item() )
1946
451
 :)
229
  as xs:QName external;
1947
452
declare updating function 
230
1948
453
dml:delete-node-first($name as xs:QName) external;
231
(:~
1949
454
232
 : Deletes items (nodes or JSON items) from a collection.
1950
455
233
 :
1951
456
(:~
234
 : @param $items The items in the collection to delete.
1952
457
 : The delete-first function is an updating function that deletes the first item
235
 : @return An empty XDM instance and a pending update list that, once applied,
1953
458
 : from a collection.
236
 : deletes the items from their collections.
1954
459
 :
237
 : @error zerr:ZDDY0011 if any item in <code>$items</code> is not a member of a
1955
460
 : @param $name The name of the collection from which the first item should be deleted.
238
 : collection or not all items belong to the same collection.
1956
461
 :
239
 :)
1957
462
 : @return The result of this function is an empty XDM instance and a pending update
240
declare updating function dml:delete( $items as item()* )
1958
463
 :         list which, once applied, deletes the first item from the collection.
241
  external;
1959
464
 :
242
1960
465
 : @error zerr:ZDDY0011 if the collection doesn't contain any item.
243
(:~
1961
466
 :
244
 : Deletes the first item from a collection.
1962
467
 :)
245
 :
1963
468
declare updating function 
246
 : @param $name The name of the collection to delete from.
1964
469
dml:delete-first($name as xs:QName) external;
247
 : @return An empty XDM instance and a pending update list that, once applied,
1965
470
248
 : deletes the first item from the collection.
1966
471
249
 : @error zerr:ZDDY0011 if the collection is empty.
1967
472
(:~
250
 :)
1968
473
 : The delete-nodes-first function is an updating function that deletes the
251
declare updating function dml:delete-first( $name as xs:QName )
1969
474
 : first n nodes from a collection.
252
  external;
1970
475
 :
253
1971
476
 : @param $name The name of the collection from which the first node should be deleted.
254
(:~
1972
477
 : @param $number The number of nodes that should be removed from the beginning of
255
 : Deletes the first <i>N</i> items from a collection.
1973
478
 :        the collection.
256
 :
1974
479
 :
257
 : @param $name The name of the collection to delete from.
1975
480
 : @return The result of this function is an empty XDM instance and a pending update
258
 : @param $number The number of items to delete.
1976
481
 :         list which, once applied, deletes the nodes from the collection.
259
 : @return An empty XDM instance and a pending update list that, once applied,
1977
482
 :
260
 : deletes the items from the collection.
1978
483
 : @error zerr:ZDDY0011 if the collection doesn't contain the given number of nodes.
261
 : @error zerr:ZDDY0003 if the collection is not available.
1979
484
 :
262
 : @error zerr:ZDDY0011 if the collection contains less than
1980
485
 : @deprecated please use the cdml:delete-first#2 function
263
 : <code>$number</code> items.
1981
486
 :
264
 :)
1982
487
 :)
265
declare updating function dml:delete-first( $name as xs:QName,
1983
488
declare updating function 
266
                                            $number as xs:integer )
1984
489
dml:delete-nodes-first($name as xs:QName, $number as xs:integer) external;
267
  external;
1985
490
268
1986
491
269
(:~
1987
492
(:~
270
 : Deletes the last item from a collection.
1988
493
 : The delete-first function is an updating function that deletes the first N
271
 :
1989
494
 : items from a collection.
272
 : @param $name The name of the collection to delete from.
1990
495
 :
273
 : @return An empty XDM instance and a pending update list that, once applied,
1991
496
 : @param $name The name of the collection from which the first N items should be deleted.
274
 : deletes the last item from the collection.
1992
497
 : @param $number The number N of items that should be removed from the beginning of
275
 : @error zerr:ZDDY0003 if the collection is not available.
1993
498
 :        the collection.
276
 : @error zerr:ZDDY0011 if the collection is empty.
1994
499
 :
277
 :)
1995
500
 : @return The result of this function is an empty XDM instance and a pending update
278
declare updating function dml:delete-last( $name as xs:QName )
1996
501
 :         list which, once applied, deletes the items from the collection.
279
  external;
1997
502
 :
280
1998
503
 : @error zerr:ZDDY0011 if the collection doesn't contain the given number of items.
281
(:~
1999
504
 :
282
 : Deletes the last <i>N</i> items from a collection.
2000
505
 :)
283
 :
2001
506
declare updating function 
284
 : @param $name The name of the collection to delete from.
2002
507
dml:delete-first($name as xs:QName, $number as xs:integer) external;
285
 : @param $number The number of items to delete.
2003
508
286
 : @return An empty XDM instance and a pending update list that, once applied,
2004
509
287
 : deletes the last N items.
2005
510
(:~
288
 : @error zerr:ZDDY0003 if the collection is not available.
2006
511
 : The delete-node-last function is an updating function that deletes the
289
 : @error zerr:ZDDY0011 if the collection contains less than
2007
512
 : last node from a collection.
290
 : <code>$number</code> items.
2008
513
 :
291
 :)
2009
514
 : @param $name The name of the collection from which the last node should be deleted.
292
declare updating function dml:delete-last( $name as xs:QName,
2010
515
 :
293
                                           $number as xs:integer )
2011
516
 : @return The result of this function is an empty XDM instance and a pending update
294
  external;
2012
517
 :         list which, once applied, deletes the last node from the collection.
295
2013
518
 :
296
(:~
2014
519
 : @error zerr:ZDDY0003 If available collections does not provide a mapping
297
 : Edits the first supplied item so as to make it look exactly like a copy of
2015
520
 :        for the expanded QName $name.
298
 : the second supplied item while retaining its original identity.
2016
521
 : @error zerr:ZDDY0011 if the collection doesn't contain any node.
299
 :
2017
522
 :
300
 : @param $target The target item to be edited.
2018
523
 : @deprecated please use the cdml:delete-last#1 function
301
 : @param $content The item that serves as an edit goal.
2019
524
 :
302
 : @return An empty XDM instance and a pending update list that, once applied,
2020
525
 :)
303
 : performs the edit.
2021
526
declare updating function 
304
 : @error zerr:ZDDY0003 if the collection to which <code>$target</code> belongs
2022
527
dml:delete-node-last($name as xs:QName) external;
305
 : is not available.
2023
528
306
 : @error zerr:ZDDY0006 if the collection to which <code>$target</code> belongs
2024
529
307
 : is append-only, const, or queue.
2025
530
(:~
308
 : @error zerr:ZDDY0017 if <code>$target</code> is not a member of a collection.
1814
531
 : The delete-last function is an updating function that deletes the last item
1815
532
 : from a collection.
1816
533
 :
1817
534
 : @param $name The name of the collection from which the last item should be deleted.
1818
535
 :
1819
536
 : @return The result of this function is an empty XDM instance and a pending update
1820
537
 :         list which, once applied, deletes the last item from the collection.
1821
538
 :
1822
539
 : @error zerr:ZDDY0003 If available collections does not provide a mapping
1823
540
 :        for the expanded QName $name.
1824
541
 : @error zerr:ZDDY0011 if the collection doesn't contain any item.
1825
542
 :
1826
543
 :)
1827
544
declare updating function 
1828
545
dml:delete-last($name as xs:QName) external;
1829
546
1830
547
1831
548
(:~
1832
549
 : The delete-nodes-last function is an updating function that deletes the
1833
550
 : last n nodes from an ordered collection.
1834
551
 :
1835
552
 : @param $name The name of the collection from which the first node should be deleted.
1836
553
 : @param $number The number of nodes to delete.
1837
554
 :
1838
555
 : @return The result of this function is an empty XDM instance and a pending update
1839
556
 :         list which, once applied, deletes the last n nodes.
1840
557
 :
1841
558
 : @error zerr:ZDDY0003 If available collections does not provide a mapping
1842
559
 :        for the expanded QName $name.
1843
560
 : @error zerr:ZDDY0011 if the collection doesn't contain the given number of nodes.
1844
561
 :
1845
562
 : @deprecated please use the cdml:delete-last#2 function
1846
563
 :
1847
564
 :)
1848
565
declare updating function 
1849
566
dml:delete-nodes-last($name as xs:QName, $number as xs:integer) external;
1850
567
1851
568
1852
569
(:~
1853
570
 : The delete-last function is an updating function that deletes the last N 
1854
571
 : items from an ordered collection.
1855
572
 :
1856
573
 : @param $name The name of the collection from which the lsat N items should be deleted.
1857
574
 : @param $number The number N of items to delete.
1858
575
 :
1859
576
 : @return The result of this function is an empty XDM instance and a pending update
1860
577
 :         list which, once applied, deletes the last N items.
1861
578
 :
1862
579
 : @error zerr:ZDDY0003 If available collections does not provide a mapping
1863
580
 :        for the expanded QName $name.
1864
581
 : @error zerr:ZDDY0011 if the collection doesn't contain the given number of items.
1865
582
 :
1866
583
 :)
1867
584
declare updating function 
1868
585
dml:delete-last($name as xs:QName, $number as xs:integer) external;
1869
586
1870
587
1871
588
(:~
1872
589
 : The edit function is an updating function that edits the first supplied
1873
590
 : item so as to make it look exactly like a copy of the second supplied item,
1874
591
 : while retaining its original identity.
1875
592
 :
1876
593
 : @param $target The target item ,that must be edited.
1877
594
 : @param $content The content item, that serves as an edit goal.
1878
595
 :
1879
596
 : @return The result of the function is an empty XDM instance and a pending update list
1880
597
 :         which, once applied, performs the replacement.
1881
598
 :
1882
599
 : @error zerr:ZDDY0003 if the collection to which $target belongs is not available.
1883
600
 : @error zerr:ZDDY0006 if the modifier property of the collection to which $target
1884
601
 :        belongs is append-only, const, or queue.
1885
602
 : @error zerr:ZDDY0017 if the $target item is not a member of a collection.
2026
603
 : @error zerr:ZDDY0037 if the collection is append-only.
309
 : @error zerr:ZDDY0037 if the collection is append-only.
2027
604
 : @error zerr:ZDDY0038 if the collection is a queue.
310
 : @error zerr:ZDDY0038 if the collection is a queue.
2138
605
 : @error zerr:ZDDY0039 if the $target item is not a root.
311
 : @error zerr:ZDDY0039 if <code>$target</code> is not a root.
2139
606
 : @error zerr:ZDDY0040 if the target cannot be updated to match the content (for
312
 : @error zerr:ZDDY0040 if <code>$target</code> cannot be updated to match the
2140
607
 :        example because the target is a node and the content is an object).
313
 : content (for example, because the target is a node and the content is an
2141
608
 :
314
 : object).
2142
609
 :)
315
 :)
2143
610
declare updating function 
316
declare updating function dml:edit( $target as item(),
2144
611
dml:edit($target as item(), $content as item()) external;
317
                                    $content as item() )
2145
612
318
  external;
2146
613
319
2147
614
(:~
320
(:~
2148
615
 : The truncate function is an updating function that deletes the
321
 : Gets the position of the given item (node or JSON item) within its
2149
616
 : entire contents of collection.
322
 : collection.
2150
617
 :
323
 :
2151
618
 : @param $name The name of the collection whose content to delete
324
 : @param $item The item to get the index of.
2152
619
 :
325
 : @return The position of <code>$item</code> in its collection.
2153
620
 : @return The result of this function is an empty XDM instance and a pending update
326
 : @error zerr:ZDDY0011 if <code>$item</code> does not belong to a collection.
2154
621
 :         list which, once applied, deletes the nodes.
327
 :)
2155
622
 :
328
declare function dml:index-of( $item as item() )
2156
623
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
329
  as xs:integer external;
2157
624
 :)
330
2158
625
declare updating function dml:truncate($name as xs:QName) external;
331
(:~
2159
626
332
 : Deletes the entire contents of a collection.
2160
627
333
 :
2161
628
(:~
334
 : @param $name The name of the collection whose contents to delete.
2162
629
 : The collection function returns the sequence of nodes and/or json items
335
 : @return An empty XDM instance and a pending update list that, once applied,
2163
630
 : that belong to the collection identified by the given name.
336
 : deletes the contents.
2164
631
 :
337
 : @error zerr:ZDDY0003 if the collection is not available.
2165
632
 : @param $name The name of the collection.
338
 :)
2166
633
 :
339
declare updating function dml:truncate( $name as xs:QName )
2167
634
 : @return The sequence contained in the given collection.
340
  external;
2168
635
 :
341
2169
636
 : @error zerr:ZDDY0003 If available collections does not provide a mapping
342
(:===========================================================================:)
2170
637
 :        for the expanded QName $name.
343
2171
638
 :
344
(: vim:set et sw=2 ts=2: :)
2062
639
 :)
2063
640
declare function dml:collection($name as xs:QName) as item()* external;
2064
641
2065
642
2066
643
(:~
2067
644
 : The collection function returns the sequence of nodes and/or json items
2068
645
 : that belong to the collection identified by the given name.
2069
646
 :
2070
647
 : @param $name The name of the collection.
2071
648
 : @param $skip The number of collection items to skip.
2072
649
 :
2073
650
 : @return The sequence contained in the given collection.
2074
651
 :
2075
652
 : @error zerr:ZDDY0003 If available collections does not provide a mapping
2076
653
 :        for the expanded QName $name.
2077
654
 :
2078
655
 :)
2079
656
declare function
2080
657
dml:collection($name as xs:QName, $skip as xs:integer) as item()* external;
2081
658
2082
659
2083
660
(:~
2084
661
 : The collection function returns the sequence of nodes and/or json items
2085
662
 : that belong to the collection identified by the given name.
2086
663
 : The parameters $start and $skip can be used to skip over some items at
2087
664
 : the beginning of the collection. If both are given, both are applied:
2088
665
 : first $start to skip to the referenced item and then $skip to skip an
2089
666
 : additional number of items.
2090
667
 :
2091
668
 : @param $name The name of the collection.
2092
669
 : @param $start A reference to the first item to return. All items before
2093
670
                 are skipped.
2094
671
 : @param $skip The number of collection items to skip.
2095
672
 :
2096
673
 : @return The sequence contained in the given collection.
2097
674
 :
2098
675
 : @error zerr:ZAPI0028 If the given URI is not a valid node
2099
676
 :        position computed by the <tt>np:node-position</tt> function. 
2100
677
 : @error zerr:ZDDY0003 If available collections does not provide a mapping
2101
678
 :        for the expanded QName $name.
2102
679
 : @error zerr:ZSTR0066 If the passed reference $start does not reference
2103
680
 :        a node from the collection identified by $name.
2104
681
 :
2105
682
 :)
2106
683
declare function
2107
684
dml:collection($name as xs:QName, 
2108
685
               $start as xs:anyURI,
2109
686
               $skip as xs:integer) as item()* external;
2110
687
2111
688
2112
689
(:~
2113
690
 : The collection-name function returns the name of the collection the given
2114
691
 : item (node or json item) belongs to.
2115
692
 :
2116
693
 : @param $item The item for which to get the name of the collection
2117
694
 : @return The result of this function is a QName which identifies the collection
2118
695
 :         to which the given item belongs to.
2119
696
 :
2120
697
 : @error zerr:ZDDY0011 if the given item does not belong to a collection.
2121
698
 :
2122
699
 :)
2123
700
declare function dml:collection-name($item as item()) as xs:QName external;
2124
701
2125
702
2126
703
(:~
2127
704
 : The index-of function returns the position of the given item (node or 
2128
705
 : json item) within its containing the collection.
2129
706
 :
2130
707
 : @param $item The item to retrieve the index from.
2131
708
 :
2132
709
 : @return Returns the position as xs:integer of the given item in the collection.
2133
710
 :
2134
711
 : @error zerr:ZDDY0011 if the item is not contained in any collection.
2135
712
 :
2136
713
 :)
2137
714
declare function dml:index-of($item as item()) as xs:integer external;
2172
715
345
2173
=== modified file 'modules/store/dynamic/collections/w3c/ddl.xq'
2174
--- modules/com/zorba-xquery/www/modules/store/dynamic/collections/w3c/ddl.xq	2013-09-26 23:15:11 +0000
2175
+++ modules/store/dynamic/collections/w3c/ddl.xq	2013-10-17 02:02:41 +0000
2176
@@ -1,7 +1,7 @@
2177
1
xquery version "3.0";
1
xquery version "3.0";
2178
2
2
2179
3
(:
3
(:
2181
4
 : Copyright 2006-2009 The FLWOR Foundation.
4
 : Copyright 2006-2013 The FLWOR Foundation.
2182
5
 :
5
 :
2183
6
 : Licensed under the Apache License, Version 2.0 (the "License");
6
 : Licensed under the Apache License, Version 2.0 (the "License");
2184
7
 : you may not use this file except in compliance with the License.
7
 : you may not use this file except in compliance with the License.
2185
@@ -17,146 +17,140 @@
2186
17
:)
17
:)
2187
18
18
2188
19
(:~
19
(:~
2197
20
 : This modules defines a set of functions for managing persistent, ordered, and
20
 : This modules defines a set of functions for managing persistent, ordered,
2198
21
 : updatable collections.
21
 : and updatable collections.
2199
22
 :
22
 : <p/>
2200
23
 : <p>Such collections are identified by a URI as defined in the XQuery specification.
23
 : Such collections are identified by a URI as defined in the XQuery
2201
24
 : However, please note that we do not advice users to use collections identified by URIs.
24
 : specification.
2202
25
 : Instead, we refer to the <a href="../zorba/data_lifecycle.html">data lifecycle
25
 : However, please note that we do not advise users to use collections
2203
26
 : documentation</a>. It gives an overview over serveral ways to work with collections,
26
 : identified by URIs.
2204
27
 : documents, and other data-structures.</p>
27
 : Instead, we refer to the
2205
28
 : <a href="../zorba/data_lifecycle.html">data lifecycle documentation</a>.
2206
29
 : It gives an overview of several ways to work with collections, documents,
2207
30
 : and other data-structures.
2208
28
 :
31
 :
2209
29
 : @see <a href="../zorba/data_lifecycle.html">Data Lifecycle</a>
32
 : @see <a href="../zorba/data_lifecycle.html">Data Lifecycle</a>
2213
30
 : @see http://www.zorba-xquery.com/modules/store/dynamic/collections/w3c/dml
33
 : @see http://zorba.io/modules/store/dynamic/collections/w3c/dml
2214
31
 : @see http://www.zorba-xquery.com/modules/store/dynamic/collections/ddl
34
 : @see http://zorba.io/modules/store/dynamic/collections/ddl
2215
32
 : @see http://www.zorba-xquery.com/modules/store/dynamic/collections/dml
35
 : @see http://zorba.io/modules/store/dynamic/collections/dml
2216
33
 : @see http://zorba.io/errors
36
 : @see http://zorba.io/errors
2217
34
 :
37
 :
2218
35
 : @author Matthias Brantner, David Graf, Till Westmann, Markos Zaharioudakis
38
 : @author Matthias Brantner, David Graf, Till Westmann, Markos Zaharioudakis
2219
36
 :
2220
37
 : @project Zorba/Data Store/Collections/W3C Data Definition
39
 : @project Zorba/Data Store/Collections/W3C Data Definition
2221
38
 :)
40
 :)
2223
39
module namespace ddl = "http://www.zorba-xquery.com/modules/store/dynamic/collections/w3c/ddl";
41
module namespace ddl = "http://zorba.io/modules/store/dynamic/collections/w3c/ddl";
2224
40
42
2226
41
import module namespace qddl = "http://www.zorba-xquery.com/modules/store/dynamic/collections/ddl";
43
import module namespace qddl = "http://zorba.io/modules/store/dynamic/collections/ddl";
2227
42
44
2228
43
declare namespace zerr = "http://zorba.io/errors";
45
declare namespace zerr = "http://zorba.io/errors";
2229
44
declare namespace ver = "http://zorba.io/options/versioning";
46
declare namespace ver = "http://zorba.io/options/versioning";
2230
45
declare option ver:module-version "2.0";
47
declare option ver:module-version "2.0";
2231
46
48
2232
49
(:===========================================================================:)
2233
50
2234
47
(:~
51
(:~
2242
48
 : Function used for internal purposes only. It converts a URI
52
 : THIS FUNCTION IS FOR INTERNAL USE ONLY.
2243
49
 : given as string into a reserved QName. This QName is used
53
 : Converts a URI given as a string into a reserved QName.
2244
50
 : in the module to be able to store collections identified by
54
 : This QName is used in the module to be able to store collections identified
2245
51
 : URIs using dynamic collections which are identified by QNames.
55
 : by URIs using dynamic collections that are identified by QNames.
2246
52
 :
56
 :
2247
53
 : @param $name URI to convert to a reserved QName.
57
 : @param $uri URI to convert to a reserved QName.
2241
54
 :
2248
55
 : @return The reserved QName for the given URI.
58
 : @return The reserved QName for the given URI.
2275
56
 :
59
 :)
2276
57
 :)
60
declare function ddl:to-qname( $uri as xs:string )
2277
58
declare function ddl:to-qname($name as xs:string) as xs:QName
61
  as xs:QName
2278
59
{
62
{
2279
60
  fn:QName($name, "zorba-internal-name-for-w3c-collections")
63
  fn:QName( $uri, "zorba-internal-name-for-w3c-collections" )
2280
61
};
64
};
2281
62
65
2282
63
(:~
66
(:~
2283
64
 : Function used for internal purposes only. It returns the namespace
67
 : THIS FUNCTION IS FOR INTERNAL USE ONLY.
2284
65
 : component of the given QName.
68
 : Gets the namespace component of the given QName.
2285
66
 :
69
 :
2286
67
 : @param $name QName whose namespace component should be returned
70
 : @param $name The QName whose namespace component should be returned.
2287
68
 :
71
 : @return The namespace component of <code>$name</code>
2288
69
 : @return the namespace componentn of the given QName
72
 :)
2289
70
 :)
73
declare function ddl:from-qname( $name as xs:QName )
2290
71
declare function ddl:from-qname($name as xs:QName) as xs:string
74
  as xs:string
2291
72
{
75
{
2292
73
  fn:namespace-uri-from-QName($name)
76
  fn:namespace-uri-from-QName( $name )
2293
74
};
77
};
2294
75
78
2295
76
(:~
79
(:~
2296
77
 : The function returns true if a collection with the given URI is available
80
 : Checks whether a collection with the given URI exists.
2297
78
 : (i.e. has been created).
81
 :
2298
79
 :
82
 : @param $uri The URI of the collection to check.
2273
80
 : @param $name The URI of the collection that is being checked.
2274
81
 :
2299
82
 : @return true if the collection is available and false otherwise.
83
 : @return true if the collection is available and false otherwise.
2300
83
 :
2301
84
 :)
84
 :)
2303
85
declare function ddl:is-available-collection($coll-name as xs:string) as xs:boolean
85
declare function ddl:is-available-collection( $uri as xs:string )
2304
86
  as xs:boolean
2305
86
{
87
{
2307
87
  qddl:is-available-collection(ddl:to-qname($coll-name))
88
  qddl:is-available-collection( ddl:to-qname( $uri ) )
2308
88
};
89
};
2309
89
90
2310
90
(:~
91
(:~
2311
91
 : The function returns a sequence of URIs of the collections that are
92
 : The function returns a sequence of URIs of the collections that are
2312
92
 : available. The sequence will be empty if there are no collections.
93
 : available. The sequence will be empty if there are no collections.
2313
93
 :
94
 :
2316
94
 : @return A sequence of URIs, one for each available collection, or an emtpy sequence.
95
 : @return A sequence of URIs, one for each available collection, or an emtpy
2317
95
 :
96
 : sequence.
2318
96
 :)
97
 :)
2320
97
declare function ddl:available-collections() as xs:string* 
98
declare function ddl:available-collections()
2321
99
  as xs:string* 
2322
98
{
100
{
2323
99
  for $c in qddl:available-collections()
101
  for $c in qddl:available-collections()
2387
100
  where fn:local-name-from-QName($c) eq "zorba-internal-name-for-w3c-collections"
102
  where fn:local-name-from-QName( $c )
2388
101
  return ddl:from-qname($c)
103
        eq "zorba-internal-name-for-w3c-collections"
2389
102
};
104
  return ddl:from-qname( $c )
2390
103
105
};
2391
104
(:~
106
2392
105
 : The create function is an updating function which creates
107
(:~
2393
106
 : the collection with the given URI and the empty-sequence as contents.
108
 : Creates the collection with the given URI.
2394
107
 :
109
 :
2395
108
 : @param $name The URI of the collection to create.
110
 : @param $uri The URI of the collection to create.
2396
109
 :
111
 : @return An empty XDM instance and a pending update list that, once applied,
2397
110
 : @return The result of the function is an empty XDM instance and a 
112
 : creates a collection with the given URI.
2398
111
 :         pending update list which, once applied, creates a collection
113
 : @error zerr:ZDDY0002 if a collection identified by <code>$uri</code> already
2399
112
 :         with the given name.
114
 : exists.
2400
113
 :
115
 :)
2401
114
 : @error zerr:ZDDY0002 if a collection with the given URI already exists.
116
declare updating function ddl:create( $uri as xs:string )
2402
115
 :
117
{
2403
116
 :)
118
  qddl:create( ddl:to-qname( $uri ) )
2404
117
declare updating function ddl:create($coll-name as xs:string) 
119
};
2405
118
{
120
2406
119
  qddl:create(ddl:to-qname($coll-name))
121
(:~
2407
120
};
122
 : Creates the collection with the given URI and adds copies of the given
2408
121
123
 : sequence to the new collection.
2409
122
(:~
124
 :
2410
123
 : The create function is an updating function which creates
125
 : @param $uri The URI of the collection to create.
2411
124
 : the collection with the given URI. Moreover, it adds copies
126
 : @param $content The sequence of nodes to add to the new collection.
2412
125
 : of the sequence $content to the new collection.
127
 : @return An empty XDM instance and a pending update list that, once applied,
2413
126
 :
128
 : creates a collection identified by <code>$uri</code> and inserts
2414
127
 : @param $name The URI of the collection to create.
129
 : <code>$content</code> into it.
2415
128
 : @param $content The sequences of nodes that should be added to the new collection.
130
 : @error zerr:ZDDY0002 if a collection identified by <code>$uri</code> already
2416
129
 :
131
 : exists.
2417
130
 : @return The result of the function is an empty XDM instance and a 
132
 :)
2418
131
 :         pending update list which, once applied, creates a collection
133
declare updating function ddl:create( $uri as xs:string,
2419
132
 :         with the given name and inserts the given nodes into it.
134
                                      $content as node()* )
2420
133
 :
135
{
2421
134
 : @error zerr:ZDDY0002 if a collection with the given URI already exists.
136
  qddl:create( ddl:to-qname( $uri ), $content )
2422
135
 :
137
};
2423
136
 :)
138
2424
137
declare updating function ddl:create(
139
(:~
2425
138
  $coll-name as xs:string,
140
 : Deletes the collection with the given URI.
2426
139
  $content as node()*) 
141
 :
2427
140
{
142
 : @param $uri The URI of the collection to delete.
2428
141
  qddl:create(ddl:to-qname($coll-name), $content)
143
 : @return An empty XDM instance and a pending update list that, once applied,
2429
142
};
144
 : deletes the collection identified by <code>$uri</code>.
2430
143
145
 : @error zerr:ZDDY0003 if the collection is not available.
2431
144
(:~
146
 : @error zerr:ZDDY0015 if any of the in-scope variables reference a node that
2432
145
 : The delete function is an updating function that removes
147
 : belongs to the collection identified by <code>$uri</code>.
2433
146
 : the collection with the given URI.
148
 :)
2434
147
 :
149
declare updating function ddl:delete( $uri as xs:string )
2435
148
 : @param $name The URI of the collection to delete.
150
{
2436
149
 :
151
  qddl:delete( ddl:to-qname( $uri ) )
2437
150
 : @return The result of the function is an empty XDM instance and a pending
152
};
2438
151
 :         update list which, once applied, deletes the collection with the given
153
2439
152
 :         name.
154
(:===========================================================================:)
2440
153
 :
155
2441
154
 : @error zerr:ZDDY0003 if the URI $name is not equal to any of the available collections.
156
(: vim:set et sw=2 ts=2: :)
2379
155
 : @error zerr:ZDDY0015 if any of the in-scope variables references a node that
2380
156
 :        belongs to the collection with the given URI.
2381
157
 :
2382
158
 :)
2383
159
declare updating function ddl:delete($coll-name as xs:string)
2384
160
{
2385
161
  qddl:delete(ddl:to-qname($coll-name))
2386
162
};
2442
163
157
2443
=== modified file 'modules/store/dynamic/collections/w3c/dml.xq'
2444
--- modules/com/zorba-xquery/www/modules/store/dynamic/collections/w3c/dml.xq	2013-09-26 23:15:11 +0000
2445
+++ modules/store/dynamic/collections/w3c/dml.xq	2013-10-17 02:02:41 +0000
2446
@@ -1,7 +1,7 @@
2447
1
xquery version "3.0";
1
xquery version "3.0";
2448
2
2
2449
3
(:
3
(:
2451
4
 : Copyright 2006-2009 The FLWOR Foundation.
4
 : Copyright 2006-2013 The FLWOR Foundation.
2452
5
 :
5
 :
2453
6
 : Licensed under the Apache License, Version 2.0 (the "License");
6
 : Licensed under the Apache License, Version 2.0 (the "License");
2454
7
 : you may not use this file except in compliance with the License.
7
 : you may not use this file except in compliance with the License.
2455
@@ -17,30 +17,32 @@
2456
17
:)
17
:)
2457
18
18
2458
19
(:~
19
(:~
2467
20
 : This modules provides a set of functions to modify a collection and retrieve the nodes
20
 : This modules provides a set of functions to modify a collection and retrieve
2468
21
 : contained in a particular collection.
21
 : the nodes contained in a particular collection.
2469
22
 :
22
 : <p/>
2470
23
 : <p>Such collections are identified by a URI as defined in the XQuery specification.
23
 : Such collections are identified by a URI as defined in the XQuery
2471
24
 : However, please note that we do not advice users to use collections identified by URIs.
24
 : specification.
2472
25
 : Instead, we refer to the <a href="../zorba/data_lifecycle.html">data lifecycle
25
 : However, please note that we do not advice users to use collections
2473
26
 : documentation</a>. It gives an overview over serveral ways to work with collections,
26
 : identified by URIs.
2474
27
 : documents, and other data-structures.</p>
27
 : Instead, we refer to the
2475
28
 : <a href="../zorba/data_lifecycle.html">data lifecycle documentation</a>.
2476
29
 : It gives an overview of several ways to work with collections, documents,
2477
30
 : and other data-structures.
2478
28
 :
31
 :
2479
29
 : @see <a href="../zorba/data_lifecycle.html">Data Lifecycle</a>
32
 : @see <a href="../zorba/data_lifecycle.html">Data Lifecycle</a>
2483
30
 : @see http://www.zorba-xquery.com/modules/store/dynamic/collections/w3c/ddl
33
 : @see http://zorba.io/modules/store/dynamic/collections/w3c/ddl
2484
31
 : @see http://www.zorba-xquery.com/modules/store/dynamic/collections/ddl
34
 : @see http://zorba.io/modules/store/dynamic/collections/ddl
2485
32
 : @see http://www.zorba-xquery.com/modules/store/dynamic/collections/dml
35
 : @see http://zorba.io/modules/store/dynamic/collections/dml
2486
33
 : @see http://zorba.io/errors
36
 : @see http://zorba.io/errors
2487
34
 :
37
 :
2488
35
 : @author Matthias Brantner, David Graf, Till Westmann, Markos Zaharioudakis
38
 : @author Matthias Brantner, David Graf, Till Westmann, Markos Zaharioudakis
2489
36
 :
2490
37
 : @project Zorba/Data Store/Collections/W3C Data Manipulation
39
 : @project Zorba/Data Store/Collections/W3C Data Manipulation
2491
38
 :)
40
 :)
2497
39
module namespace dml = "http://www.zorba-xquery.com/modules/store/dynamic/collections/w3c/dml";
41
module namespace dml = "http://zorba.io/modules/store/dynamic/collections/w3c/dml";
2498
40
42
2499
41
import module namespace ddl = "http://www.zorba-xquery.com/modules/store/dynamic/collections/w3c/ddl";
43
import module namespace ddl = "http://zorba.io/modules/store/dynamic/collections/w3c/ddl";
2500
42
44
2501
43
import module namespace qdml = "http://www.zorba-xquery.com/modules/store/dynamic/collections/dml";
45
import module namespace qdml = "http://zorba.io/modules/store/dynamic/collections/dml";
2502
44
46
2503
45
declare namespace zerr = "http://zorba.io/errors";
47
declare namespace zerr = "http://zorba.io/errors";
2504
46
declare namespace an = "http://zorba.io/annotations";
48
declare namespace an = "http://zorba.io/annotations";
2505
@@ -48,332 +50,274 @@
2506
48
declare namespace ver = "http://zorba.io/options/versioning";
50
declare namespace ver = "http://zorba.io/options/versioning";
2507
49
declare option ver:module-version "2.0";
51
declare option ver:module-version "2.0";
2508
50
52
2591
51
(:~
53
(:===========================================================================:)
2592
52
 : The insert-nodes-first function is an updating function that inserts copies of the
54
2593
53
 : given nodes at the beginning of the collection.
55
(:~
2594
54
 :
56
 : Inserts copies of the given nodes at the beginning of the collection.
2595
55
 : @param $name The name of the collection to which the nodes should be added.
57
 :
2596
56
 : @param $content The sequences of nodes whose copies should be added to the collection.
58
 : @param $name The name of the collection to insert into.
2597
57
 :
59
 : @param $content The sequence of nodes whose copies will be inserted.
2598
58
 : @return The result of the function is an empty XDM instance and a pending update list
60
 : @return An empty XDM instance and a pending update list that, once applied,
2599
59
 :         which, once applied, inserts the nodes into the collection.
61
 : inserts <code>$content</code> into the collection.
2600
60
 :
62
 : @error zerr:ZDDY0003 if the collection is not available.
2601
61
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
63
 :)
2602
62
 :
64
declare updating function dml:insert-nodes-first( $name as xs:string,
2603
63
 :)
65
                                                  $content as node()* )
2604
64
declare updating function dml:insert-nodes-first(
66
{
2605
65
  $name as xs:string,
67
  qdml:insert-first( ddl:to-qname( $name ), $content )
2606
66
  $content as node()*)
68
};
2607
67
{
69
2608
68
  qdml:insert-nodes-first(ddl:to-qname($name), $content)
70
(:~
2609
69
};
71
 : Inserts copies of the given nodes at the end of the collection.
2610
70
72
 :
2611
71
(:~
73
 : @param $name The name of the collection to insert into.
2612
72
 : The insert-nodes-last function is an updating function that inserts copies of the
74
 : @param $content The sequence of nodes whose copies will be inserted.
2613
73
 : given nodes at the end of the collection.
75
 : @return An empty XDM instance and a pending update list that, once applied,
2614
74
 :
76
 : inserts the nodes into the collection.
2615
75
 : @param $name The name of the collection to which the nodes should  be added.
77
 : @error zerr:ZDDY0003 if the collection is not available.
2616
76
 : @param $content The sequences of nodes whose copies should be added to the collection.
78
 :)
2617
77
 :
79
declare updating function dml:insert-nodes-last( $name as xs:string,
2618
78
 : @return The result of the function is an empty XDM instance and a pending update list
80
                                                 $content as node()* )
2619
79
 :         which, once applied, inserts the nodes into the collection.
81
{
2620
80
 :
82
  qdml:insert-last( ddl:to-qname( $name ), $content )
2621
81
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
83
};
2622
82
 :
84
2623
83
 :)
85
(:~
2624
84
declare updating function dml:insert-nodes-last(
86
 : Inserts copies of the given nodes into a collection at the position directly
2625
85
  $name as xs:string,
87
 : preceding the given target node.
2626
86
  $content as node()*)
88
 :
2627
87
{
89
 : @param $name The name of the collection to insert into.
2628
88
  qdml:insert-nodes-last(ddl:to-qname($name), $content)
90
 : @param $target The node in the collection before which <code>$content</code>
2629
89
};
91
 : will be inserted.
2630
90
92
 : @param $content The sequences of nodes whose copies will be inserted.
2631
91
(:~
93
 : @return An empty XDM instance and a pending update list that, once applied,
2632
92
 : The insert-nodes-before function is an updating function that inserts
94
 : inserts the nodes into the collection.
2633
93
 : copies of the given nodes into a collection at the position directly preceding the
95
 : @error zerr:ZDDY0003 if the collection is not available.
2634
94
 : given target node.
96
 : @error zerr:ZDDY0011 if <code>$target</code> node is not contained in the
2635
95
 :
97
 : collection.
2636
96
 : @param $name The name of the collection to which the nodes should  be added.
98
 :)
2637
97
 : @param $target The node in the collection before which the $content
99
declare updating function dml:insert-nodes-before( $name as xs:string,
2638
98
 :        sequence should be inserted.
100
                                                   $target as node(),
2639
99
 : @param $content The sequences of nodes whose copies should be added to the collection.
101
                                                   $content as node()* )
2640
100
 :
102
{
2641
101
 : @return The result of the function is an empty XDM instance and a pending update list
103
  qdml:insert-before( ddl:to-qname( $name ), $target, $content )
2642
102
 :         which, once applied, inserts the nodes into the collection.
104
};
2643
103
 :
105
2644
104
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
106
(:~
2645
105
 : @error zerr:ZDDY0011 if the target node is not contained in the collection.
107
 : Inserts copies of the given nodes into a collection at the position
2646
106
 :
108
 : directly following the given target node.
2647
107
 :)
109
 :
2648
108
declare updating function dml:insert-nodes-before($name as xs:string,
110
 : @param $name The name of the collection to insert into.
2649
109
                                                    $target as node(),
111
 : @param $target The node in the collection after which <code>$content</code>
2650
110
                                                    $content as node()*)
112
 : will be inserted.
2651
111
{
113
 : @param $content The sequence of nodes whose copies will be inserted.
2652
112
  qdml:insert-nodes-before(ddl:to-qname($name), $target, $content)
114
 : @return An empty XDM instance and a pending update list that, once applied,
2653
113
};
115
 : inserts the nodes into the collection.
2654
114
116
 : @error zerr:ZDDY0003 if the collection is not available.
2655
115
(:~
117
 : @error zerr:ZDDY0011 if <code>$target</code> node is not contained in the
2656
116
 : The insert-nodes-after function is an updating function that inserts
118
 : collection.
2657
117
 : copies of the given nodes into a collection at the position directlry following the
119
 :)
2658
118
 : given target node.
120
declare updating function dml:insert-nodes-after( $name as xs:string,
2577
119
 :
2578
120
 : @param $name The name of the collection to which the nodes should be added.
2579
121
 : @param $target The node in the collection after which the $content
2580
122
 :        sequence should be inserted.
2581
123
 : @param $content The sequences of nodes whose copies should be added to the collection.
2582
124
 :
2583
125
 : @return The result of the function is an empty XDM instance and a pending update list
2584
126
 :         which, once applied, inserts the nodes into the collection.
2585
127
 :
2586
128
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
2587
129
 : @error zerr:ZDDY0011 if the target node is not contained in the collection.
2588
130
 :
2589
131
 :)
2590
132
declare updating function dml:insert-nodes-after($name as xs:string,
2659
133
                                                  $pos as node(),
121
                                                  $pos as node(),
2661
134
                                                  $content as node()*)
122
                                                  $content as node()* )
2662
135
{
123
{
2664
136
  qdml:insert-nodes-after(ddl:to-qname($name), $pos, $content)
124
  qdml:insert-after( ddl:to-qname( $name ), $pos, $content )
2665
137
};
125
};
2666
138
126
2667
139
2668
140
(:~
127
(:~
2671
141
 : This function does the same as the insert-nodes function except
128
 : This function does the same as the <code>insert-nodes()</code> function
2672
142
 : it immediately applies the resulting pending updates and returns the
129
 : except it immediately applies the resulting pending updates and returns the
2673
143
 : nodes that have been inserted.
130
 : nodes that have been inserted.
2674
144
 :
131
 :
2683
145
 : @param $name The name of the collection to which the nodes should be added.
132
 : @param $name The name of the collection to insert into.
2684
146
 : @param $content The sequences of nodes whose copies should be added to the collection.
133
 : @param $content The sequence of nodes whose copies will be inserted.
2685
147
 :
134
 : @return The sequence of nodes that have been inserted.
2686
148
 : @return The result of the function is the sequence of nodes that have been
135
 : @error zerr:ZDDY0003 if the collection is not available.
2679
149
 :         inserted into the collection.
2680
150
 :
2681
151
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
2682
152
 :
2687
153
 : @see dml:insert-nodes-first
136
 : @see dml:insert-nodes-first
2688
154
 :
2689
155
 :)
137
 :)
2693
156
declare %an:sequential function dml:apply-insert-nodes-first(
138
declare %an:sequential function
2694
157
  $name as xs:string,
139
dml:apply-insert-nodes-first( $name as xs:string, $content as node()* )
2695
158
  $content as node()*) as node()*
140
  as node()*
2696
159
{
141
{
2698
160
  qdml:apply-insert-nodes-first(ddl:to-qname($name), $content)
142
  qdml:apply-insert-first( ddl:to-qname( $name ), $content )
2699
161
};
143
};
2700
162
144
2701
163
(:~
145
(:~
2704
164
 : This function does the same as the insert-nodes-last function except
146
 : This function does the same as the <code>insert-nodes-last()</code> function
2705
165
 : it immediately applies the resulting pending updates and returns the
147
 : except it immediately applies the resulting pending updates and returns the
2706
166
 : nodes that have been inserted.
148
 : nodes that have been inserted.
2707
167
 :
149
 :
2716
168
 : @param $name The name of the collection to which the nodes should be added.
150
 : @param $name The name of the collection to insert into.
2717
169
 : @param $content The sequences of nodes whose copies should be added to the collection.
151
 : @param $content The sequence of nodes whose copies will be inserted.
2718
170
 :
152
 : @return The sequence of nodes that have been inserted.
2719
171
 : @return The result of the function is the sequence of nodes that have been
153
 : @error zerr:ZDDY0003 if the collection is not available.
2712
172
 :         inserted into the collection.
2713
173
 :
2714
174
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
2715
175
 :
2720
176
 : @see dml:insert-nodes-last
154
 : @see dml:insert-nodes-last
2721
177
 :
2722
178
 :)
155
 :)
2726
179
declare %an:sequential function dml:apply-insert-nodes-last(
156
declare %an:sequential function
2727
180
  $name as xs:string,
157
dml:apply-insert-nodes-last( $name as xs:string, $content as node()* )
2728
181
  $content as node()*) as node()*
158
  as node()*
2729
182
{
159
{
2731
183
  qdml:apply-insert-nodes-last(ddl:to-qname($name), $content)
160
  qdml:apply-insert-last( ddl:to-qname( $name ), $content )
2732
184
};
161
};
2733
185
162
2734
186
(:~
163
(:~
2749
187
 : This function does the same as the insert-nodes-before function except
164
 : This function does the same as the <code>insert-nodes-before()</code>
2750
188
 : it immediately applies the resulting pending updates and returns the
165
 : function except it immediately applies the resulting pending updates and
2751
189
 : nodes that have been inserted.
166
 : returns the nodes that have been inserted.
2752
190
 :
167
 :
2753
191
 : @param $name The name of the collection to which the nodes should be added.
168
 : @param $name The name of the collection to insert into.
2754
192
 : @param $target The node in the collection before which the $content
169
 : @param $target The node in the collection before which <code>$content</code>
2755
193
 :        sequence should be inserted.
170
 : will be inserted.
2756
194
 : @param $content The sequences of nodes whose copies should be added to the collection.
171
 : @param $content The sequence of nodes whose copies will be inserted.
2757
195
 :
172
 : @return The sequence of nodes that have been inserted.
2758
196
 : @return The result of the function is the sequence of nodes that have been
173
 : @error zerr:ZDDY0003 if the collection is not available.
2745
197
 :         inserted into the collection.
2746
198
 :
2747
199
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
2748
200
 :
2759
201
 : @see dml:insert-nodes-before
174
 : @see dml:insert-nodes-before
2760
202
 :
2761
203
 :)
175
 :)
2766
204
declare %an:sequential function dml:apply-insert-nodes-before(
176
declare %an:sequential function
2767
205
  $name as xs:string,
177
dml:apply-insert-nodes-before( $name as xs:string,
2768
206
  $target as node(),
178
                               $target as node(),
2769
207
  $content as node()*) as node()*
179
                               $content as node()* )
2770
180
  as node()*
2771
208
{
181
{
2773
209
  qdml:apply-insert-nodes-before(ddl:to-qname($name), $target, $content)
182
  qdml:apply-insert-before( ddl:to-qname( $name ), $target, $content )
2774
210
};
183
};
2775
211
184
2776
212
(:~
185
(:~
2791
213
 : This function does the same as the insert-nodes-after function except
186
 : This function does the same as the <code>insert-nodes-after()</code>
2792
214
 : it immediately applies the resulting pending updates and returns the
187
 : function except it immediately applies the resulting pending updates and
2793
215
 : nodes that have been inserted.
188
 : returns the nodes that have been inserted.
2794
216
 :
189
 :
2795
217
 : @param $name The name of the collection to which the nodes should be added.
190
 : @param $name The name of the collection to insert into.
2796
218
 : @param $target The node in the collection after which the $content
191
 : @param $target The node in the collection after which <code>$content</code>
2797
219
 :        sequence should be inserted.
192
 : will be inserted.
2798
220
 : @param $content The sequences of nodes whose copies should be added to the collection.
193
 : @param $content The sequence of nodes whose copies will be inserted.
2799
221
 :
194
 : @return The sequence of nodes that have been inserted.
2800
222
 : @return The result of the function is the sequence of nodes that have been
195
 : @error zerr:ZDDY0003 if the collection is not available.
2787
223
 :         inserted into the collection.
2788
224
 :
2789
225
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
2790
226
 :
2801
227
 : @see dml:insert-nodes-after
196
 : @see dml:insert-nodes-after
2925
228
 :
197
 :)
2926
229
 :)
198
declare %an:sequential function
2927
230
declare %an:sequential function dml:apply-insert-nodes-after(
199
dml:apply-insert-nodes-after( $name as xs:string,
2928
231
  $name as xs:string,
200
                              $pos as node(),
2929
232
  $pos as node(),
201
                              $content as node()* )
2930
233
  $content as node()*) as node()*
202
  as node()*
2931
234
{
203
{
2932
235
  qdml:apply-insert-nodes-after(ddl:to-qname($name), $pos, $content)
204
  qdml:apply-insert-after( ddl:to-qname( $name ), $pos, $content )
2933
236
};
205
};
2934
237
206
2935
238
(:~
207
(:~
2936
239
 : The delete-nodes function is an updating function that deletes zero of more
208
 : Gets the sequence of nodes of the collection identified by the given name.
2814
240
 : nodes from a collection. 
2815
241
 :
2816
242
 : @param $target the nodes in the collection that should be deleted.
2817
243
 :
2818
244
 : @return The result of this function is an empty XDM instance and a pending update
2819
245
 :         list which, once applied, deletes the nodes from their collections.
2820
246
 :
2821
247
 : @error zerr:ZDDY0011 if any nodes in the $target sequence is not a member of a collection
2822
248
 :        or not all nodes of the $target sequence belong to the same collection.
2823
249
 :        the collection identified by the $name parameter.
2824
250
 :
2825
251
 :)
2826
252
declare updating function dml:delete-nodes($target as node()*)
2827
253
{
2828
254
  qdml:delete-nodes($target)
2829
255
};
2830
256
2831
257
(:~
2832
258
 : The delete-node-first function is an updating function that deletes the
2833
259
 : first node from a collection.
2834
260
 :
2835
261
 : @param $name The name of the collection from which the first node should be deleted.
2836
262
 :
2837
263
 : @return The result of this function is an empty XDM instance and a pending update
2838
264
 :         list which, once applied, deletes the first node from the collection.
2839
265
 :
2840
266
 : @error zerr:ZDDY0011 if the collection doesn't contain any node.
2841
267
 :
2842
268
 :)
2843
269
declare updating function dml:delete-node-first($name as xs:string)
2844
270
{
2845
271
  qdml:delete-node-first(ddl:to-qname($name))
2846
272
};
2847
273
2848
274
(:~
2849
275
 : The delete-nodes-first function is an updating function that deletes the
2850
276
 : first n nodes from a collection.
2851
277
 :
2852
278
 : @param $name The name of the collection from which the first node should be deleted.
2853
279
 : @param $number The number of nodes that should be removed from the beginning of
2854
280
 :        the collection.
2855
281
 :
2856
282
 : @return The result of this function is an empty XDM instance and a pending update
2857
283
 :         list which, once applied, deletes the nodes from the collection.
2858
284
 :
2859
285
 : @error zerr:ZDDY0011 if the collection doesn't contain the given number of nodes.
2860
286
 :)
2861
287
declare updating function dml:delete-nodes-first(
2862
288
  $name as xs:string,
2863
289
  $number as xs:integer)
2864
290
{
2865
291
  qdml:delete-nodes-first(ddl:to-qname($name), $number)
2866
292
};
2867
293
2868
294
(:~
2869
295
 : The delete-node-last function is an updating function that deletes the
2870
296
 : last node from a collection.
2871
297
 :
2872
298
 : @param $name The name of the collection from which the first node should be deleted.
2873
299
 :
2874
300
 : @return The result of this function is an empty XDM instance and a pending update
2875
301
 :         list which, once applied, deletes the last node from the collection.
2876
302
 :
2877
303
 : @error zerr:ZDDY0009 If available collections does not provide a mapping
2878
304
 :        for the URI $name.
2879
305
 : @error zerr:ZDDY0011 if the collection doesn't contain any node.
2880
306
 :)
2881
307
declare updating function dml:delete-node-last($name as xs:string)
2882
308
{
2883
309
  qdml:delete-node-last(ddl:to-qname($name))
2884
310
};
2885
311
2886
312
(:~
2887
313
 : The delete-nodes-last function is an updating function that deletes the
2888
314
 : last n nodes from an ordered collection.
2889
315
 :
2890
316
 : @param $name The name of the collection from which the first node should be deleted.
2891
317
 : @param $number The number of nodes to delete.
2892
318
 :
2893
319
 : @return The result of this function is an empty XDM instance and a pending update
2894
320
 :         list which, once applied, deletes the last n nodes.
2895
321
 :
2896
322
 : @error zerr:ZDDY0009 If available collections does not provide a mapping
2897
323
 :        for the URI $name.
2898
324
 : @error zerr:ZDDY0011 if the collection doesn't contain the given number of nodes.
2899
325
 :)
2900
326
declare updating function dml:delete-nodes-last(
2901
327
  $name as xs:string,
2902
328
  $number as xs:integer)
2903
329
{
2904
330
  qdml:delete-nodes-last(ddl:to-qname($name), $number)
2905
331
};
2906
332
2907
333
(:~
2908
334
 : The index-of function return the index of the given node in the collection.
2909
335
 :
2910
336
 : @param node The node to retrieve the index from.
2911
337
 :
2912
338
 : @return Returns the position as xs:integer of the given node in the collection.
2913
339
 :
2914
340
 : @error zerr:ZDDY0011 if node is not contained in any collection.
2915
341
 :
2916
342
 :)
2917
343
declare function dml:index-of($node as node()) as xs:integer
2918
344
{
2919
345
  qdml:index-of($node)
2920
346
};
2921
347
2922
348
(:~
2923
349
 : The collection function returns the sequence of nodes of the collection
2924
350
 : identified by the given name.
2937
351
 :
209
 :
2938
352
 : @param $name The name of the collection.
210
 : @param $name The name of the collection.
2939
353
 :
2940
354
 : @return The sequence contained in the given collection.
211
 : @return The sequence contained in the given collection.
2966
355
 :
212
 : @error zerr:ZDDY0003 if the collection is not available.
2967
356
 : @error zerr:ZDDY0009 If available collections does not provide a mapping
213
 :)
2968
357
 :        for the URI $name.
214
declare function dml:collection( $name as xs:string )
2969
358
 :
215
  as node()*
2970
359
 :)
216
{
2971
360
declare function dml:collection($name as xs:string) as node()*
217
  qdml:collection( ddl:to-qname( $name ) )
2972
361
{
218
};
2973
362
  qdml:collection(ddl:to-qname($name))
219
2974
363
};
220
(:~
2975
364
221
 : Gets the name of the collection the given node belongs to.
2976
365
(:~
222
 :
2977
366
 : This function returns the name of the collection the given node belongs
223
 : @param $node The node for which to get the name of the collection.
2978
367
 : to.
224
 : @return The URI of the collection to which <code>$node</code> belongs.
2979
368
 :
225
 : @error zerr:ZDDY0011 if <code>$node</code> does not belong to a collection.
2980
369
 : @param $node The node for which to get the name of the collection
226
 :)
2981
370
 : @return The result of this function is a URI which identifies the collection
227
declare function dml:collection-name( $node as node() )
2982
371
 :         to which the given node belongs to.
228
  as xs:string
2983
372
 :
229
{
2984
373
 : @error zerr:ZDDY0011 if the given node does not belong to a collection.
230
  ddl:from-qname( qdml:collection-name( $node ) )
2985
374
 :
231
};
2986
375
 :)
232
2987
376
declare function dml:collection-name($node as node()) as xs:string
233
(:~
2988
377
{
234
 : Deletes nodes from a collection. 
2989
378
  ddl:from-qname(qdml:collection-name($node))
235
 :
2990
379
};
236
 : @param $nodes the nodes in the collection that should be deleted.
2991
237
 : @return An empty XDM instance and a pending update list that, once applied,
2992
238
 : deletes the nodes from their collections.
2993
239
 : @error zerr:ZDDY0011 if any nodes are not a member of a collection or not
2994
240
 : all nodes of belong to the same collection.
2995
241
 :)
2996
242
declare updating function dml:delete-nodes( $nodes as node()* )
2997
243
{
2998
244
  qdml:delete( $nodes )
2999
245
};
3000
246
3001
247
(:~
3002
248
 : Deletes the first node from a collection.
3003
249
 :
3004
250
 : @param $name The name of the collection to delete from.
3005
251
 : @return An empty XDM instance and a pending update list that, once applied,
3006
252
 : deletes the first node from the collection.
3007
253
 : @error zerr:ZDDY0011 if the collection is empty.
3008
254
 :)
3009
255
declare updating function dml:delete-node-first( $name as xs:string )
3010
256
{
3011
257
  qdml:delete-first( ddl:to-qname( $name ) )
3012
258
};
3013
259
3014
260
(:~
3015
261
 : Deletes the first <i>N</i> nodes from a collection.
3016
262
 :
3017
263
 : @param $name The name of the collection to delete from.
3018
264
 : @param $number The number of nodes to delete.
3019
265
 : @return An empty XDM instance and a pending update list that, once applied,
3020
266
 : deletes the nodes from the collection.
3021
267
 : @error zerr:ZDDY0011 if the collection contains less than
3022
268
 : <code>$number</code> items.
3023
269
 :)
3024
270
declare updating function dml:delete-nodes-first( $name as xs:string,
3025
271
                                                  $number as xs:integer )
3026
272
{
3027
273
  qdml:delete-first( ddl:to-qname( $name ), $number )
3028
274
};
3029
275
3030
276
(:~
3031
277
 : Deletes the last node from a collection.
3032
278
 :
3033
279
 : @param $name The name of the collection to delete from.
3034
280
 : @return An empty XDM instance and a pending update list that, once applied,
3035
281
 : deletes the last node from the collection.
3036
282
 : @error zerr:ZDDY0003 if the collection is not available.
3037
283
 : @error zerr:ZDDY0011 if the collection is empty.
3038
284
 :)
3039
285
declare updating function dml:delete-node-last( $name as xs:string )
3040
286
{
3041
287
  qdml:delete-last( ddl:to-qname( $name ) )
3042
288
};
3043
289
3044
290
(:~
3045
291
 : Deletes the last <i>N</i> nodes from a collection.
3046
292
 :
3047
293
 : @param $name The name of the collection to delete from.
3048
294
 : @param $number The number of nodes to delete.
3049
295
 : @return An empty XDM instance and a pending update list that, once applied,
3050
296
 : deletes the last n nodes.
3051
297
 : @error zerr:ZDDY0003 if the collection is not available.
3052
298
 : @error zerr:ZDDY0011 if the collection contains less than
3053
299
 : <code>$number</code> items.
3054
300
 :)
3055
301
declare updating function dml:delete-nodes-last( $name as xs:string,
3056
302
                                                 $number as xs:integer )
3057
303
{
3058
304
  qdml:delete-last( ddl:to-qname( $name ), $number )
3059
305
};
3060
306
3061
307
(:~
3062
308
 : Gets the index of the given node in the collection.
3063
309
 :
3064
310
 : @param $node The node to get the index of.
3065
311
 : @return Returns the position of <code>$node</code> in the collection.
3066
312
 : @error zerr:ZDDY0011 if <code>$node</code> is not contained in any
3067
313
 : collection.
3068
314
 :)
3069
315
declare function dml:index-of( $node as node() )
3070
316
  as xs:integer
3071
317
{
3072
318
  qdml:index-of( $node )
3073
319
};
3074
320
3075
321
(:===========================================================================:)
3076
322
3077
323
(: vim:set et sw=2 ts=2: :)
3078
380
324
3079
=== renamed directory 'modules/com/zorba-xquery/www/modules/store/static' => 'modules/store/static'
3080
=== modified file 'modules/store/static/collections/ddl.xq'
3081
--- modules/com/zorba-xquery/www/modules/store/static/collections/ddl.xq	2013-09-26 23:15:11 +0000
3082
+++ modules/store/static/collections/ddl.xq	2013-10-17 02:02:41 +0000
3083
@@ -1,7 +1,7 @@
3084
1
xquery version "3.0";
1
xquery version "3.0";
3085
2
2
3086
3
(:
3
(:
3088
4
 : Copyright 2006-2009 The FLWOR Foundation.
4
 : Copyright 2006-2013 The FLWOR Foundation.
3089
5
 :
5
 :
3090
6
 : Licensed under the Apache License, Version 2.0 (the "License");
6
 : Licensed under the Apache License, Version 2.0 (the "License");
3091
7
 : you may not use this file except in compliance with the License.
7
 : you may not use this file except in compliance with the License.
3092
@@ -17,146 +17,128 @@
3093
17
 :)
17
 :)
3094
18
18
3095
19
(:~
19
(:~
3097
20
 : This modules defines a set of functions for managing collections which are
20
 : This modules defines a set of functions for managing collections that are
3098
21
 : declared in the prolog of a module.
21
 : declared in the prolog of a module.
3102
22
 : For example, it provides functions to create, delete, or introspect collections.
22
 : For example, it provides functions to create, delete, or introspect
3103
23
 :
23
 : collections.
3104
24
 : <p>This module is part of <a href="../zorba/xqddf.html">Zorba's XQuery Data
24
 : <p/>
3105
25
 : This module is part of <a href="../zorba/xqddf.html">Zorba's XQuery Data
3106
25
 : Definition Facility</a>. All the collections managed by this module
26
 : Definition Facility</a>. All the collections managed by this module
3107
26
 : have to be pre-declared in the prolog of a module. Please refer to the
27
 : have to be pre-declared in the prolog of a module. Please refer to the
3108
27
 : <a href="../zorba/data_lifecycle.html">general documentation</a>
28
 : <a href="../zorba/data_lifecycle.html">general documentation</a>
3110
28
 : for more information and examples.</p>
29
 : for more information and examples.
3111
29
 :
30
 :
3112
30
 : @see <a href="../zorba/data_lifecycle.html">Data Lifecycle</a>
31
 : @see <a href="../zorba/data_lifecycle.html">Data Lifecycle</a>
3113
31
 : @see <a href="../zorba/xqddf.html">XQuery Data Definition Facility</a>
32
 : @see <a href="../zorba/xqddf.html">XQuery Data Definition Facility</a>
3119
32
 : @see http://www.zorba-xquery.com/modules/store/static/collections/dml
33
 : @see http://zorba.io/modules/store/static/collections/dml
3120
33
 : @see http://www.zorba-xquery.com/modules/store/static/indexes/ddl
34
 : @see http://zorba.io/modules/store/static/indexes/ddl
3121
34
 : @see http://www.zorba-xquery.com/modules/store/static/indexes/dml
35
 : @see http://zorba.io/modules/store/static/indexes/dml
3122
35
 : @see http://www.zorba-xquery.com/modules/store/static/integrity_constraints/ddl
36
 : @see http://zorba.io/modules/store/static/integrity-constraints/ddl
3123
36
 : @see http://www.zorba-xquery.com/modules/store/static/integrity_constraints/dml
37
 : @see http://zorba.io/modules/store/static/integrity-constraints/dml
3124
37
 : @see http://zorba.io/errors
38
 : @see http://zorba.io/errors
3125
38
 :
39
 :
3126
39
 : @author Nicolae Brinza, Matthias Brantner, David Graf, Till Westmann, Markos Zaharioudakis
40
 : @author Nicolae Brinza, Matthias Brantner, David Graf, Till Westmann, Markos Zaharioudakis
3127
40
 :
3128
41
 : @project Zorba/Data Store/Collections/Static Data Definition
41
 : @project Zorba/Data Store/Collections/Static Data Definition
3129
42
 :
3130
43
 :)
42
 :)
3132
44
module namespace cddl = "http://www.zorba-xquery.com/modules/store/static/collections/ddl";
43
module namespace cddl = "http://zorba.io/modules/store/static/collections/ddl";
3133
45
44
3134
46
declare namespace zerr = "http://zorba.io/errors";
45
declare namespace zerr = "http://zorba.io/errors";
3135
47
declare namespace ver = "http://zorba.io/options/versioning";
46
declare namespace ver = "http://zorba.io/options/versioning";
3136
48
declare option ver:module-version "2.0";
47
declare option ver:module-version "2.0";
3137
49
48
3199
50
49
(:===========================================================================:)
3200
51
(:~
50
3201
52
 : The create function is an updating function which creates
51
(:~
3202
53
 : the collection with the given expanded QName.
52
 : Gets the QNames of the collections that have been statically declared and
3203
54
 :
53
 : are available, if any.
3204
55
 : @param $name The QName of the collection to create.
54
:
3205
56
 :
55
 : @return A sequence comprising one QName for each statically declared and
3206
57
 : @return The result of the function is an empty XDM instance and a 
56
 : available collection or an emtpy sequence if no such collections are
3207
58
 :         pending update list which, once applied, creates a collection
57
 : available.
3208
59
 :         with the given name.
58
 :)
3209
60
 :
59
declare function cddl:available-collections()
3210
61
 : @error zerr:ZDDY0001 if the expanded QName $name is not equal
60
  as xs:QName* external;
3211
62
 :        to any of the declared collections in the static context.
61
3212
63
 : @error zerr:ZDDY0002 if a collection with the given expanded QName already
62
(:~
3213
64
 :        exists.
63
 : Creates a collection.
3214
65
 :
64
 :
3215
66
 :)
65
 : @param $name The of the collection to create.
3216
67
declare updating function cddl:create($name as xs:QName) external;
66
 : @return An empty XDM instance and a pending update list that, once applied,
3217
68
67
 : creates a collection with the given name.
3218
69
68
 : @error zerr:ZDDY0001 if <code>$name</code> is not equal to any of the
3219
70
(:~
69
 : declared collections in the static context.
3220
71
 : The create function is an updating function which creates
70
 : @error zerr:ZDDY0002 if a collection with <code>$name</code> already exists.
3221
72
 : the collection with the given expanded QName. Moreover, it adds copies
71
 :)
3222
73
 : of the sequence $content to the new collection.
72
declare updating function cddl:create( $name as xs:QName ) external;
3223
74
 :
73
3224
75
 : @param $name The QName of the collection to create.
74
(:~
3225
76
 : @param $content The sequences of items (nodes and/or json items) that should
75
 : Creates a collection and adds the given sequence as content to the new
3226
77
 :        be added to the new collection.
76
 : collection.
3227
78
 :
77
 :
3228
79
 : @return The result of the function is an empty XDM instance and a 
78
 : @param $name The name of the collection to create.
3229
80
 :         pending update list which, once applied, creates a collection
79
 : @param $content The sequences of items (nodes or JSON items) to be added to
3230
81
 :         with the given name and inserts the given items into it.
80
 : the new collection.
3231
82
 :
81
 : @return An empty XDM instance and a pending update list that, once applied,
3232
83
 : @error zerr:ZDDY0001 if the expanded QName $name is not equal
82
 : creates a collection with the given name and inserts the given items into
3233
84
 :        to any of the declared collections in the static context.
83
 : it.
3234
85
 : @error zerr:ZDDY0002 if a collection with the given expanded QName already
84
 : @error zerr:ZDDY0001 if <code>$name</code> is not equal to any of the
3235
86
 :        exists.
85
 : declared collections in the static context.
3236
87
 : @error zerr:ZDTY0001 if $content does not match the expected type
86
 : @error zerr:ZDDY0002 if a collection with <code>$name</code> already exists.
3237
88
 :        (i.e. declared by the collection) according to the rules
87
 : @error zerr:ZDTY0001 if <code>$content</code> does not match the expected
3238
89
 :        for SequenceType Matching.
88
 : type declared by the collection according to the rules for SequenceType
3239
90
 :
89
 : Matching.
3240
91
 :)
90
 :)
3241
92
declare updating function cddl:create($name as xs:QName, $content as item()*) external;
91
declare updating function cddl:create( $name as xs:QName,
3242
93
92
                                       $content as item()* )
3243
94
93
  external;
3244
95
(:~
94
3245
96
 : The delete function is an updating function that deletes
95
(:~
3246
97
 : the collection with the given expanded QName.
96
 : Gets the collections that have been declared in the prolog of the static
3247
98
 :
97
 : context.
3248
99
 : @param $name The QName of the collection to delete.
98
 :
3249
100
 :
99
 : @return A sequence of QNames, one for each collection created in the static
3250
101
 : @return The result of the function is an empty XDM instance and a pending
100
 : context, or an emtpy sequence.
3251
102
 :         update list which, once applied, deletes the collection with the given
101
 :)
3252
103
 :         name.
102
declare function cddl:declared-collections()
3253
104
 :
103
  as xs:QName* external;
3254
105
 : @error zerr:ZDDY0001 if the expanded QName $name is not equal
104
3255
106
 :        to any of the declared collections in the static context.
105
(:~
3256
107
 : @error zerr:ZDDY0003 if the expanded QName $name is not equal
106
 : Deletes a collection.
3257
108
 :        to any of the available collections.
107
 :
3258
109
 : @error zerr:ZDDY0015 if any of the in-scope variables references an item that
108
 : @param $name The collection to delete.
3259
110
 :        belongs to the collection with QName $name.
109
 : @return An empty XDM instance and a pending update list that, once applied,
3260
110
 : deletes the collection with the given name.
3261
111
 : @error zerr:ZDDY0001 if <code>$name</code> is not equal to any of the
3262
112
 : declared collections in the static context.
3263
113
 : @error zerr:ZDDY0003 if the collection identified by <code>$name</code> is
3264
114
 : not available.
3265
111
 : @error zerr:ZDDY0013 if the domain or key expression of any of the available
115
 : @error zerr:ZDDY0013 if the domain or key expression of any of the available
3317
112
 :        indexes access the collection with name $name.
116
 : indexes access the collection having <code>$name</code>.
3318
113
 :
117
 : @error zerr:ZDDY0015 if any of the in-scope variables references an item
3319
114
 :)
118
 : that belongs to the collection having <code>$name</code>
3320
115
declare updating function cddl:delete($name as xs:QName) external;
119
 :)
3321
116
120
declare updating function cddl:delete( $name as xs:QName )
3322
117
121
  external;
3323
118
(:~
122
3324
119
 : The function returns true if a collection with the given QName is
123
(:~
3325
120
 : statically declared and available (i.e. has been created).
124
 : Gets whether a collection is statically declared and available.
3326
121
 :
125
 :
3327
122
 : @param $name The QName of the collection that is being checked.
126
 : @param $name The name of the collection to check.
3328
123
 :
127
 : @return true if the collection was statically declared and is available;
3329
124
 : @return true if the collection is statically declared and available,
128
 : false otherwise.
3330
125
 :   false otherwise.
129
 :)
3331
126
 :
130
declare function cddl:is-available-collection( $name as xs:QName )
3332
127
 :)
131
  as xs:boolean external;
3333
128
declare function cddl:is-available-collection($name as xs:QName) as xs:boolean external;
132
3334
129
133
(:~
3335
130
134
 : Gers whether a collection was declared in the prolog of the static context.
3336
131
(:~
135
 :
3337
132
 : The function returns a sequence of QNames of the collections that are
136
 : @param $name The name of the collection to check.
3338
133
 : statically declared and available. The sequence will be empty if there
137
 : @return true if the collection was declared; false otherwise.
3339
134
 : are no such collections.
138
 :)
3340
135
 :
139
declare function cddl:is-declared-collection( $name as xs:QName )
3341
136
 : @return A sequence of QNames, one for each statically declared and available
140
  as xs:boolean external;
3342
137
 :  collection, or an emtpy sequence.
141
3343
138
 :
142
(:===========================================================================:)
3344
139
 :)
143
3345
140
declare function cddl:available-collections() as xs:QName*  external;
144
(: vim:set et sw=2 ts=2: :)
3295
141
3296
142
3297
143
(:~
3298
144
 : The function returns true if a collection with the given
3299
145
 : QName is declared in the prolog of the static context.
3300
146
 :
3301
147
 : @param $name The QName of the collection that is being checked.
3302
148
 :
3303
149
 : @return true if the collection is declared or false otherwise.
3304
150
 :
3305
151
 :)
3306
152
declare function cddl:is-declared-collection($name as xs:QName) as xs:boolean external;
3307
153
3308
154
3309
155
(:~
3310
156
 : The function returns a sequence of QNames representing the collections that have
3311
157
 : been declared in the prolog of the static context.
3312
158
 :
3313
159
 : @return A sequence of QNames, one for each created collection, or an emtpy sequence.
3314
160
 :
3315
161
 :)
3316
162
declare function cddl:declared-collections() as xs:QName*  external;
3346
163
145
3347
=== modified file 'modules/store/static/collections/dml.xq'
3348
--- modules/com/zorba-xquery/www/modules/store/static/collections/dml.xq	2013-09-26 23:15:11 +0000
3349
+++ modules/store/static/collections/dml.xq	2013-10-17 02:02:41 +0000
3350
@@ -1,7 +1,7 @@
3351
1
xquery version "3.0";
1
xquery version "3.0";
3352
2
2
3353
3
(:
3
(:
3355
4
 : Copyright 2006-2009 The FLWOR Foundation.
4
 : Copyright 2006-2013 The FLWOR Foundation.
3356
5
 :
5
 :
3357
6
 : Licensed under the Apache License, Version 2.0 (the "License");
6
 : Licensed under the Apache License, Version 2.0 (the "License");
3358
7
 : you may not use this file except in compliance with the License.
7
 : you may not use this file except in compliance with the License.
3359
@@ -17,30 +17,30 @@
3360
17
:)
17
:)
3361
18
18
3362
19
(:~
19
(:~
3369
20
 : This modules provides a set of functions to modify a collection and retrieve the items
20
 : This modules provides a set of functions to modify a collection
3370
21
 : contained in a particular collection.
21
 : and retrieve the items contained in a particular collection.
3371
22
 :
22
 : <p/>
3372
23
 : <p>This module is part of <a href="../zorba/xqddf.html">Zorba's XQuery Data
23
 : This module is part of
3373
24
 : Definition Facility</a>. All the collections managed by this module
24
 : <a href="../zorba/xqddf.html">Zorba's XQuery Data Definition Facility</a>.
3374
25
 : have to be pre-declared in the prolog of a module. Please refer to the
25
 : All the collections managed by this module have to be pre-declared in the
3375
26
 : prolog of a module.
3376
27
 : Please refer to the
3377
26
 : <a href="../zorba/data_lifecycle.html">general documentation</a>
28
 : <a href="../zorba/data_lifecycle.html">general documentation</a>
3379
27
 : for more information and examples.</p>
29
 : for more information and examples.
3380
28
 :
30
 :
3381
29
 : @see <a href="../zorba/data_lifecycle.html">Data Lifecycle</a>
31
 : @see <a href="../zorba/data_lifecycle.html">Data Lifecycle</a>
3382
30
 : @see <a href="../zorba/xqddf.html">XQuery Data Definition Facility</a>
32
 : @see <a href="../zorba/xqddf.html">XQuery Data Definition Facility</a>
3388
31
 : @see http://www.zorba-xquery.com/modules/store/static/collections/ddl
33
 : @see http://zorba.io/modules/store/static/collections/ddl
3389
32
 : @see http://www.zorba-xquery.com/modules/store/static/indexes/ddl
34
 : @see http://zorba.io/modules/store/static/indexes/ddl
3390
33
 : @see http://www.zorba-xquery.com/modules/store/static/indexes/dml
35
 : @see http://zorba.io/modules/store/static/indexes/dml
3391
34
 : @see http://www.zorba-xquery.com/modules/store/static/integrity_constraints/ddl
36
 : @see http://zorba.io/modules/store/static/integrity-constraints/ddl
3392
35
 : @see http://www.zorba-xquery.com/modules/store/static/integrity_constraints/dml
37
 : @see http://zorba.io/modules/store/static/integrity-constraints/dml
3393
36
 : @see http://zorba.io/errors
38
 : @see http://zorba.io/errors
3394
37
 :
39
 :
3395
38
 : @author Nicolae Brinza, Matthias Brantner, David Graf, Till Westmann, Markos Zaharioudakis
40
 : @author Nicolae Brinza, Matthias Brantner, David Graf, Till Westmann, Markos Zaharioudakis
3396
39
 :
3397
40
 : @project Zorba/Data Store/Collections/Static Data Manipulation
41
 : @project Zorba/Data Store/Collections/Static Data Manipulation
3398
41
 :
3399
42
 :)
42
 :)
3401
43
module namespace cdml = "http://www.zorba-xquery.com/modules/store/static/collections/dml";
43
module namespace cdml = "http://zorba.io/modules/store/static/collections/dml";
3402
44
44
3403
45
declare namespace an = "http://zorba.io/annotations";
45
declare namespace an = "http://zorba.io/annotations";
3404
46
declare namespace zerr = "http://zorba.io/errors";
46
declare namespace zerr = "http://zorba.io/errors";
3405
@@ -48,923 +48,430 @@
3406
48
declare namespace ver = "http://zorba.io/options/versioning";
48
declare namespace ver = "http://zorba.io/options/versioning";
3407
49
declare option ver:module-version "2.0";
49
declare option ver:module-version "2.0";
3408
50
50
3647
51
51
(:===========================================================================:)
3648
52
(:~
52
3649
53
 : The insert-nodes function is an updating function that inserts copies of the
53
(:~
3650
54
 : given nodes into a collection. 
54
 : Gets the sequence of nodes or JSON items from a collection.
3651
55
 : Please note that the insertion position of the nodes in the collection is
55
 :
3652
56
 : not defined.
56
 : @param $name The name of the collection.
3653
57
 :
57
 : @return The seqnence of items from the collection.
3654
58
 : @param $name The name of the collection to which the nodes should be added.
58
 : @error zerr:ZDDY0001 if the collection is not declared.
3655
59
 : @param $content The sequences of nodes whose copies should be added to the collection.
59
 : @error zerr:ZDDY0003 if the collection is not available.
3656
60
 :
60
 :)
3657
61
 : @return The result of the function is an empty XDM instance and a pending update list
61
declare function cdml:collection( $name as xs:QName )
3658
62
 :         which, once applied, inserts the nodes into the collection.
62
  as item()* external;
3659
63
 :
63
3660
64
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
64
(:~
3661
65
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
65
 : Gets the sequence of nodes or JSON items from a collection.
3662
66
 : @error zerr:ZDDY0006 if the modifier property of the collection $name is append-only,
66
 :
3663
67
 :        const, or queue.
67
 : @param $name The name of the collection.
3664
68
 : @error zerr:ZDTY0001 if $content does not match the expected type (as specified
68
 : @param $skip The initial number of items to skip.
3665
69
 :        in the collection declaration) according to the rules for SequenceType Matching.
69
 : @return The (sub)sequence of items from the collection.
3666
70
 :
70
 :
3667
71
 : @deprecated please use the cdml:insert#2 function
71
 : @error zerr:ZDDY0001 if the collection is not declared.
3668
72
 :
72
 : @error zerr:ZDDY0003 if the collection is not available.
3669
73
 :)
73
 :)
3670
74
declare updating function 
74
declare function cdml:collection( $name as xs:QName, $skip as xs:integer )
3671
75
cdml:insert-nodes($name as xs:QName, $content as node()*) external;
75
  as item()* external;
3672
76
76
3673
77
77
(:~
3674
78
(:~
78
 : Gets the sequence of items (nodes or JSON items) from a collection.
3675
79
 : The insert function is an updating function that inserts copies of the given
79
 : The parameters <code>$start</code> and <code>$skip</code> can be used to
3676
80
 : items (nodes and/or json items) into a collection. Please note that the 
80
 : skip over some items at the beginning of the collection.
3677
81
 : insertion position of the items in the collection is not defined.
81
 : If both are given, both are applied:
3678
82
 :
82
 : first <code>$start</code> to skip to the referenced item
3679
83
 : @param $name The name of the collection to which the items should be added.
83
 : and then <code>$skip</code> to skip that additional number of items.
3680
84
 : @param $content The sequences of items whose copies should be added to the collection.
84
 :
3681
85
 :
85
 : @param $name The name of the collection.
3682
86
 : @return The result of the function is an empty XDM instance and a pending update list
86
 : @param $start The reference to the first item to return.
3683
87
 :         which, once applied, inserts the items into the collection.
87
 : @param $skip The number of additional items to skip.
3684
88
 :
88
 : @return The sub-sequence from the collection.
3685
89
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
89
 : @error zerr:ZAPI0028 If the given URI is not a valid node position computed
3686
90
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
90
 : by the <code>np:node-position</code> function.
3687
91
 : @error zerr:ZDDY0006 if the modifier property of the collection $name is append-only,
91
 : @error zerr:ZDDY0001 if the collection is not declared.
3688
92
 :        const, or queue.
92
 : @error zerr:ZDDY0003 if the collection is not available.
3689
93
 : @error zerr:ZDTY0001 if $content does not match the expected type (as specified
93
 : @error zerr:ZSTR0066 if <code>$start</code> does not reference a node from
3690
94
 :        in the collection declaration) according to the rules for SequenceType 
94
 : the collection.
3691
95
 :        Matching.
95
 :)
3692
96
 :
96
declare function cdml:collection( $name as xs:QName, 
3693
97
 :)
97
                                  $start as xs:anyURI,
3694
98
declare updating function 
98
                                  $skip as xs:integer )
3695
99
cdml:insert($name as xs:QName, $content as item()*) external;
99
  as item()* external;
3696
100
100
3697
101
101
(:~
3698
102
(:~
102
 : Inserts copies of the given items (nodes or JSON items) into a collection.
3699
103
 : The insert-nodes-first function is an updating function that inserts copies
103
 : Note that the insertion position of the items in the collection is not
3700
104
 : of the given nodes at the beginning of a collection. 
104
 : defined.
3701
105
 :
105
 :
3702
106
 : @param $name The name of the collection to which the nodes should be added.
106
 : @param $name The name of the collection to insert into.
3703
107
 : @param $content The sequences of nodes whose copies should be added to the collection.
107
 : @param $content The sequence of items whose copies to insert.
3704
108
 :
108
 : @return An empty XDM instance and a pending update list that, once applied,
3705
109
 : @return The result of the function is an empty XDM instance and a pending update list
109
 : inserts the items into the collection.
3706
110
 :         which, once applied, inserts the nodes into the collection.
110
 :
3707
111
 :
111
 : @error zerr:ZDDY0001 if the collection is not declared.
3708
112
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
112
 : @error zerr:ZDDY0003 if the collection is not available.
3709
113
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
113
 : @error zerr:ZDDY0006 if the collection is append-only, const, or queue.
3710
114
 : @error zerr:ZDDY0006 if the modifier property of the collection $name is append-only,
114
 : @error zerr:ZDTY0001 if <code>$content</code> does not match the expected
3711
115
 :        const, or queue.
115
 : type as specified in the collection declaration according to the rules for
3712
116
 : @error zerr:ZDDY0012 if the order property of the collection $name is unordered.
116
 : SequenceType Matching.
3713
117
 : @error zerr:ZDTY0001 if $content does not match the expected type (as specified
117
 :)
3714
118
 :        in the collection declaration) according to the rules for SequenceType Matching.
118
declare updating function cdml:insert( $name as xs:QName,
3715
119
 :
119
                                       $content as item()* )
3716
120
 : @deprecated please use the cdml:insert-first#2 function
120
  external;
3479
121
 :
3480
122
 :)
3481
123
declare updating function 
3482
124
cdml:insert-nodes-first($name as xs:QName, $content as node()*)  external;
3483
125
3484
126
3485
127
(:~
3486
128
 : The insert-first function is an updating function that inserts copies of the
3487
129
 : given items (nodes and/or json items) at the beginning of a collection. 
3488
130
 :
3489
131
 : @param $name The name of the collection to which the items should be added.
3490
132
 : @param $content The sequences of items whose copies should be added to the collection.
3491
133
 :
3492
134
 : @return The result of the function is an empty XDM instance and a pending update list
3493
135
 :         which, once applied, inserts the items into the collection.
3494
136
 :
3495
137
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
3496
138
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
3497
139
 : @error zerr:ZDDY0006 if the modifier property of the collection $name is append-only,
3498
140
 :        const, or queue.
3499
141
 : @error zerr:ZDDY0012 if the order property of the collection $name is unordered.
3500
142
 : @error zerr:ZDTY0001 if $content does not match the expected type (as specified
3501
143
 :        in the collection declaration) according to the rules for SequenceType Matching.
3502
144
 :
3503
145
 :)
3504
146
declare updating function 
3505
147
cdml:insert-first($name as xs:QName, $content as item()*) external;
3506
148
3507
149
3508
150
(:~
3509
151
 : The insert-nodes-last function is an updating function that inserts
3510
152
 : copies of the given nodes at the end of a collection.
3511
153
 :
3512
154
 : @param $name The name of the collection to which the nodes should be added.
3513
155
 : @param $content The sequences of nodes whose copies should be added to the collection.
3514
156
 :
3515
157
 : @return The result of the function is an empty XDM instance and a pending update list
3516
158
 :         which, once applied, inserts the nodes into the collection.
3517
159
 :
3518
160
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
3519
161
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
3520
162
 : @error zerr:ZDDY0006 if the modifier property of the collection $name is const.
3521
163
 : @error zerr:ZDDY0012 if the order property of the collection $name is unordered.
3522
164
 : @error zerr:ZDTY0001 if $content does not match the expected type (as specified
3523
165
 :        in the collection declaration) according to the rules for SequenceType Matching.
3524
166
 :
3525
167
 : @deprecated please use the cdml:insert-last#2 function
3526
168
 :
3527
169
 :)
3528
170
declare updating function 
3529
171
cdml:insert-nodes-last($name as xs:QName, $content as node()*)  external;
3530
172
3531
173
3532
174
(:~
3533
175
 : The insert-last function is an updating function that inserts copies of the
3534
176
 : given items (nodes and/or json items) at the end of a collection.
3535
177
 :
3536
178
 : @param $name The name of the collection to which the items should be added.
3537
179
 : @param $content The sequences of itemss whose copies should be added to the collection.
3538
180
 :
3539
181
 : @return The result of the function is an empty XDM instance and a pending update list
3540
182
 :         which, once applied, inserts the items into the collection.
3541
183
 :
3542
184
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
3543
185
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
3544
186
 : @error zerr:ZDDY0006 if the modifier property of the collection $name is const.
3545
187
 : @error zerr:ZDDY0012 if the order property of the collection $name is unordered.
3546
188
 : @error zerr:ZDTY0001 if $content does not match the expected type (as specified
3547
189
 :        in the collection declaration) according to the rules for SequenceType Matching.
3548
190
 :
3549
191
 :)
3550
192
declare updating function 
3551
193
cdml:insert-last($name as xs:QName, $content as item()*)  external;
3552
194
3553
195
3554
196
(:~
3555
197
 : The insert-nodes-before function is an updating function that inserts
3556
198
 : copies of the given nodes into a collection at the position directly preceding the
3557
199
 : given target node.
3558
200
 :
3559
201
 : @param $name The name of the collection to which the nodes should be added.
3560
202
 : @param $target The node in the collection before which the $content
3561
203
 :        sequence should be inserted.
3562
204
 : @param $content The sequences of nodes whose copies should be added to the collection.
3563
205
 :
3564
206
 : @return The result of the function is an empty XDM instance and a pending update list
3565
207
 :         which, once applied, inserts the nodes into the collection.
3566
208
 :
3567
209
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
3568
210
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
3569
211
 : @error zerr:ZDDY0006 if the modifier property of the collection $name is const,
3570
212
 :        append-only, or queue.
3571
213
 : @error zerr:ZDDY0012 if the order property of the collection $name is unordered.
3572
214
 : @error zerr:ZDTY0001 if $content does not match the expected type (as specified
3573
215
 :        in the collection declaration) according to the rules for SequenceType Matching.
3574
216
 : @error zerr:ZDDY0011 if the $target node is not a node that is contained in
3575
217
 :        the collection $name.
3576
218
 :
3577
219
 : @deprecated please use the cdml:insert-before#3 function
3578
220
 :
3579
221
 :)
3580
222
declare updating function 
3581
223
cdml:insert-nodes-before(
3582
224
  $name as xs:QName,
3583
225
  $target as node(),
3584
226
  $content as node()*)  external;
3585
227
3586
228
3587
229
(:~
3588
230
 : The insert-before function is an updating function that inserts copies of the
3589
231
 : given items (nodes and/or json items) into a collection at the position 
3590
232
 : directly preceding the given target item.
3591
233
 :
3592
234
 : @param $name The name of the collection to which the items should be added.
3593
235
 : @param $target The item in the collection before which the $content
3594
236
 :        sequence should be inserted.
3595
237
 : @param $content The sequences of items whose copies should be added to the collection.
3596
238
 :
3597
239
 : @return The result of the function is an empty XDM instance and a pending update list
3598
240
 :         which, once applied, inserts the items into the collection.
3599
241
 :
3600
242
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
3601
243
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
3602
244
 : @error zerr:ZDDY0006 if the modifier property of the collection $name is const,
3603
245
 :        append-only, or queue.
3604
246
 : @error zerr:ZDDY0012 if the order property of the collection $name is unordered.
3605
247
 : @error zerr:ZDTY0001 if $content does not match the expected type (as specified
3606
248
 :        in the collection declaration) according to the rules for SequenceType Matching.
3607
249
 : @error zerr:ZDDY0011 if the $target item is not an item that is contained in
3608
250
 :        the collection $name.
3609
251
 :
3610
252
 :)
3611
253
declare updating function 
3612
254
cdml:insert-before($name as xs:QName, $target as item(), $content as item()*) external;
3613
255
3614
256
3615
257
(:~
3616
258
 : The insert-nodes-after function is an updating function that inserts
3617
259
 : copies of the given nodes into a collection at the position directlry following the
3618
260
 : given target node.
3619
261
 :
3620
262
 : @param $name The name of the collection to which the nodes should be added.
3621
263
 : @param $target The node in the collection after which the $content
3622
264
 :        sequence should be inserted.
3623
265
 : @param $content The sequences of nodes whose copies should be added to the collection.
3624
266
 :
3625
267
 : @return The result of the function is an empty XDM instance and a pending update list
3626
268
 :         which, once applied, inserts the nodes into the collection.
3627
269
 :
3628
270
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
3629
271
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
3630
272
 : @error zerr:ZDDY0006 if the modifier property of the collection $name is const,
3631
273
 :        append-only, or queue.
3632
274
 : @error zerr:ZDDY0012 if the order property of the collection $name is unordered.
3633
275
 : @error zerr:ZDTY0001 if $content does not match the expected type (as specified
3634
276
 :        in the collection declaration) according to the rules for SequenceType Matching.
3635
277
 : @error zerr:ZDDY0011 if the $target node is not a node that is contained in
3636
278
 :        the collection $name.
3637
279
 :
3638
280
 : @deprecated please use the cdml:insert-after#3 function
3639
281
 :
3640
282
 :)
3641
283
declare updating function 
3642
284
cdml:insert-nodes-after(
3643
285
  $name as xs:QName,
3644
286
  $target as node(),
3645
287
  $content as node()*)  external;
3646
288
3717
289
121
3718
290
(:~
122
(:~
3719
291
 : The insert-after function is an updating function that inserts copies of the
123
 : The insert-after function is an updating function that inserts copies of the
3790
292
 : given items (nodes and/or json items) into a collection at the position 
124
 : given items (nodes or JSON items) into a collection at the position 
3791
293
 : directlry following the given target item.
125
 : directly following the given target item.
3792
294
 :
126
 :
3793
295
 : @param $name The name of the collection to which the items should be added.
127
 : @param $name The name of the collection to insert into.
3794
296
 : @param $target The item in the collection after which the $content
128
 : @param $target The item in the collection after which <code>$content</code>
3795
297
 :        sequence should be inserted.
129
 : will be inserted.
3796
298
 : @param $content The sequences of items whose copies should be added to the collection.
130
 : @param $content The sequence of items whose copies to insert.
3797
299
 :
131
 : @return An empty XDM instance and a pending update list that, once applied,
3798
300
 : @return The result of the function is an empty XDM instance and a pending update list
132
 : inserts the items into the collection.
3799
301
 :         which, once applied, inserts the items into the collection.
133
 : @error zerr:ZDDY0001 if the collection is not declared.
3800
302
 :
134
 : @error zerr:ZDDY0003 if the collection is not available.
3801
303
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
135
 : @error zerr:ZDDY0006 if the collection is const, append-only, or queue.
3802
304
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
136
 : @error zerr:ZDDY0012 if the collection is unordered.
3803
305
 : @error zerr:ZDDY0006 if the modifier property of the collection $name is const,
137
 : @error zerr:ZDTY0001 if <code>$content</code> does not match the expected
3804
306
 :        append-only, or queue.
138
 : type as specified in the collection declaration according to the rules for
3805
307
 : @error zerr:ZDDY0012 if the order property of the collection $name is unordered.
139
 : SequenceType Matching.
3806
308
 : @error zerr:ZDTY0001 if $content does not match the expected type (as specified
140
 : @error zerr:ZDDY0011 if <code>$target</code> is not a node that is contained
3807
309
 :        in the collection declaration) according to the rules for SequenceType Matching.
141
 : in the collection.
3808
310
 : @error zerr:ZDDY0011 if the $target node is not a node that is contained in
142
 :)
3809
311
 :        the collection $name.
143
declare updating function cdml:insert-after( $name as xs:QName,
3810
312
 :
144
                                             $target as item(),
3811
313
 :)
145
                                             $content as item()* )
3812
314
declare updating function 
146
  external;
3813
315
cdml:insert-after($name as xs:QName, $target as item(), $content as item()*) external;
147
3814
316
148
(:~
3815
317
149
 : Inserts copies of the given items (nodes or JSON items) into a collection at
3816
318
(:~
150
 : the position directly preceding the given target item.
3817
319
 : This function does the same as the insert-nodes function except
151
 :
3818
320
 : it immediately applies the resulting pending updates and returns the
152
 : @param $name The name of the collection to insert into.
3819
321
 : nodes that have been inserted.
153
 : @param $target The item in the collection before which <code>$content</code>
3820
322
 :
154
 : will be inserted.
3821
323
 : @param $name The name of the collection to which the nodes should be added.
155
 : @param $content The sequence of items whose copies to insert.
3822
324
 : @param $content The sequences of nodes whose copies should be added to the collection.
156
 : @return An empty XDM instance and a pending update list that, once applied,
3823
325
 :
157
 : inserts the items into the collection.
3824
326
 : @return The result of the function is the sequence of nodes that have been
158
 : @error zerr:ZDDY0001 if the collection is not declared.
3825
327
 :         inserted into the collection.
159
 : @error zerr:ZDDY0003 if the collection is not available.
3826
328
 :
160
 : @error zerr:ZDDY0006 if the collection is const, append-only, or queue.
3827
329
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
161
 : @error zerr:ZDDY0012 if the collection is unordered.
3828
330
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
162
 : @error zerr:ZDTY0001 if <code>$content</code> does not match the expected
3829
331
 : @error zerr:ZDDY0006 if the modifier property of the collection $name is append-only,
163
 : type as specified in the collection declaration according to the rules for
3830
332
 :        const, or queue.
164
 : SequenceType Matching.
3831
333
 : @error zerr:ZDTY0001 if $content does not match the expected type (as specified
165
 : @error zerr:ZDDY0011 if <code>$target</code> is not an item that is
3832
334
 :        in the collection declaration) according to the rules for SequenceType Matching.
166
 : contained in the collection.
3833
335
 :
167
 :)
3834
336
 : @see cdml:insert-nodes
168
declare updating function cdml:insert-before( $name as xs:QName,
3835
337
 :
169
                                              $target as item(),
3836
338
 : @deprecated please use the cdml:apply-insert#2 function
170
                                              $content as item()* )
3837
339
 :
171
  external;
3838
340
 :)
172
3839
341
declare %an:sequential function 
173
(:~
3840
342
cdml:apply-insert-nodes($name as xs:QName, $content as node()*) as node()* external;
174
 : Inserts copies of the given items (nodes or JSON items) at the beginning of
3841
343
175
 : a collection.
3842
344
176
 :
3843
345
(:~
177
 : @param $name The name of the collection to insert into.
3844
346
 : This function does the same as the insert function except it immediately applies
178
 : @param $content The sequence of items whose copies to insert.
3845
347
 : the resulting pending updates and returns the items that have been inserted.
179
 : @return An empty XDM instance and a pending update list that, once applied,
3846
348
 :
180
 : inserts the items into the collection.
3847
349
 : @param $name The name of the collection to which the items should be added.
181
 : @error zerr:ZDDY0001 if the collection is not declared.
3848
350
 : @param $content The sequences of items whose copies should be added to the collection.
182
 : @error zerr:ZDDY0003 if the collection is not available.
3849
351
 :
183
 : @error zerr:ZDDY0006 if the collection is append-only, const, or queue.
3850
352
 : @return The result of the function is the sequence of items that have been
184
 : @error zerr:ZDDY0012 if the collection is unordered.
3851
353
 :         inserted into the collection.
185
 : @error zerr:ZDTY0001 if <code>$content</code> does not match the expected
3852
354
 :
186
 : type as specified in the collection declaration according to the rules for
3853
355
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
187
 : SequenceType Matching.
3854
356
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
188
 :)
3855
357
 : @error zerr:ZDDY0006 if the modifier property of the collection $name is append-only,
189
declare updating function cdml:insert-first( $name as xs:QName,
3856
358
 :        const, or queue.
190
                                             $content as item()* )
3857
359
 : @error zerr:ZDTY0001 if $content does not match the expected type (as specified
191
  external;
3858
360
 :        in the collection declaration) according to the rules for SequenceType Matching.
192
3859
361
 :
193
(:~
3860
194
 : Inserts copies of the given items (nodes or JSON items) at the end of a
3861
195
 : collection.
3862
196
 :
3863
197
 : @param $name The name of the collection to insert into.
3864
198
 : @param $content The sequence of itemss whose copies to insert.
3865
199
 : @return An empty XDM instance and a pending update list that, once applied,
3866
200
 : inserts the items into the collection.
3867
201
 : @error zerr:ZDDY0001 if the collection is not declared.
3868
202
 : @error zerr:ZDDY0003 if the collection is not available.
3869
203
 : @error zerr:ZDDY0006 if the collection is const.
3870
204
 : @error zerr:ZDDY0012 if the collection is unordered.
3871
205
 : @error zerr:ZDTY0001 if <code>$content</code> does not match the expected
3872
206
 : type as specified in the collection declaration according to the rules for
3873
207
 : SequenceType Matching.
3874
208
 :)
3875
209
declare updating function cdml:insert-last( $name as xs:QName,
3876
210
                                            $content as item()* )
3877
211
  external;
3878
212
3879
213
(:~
3880
214
 : This function does the same thing as <code>insert()</code> except it
3881
215
 : immediately applies the resulting pending updates and returns the items that
3882
216
 : have been inserted.
3883
217
 :
3884
218
 : @param $name The name of the collection to insert into.
3885
219
 : @param $content The sequence of items whose copies to insert.
3886
220
 : @return The sequence of items that have been inserted.
3887
221
 : @error zerr:ZDDY0001 if the collection is not declared.
3888
222
 : @error zerr:ZDDY0003 if the collection is not available.
3889
223
 : @error zerr:ZDDY0006 if the collection is append-only, const, or queue.
3890
224
 : @error zerr:ZDTY0001 if <code>$content</code> does not match the expected
3891
225
 : type as specified in the collection declaration according to the rules for
3892
226
 : SequenceType Matching.
3893
362
 : @see cdml:insert
227
 : @see cdml:insert
3948
363
 :
228
 :)
3949
364
 :)
229
declare %an:sequential function cdml:apply-insert( $name as xs:QName,
3950
365
declare %an:sequential function 
230
                                                   $content as item()* )
3951
366
cdml:apply-insert($name as xs:QName, $content as item()*) as item()* external;
231
  as item()* external;
3952
367
232
3953
368
(:~
233
(:~
3954
369
 : This function does the same as the insert-nodes-first function except
234
 : This function does the same thing as <code>insert-first()</code> except it
3955
370
 : it immediately applies the resulting pending updates and returns the
235
 : immediately applies the resulting pending updates and returns the items that
3956
371
 : nodes that have been inserted.
236
 : have been inserted.
3957
372
 :
237
 :
3958
373
 : @param $name The name of the collection to which the nodes should be added.
238
 : @param $name The name of the collection to insert into.
3959
374
 : @param $content The sequences of nodes whose copies should be added to the collection.
239
 : @param $content The sequence of items whose copies to insert.
3960
375
 :
240
 : @return The Sequence of items that have been inserted.
3961
376
 : @return The result of the function is the sequence of nodes that have been
241
 : @error zerr:ZDDY0001 if the collection is not declared.
3962
377
 :         inserted into the collection.
242
 : @error zerr:ZDDY0003 if the collection is not available.
3963
378
 :
243
 : @error zerr:ZDDY0006 if the collection $name is append-only, const, or
3964
379
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
244
 : queue.
3965
380
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
245
 : @error zerr:ZDDY0012 if the collection is unordered.
3966
381
 : @error zerr:ZDDY0006 if the modifier property of the collection $name is append-only,
246
 : @error zerr:ZDTY0001 if <code>$content</code> does not match the expected
3967
382
 :        const, or queue.
247
 : type as specified in the collection declaration according to the rules for
3968
383
 : @error zerr:ZDDY0012 if the order property of the collection $name is unordered.
248
 : SequenceType Matching.
3915
384
 : @error zerr:ZDTY0001 if $content does not match the expected type according to the
3916
385
 :        rules for SequenceType Matching.
3917
386
 :
3918
387
 : @see cdml:insert-nodes-first
3919
388
 :
3920
389
 : @deprecated please use the cdml:apply-insert-first#2 function
3921
390
 :
3922
391
 :)
3923
392
declare %an:sequential function 
3924
393
cdml:apply-insert-nodes-first(
3925
394
  $name as xs:QName, 
3926
395
  $content as node()*) as node()* external;
3927
396
3928
397
3929
398
(:~
3930
399
 : This function does the same as the insert-first function except it immediately
3931
400
 : applies the resulting pending updates and returns the items that have been 
3932
401
 : inserted.
3933
402
 :
3934
403
 : @param $name The name of the collection to which the items should be added.
3935
404
 : @param $content The sequences of items whose copies should be added to the collection.
3936
405
 :
3937
406
 : @return The result of the function is the sequence of items that have been
3938
407
 :         inserted into the collection.
3939
408
 :
3940
409
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
3941
410
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
3942
411
 : @error zerr:ZDDY0006 if the modifier property of the collection $name is append-only,
3943
412
 :        const, or queue.
3944
413
 : @error zerr:ZDDY0012 if the order property of the collection $name is unordered.
3945
414
 : @error zerr:ZDTY0001 if $content does not match the expected type (as specified
3946
415
 :        in the collection declaration) according to the rules for SequenceType Matching.
3947
416
 :
3969
417
 : @see cdml:insert-first
249
 : @see cdml:insert-first
4022
418
 :
250
 :)
4023
419
 :)
251
declare %an:sequential function cdml:apply-insert-first( $name as xs:QName,
4024
420
declare %an:sequential function 
252
                                                         $content as item()* )
4025
421
cdml:apply-insert-first($name as xs:QName, $content as item()*) as item()* external;
253
  as item()* external;
4026
422
254
4027
423
(:~
255
(:~
4028
424
 : This function does the same as the insert-nodes-last function except
256
 : This function does the same thing as <code>insert-last()</code> except it
4029
425
 : it immediately applies the resulting pending updates and returns the
257
 : immediately applies the resulting pending updates and returns the items that
4030
426
 : nodes that have been inserted.
258
 : have been inserted.
4031
427
 :
259
 :
4032
428
 : @param $name The name of the collection to which the nodes should be added.
260
 : @param $name The name of the collection to insert into.
4033
429
 : @param $content The sequences of nodes whose copies should be added to the collection.
261
 : @param $content The sequence of items whose copies to insert.
4034
430
 :
262
 : @return The sequence of items that have been inserted.
4035
431
 : @return The result of the function is the sequence of nodes that have been
263
 : @error zerr:ZDDY0001 if the collection is not declared.
4036
432
 :         inserted into the collection.
264
 : @error zerr:ZDDY0003 if the collection is not available.
4037
433
 :
265
 : @error zerr:ZDDY0006 if the collection is const.
4038
434
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
266
 : @error zerr:ZDDY0012 if the collection is unordered.
4039
435
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
267
 : @error zerr:ZDTY0001 if <code>$content</code> does not match the expected
4040
436
 : @error zerr:ZDDY0006 if the modifier property of the collection $name is const.
268
 : type as specified in the collection declaration according to the rules for
4041
437
 : @error zerr:ZDDY0012 if the order property of the collection $name is unordered.
269
 : SequenceType Matching.
3990
438
 : @error zerr:ZDTY0001 if $content does not match the expected type (as specified
3991
439
 :        in the collection declaration) according to the rules for SequenceType Matching.
3992
440
 :
3993
441
 : @see cdml:insert-nodes-last
3994
442
 :
3995
443
 : @deprecated please use the cdml:apply-insert-last#2 function
3996
444
 :
3997
445
 :)
3998
446
declare %an:sequential function 
3999
447
cdml:apply-insert-nodes-last(
4000
448
  $name as xs:QName,
4001
449
  $content as node()*) as node()*  external;
4002
450
4003
451
4004
452
(:~
4005
453
 : This function does the same as the insert-last function except it immediately
4006
454
 : applies the resulting pending updates and returns the items that have been
4007
455
 : inserted.
4008
456
 :
4009
457
 : @param $name The name of the collection to which the items should be added.
4010
458
 : @param $content The sequences of items whose copies should be added to the collection.
4011
459
 :
4012
460
 : @return The result of the function is the sequence of items that have been
4013
461
 :         inserted into the collection.
4014
462
 :
4015
463
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
4016
464
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
4017
465
 : @error zerr:ZDDY0006 if the modifier property of the collection $name is const.
4018
466
 : @error zerr:ZDDY0012 if the order property of the collection $name is unordered.
4019
467
 : @error zerr:ZDTY0001 if $content does not match the expected type (as specified
4020
468
 :        in the collection declaration) according to the rules for SequenceType Matching.
4021
469
 :
4042
470
 : @see cdml:insert-last
270
 : @see cdml:insert-last
4107
471
 :
271
 :)
4108
472
 :)
272
declare %an:sequential function cdml:apply-insert-last( $name as xs:QName,
4109
473
declare %an:sequential function 
273
                                                        $content as item()* )
4110
474
cdml:apply-insert-last($name as xs:QName, $content as item()*) as item()*  external;
274
  as item()* external;
4111
475
275
4112
476
276
(:~
4113
477
(:~
277
 : This function does the same thing as <code>insert-before()</code> except it
4114
478
 : This function does the same as the insert-nodes-before function except
278
 : immediately applies the resulting pending updates and returns the items that
4115
479
 : it immediately applies the resulting pending updates and returns the
279
 : have been inserted.
4116
480
 : nodes that have been inserted.
280
 :
4117
481
 :
281
 : @param $name The name of the collection to insert into.
4118
482
 : @param $name The name of the collection to which the nodes should be added.
282
 : @param $target The item in the collection before which <code>$content</code>
4119
483
 : @param $target The node in the collection before which the $content
283
 : will be inserted.
4120
484
 :        sequence should be inserted.
284
 : @param $content The sequence of items whose copies to insert.
4121
485
 : @param $content The sequences of nodes whose copies should be added to the collection.
285
 : @return The sequence of items that have been inserted.
4122
486
 :
286
 : @error zerr:ZDDY0001 if the collection is not declared.
4123
487
 : @return The result of the function is the sequence of nodes that have been
287
 : @error zerr:ZDDY0003 if the collection is not available.
4124
488
 :         inserted into the collection.
288
 : @error zerr:ZDDY0006 if the collection $name is const, append-only, or
4125
489
 :
289
 : queue.
4126
490
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
290
 : @error zerr:ZDDY0012 if the collection is unordered.
4127
491
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
291
 : @error zerr:ZDTY0001 if <code>$content</code> does not match the expected
4128
492
 : @error zerr:ZDDY0006 if the modifier property of the collection $name is const,
292
 : type as specified in the collection declaration according to the rules for
4129
493
 :        append-only, or queue.
293
 : SequenceType Matching.
4130
494
 : @error zerr:ZDDY0012 if the order property of the collection $name is unordered.
294
 : @error zerr:ZDDY0011 if <code>$target</code> is not an item that is
4131
495
 : @error zerr:ZDTY0001 if $content does not match the expected type (as specified
295
 : contained in the collection.
4068
496
 :        in the collection declaration) according to the rules for SequenceType Matching.
4069
497
 : @error zerr:ZDDY0011 if the $target node is not a node that is contained in
4070
498
 :        the collection $name.
4071
499
 :
4072
500
 : @see cdml:insert-nodes-before
4073
501
 :
4074
502
 : @deprecated please use the cdml:apply-insert-before#3 function
4075
503
 :
4076
504
 :)
4077
505
declare %an:sequential function 
4078
506
cdml:apply-insert-nodes-before(
4079
507
  $name as xs:QName,
4080
508
  $target as node(),
4081
509
  $content as node()*) as node()*  external;
4082
510
4083
511
4084
512
(:~
4085
513
 : This function does the same as the insert-before function except it immediately
4086
514
 : applies the resulting pending updates and returns the items that have been 
4087
515
 : inserted.
4088
516
 :
4089
517
 : @param $name The name of the collection to which the items should be added.
4090
518
 : @param $target The item in the collection before which the $content
4091
519
 :        sequence should be inserted.
4092
520
 : @param $content The sequences of items whose copies should be added to the collection.
4093
521
 :
4094
522
 : @return The result of the function is the sequence of items that have been
4095
523
 :         inserted into the collection.
4096
524
 :
4097
525
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
4098
526
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
4099
527
 : @error zerr:ZDDY0006 if the modifier property of the collection $name is const,
4100
528
 :        append-only, or queue.
4101
529
 : @error zerr:ZDDY0012 if the order property of the collection $name is unordered.
4102
530
 : @error zerr:ZDTY0001 if $content does not match the expected type (as specified
4103
531
 :        in the collection declaration) according to the rules for SequenceType Matching.
4104
532
 : @error zerr:ZDDY0011 if the $target item is not an item that is contained in
4105
533
 :        the collection $name.
4106
534
 :
4132
535
 : @see cdml:insert-before
296
 : @see cdml:insert-before
4200
536
 :
297
 :)
4201
537
 :)
298
declare %an:sequential function cdml:apply-insert-before( $name as xs:QName,
4202
538
declare %an:sequential function 
299
                                                          $target as item(),
4203
539
cdml:apply-insert-before(
300
                                                          $content as item()* )
4204
540
  $name as xs:QName,
301
  as item()* external;
4205
541
  $target as item(),
302
4206
542
  $content as item()*) as item()*  external;
303
(:~
4207
543
304
 : This function does the same thing as the <code>insert-after()</code>
4208
544
305
 : function except it immediately applies the resulting pending updates and
4209
545
(:~
306
 : returns the items that have been inserted.
4210
546
 : This function does the same as the insert-nodes-after function except
307
 :
4211
547
 : it immediately applies the resulting pending updates and returns the
308
 : @param $name The name of the collection to insert into.
4212
548
 : nodes that have been inserted.
309
 : @param $target The item in the collection after which <code>$content</code>
4213
549
 :
310
 : will be inserted.
4214
550
 : @param $name The name of the collection to which the nodes should be added.
311
 : @param $content The sequence of items whose copies to insert.
4215
551
 : @param $target The node in the collection after which the $content
312
 : @return The sequence of items that have been inserted.
4216
552
 :        sequence should be inserted.
313
 : @error zerr:ZDDY0001 if the collection is not declared.
4217
553
 : @param $content The sequences of nodes whose copies should be added to the collection.
314
 : @error zerr:ZDDY0003 if the collection is not available.
4218
554
 :
315
 : @error zerr:ZDDY0006 if the collection is const, append-only, or queue.
4219
555
 : @return The result of the function is the sequence of nodes that have been
316
 : @error zerr:ZDDY0012 if the collection is unordered.
4220
556
 :         inserted into the collection.
317
 : @error zerr:ZDTY0001 if <code>$content</code> does not match the expected
4221
557
 :
318
 : type as specified in the collection declaration according to the rules for
4222
558
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
319
 : SequenceType Matching.
4223
559
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
320
 : @error zerr:ZDDY0011 if <code>$target</code> is not in the collection.
4157
560
 : @error zerr:ZDDY0006 if the modifier property of the collection $name is 
4158
561
 :        const, append-only, or queue.
4159
562
 : @error zerr:ZDDY0012 if the order property of the collection $name is unordered.
4160
563
 : @error zerr:ZDTY0001 if $content does not match the expected type (as specified
4161
564
 :        in the collection declaration) according to the rules for SequenceType Matching.
4162
565
 : @error zerr:ZDDY0011 if the $target node is not a node that is contained in
4163
566
 :        the collection $name.
4164
567
 :
4165
568
 : @see cdml:insert-nodes-after
4166
569
 :
4167
570
 : @deprecated please use the cdml:apply-insert-after#3 function
4168
571
 :
4169
572
 :)
4170
573
declare %an:sequential function 
4171
574
cdml:apply-insert-nodes-after(
4172
575
  $name as xs:QName,
4173
576
  $pos as node(),
4174
577
  $content as node()*) as node()*  external;
4175
578
4176
579
4177
580
(:~
4178
581
 : This function does the same as the insert-after function except it immediately
4179
582
 : applies the resulting pending updates and returns the items that have been 
4180
583
 : inserted.
4181
584
 :
4182
585
 : @param $name The name of the collection to which the items should be added.
4183
586
 : @param $target The item in the collection after which the $content
4184
587
 :        sequence should be inserted.
4185
588
 : @param $content The sequences of items whose copies should be added to the collection.
4186
589
 :
4187
590
 : @return The result of the function is the sequence of items that have been
4188
591
 :         inserted into the collection.
4189
592
 :
4190
593
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
4191
594
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
4192
595
 : @error zerr:ZDDY0006 if the modifier property of the collection $name is 
4193
596
 :        const, append-only, or queue.
4194
597
 : @error zerr:ZDDY0012 if the order property of the collection $name is unordered.
4195
598
 : @error zerr:ZDTY0001 if $content does not match the expected type (as specified
4196
599
 :        in the collection declaration) according to the rules for SequenceType Matching.
4197
600
 : @error zerr:ZDDY0011 if the $target item is not an item that is contained in
4198
601
 :        the collection $name.
4199
602
 :
4224
603
 : @see cdml:insert-after
321
 : @see cdml:insert-after
4470
604
 :
322
 :)
4471
605
 :)
323
declare %an:sequential function cdml:apply-insert-after( $name as xs:QName,
4472
606
declare %an:sequential function 
324
                                                         $pos as item(),
4473
607
cdml:apply-insert-after(
325
                                                         $content as item()* )
4474
608
  $name as xs:QName,
326
  as item()* external;
4475
609
  $pos as item(),
327
4476
610
  $content as item()*) as item()*  external;
328
(:~
4477
611
329
 : Deletes items (nodes or JSON items) from a collection.
4478
612
330
 :
4479
613
(:~
331
 : @param $items The items in the collection to delete.
4480
614
 : The delete-nodes function is an updating function that deletes zero of more
332
 :
4481
615
 : nodes from a collection. 
333
 : @return An empty XDM instance and a pending update list that, once applied,
4482
616
 :
334
 : deletes the items from their collections.
4483
617
 : @param $target the nodes in the collection that should be deleted.
335
 : @error zerr:ZDDY0001 if the collection is not declared.
4484
618
 :
336
 : @error zerr:ZDDY0003 if the collection is not available.
4485
619
 : @return The result of this function is an empty XDM instance and a pending update
337
 : @error zerr:ZDDY0006 if the collection is const, append-only, or queue.
4486
620
 :         list which, once applied, deletes the nodes from their collections.
338
 : @error zerr:ZDDY0011 if any item in <code>$items</code> is not a member of a
4487
621
 :
339
 : collection or not all items belong to the same collection.
4488
622
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
340
 :)
4489
623
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
341
declare updating function cdml:delete( $items as item()* )
4490
624
 : @error zerr:ZDDY0006 if the modifier property of the collection $name is const,
342
  external;
4491
625
 :        append-only, or queue.
343
4492
626
 : @error zerr:ZDDY0011 if any node in the $target sequence is not a member of a
344
(:~
4493
627
 :        collection or not all nodes of the $target sequence belong to the same
345
 : Deletes the first item from a collection.
4494
628
 :        collection.
346
 :
4495
629
 :
347
 : @param $name The name of the collection to delete from.
4496
630
 : @deprecated please use the cdml:delete#1 function
348
 : @return An empty XDM instance and a pending update list that, once applied,
4497
631
 :
349
 : deletes the first item from the collection.
4498
632
 :)
350
 : @error zerr:ZDDY0001 if the collection is not declared.
4499
633
declare updating function 
351
 : @error zerr:ZDDY0003 if the collection is not available.
4500
634
cdml:delete-nodes($target as node()*)  external;
352
 : @error zerr:ZDDY0006 if the collection is const or append-only.
4501
635
353
 : @error zerr:ZDDY0012 if the collection is unordered.
4502
636
354
 : @error zerr:ZDDY0011 if the collection is empty.
4503
637
(:~
355
 :)
4504
638
 : The delete function is an updating function that deletes zero of more items
356
declare updating function cdml:delete-first( $name as xs:QName )
4505
639
 : (nodes and/or json items) from a collection. 
357
  external;
4506
640
 :
358
4507
641
 : @param $target the items in the collection that should be deleted.
359
(:~
4508
642
 :
360
 : Deletes the first <i>N</i> items from a collection.
4509
643
 : @return The result of this function is an empty XDM instance and a pending update
361
 :
4510
644
 :         list which, once applied, deletes the items from their collections.
362
 : @param $name The name of the collection to delete from.
4511
645
 :
363
 : @param $number The number of items to delete.
4512
646
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
364
 : @return An empty XDM instance and a pending update list that, once applied,
4513
647
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
365
 : deletes the items from the collection.
4514
648
 : @error zerr:ZDDY0006 if the modifier property of the collection $name is const,
366
 : @error zerr:ZDDY0001 if the collection is not declared.
4515
649
 :        append-only, or queue.
367
 : @error zerr:ZDDY0003 if the collection is not available.
4516
650
 : @error zerr:ZDDY0011 if any item in the $target sequence is not a member of a
368
 : @error zerr:ZDDY0006 if the collection is const or append-only.
4517
651
 :        collection or not all items of the $target sequence belong to the same
369
 : @error zerr:ZDDY0012 if the collection is unordered.
4518
652
 :        collection.
370
 : @error zerr:ZDDY0011 if the collection contains less than
4519
653
 :
371
 : <code>$number</code> items.
4520
654
 :)
372
 :)
4521
655
declare updating function 
373
declare updating function cdml:delete-first( $name as xs:QName,
4522
656
cdml:delete($target as item()*)  external;
374
                                             $number as xs:integer )
4523
657
375
  external;
4524
658
376
4525
659
(:~
377
(:~
4526
660
 : The delete-node-first function is an updating function that deletes the
378
 : Deletes the last item from a collection.
4527
661
 : first node from an ordered collection.
379
 :
4528
662
 :
380
 : @param $name The name of the collection to delete from.
4529
663
 : @param $name The name of the collection from which the first node should be deleted.
381
 : @return An empty XDM instance and a pending update list that, once applied,
4530
664
 :
382
 : deletes the last item from the collection.
4531
665
 : @return The result of this function is an empty XDM instance and a pending update
383
 : @error zerr:ZDDY0001 if the collection is not declared.
4532
666
 :         list which, once applied, deletes the first node from the collection.
384
 : @error zerr:ZDDY0003 if the collection is not available.
4533
667
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
385
 : @error zerr:ZDDY0006 if the collection is const, append-only, or queue.
4534
668
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
386
 : @error zerr:ZDDY0012 if the collection is unordered.
4535
669
 : @error zerr:ZDDY0006 if the modifier property of the collection $name is 
387
 : @error zerr:ZDDY0011 if the collection is empty.
4536
670
 :        const or append-only.
388
 :)
4537
671
 : @error zerr:ZDDY0012 if the order property of the collection $name is unordered.
389
declare updating function cdml:delete-last( $name as xs:QName )
4538
672
 : @error zerr:ZDDY0011 If the collection is empty.
390
  external;
4539
673
 :
391
4540
674
 : @deprecated please use the cdml:delete-first#1 function
392
(:~
4541
675
 :
393
 : Deletes the last <i>N</i> items from a collection.
4542
676
 :)
394
 :
4543
677
declare updating function 
395
 : @param $name The name of the collection to delete from.
4544
678
cdml:delete-node-first($name as xs:QName) external;
396
 : @param $number The number of items to delete.
4545
679
397
 : @return An empty XDM instance and a pending update list that, once applied,
4546
680
398
 : deletes the items.
4547
681
(:~
399
 : @error zerr:ZDDY0001 if the collection is not declared.
4548
682
 : The delete-first function is an updating function that deletes the first 
400
 : @error zerr:ZDDY0003 if the collection is not available.
4549
683
 : item from an ordered collection.
401
 : @error zerr:ZDDY0012 if the collection is unordered.
4550
684
 :
402
 : @error zerr:ZDDY0011 if the collection contains less than
4551
685
 : @param $name The name of the collection from which the first item should be deleted.
403
 : <code>$number</code> items.
4552
686
 :
404
 :)
4553
687
 : @return The result of this function is an empty XDM instance and a pending update
405
declare updating function cdml:delete-last( $name as xs:QName,
4554
688
 :         list which, once applied, deletes the first item from the collection.
406
                                            $number as xs:integer )
4555
689
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
407
  external;
4556
690
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
408
4557
691
 : @error zerr:ZDDY0006 if the modifier property of the collection $name is 
409
(:~
4558
692
 :        const or append-only.
410
 : Edits the first supplied item so as to make it look exactly like a copy of
4559
693
 : @error zerr:ZDDY0012 if the order property of the collection $name is unordered.
411
 : the second supplied item while retaining its original identity.
4560
694
 : @error zerr:ZDDY0011 If the collection is empty.
412
 :
4561
695
 :
413
 : @param $target The target item to be edited.
4562
696
 :)
414
 : @param $content The item that serves as an edit goal.
4563
697
declare updating function 
415
 : @return An empty XDM instance and a pending update list that, once applied,
4564
698
cdml:delete-first($name as xs:QName) external;
416
 : performs the edit.
4565
699
417
 : @error zerr:ZDDY0001 if the collection to which <code>$target</code> belongs
4566
700
418
 : is not declared.
4567
701
(:~
419
 : @error zerr:ZDDY0003 if the collection to which <code>$target</code> belongs
4568
702
 : The delete-nodes-first function is an updating function that deletes the
420
 : is not available.
4569
703
 : first n nodes from an ordered collection.
421
 : @error zerr:ZDDY0006 if the collection to which <code>$target</code> belongs
4570
704
 :
422
 : is append-only, const, or queue.
4571
705
 : @param $name The name of the collection from which the first node should be deleted.
423
 : @error zerr:ZDDY0017 if <code>$target</code> is not a member of a collection.
4327
706
 : @param $number The number of nodes that should be removed from the beginning of
4328
707
 :        the collection.
4329
708
 :
4330
709
 : @return The result of this function is an empty XDM instance and a pending update
4331
710
 :         list which, once applied, deletes the nodes from the collection.
4332
711
 :
4333
712
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
4334
713
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
4335
714
 : @error zerr:ZDDY0006 if the modifier property of the collection $name is
4336
715
 :        const or append-only.
4337
716
 : @error zerr:ZDDY0012 if the order property of the collection $name is unordered.
4338
717
 : @error zerr:ZDDY0011 If the collection contains less than $number nodes.
4339
718
 :
4340
719
 : @deprecated please use the cdml:delete-first#2 function
4341
720
 :
4342
721
 :)
4343
722
declare updating function 
4344
723
cdml:delete-nodes-first($name as xs:QName, $number as xs:integer)  external;
4345
724
4346
725
4347
726
(:~
4348
727
 : The delete-first function is an updating function that deletes the first N
4349
728
 : items from an ordered collection.
4350
729
 :
4351
730
 : @param $name The name of the collection from which the first N items should be deleted.
4352
731
 : @param $number The number N of items that should be removed from the beginning of
4353
732
 :        the collection.
4354
733
 :
4355
734
 : @return The result of this function is an empty XDM instance and a pending update
4356
735
 :         list which, once applied, deletes the items from the collection.
4357
736
 :
4358
737
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
4359
738
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
4360
739
 : @error zerr:ZDDY0006 if the modifier property of the collection $name is
4361
740
 :        const or append-only.
4362
741
 : @error zerr:ZDDY0012 if the order property of the collection $name is unordered.
4363
742
 : @error zerr:ZDDY0011 If the collection contains less than $number items.
4364
743
 :
4365
744
 :)
4366
745
declare updating function 
4367
746
cdml:delete-first($name as xs:QName, $number as xs:integer)  external;
4368
747
4369
748
4370
749
(:~
4371
750
 : The delete-node-last function is an updating function that deletes the
4372
751
 : last node from an ordered collection.
4373
752
 :
4374
753
 : @param $name The name of the collection from which the last node should be deleted.
4375
754
 :
4376
755
 : @return The result of this function is an empty XDM instance and a pending update
4377
756
 :         list which, once applied, deletes the last node from the collection.
4378
757
 :
4379
758
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
4380
759
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
4381
760
 : @error zerr:ZDDY0006 if the modifier property of the collection $name is const,
4382
761
 :        append-only, or queue.
4383
762
 : @error zerr:ZDDY0012 if the order property of the collection $name is unordered.
4384
763
 : @error zerr:ZDDY0011 If the collection is empty.
4385
764
 :
4386
765
 : @deprecated please use the cdml:delete-last#1 function
4387
766
 :)
4388
767
declare updating function 
4389
768
cdml:delete-node-last($name as xs:QName)  external;
4390
769
4391
770
4392
771
(:~
4393
772
 : The delete-last function is an updating function that deletes the last item
4394
773
 : from an ordered collection.
4395
774
 :
4396
775
 : @param $name The name of the collection from which the last item should be deleted.
4397
776
 :
4398
777
 : @return The result of this function is an empty XDM instance and a pending update
4399
778
 :         list which, once applied, deletes the last item from the collection.
4400
779
 :
4401
780
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
4402
781
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
4403
782
 : @error zerr:ZDDY0006 if the modifier property of the collection $name is const,
4404
783
 :        append-only, or queue.
4405
784
 : @error zerr:ZDDY0012 if the order property of the collection $name is unordered.
4406
785
 : @error zerr:ZDDY0011 If the collection is empty.
4407
786
 :)
4408
787
declare updating function 
4409
788
cdml:delete-last($name as xs:QName)  external;
4410
789
4411
790
4412
791
(:~
4413
792
 : The delete-nodes-last function is an updating function that deletes the
4414
793
 : last n nodes from an ordered collection.
4415
794
 :
4416
795
 : @param $name The name of the collection from which the first node should be deleted.
4417
796
 : @param $number The number of nodes to delete.
4418
797
 :
4419
798
 : @return The result of this function is an empty XDM instance and a pending update
4420
799
 :         list which, once applied, deletes the nodes.
4421
800
 :
4422
801
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
4423
802
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
4424
803
 : @error zerr:ZDDY0012 if the order property of the collection $name is unordered.
4425
804
 : @error zerr:ZDDY0011 If the collection contains less than $number nodes.
4426
805
 :
4427
806
 : @deprecated please use the cdml:delete-last#2 function
4428
807
 :
4429
808
 :)
4430
809
declare updating function 
4431
810
cdml:delete-nodes-last($name as xs:QName, $number as xs:integer)  external;
4432
811
4433
812
4434
813
(:~
4435
814
 : The delete-last function is an updating function that deletes the last N items
4436
815
 : from an ordered collection.
4437
816
 :
4438
817
 : @param $name The name of the collection from which the last N items should be deleted.
4439
818
 : @param $number The number of items to delete.
4440
819
 :
4441
820
 : @return The result of this function is an empty XDM instance and a pending update
4442
821
 :         list which, once applied, deletes the items.
4443
822
 :
4444
823
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
4445
824
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
4446
825
 : @error zerr:ZDDY0012 if the order property of the collection $name is unordered.
4447
826
 : @error zerr:ZDDY0011 If the collection contains less than $number items.
4448
827
 :
4449
828
 :)
4450
829
declare updating function 
4451
830
cdml:delete-last($name as xs:QName, $number as xs:integer)  external;
4452
831
4453
832
4454
833
(:~
4455
834
 : The edit function is an updating function that edits the first supplied
4456
835
 : item so as to make it look exactly like a copy of the second supplied item,
4457
836
 : while retaining its original identity.
4458
837
 :
4459
838
 : @param $target The target item ,that must be edited.
4460
839
 : @param $content The content item, that serves as an edit goal.
4461
840
 :
4462
841
 : @return The result of the function is an empty XDM instance and a pending update list
4463
842
 :         which, once applied, performs the edit.
4464
843
 :
4465
844
 : @error zerr:ZDDY0001 if the collection to which $target belongs is not declared.
4466
845
 : @error zerr:ZDDY0003 if the collection to which $target belongs is not available.
4467
846
 : @error zerr:ZDDY0006 if the modifier property of the collection to which $target
4468
847
 :        belongs is append-only, const, or queue.
4469
848
 : @error zerr:ZDDY0017 if the $target item is not a member of a collection.
4572
849
 : @error zerr:ZDDY0037 if the collection is append-only.
424
 : @error zerr:ZDDY0037 if the collection is append-only.
4573
850
 : @error zerr:ZDDY0038 if the collection is a queue.
425
 : @error zerr:ZDDY0038 if the collection is a queue.
4580
851
 : @error zerr:ZDDY0039 if the $target item is not a root.
426
 : @error zerr:ZDDY0039 if <code>$target</code> is not a root.
4581
852
 : @error zerr:ZDDY0040 if the target cannot be updated to match the content (for
427
 : @error zerr:ZDDY0040 if <code>$target</code> cannot be updated to match the
4582
853
 :        example because the target is a node and the content is an object).
428
 : content (for example, because the target is a node and the content is an
4583
854
 : @error zerr:ZDTY0001 if $content does not match the expected type (as specified
429
 : object).
4584
855
 :        in the collection declaration) according to the rules for SequenceType Matching.
430
 : @error zerr:ZDTY0001 if <code>$content</code> does not match the expected
4585
856
 :
431
 : type (as specified in the collection declaration) according to the rules for
4586
432
 : SequenceType Matching.
4587
857
 :)
433
 :)
4591
858
declare updating function 
434
declare updating function cdml:edit( $target as item(),
4592
859
cdml:edit($target as item(), $content as item()) external;
435
                                     $content as item() )
4593
860
436
  external;
4594
861
437
4595
862
(:~
438
(:~
4599
863
 : The truncate function is an updating function that deletes the
439
 : Deletes the entire contents of collection.
4597
864
 : entire contents of collection.
4598
865
 :
4600
866
 : Please note that applying this function can not be undone in case
440
 : Please note that applying this function can not be undone in case
4601
867
 : an error happens during the application of the containing PUL.
441
 : an error happens during the application of the containing PUL.
4602
868
 :
442
 :
4705
869
 : @param $name The name of the collection whose content to delete
443
 : @param $name The name of the collection whose content to delete.
4706
870
 :
444
 : @return An empty XDM instance and a pending update list that, once applied,
4707
871
 : @return The result of this function is an empty XDM instance and a pending update
445
 : deletes the nodes.
4708
872
 :         list which, once applied, deletes the nodes.
446
 : @error zerr:ZDDY0001 if the collection is not declared.
4709
873
 :
447
 : @error zerr:ZDDY0003 if the collection is not available.
4710
874
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
448
 :)
4711
875
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
449
declare updating function cdml:truncate( $name as xs:QName )
4712
876
 :
450
  external;
4713
877
 :)
451
4714
878
declare updating function 
452
(:~
4715
879
cdml:truncate($name as xs:QName) external;
453
 : Gets the name of the collection the given item (node or JSON item) belongs
4716
880
454
 : to.
4717
881
455
 :
4718
882
(:~
456
 : @param $item The item for which to get the name of its collection.
4719
883
 : The collection function returns the sequence of nodes and/or json items
457
 : @return The name of the collection to which the given item belongs.
4720
884
 : that belong to the collection identified by the given name.
458
 : @error zerr:ZDDY0011 if <code>$item</code> does not belong to a collection.
4721
885
 :
459
 :)
4722
886
 : @param $name The name of the collection.
460
declare function cdml:collection-name( $item as item() )
4723
887
 :
461
  as xs:QName external;
4724
888
 : @return The sequence contained in the given collection.
462
4725
889
 :
463
(:~
4726
890
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
464
 : Gets the position of the given item (node or JSON item) within its
4727
891
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
465
 : collection.
4728
892
 :
466
 :
4729
893
 :)
467
 : @param $item The item to get the index of.
4730
894
declare function 
468
 : @return The position of <code>$item</code> in its collection.
4731
895
cdml:collection($name as xs:QName) as item()*  external;
469
 : @error zerr:ZDDY0011 if <code>$item</code> does not belong to a collection.
4732
896
470
 : @error zerr:ZDDY0012 if the collection is unordered.
4733
897
471
 :)
4734
898
(:~
472
declare function cdml:index-of( $item as item() )
4735
899
 : The collection function returns the sequence of nodes and/or json items
473
  as xs:integer external;
4736
900
 : that belong to the collection identified by the given name.
474
4737
901
 :
475
(:===========================================================================:)
4738
902
 : @param $name The name of the collection.
476
4739
903
 : @param $skip The number of collection items to skip.
477
(: vim:set et sw=2 ts=2: :)
4638
904
 :
4639
905
 : @return The sequence contained in the given collection.
4640
906
 :
4641
907
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
4642
908
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
4643
909
 :
4644
910
 :)
4645
911
declare function 
4646
912
cdml:collection($name as xs:QName, $skip as xs:integer) as item()*  external;
4647
913
4648
914
4649
915
(:~
4650
916
 : The collection function returns the sequence of nodes and/or json items
4651
917
 : that belong to the collection identified by the given name.
4652
918
 : The parameters $start and $skip can be used to skip over some items at
4653
919
 : the beginning of the collection. If both are given, both are applied:
4654
920
 : first $start to skip to the referenced item and then $skip to skip an
4655
921
 : additional number of items.
4656
922
 :
4657
923
 : @param $name The name of the collection.
4658
924
 : @param $start The reference to the first item to return. All items before
4659
925
                 are skipped.
4660
926
 : @param $skip The number of collection items to skip.
4661
927
 :
4662
928
 : @return The sequence contained in the given collection.
4663
929
 :
4664
930
 : @error zerr:ZAPI0028 If the given URI is not a valid node
4665
931
 :        position computed by the <tt>np:node-position</tt> function. 
4666
932
 : @error zerr:ZDDY0001 if the collection identified by $name is not declared.
4667
933
 : @error zerr:ZDDY0003 if the collection identified by $name is not available.
4668
934
 : @error zerr:ZSTR0066 if the passed reference $start does not reference
4669
935
 :        a node from the collection identified by $name.
4670
936
 :
4671
937
 :)
4672
938
declare function 
4673
939
cdml:collection($name as xs:QName, 
4674
940
                $start as xs:anyURI,
4675
941
                $skip as xs:integer) as item()* external;
4676
942
(:~
4677
943
 : The collection-name function returns the name of the collection the given
4678
944
 : item (node or json item) belongs to.
4679
945
 :
4680
946
 : @param $item The item for which to get the name of the collection
4681
947
 : @return The result of this function is a QName which identifies the collection
4682
948
 :         to which the given item belongs to.
4683
949
 :
4684
950
 : @error zerr:ZDDY0011 if the given item does not belong to a collection.
4685
951
 :
4686
952
 :)
4687
953
declare function 
4688
954
cdml:collection-name($item as item()) as xs:QName external;
4689
955
4690
956
4691
957
(:~
4692
958
 : The index-of function returns the position of the given item (node or 
4693
959
 : json item) within its containing collection.
4694
960
 :
4695
961
 : @param $node The item to retrieve the index for.
4696
962
 :
4697
963
 : @return Returns the position as xs:integer of the given item in the collection.
4698
964
 :
4699
965
 : @error zerr:ZDDY0011 if the item is not stored in any collection.
4700
966
 : @error zerr:ZDDY0012 if the order property of the collection is unordered.
4701
967
 :
4702
968
 :)
4703
969
declare function 
4704
970
cdml:index-of($item as item()) as xs:integer external;
4740
971
478
4741
=== modified file 'modules/store/static/indexes/ddl.xq'
4742
--- modules/com/zorba-xquery/www/modules/store/static/indexes/ddl.xq	2013-09-26 23:15:11 +0000
4743
+++ modules/store/static/indexes/ddl.xq	2013-10-17 02:02:41 +0000
4744
@@ -17,103 +17,99 @@
4745
17
:)
17
:)
4746
18
18
4747
19
(:~
19
(:~
4749
20
 : This modules defines a set of functions for managing indexes which are
20
 : This modules defines a set of functions for managing indexes that are
4750
21
 : declared in the prolog of a module.
21
 : declared in the prolog of a module.
4755
22
 :
22
 : <p/>
4756
23
 : <p>This module is part of <a href="../zorba/xqddf.html">Zorba's XQuery Data
23
 : This module is part of
4757
24
 : Definition Facility</a>. All the indexes managed by this module
24
 : <a href="../zorba/xqddf.html">Zorba's XQuery Data Definition Facility</a>.
4758
25
 : have to be pre-declared in the prolog of a module. Please refer to the
25
 : All the indexes managed by this module have to be pre-declared in the prolog
4759
26
 : of a module.
4760
27
 : Please refer to the
4761
26
 : <a href="../zorba/data_lifecycle.html">general documentation</a>
28
 : <a href="../zorba/data_lifecycle.html">general documentation</a>
4763
27
 : for more information and examples.</p>
29
 : for more information and examples.
4764
28
 :
30
 :
4765
29
 : @see <a href="../zorba/data_lifecycle.html">Data Lifecycle</a>
31
 : @see <a href="../zorba/data_lifecycle.html">Data Lifecycle</a>
4766
30
 : @see <a href="../zorba/xqddf.html">XQuery Data Definition Facility</a>
32
 : @see <a href="../zorba/xqddf.html">XQuery Data Definition Facility</a>
4772
31
 : @see http://www.zorba-xquery.com/modules/store/static/indexes/dml
33
 : @see http://zorba.io/modules/store/static/indexes/dml
4773
32
 : @see http://www.zorba-xquery.com/modules/store/static/collections/dml
34
 : @see http://zorba.io/modules/store/static/collections/dml
4774
33
 : @see http://www.zorba-xquery.com/modules/store/static/collections/ddl
35
 : @see http://zorba.io/modules/store/static/collections/ddl
4775
34
 : @see http://www.zorba-xquery.com/modules/store/static/integrity_constraints/ddl
36
 : @see http://zorba.io/modules/store/static/integrity-constraints/ddl
4776
35
 : @see http://www.zorba-xquery.com/modules/store/static/integrity_constraints/dml
37
 : @see http://zorba.io/modules/store/static/integrity-constraints/dml
4777
36
 : @see http://zorba.io/errors
38
 : @see http://zorba.io/errors
4778
37
 :
39
 :
4779
38
 : @author Nicolae Brinza, Matthias Brantner, David Graf, Till Westmann, Markos Zaharioudakis
40
 : @author Nicolae Brinza, Matthias Brantner, David Graf, Till Westmann, Markos Zaharioudakis
4780
39
 :
4781
40
 : @project Zorba/Data Store/Indexes/Static Data Definition
41
 : @project Zorba/Data Store/Indexes/Static Data Definition
4782
41
 :
4783
42
 :)
42
 :)
4785
43
module namespace iddl = "http://www.zorba-xquery.com/modules/store/static/indexes/ddl";
43
module namespace iddl = "http://zorba.io/modules/store/static/indexes/ddl";
4786
44
44
4787
45
declare namespace zerr = "http://zorba.io/errors";
45
declare namespace zerr = "http://zorba.io/errors";
4788
46
declare namespace ver = "http://zorba.io/options/versioning";
46
declare namespace ver = "http://zorba.io/options/versioning";
4789
47
declare option ver:module-version "2.0";
47
declare option ver:module-version "2.0";
4790
48
48
4800
49
(:~
49
(:===========================================================================:)
4792
50
 : The function returns true if an index with the given QName is available.
4793
51
 : (i.e. has been created).
4794
52
 :
4795
53
 : @param $name The QName of the index that is being checked.
4796
54
 :
4797
55
 : @return true if the index is available and false otherwise.
4798
56
 :)
4799
57
declare function iddl:is-available-index($name as xs:QName) as xs:boolean external;
4801
58
50
4802
59
(:~
51
(:~
4805
60
 : The function returns a sequence of QNames representing the indexes that are
52
 : Gets the available indexes.
4804
61
 : available. The sequence will be empty if there are no indexes.
4806
62
 :
53
 :
4807
63
 : @return A sequence of QNames, one for each available index, or an empty
54
 : @return A sequence of QNames, one for each available index, or an empty
4808
64
 : sequence if none are.
55
 : sequence if none are.
4809
65
 :)
56
 :)
4864
66
declare function iddl:available-indexes() as xs:QName* external;
57
declare function iddl:available-indexes()
4865
67
58
  as xs:QName* external;
4866
68
(:~
59
4867
69
 : The create function is an updating function which creates the
60
(:~
4868
70
 : index with the given expanded QName and populates the index with its
61
 : Creates an index.
4869
71
 : values.
62
 :
4870
72
 :
63
 : @param $name The name of the index to create.
4871
73
 : @param $name The QName of the index to create.
64
 : @return An empty XDM instance and a pending update list that, once applied,
4872
74
 :
65
 : creates the index with the given name.
4873
75
 : @return The result of the function is an empty XDM instance and a pending
66
 :
4874
76
 :         update list which, once applied, creates the index with the given
67
 : @error zerr:ZDDY0021 if <code>$name</code> is not equal to the name of any
4875
77
 :         name.
68
 : resource in the statically known indexes.
4876
78
 :
69
 : @error zerr:ZDDY0022 if an index with <code>$name</code> already exists.
4877
79
 : @error zerr:ZDDY0021 if the expanded QName of $name is not equal  
70
 :)
4878
80
 :        to the name of any resource in the statically known indexes.
71
declare updating function iddl:create( $name as xs:QName )
4879
81
 : @error zerr:ZDDY0022 if the index with the given name is already created.
72
  external;
4880
82
 :)
73
4881
83
declare updating function iddl:create(
74
(:~
4882
84
  $name as xs:QName)  external;
75
 : Gets a sequence of QNames representing the indexes that have been declared
4883
85
76
 : in the prolog of the static context.
4884
86
(:~
77
 :
4885
87
 : The delete function is an updating function that deletes
78
 : @return A sequence of QNames, one for each created collection, or an emtpy
4886
88
 : the index with the given expanded QName.
79
 : sequence.
4887
89
 :
80
 :)
4888
90
 : @param $name The QName of the index to delete.
81
declare function iddl:declared-indexes()
4889
91
 :
82
  as xs:QName* external;
4890
92
 : @return The result of the function is an empty XDM instance and a pending
83
4891
93
 :         update list which, once applied, deletes the index with the given name.
84
(:~
4892
94
 :
85
 : Deletes an index.
4893
95
 : @error zerr:ZDDY0009 If available indexes does not provide a mapping for
86
 :
4894
96
 :        the expanded QName $name.
87
 : @param $name The name of the index to delete.
4895
97
 :
88
 : @return An empty XDM instance and a pending update list that, once applied,
4896
98
 :)
89
 : deletes the index with the given name.
4897
99
declare updating function iddl:delete(
90
 : @error zerr:ZDDY0009 if the index does not exist.
4898
100
  $name as xs:QName)  external;
91
 :)
4899
101
92
declare updating function iddl:delete( $name as xs:QName )
4900
102
(:~
93
  external;
4901
103
 : The function returns true if a index with the given
94
4902
104
 : QName is declared in the prolog of the static context.
95
(:~
4903
105
 :
96
 : Gets whether an index exists.
4904
106
 : @param $name The QName of the index that is being checked.
97
 :
4905
107
 :
98
 : @param $name The name of the index that is being checked.
4906
108
 : @return true if the index is declared or false otherwise.
99
 : @return true if the index is available; false otherwise.
4907
109
 :)
100
 :)
4908
110
declare function iddl:is-declared-index(
101
declare function iddl:is-available-index( $name as xs:QName )
4909
111
  $name as xs:QName) as xs:boolean  external;
102
  as xs:boolean external;
4910
112
103
4911
113
(:~
104
(:~
4912
114
 : The function returns a sequence of QNames representing the indexes that have
105
 : Gets whether an index has been declared in the prolog of the static context.
4913
115
 : been declared in the prolog of the static context.
106
 :
4914
116
 :
107
 : @param $name The name of the index that is being checked.
4915
117
 : @return A sequence of QNames, one for each created collection, or an emtpy sequence.
108
 : @return true if the index was declared; false otherwise.
4916
118
 :)
109
 :)
4917
119
declare function iddl:declared-indexes() as xs:QName*  external;
110
declare function iddl:is-declared-index( $name as xs:QName )
4918
111
  as xs:boolean external;
4919
112
4920
113
(:===========================================================================:)
4921
114
4922
115
(: vim:set et sw=2 ts=2: :)
4923
120
116
4924
=== modified file 'modules/store/static/indexes/dml.xq'
4925
--- modules/com/zorba-xquery/www/modules/store/static/indexes/dml.xq	2013-09-26 23:15:11 +0000
4926
+++ modules/store/static/indexes/dml.xq	2013-10-17 02:02:41 +0000
4927
@@ -1,7 +1,7 @@
4928
1
xquery version "3.0";
1
xquery version "3.0";
4929
2
2
4930
3
(:
3
(:
4932
4
 : Copyright 2006-2009 The FLWOR Foundation.
4
 : Copyright 2006-2013 The FLWOR Foundation.
4933
5
 :
5
 :
4934
6
 : Licensed under the Apache License, Version 2.0 (the "License");
6
 : Licensed under the Apache License, Version 2.0 (the "License");
4935
7
 : you may not use this file except in compliance with the License.
7
 : you may not use this file except in compliance with the License.
4936
@@ -19,353 +19,344 @@
4937
19
(:~
19
(:~
4938
20
 : This module defines a set of functions to probe and refresh indexes which are
20
 : This module defines a set of functions to probe and refresh indexes which are
4939
21
 : declared in the prolog of a module.
21
 : declared in the prolog of a module.
4944
22
 :
22
 : <p/>
4945
23
 : <p>This module is part of <a href="../zorba/xqddf.html">Zorba's XQuery Data
23
 : This module is part of
4946
24
 : Definition Facility</a>. All the indexes managed by this module
24
 : <a href="../zorba/xqddf.html">Zorba's XQuery Data Definition Facility</a>.
4947
25
 : have to be pre-declared in the prolog of a library module. Please refer to the
25
 : All the indexes managed by this module have to be pre-declared in the prolog
4948
26
 : of a library module.
4949
27
 : Please refer to the
4950
26
 : <a href="../zorba/data_lifecycle.html">general documentation</a>
28
 : <a href="../zorba/data_lifecycle.html">general documentation</a>
4952
27
 : for more information and examples.</p>
29
 : for more information and examples.
4953
28
 :
30
 :
4954
29
 : @see <a href="../zorba/data_lifecycle.html">Data Lifecycle</a>
31
 : @see <a href="../zorba/data_lifecycle.html">Data Lifecycle</a>
4955
30
 : @see <a href="../zorba/xqddf.html">XQuery Data Definition Facility</a>
32
 : @see <a href="../zorba/xqddf.html">XQuery Data Definition Facility</a>
4961
31
 : @see http://www.zorba-xquery.com/modules/store/static/indexes/ddl
33
 : @see http://zorba.io/modules/store/static/indexes/ddl
4962
32
 : @see http://www.zorba-xquery.com/modules/store/static/collections/dml
34
 : @see http://zorba.io/modules/store/static/collections/dml
4963
33
 : @see http://www.zorba-xquery.com/modules/store/static/collections/ddl
35
 : @see http://zorba.io/modules/store/static/collections/ddl
4964
34
 : @see http://www.zorba-xquery.com/modules/store/static/integrity_constraints/ddl
36
 : @see http://zorba.io/modules/store/static/integrity-constraints/ddl
4965
35
 : @see http://www.zorba-xquery.com/modules/store/static/integrity_constraints/dml
37
 : @see http://zorba.io/modules/store/static/integrity-constraints/dml
4966
36
 : @see http://zorba.io/errors
38
 : @see http://zorba.io/errors
4967
37
 :
39
 :
4968
38
 : @author Zorba Team
40
 : @author Zorba Team
4969
39
 :
4970
40
 : @project Zorba/Data Store/Indexes/Static Data Manipulation
41
 : @project Zorba/Data Store/Indexes/Static Data Manipulation
4971
41
 :
4972
42
 :)
42
 :)
4974
43
module namespace idml = "http://www.zorba-xquery.com/modules/store/static/indexes/dml";
43
module namespace idml = "http://zorba.io/modules/store/static/indexes/dml";
4975
44
44
4976
45
declare namespace an = "http://zorba.io/annotations";
4977
45
declare namespace zerr = "http://zorba.io/errors";
46
declare namespace zerr = "http://zorba.io/errors";
4978
46
declare namespace an = "http://zorba.io/annotations";
4979
47
47
4980
48
declare namespace ver = "http://zorba.io/options/versioning";
48
declare namespace ver = "http://zorba.io/options/versioning";
4981
49
4982
50
declare option ver:module-version "2.0";
49
declare option ver:module-version "2.0";
4983
51
50
4984
51
(:===========================================================================:)
4985
52
4986
52
(:~
53
(:~
4987
53
 : <p>The probe-index-point-value function retrieves from an index the domain 
4988
54
 : nodes associated by value equality with a given <strong>search tuple</strong>.
4989
55
 : The search tuple consists of a number of <strong>search keys</strong>, where
4990
56
 : each search key is either an atomic item or the empty sequence.  The number
4991
57
 : of search keys given must be equal to the number of keys declared for the 
4992
58
 : index. Since the number of keys differs from one index to another, this 
4993
59
 : function is variadic.</p>
4994
60
 :
4995
61
 : <p>The result of the function is either an error or the set of domain nodes for 
4996
62
 : which the following xquery expression returns true:</p>
4997
63
 :
4998
64
 : <pre>
4999
65
 : $key1 eq $node/keyExpr1 and ... and $keyM eq $node/keyExprM
5000
66
 : </pre>
Reviewer	Date Requested	Status
Matthias Brantner	2013-10-17	Approve on 2013-10-17
Paul J. Lucas		Approve on 2013-10-10
Review via email: mp+190266@code.launchpad.net