Changes

This [[Module Library|XQuery Module]] contains various small some utility and helper functions. Please note that some  With {{Announce|Version 11}}, many functions have been removed in favor of new features of the XQuery 4: {||- valign="top"| '''BaseX 10'''| '''XQuery 4'''|- valign="top"| {{Code|util:array-members}}| [https://qt4cg.org/specifications/xpath-functions-40/Overview.html#func-array-members <code>array:members</code>]|- valign="top"| {{Code|util:array-values}}| [https://qt4cg.org/specifications/xpath-functions-40/Overview.html#func-array-values <code>array:values</code>]|- valign="top"| {{Code|util:chars}}| [https://qt4cg.org/specifications/xpath-functions-40/Overview.html#func-chars <code>fn:characters</code>]|- valign="top"| {{Code|util:duplicates}}| [https://qt4cg.org/specifications/xpath-functions are used for internal query rewritings-40/Overview. They may be renamed html#func-duplicate-values <code>fn:duplicate-values</code>]|- valign="top"| {{Code|util:init}}| [https://qt4cg.org/specifications/xpath-functions-40/Overview.html#func-trunk <code>fn:trunk</code>]|- valign="top"| {{Code|util:intersperse}}| [https://qt4cg.org/specifications/xpath-functions-40/Overview.html#func-intersperse <code>fn:intersperse</code>]|- valign="top"| {{Code|util:item}}| [https://qt4cg.org/specifications/xpath-functions-40/Overview.html#func-items-at <code>fn:items-at</code>]|- valign="top"| {{Code|util:last}}| [https://qt4cg.org/specifications/xpath-functions-40/Overview.html#func-foot <code>fn:foot</code>]|- valign="top"| {{Code|util:map-entries}}| [https://qt4cg.org/specifications/xpath-functions-40/Overview.html#func-map-entries <code>map:entries</code>]|- valign="top"| {{Code|util:map-values}}| [https://qt4cg.org/specifications/xpath-functions-40/Overview.html#func-map-values <code>map:values</code>]|- valign="top"| {{Code|util:or moved to other modules in future versions of BaseX}}| <code>$expr1 otherwise $expr2|- valign="top"| {{Code|util:replicate}}| [https://qt4cg.org/specifications/xpath-functions-40/Overview.html#func-replicate <code>fn:replicate</code>]|}

All functions and errors in this module and errors are assigned to the <code><nowiki>http://basex.org/modules/util</nowiki></code> namespace, which is statically bound to the {{Code|util}} prefix.<br/>

=Function ItemsConditions and Ranges=

==util:function-annotationsif==

|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|<pre>util:function-annotations|if( $function condition as functionitem()*, $then as item()?|map*, $else as item(xs)* :QName, xs:anyAtomicType= ()) as item()*)}}<br/pre>|-valign="top"

|Returns Alternative writing for the annotations if/then/else expression:* If the ''effective boolean value'' of {{Code|$condition}} is true, the specified {{Code|$functionthen}} branch will be evaluated.* Otherwise, {{Code|$else}} in a mapwill be evaluated. If the third argument is omitted, an empty sequence will be returned.|-valign="top"

* Returns an empty map:<pre class="brush:xquery"code>util:function-annotationsif(true#0(), 123, 456)</pre>* Returns a map with a single key <code><nowiki>Qreturns {{http://wwwCode|123}}.w3.org/2012/xquery}private* </nowiki></code> and an empty sequence as valueutil:<pre class="brush:xquery">declare %private function local:fif() { 0, 'well hiddenwrong!' };util:function-annotations(local:f#0)</precode>returns an empty sequence.

=Sequences= ==util:itemcount-atwithin==

|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|<pre>util:itemcount-at|within( $sequence as item()*, $position min as xs:double|iteminteger, $max as xs:integer := ()?}}) as xs:boolean<br/pre>|-valign="top"

|Returns Checks if the item from specified {{Code|$sequence}} has at the specified least {{Code|$min}} and, optionally, at most {{Code|$positionmax}}items. Equivalent to :<codepre lang='xquery'>let $count := count($sequence[)return $position]count >= $min and $count <= $max</codepre>.|-valign="top"

* <code>util:itemcount-atwithin(reverse(1 to 5'a', 'b', 'c'), 12)</code> returns <code>5</code>{{Code|true}}.* <code>util:itemcount-atwithin(('a'1 to 1000000000)[. < 10],'b')3, 06)</code> returns an empty sequence{{Code|true}}.

==util:item-range==

|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|<pre>util:item-range|( $sequence as item()*, $first as xs:double, $last as xs:double|) as item()*}}<br/pre>|-valign="top"

|Returns items from {{Code|$sequence}}, starting at position {{Code|$first}} and ending at {{Code|$last}}. Equivalent to :<codepre lang='xquery'>subsequence($sequence, $first, $last - $first + 1)</codepre>.|-valign="top"

* <code>util:item-range(//item, 11, 20)</code> returns all path results from (if available) position 11 to 20.|} =Node Functions= ==util:ddo== {| width='100%'|- valign="top"| width='120' | '''Signature'''|<pre>util:ddo( $nodes as node()*) as node()*</pre>|- valign="top"| '''Summary'''|Returns nodes in ''distinct document order'': duplicate nodes will be removed, and the remaining nodes will be returned in [https://www.w3.org/TR/xquery-31/#dt-document-order document order]. As results of path expressions are brought into distinct document order before they are returned, the function is equivalent to:<pre lang='xquery'>$nodes/self::node()</pre>

==util:last-fromroot==

|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|<pre>util:last-from|root( $sequence nodes as itemnode()*|item) as document-node()?}}*<br/pre>|-valign="top"

|Returns last item the document nodes of a the specified {{Code|$sequencenodes}}. The path expression <code>/abc</code> is internally represented as <code>util:root(.)/abc</code>. Equivalent to :<pre lang='xquery'>util:ddo($x ! /)<code/pre>|} ==util:strip-namespaces== {| width='100%'|- valign="top"| width='120' | '''Signature'''|<pre>util:strip-namespaces( $node as node(), $sequence[lastprefixes as xs:string* := ()) as node()]</pre>|- valign="top"| '''Summary'''|Removes namespaces with the specified <code>$prefixes</code> from the supplied <code>$node</code>. An empty string can be supplied to remove the default namespace. If no prefixes are specified, all namespaces will be removed.|-valign="top"

* Remove all namespaces from an element and its descendants:<codepre lang='xquery'>util:laststrip-fromnamespaces(reverse<xml xmlns='uri' xmlns:prefix='uri2' prefix:name='value'><prefix:child/></xml>) (1 to 100): yields :)<xml name='value'><child/></xml></pre>* Remove all default namespaces:<pre lang='xquery'><xml xmlns='uri1'><child xmlns='uri2'/code> returns <code/xml>=>1util:strip-namespaces('')</codepre>|} =Errors= {| class="wikitable" width="100%"! width="110"|Code|Description|- valign="top"|{{Code|negative}}|The specified number is negative.