Package net.sf.saxon.ma.map

This package implements maps, as introduced in XSLT 3.0 and XQuery 3.1: maps provide a dictionary-like data structure.

See: Description

Interface Summary

Interface	Description
MapItem	Interface supported by different implementations of an XDM map item

Class Summary

Class	Description
HashTrieMap	An immutable map.
KeyValuePair	A key and a corresponding value to be held in a Map.
MapContains	Implementation of the XPath 3.0 function map:contains(Map, key) => boolean
MapCreate	This is a variant of the map:new() or map:merge() function which differs in that duplicate keys are considered an error.
MapEntry	Implementation of the extension function map:entry(key, value) => Map
MapForEach	Implementation of the extension function map:for-each(Map, Function) => item()*
MapGet	Implementation of the XPath 3.0 function map:get(Map, key) => value
MapKeys	Implementation of the extension function map:keys(Map) => atomicValue*
MapMerge	Implementation of the extension function map:merge() => Map This function replaces map:new (May 2014) which is retained in Saxon for the time being.
MapNew	Implementation of the extension function map:new() => Map Note this function has been dropped from the spec (May 2014) but is retained in Saxon to underpin map constructor expression syntax.
MapPut	Implementation of the extension function map:put() => Map This function has been added to the spec in May 2014
MapRemove	Implementation of the XPath 3.0 function map:remove(Map, key) => value
MapSize	Implementation of the extension function map:size(map) => integer
MapType	An instance of this class represents a specific map item type, for example function(xs:int) as xs:boolean
MapUntypedContains	Implementation of an internal function map:untyped-contains(Map, key) => boolean, which is like map:contains except that if the supplied key is untyped atomic, it is converted to all the possible types present in the map and returns true if the key after conversion is present.
RangeKey	This class implements an XPath map item as a view of an XSLT key index.

Package net.sf.saxon.ma.map Description

This package implements maps, as introduced in XSLT 3.0 and XQuery 3.1: maps provide a dictionary-like data structure.

Maps are immutable, so that adding a new entry to a map creates a new map.

The entries in a map are (Key, Value) pairs. The key is always an atomic value; the value may be any XPath sequence.

There are functions (each supported by its own implementation class) to create a new map, to add an entry to a map, to get an entry from a map, and to list all the keys that are present in a map.

Michael H. Kay
Saxonica Limited
June 2015