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.

A map is an additional kind of item.

A map 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 get($map, $key). For example, if $books-by-isbn is a map whose keys are ISBNs and whose assocated 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.

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: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.

map:collation

Signatures	map:collation($map as map(*)) as xs:string
Summary	Returns the URI of the supplied map's collation.
Rules	The function map:collation returns the collation URI of the map supplied as $input.

map:contains

Signatures	map:contains($map as map(*), $key as item()) as xs:boolean
Summary	Tests whether a supplied map contains an entry for a given key.
Rules	The function map:contains 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 xs:untypedAtomic, it is converted to xs:string. If the supplied key is the xs:float or xs:double value NaN, the function returns false. let $week := map{0:="Sonntag", 1:="Montag", 2:="Dienstag", 3:="Mittwoch", 4:="Donnerstag", 5:="Freitag", 6:="Samstag"}
Examples	The expression map:contains($week, 2) returns true(). The expression map:contains($week, 9) returns false(). The expression map:contains(map{}, "xyz") returns false(). The expression map:contains(map{"xyz":=23}, "xyz") returns true().

map:entry

Signatures	map:entry($key as item(), $value as item()*) as map(*)
Summary	The function map:entry returns a new map containing a single entry. The collation of the new map is the the default collation from the static context. The key of the entry in the new map is $key, and its associated value is $value.
Rules	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:entry is intended primarily for use in conjunction with the function map:new. For example, a map containing seven entries may be constructed like this: 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{...} expression, this technique can be used to construct a map with a variable number of entries, for example: map:new(for $b in //book return map:entry($b/isbn, $b))
Examples	The expression map:entry("M", "Monday") returns map{"M":="Monday"}.

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.
Rules	The function map:get attempts to find an entry within the map supplied as $input 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 () from map:get could indicate that the key is present in the map with an associated value of (), or it could indicate that the key is not present in the map. The two cases can be distinguished by calling map:contains. Invoking the map as a function item has the same effect as calling get: that is, when $map is a map, the expression $map($K) is equivalent to get($map, $K). Similarly, the expression get(get(get($map, 'employee'), 'name'), 'first') can be written as $map('employee')('name')('first'). let $week := map{0:="Sonntag", 1:="Montag", 2:="Dienstag", 3:="Mittwoch", 4:="Donnerstag", 5:="Freitag", 6:="Samstag"}
Examples	The expression map:get($week, 4) returns "Donnerstag". The expression map:get($week, 9) returns (). (When the key is not present, the function returns an empty sequence.). The expression map:get(map:entry(7,())), 7) returns (). (An empty sequence as the result can also signify that the key is present and the associated value is an empty sequence.).

map:keys

Signatures	map:keys($map as map(*)) as xs:anyAtomicType*
Summary	Returns a sequence containing all the key values present in a map.
Rules	The function map:keys takes any map as its $input argument and returns the keys that are present in the map as a sequence of atomic values, in implementation-dependent order.
Examples	The expression map:keys(map{1:="yes", 2:="no"}) returns some permutation of (1,2). (The result is in implementation-dependent order.).

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	Creates a new map: either an empty map, or a map that combines entries from a number of existing maps.
Rules	The function map:new 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 $input argument. It is equivalent to calling the two-argument form of the function with the default collation from the static context as the second argument. The two-argument form of the function returns a map that is formed by combining the contents of the maps supplied in the $input argument. The collation of the new map is the value of the $collation argument. The supplied maps are combined as follows: There is one entry in the new map for each distinct key value present in the union of the input maps, where keys are considered distinct according to the rules of the distinct-values function with $collation as the collation. The associated value for each such key is taken from the last map in the input sequence $input that contains an entry with this key. If this map contains more than one entry with this key (which can happen if its collation is different from that of the new map) then it is implementation-dependent which of them is selected. There is no requirement that the supplied input maps should have the same or compatible types. The type of a map (for example map(xs:integer, xs:string)) is descriptive of the entries it currently contains, but is not a constraint on how the map may be combined with other maps. let $week := map{0:="Sonntag", 1:="Montag", 2:="Dienstag", 3:="Mittwoch", 4:="Donnerstag", 5:="Freitag", 6:="Samstag"}
Examples	The expression map:new() returns map{}. (Returns an empty map, whose collation is the default collation from the static context). The expression map:new(()) returns map{}. (Returns an empty map, whose collation is the default collation from the static context). The expression map:new(map:entry(0, "no"), map:entry(1, "yes")) returns map{0:="no", 1:="yes"}. (Returns a map with two entries; the collation of the map is the default collation from the static context). The expression map:new(map:entry(0, "no"), map:entry(1, "yes")) returns map{0:="no", 1:="yes"}. (Returns a map with two entries; the collation of the map is the default collation from the static context). The expression map:new(($week, map{7:="Unbekannt"})) returns map{0:="Sonntag", 1:="Montag", 2:="Dienstag", 3:="Mittwoch", 4:="Donnerstag", 5:="Freitag", 6:="Samstag", 7:="Unbekannt"}. (The value of the existing map is unchanged; a new map is created containing all the entries from $week, supplemented with a new entry.). The expression map:new(($week, map{6:="Sonnabend"})) returns map{0:="Sonntag", 1:="Montag", 2:="Dienstag", 3:="Mittwoch", 4:="Donnerstag", 5:="Freitag", 6:="Sonnabend"}. (The value of the existing map is unchanged; a new map is created containing all the entries from $week, with one entry replaced by a new entry. Both input maps contain an entry with the key value 6; the one used in the result is the one that comes last in the input sequence.). The expression map:new((map{"A":=1}, map{"a:=2"}), "http://collation.example.com/caseblind") returns map{"a":=2}. (Assuming that the keys of the two entries are equal under the rules of the chosen collation, only one of the entries can appear in the result; the one that is chosen is the one from the last map in the input sequence. If both entries were in the same map, it would be implementation-dependent which was chosen.).

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.
Rules	The function map:remove returns a new 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 let $week := map{0:="Sonntag", 1:="Montag", 2:="Dienstag", 3:="Mittwoch", 4:="Donnerstag", 5:="Freitag", 6:="Samstag"}
Examples	The expression map:remove($week, 4) returns map{0:="Sonntag", 1:="Montag", 2:="Dienstag", 3:="Mittwoch", 5:="Freitag", 6:="Samstag"}. The expression map:remove($week, 23) returns map{0:="Sonntag", 1:="Montag", 2:="Dienstag", 3:="Mittwoch", 4:="Donnerstag", 5:="Freitag", 6:="Samstag"}.

map:size

Signatures	map:size($map as map(*)) as xs:integer
Summary	Returns a the number of entries in the supplied map.
Rules	The function map:size takes any map as its $input argument and returns the number of entries that are present in the map.
Examples	The expression map:size(map:new()) returns 0. The expression map:size(map{"true":=1, "false":=0}) returns 2.