XQuery Function Documentation

Search and Browse

http://www.w3.org/2005/xpath-functions/map

java:org.exist.xquery.functions.map.MapModule

Functions that operate on maps

map:contains

map:contains($map as map(*), $key as xs:anyAtomicType) as xs:boolean

Tests whether a supplied map contains an entry for a given key.

Parameters:
$map The map
$key The key to look up
Returns:
xs:boolean

map:entry

map:entry($key as xs:anyAtomicType, $value as item()*) as map(*)

Creates a map that contains a single entry (a key-value pair).

Parameters:
$key The key
$value* The associated value
Returns:
map(*)

map:for-each

map:for-each($input as map(*), $action as function(*)) as item()*

takes any map as its $input argument and applies the supplied function to each entry in the map, in implementation-dependent order; the result is the sequence obtained by concatenating the results of these function calls. The function supplied as $action takes two arguments. It is called supplying the key of the map entry as the first argument, and the associated value as the second argument.

Parameters:
$input The map
$action The function to be called for each entry
Returns:
item()*

map:for-each-entry

map:for-each-entry($input as map(*), $action as function(*)) as item()*

takes any map as its $input argument and applies the supplied function to each entry in the map, in implementation-dependent order; the result is the sequence obtained by concatenating the results of these function calls. The function supplied as $action takes two arguments. It is called supplying the key of the map entry as the first argument, and the associated value as the second argument.

Parameters:
$input The map
$action The function to be called for each entry
Returns:
item()*
Deprecated:
Moved to the module: http://www.w3.org/2005/xpath-functions/map, you should now use 'map:for-each' instead! This function could be removed in the next major release version.

map:get

map:get($map as map(*), $key as xs:anyAtomicType) as item()*

Returns the value associated with a supplied key in a given map.

Parameters:
$map The map
$key The key to look up
Returns:
item()*

map:keys

map:keys($map as map(*)) as xs:anyAtomicType*

Returns a sequence containing all the key values present in a map.

Parameters:
$map The map
Returns:
xs:anyAtomicType*

map:merge

map:merge($maps as map(*)*) as map(*)

Returns a map that combines the entries from a number of existing maps.

Parameters:
$maps* Existing maps to merge to create a new map.
Returns:
map(*)

map:new

map:new() as map(*)

Constructs and returns an empty map whose collation is the default collation in the static context.

Returns:
map(*)
Deprecated:
Use the computer map constructor `map {}` instead. This function could be removed in the next major release version.

map:new

map:new($maps as map(*)*) as map(*)

Constructs and returns an empty map whose collation is the default collation in the static context.

Parameters:
$maps* Existing maps to combine into the new map.
Returns:
map(*)
Deprecated:
Moved to the module: http://www.w3.org/2005/xpath-functions/map, you should now use 'map:merge' instead! This function could be removed in the next major release version.

map:new

map:new($maps as map(*)*, $collation as xs:string) as map(*)

Constructs and returns an empty map whose collation is given in the second argument.

Parameters:
$maps* Existing maps to combine into the new map.
$collation The collation to use for the new map.
Returns:
map(*)
Deprecated:
Moved to the module: http://www.w3.org/2005/xpath-functions/map, you should now use 'map:merge' instead! This function could be removed in the next major release version.

map:put

map:put($map as map(*), $key as xs:anyAtomicType, $value as item()*) as map(*)

Returns a map containing all the contents of the supplied map, but with an additional entry, which replaces any existing entry for the same key.

Parameters:
$map The map
$key The key for the entry to insert
$value* The value for the entry to insert
Returns:
map(*)

map:remove

map:remove($map as map(*), $key as xs:string) as map(*)

Constructs a new map by removing an entry from an existing map.

Parameters:
$map The map
$key The key to remove
Returns:
map(*)

map:size

map:size($input as map(*)) as xs:integer

Returns the number of entries in the supplied map.

Parameters:
$input Any map to determine the size of.
Returns:
xs:integer