Map Module
This module contains XQuery functions for manipulating maps. All functions are preceded by the map:
prefix, which is linked to the http://www.w3.org/2005/xpath-functions/map
namespace. The following documentation is derived from an XQuery 3.0 Functions and Operators working draft proposal written by Michael H. Kay, and is not part of the official standard yet.
A map is an additional kind of item. It comprises a collation and a set of entries. Each entry comprises a key which is an arbitrary atomic value, and an arbitrary sequence called the associated value. Within a map, no two entries have the same key, when compared using the eq
operator under the map's collation. It is not necessary that all the keys should be mutually comparable (for example, they can include a mixture of integers and strings). Key values will never be of type xs:untypedAtomic
, and they will never be the xs:float
or xs:double
value NaN
.
The function call map:get($map, $key)
can be used to retrieve the value associated with a given key.
A map can also be viewed as a function from keys to associated values. To achieve this, a map is also a function item. The function corresponding to the map has the signature function($key as xs:anyAtomicType) as item()*
. Calling the function has the same effect as calling the get
function: the expression $map($key)
returns the same result as map:get($map, $key)
. For example, if $books-by-isbn
is a map whose keys are ISBNs and whose associated values are book
elements, then the expression $books-by-isbn("0470192747")
returns the book
element with the given ISBN. The fact that a map is a function item allows it to be passed as an argument to higher-order functions that expect a function item as one of their arguments. As an example, the following query uses the higher-order function fn:map($f, $seq)
to extract all bound values from a map:
let $map := map { 'foo' := 42, 'bar' := 'baz', 123 := 456 } return fn:map($map, map:keys($map))
This returns some permutation of (42, 'baz', 456)
.
Like all other values, maps are immutable. For example, the map:remove
function creates a new map by removing an entry from an existing map, but the existing map is not changed by the operation.
Like sequences, maps have no identity. It is meaningful to compare the contents of two maps, but there is no way of asking whether they are "the same map": two maps with the same content are indistinguishable.
Because a map is a function item, functions that apply to functions also apply to maps. A map is an anonymous function, so fn:function-name
returns the empty sequence; fn:function-arity
always returns 1
.
Maps may be compared using the fn:deep-equal
function. The semantics for this function are extended so that when two items are compared, at any level of recursion, the items compare equal if they are both maps, if both use the same collation, if both contain the same set of keys (compared using the eq
operator), without regard to ordering, and if for each key that is present in both maps, the associated values are deep-equal. When comparing maps, the maps' collation is used rather than the collation supplied as an argument to the fn:deep-equal
function.
There is no operation to atomize a map or convert it to a string. The following XQuery snippet shows how the contents of a map can be serialized:
let $map := map { 1:='a', 2:='b' } return string-join( for $m in map:keys($map) return concat($m, ':=', $map($m)), ', ' )
Some examples use the map $week
defined as:
declare variable $week as map(*) := map { 0:="Sonntag", 1:="Montag", 2:="Dienstag", 3:="Mittwoch", 4:="Donnerstag", 5:="Freitag", 6:="Samstag" };
Contents
map:collation
Signatures | map:collation($map as map(*)) as xs:string
|
Summary | Returns the collation URI of the map supplied as $map .
|
map:contains
Signatures | map:contains($map as map(*), $key as item()) as xs:boolean
|
Summary | Returns true if the map supplied as $map contains an entry with a key equal to the supplied value of $key ; otherwise it returns false. The equality comparison uses the map's collation; no error occurs if the map contains keys that are not comparable with the supplied $key .
If the supplied key is |
Examples |
|
map:entry
Signatures | map:entry($key as item(), $value as item()*) as map(*)
|
Summary | Creates a new map containing a single entry. The collation of the new map is the default collation from the static context. The key of the entry in the new map is $key , and its associated value is $value . If the supplied key is xs:untypedAtomic , it is converted to xs:string . If the supplied key is the xs:float or xs:double value NaN , the supplied $map is returned unchanged.
The function map:new(( map:entry("Su", "Sunday"), map:entry("Mo", "Monday"), map:entry("Tu", "Tuesday"), map:entry("We", "Wednesday"), map:entry("Th", "Thursday"), map:entry("Fr", "Friday"), map:entry("Sa", "Saturday") )) Unlike the map:new(for $b in //book return map:entry($b/isbn, $b)) |
Examples |
|
map:get
Signatures | map:get($map as map(*), $key as item()) as item()*
|
Summary | Returns the value associated with a supplied key in a given map. This function attempts to find an entry within the map supplied as $map that has a key equal to the supplied value of $key . If there is such an entry, it returns the associated value; otherwise it returns an empty sequence. The equality comparison uses the map's collation; no error occurs if the map contains keys that are not comparable with the supplied $key . If the supplied key is xs:untypedAtomic , it is converted to xs:string . If the supplied key is the xs:float or xs:double value NaN , the function returns an empty sequence.
A return value of |
Examples |
|
map:keys
Signatures | map:keys($map as map(*)) as xs:anyAtomicType*
|
Summary | Returns a sequence containing all the key values present in a map. The function takes any map as its $map argument and returns the keys that are present in the map as a sequence of atomic values, in implementation-dependent order.
|
Examples |
|
map:new
Signatures | map:new() as map(*) map:new($maps as map(*)*) as map(*) map:new($maps as map(*)*, $coll as xs:string) as map(*)
|
Summary | Constructs and returns a new map. The zero-argument form of the function returns an empty map whose collation is the default collation in the static context. It is equivalent to calling the one-argument form of the function with an empty sequence as the value of the first argument.
The one-argument form of the function returns a map that is formed by combining the contents of the maps supplied in the
There is no requirement that the supplied input maps should have the same or compatible types. The type of a map (for example |
Examples |
|
map:remove
Signatures | map:remove($map as map(*), $key as item()) as map(*) |
Summary | Constructs a new map by removing an entry from an existing map. The collation of the new map is the same as the collation of the map supplied as $map . The entries in the new map correspond to the entries of $map , excluding any entry whose key is equal to $key .
No failure occurs if the input map contains no entry with the supplied key; the input map is returned unchanged |
Examples |
|
map:size
Signatures | map:size($map as map(*)) as xs:integer |
Summary | Returns a the number of entries in the supplied map. The function takes any map as its $map argument and returns the number of entries that are present in the map.
|
Examples |
|