available-maps#0

declare function map:available-maps() as xs:QName* external

The function returns a sequence of QNames of the maps that are available. The sequence will be empty if there are no maps.

create-transient#2

declare %an:variadic %an:sequential function map:create-transient(
    $name as xs:QName,
    $key-type as xs:QName
) as empty-sequence() external

Create a transient map with a given name and a set of type identifiers for each key attribute. Note that the function is variadic and might take an arbitrary number of type identifiers for the key attributes.

create#2

declare %an:variadic %an:sequential function map:create(
    $name as xs:QName,
    $key-type as xs:QName
) as empty-sequence() external

Create a map with a given name and a set of type identifiers for each key attribute. Note that the function is variadic and might take an arbitrary number of type identifiers for the key attributes. Also note that the function is sequential and immediately creates the map in the store.

delete#1

declare %an:sequential function map:delete(
    $name as xs:QName
) as empty-sequence() external

Destroys the map with the given name.

get#2

declare %an:variadic function map:get(
    $name as xs:QName,
    $key as xs:anyAtomicType?
) as item()* external

Returns the value of the entry with the given key from the map. Note that it is possible to insert entries with empty key attributes. However as the getting the entries is based on the "eq" comparison and as "eq" with an empty sequence always return false, it is not possible to retrieve these entries.

insert#3

declare %an:variadic %an:sequential function map:insert(
    $name as xs:QName,
    $value as item()*,
    $key as xs:anyAtomicType?
) as empty-sequence() external

Inserts a new entry into the map with the given name. Note that the function is variadic and might take an arbitrary number of key attributes. If an entry with the given key already exists in the map, the value sequences of the existing entry and the sequence passed using $value argument are concatenated. Note that it is possible to insert entries with empty key attributes. However as the getting the entries is based on the "eq" comparison and as "eq" with an empty sequence always return false, it is not possible to retrieve these entries.

is-transient#1

declare function map:is-transient(
    $name as xs:QName
) as xs:boolean external

The function returns true if the map identified by the given QName is transient, false otherwise.

keys#1

declare function map:keys(
    $name as xs:QName
) as node()* external

Returns the keys of all entries of a map. The keys are returned as sequence of nodes of the form:

 <key xmlns="http://www.zorba-xquery.com/modules/store/data-structures/unordered-map">
   <attribute value="key1_value"/>
   <attribute value="key2_value"/>
   <attribute value="key3_value"/>
 </key>
 

remove#2

declare %an:variadic %an:sequential function map:remove(
    $name as xs:QName,
    $key as xs:anyAtomicType?
) as empty-sequence() external

Removes an entry identified by the given key from the map. Note that it is possible to insert entries with empty key attributes. However as the removing the entries is based on the "eq" comparison and as "eq" with an empty sequence always return false, it is not possible to remove these entries.

size#1

declare function map:size(
    $name as xs:QName
) as xs:integer external

The number of entries in a map. The following condition always holds: map:size($name) eq fn:count(map:keys($name))