Difference between revisions of "Utility Module"
Jump to navigation
Jump to search
m (Text replacement - "<syntaxhighlight lang="xquery">" to "<pre lang='xquery'>") |
|||
(One intermediate revision by the same user not shown) | |||
Line 33: | Line 33: | ||
|- valign="top" | |- valign="top" | ||
| {{Code|util:map-entries}} | | {{Code|util:map-entries}} | ||
− | | [https://qt4cg.org/specifications/xpath-functions-40/Overview.html#func-map- | + | | [https://qt4cg.org/specifications/xpath-functions-40/Overview.html#func-map-entries <code>map:entries</code>] |
|- valign="top" | |- valign="top" | ||
| {{Code|util:map-values}} | | {{Code|util:map-values}} | ||
Line 89: | Line 89: | ||
let $count := count($sequence) | let $count := count($sequence) | ||
return $count >= $min and $count <= $max | return $count >= $min and $count <= $max | ||
− | </ | + | </pre> |
|- valign="top" | |- valign="top" | ||
| '''Examples''' | | '''Examples''' | ||
Line 112: | Line 112: | ||
<pre lang='xquery'> | <pre lang='xquery'> | ||
subsequence($sequence, $first, $last - $first + 1) | subsequence($sequence, $first, $last - $first + 1) | ||
− | </ | + | </pre> |
|- valign="top" | |- valign="top" | ||
| '''Examples''' | | '''Examples''' | ||
Line 134: | Line 134: | ||
<pre lang='xquery'> | <pre lang='xquery'> | ||
$nodes/self::node() | $nodes/self::node() | ||
− | </ | + | </pre> |
|} | |} | ||
Line 150: | Line 150: | ||
<pre lang='xquery'> | <pre lang='xquery'> | ||
$nodes ! / | $nodes ! / | ||
− | </ | + | </pre> |
|} | |} | ||
Line 174: | Line 174: | ||
(: yields :) | (: yields :) | ||
<xml name='value'><child/></xml> | <xml name='value'><child/></xml> | ||
− | </ | + | </pre> |
* Remove all default namespaces: | * Remove all default namespaces: | ||
<pre lang='xquery'> | <pre lang='xquery'> | ||
<xml xmlns='uri1'><child xmlns='uri2'/></xml> | <xml xmlns='uri1'><child xmlns='uri2'/></xml> | ||
=> util:strip-namespaces('') | => util:strip-namespaces('') | ||
− | </ | + | </pre> |
|} | |} | ||
Latest revision as of 14:36, 5 December 2023
This XQuery Module contains some utility and helper functions.
With Version 11, many functions have been removed in favor of new features of XQuery 4:
BaseX 10 | XQuery 4 |
util:array-members
|
array:members
|
util:array-values
|
array:values
|
util:chars
|
fn:characters
|
util:duplicates
|
fn:duplicate-values
|
util:init
|
fn:trunk
|
util:intersperse
|
fn:intersperse
|
util:item
|
fn:items-at
|
util:last
|
fn:foot
|
util:map-entries
|
map:entries
|
util:map-values
|
map:values
|
util:or
|
$expr1 otherwise $expr2
|
util:replicate
|
fn:replicate
|
Contents
Conventions[edit]
All functions and errors in this module and errors are assigned to the http://basex.org/modules/util
namespace, which is statically bound to the util
prefix.
Conditions and Ranges[edit]
util:if[edit]
Signature | util:if( $condition as item()*, $then as item()*, $else as item()* := () ) as item()* |
Summary | Alternative writing for the if/then/else expression:
|
Examples |
|
util:count-within[edit]
Signature | util:count-within( $sequence as item()*, $min as xs:integer, $max as xs:integer := () ) as xs:boolean |
Summary | Checks if the specified $sequence has at least $min and, optionally, at most $max items. Equivalent to:
let $count := count($sequence)
return $count >= $min and $count <= $max
|
Examples |
|
util:range[edit]
Signature | util:range( $sequence as item()*, $first as xs:double, $last as xs:double ) as item()* |
Summary | Returns items from $sequence , starting at position $first and ending at $last . Equivalent to:
subsequence($sequence, $first, $last - $first + 1)
|
Examples |
|
Node Functions[edit]
util:ddo[edit]
Signature | util:ddo( $nodes as node()* ) as node()* |
Summary | Returns nodes in distinct document order: duplicate nodes will be removed, and the remaining nodes will be returned in document order. As results of path expressions are brought distinct document order before they are returned, the function is equivalent to:
$nodes/self::node()
|
util:root[edit]
Signature | util:root( $nodes as node()* ) as document-node()* |
Summary | Returns the document nodes of the specified $nodes . The path expression /abc is internally represented as util:root(.)/abc . Equivalent to:
$nodes ! /
|
util:strip-namespaces[edit]
Signature | util:strip-namespaces( $node as node(), $prefixes as xs:string* := () ) as node() |
Summary | Removes namespaces with the specified $prefixes from the supplied $node . An empty string can be supplied to remove the default namespace. If no prefixes are specified, all namespaces will be removed.
|
Examples |
util:strip-namespaces(<xml xmlns='uri' xmlns:prefix='uri2' prefix:name='value'><prefix:child/></xml>)
(: yields :)
<xml name='value'><child/></xml>
<xml xmlns='uri1'><child xmlns='uri2'/></xml>
=> util:strip-namespaces('')
|
Errors[edit]
Code | Description |
---|---|
negative
|
The specified number is negative. |
Changelog[edit]
- Version 11.0
- Removed:
util:array-members
,util:array-values
,util:chars
,util:duplicates
,util:init
,util:intersperse
,util:item
,util:last
,util:map-entries
,util:map-values
,util:replicate
- Version 9.7
- Added:
util:strip-namespaces
- Updated:
util:count-within
: Renamed fromutil:within
.
- Version 9.5
- Added:
util:intersperse
,util:within
,util:duplicates
,util:array-members
,util:array-values
,util:map-entries
,util:map-values
- Updated:
util:replicate
: Third argument added.
- Version 9.4
- Added:
util:root
- Version 9.3
- Added:
util:ddo
- Version 9.2
- Added:
util:chars
,util:init
- Updated:
util:item
,util:last
,util:range
renamed (before:util:item-at
,util:item-range
,util:last-from
)
- Version 9.1
- Added:
util:if
,util:or
- Version 9.0
- Added:
util:replicate
The Module was introduced with Version 8.5.