Package net.sf.saxon.ma.map

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.

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.

Related Packages

Package	Description
net.sf.saxon.ma	This package contains classes associated with the implementation of maps, arrays, and JSON for XSLT 3.0 and XPath 3.1.
net.sf.saxon.ma.arrays	This package implements arrays, as introduced in XPath/XQuery 3.1: arrays provide a list-like data structure that (unlike sequences) allows nesting.
net.sf.saxon.ma.json	This package implements support for JSON: it includes classes that implement the XPath 3.1 functions for JSON, and underlying support code for parsing and serializating JSON.
net.sf.saxon.ma.trie	This package contains a general-purpose implementation of immutable hash trie maps, used to underpin the Saxon implementation of XSLT 3.0 maps.
net.sf.saxon.ma.zeno	This package contains an implementation of XDM sequences known as the ZenoSequence.

Class	Description
DictionaryMap	A simple implementation of MapItem where the strings are keys, and modification is unlikely.
HashTrieMap	An immutable map.
KeyValuePair	A key and a corresponding value to be held in a Map.
MapCreate	This is a variant of the map:new() or map:merge() function which differs in that duplicate keys are considered an error.
MapFunctionSet	Function signatures (and pointers to implementations) of the functions defined in the map namespace in XPath 3.1
MapFunctionSet.MapBuild	Implementation of the proposed XPath 4.0 function map:build($sequence, $key, $value, $combined) as xs:anyAtomicType) => map(*)
MapFunctionSet.MapContains	Implementation of the XPath 3.1 function map:contains(Map, key) => boolean
MapFunctionSet.MapEntries	Implementation of the proposed 4.0 function map:entries(Map) => map(*)*
MapFunctionSet.MapEntry	Implementation of the extension function map:entry(key, value) => Map
MapFunctionSet.MapFilter	Implementation of the proposed XPath 4.0 function map:filter(Map, function(*)) => Map
MapFunctionSet.MapFind	Implementation of the XPath 3.1 function map:find(item()*, key) => array
MapFunctionSet.MapForEach	Implementation of the function map:for-each(Map, Function) => item()*
MapFunctionSet.MapGet	Implementation of the XPath 3.1 function map:get(Map, key) => value
MapFunctionSet.MapKeys	Implementation of the XPath 3.1 function map:keys(Map) => atomicValue*
MapFunctionSet.MapMerge	Implementation of the function map:merge() => Map From 9.8, map:merge is also used to implement map constructors in XPath and the xsl:map instruction in XSLT.
MapFunctionSet.MapOfPairs	Implementation of the function map:of-pairs() => Map
MapFunctionSet.MapPair	Implementation of the proposed 4.0 function map:pair(key, value) => record(key, value)
MapFunctionSet.MapPairs	Implementation of the proposed 4.0 function map:pairs(Map) => record(key, value)*
MapFunctionSet.MapPut	Implementation of the extension function map:put() => Map
MapFunctionSet.MapRemove	Implementation of the XPath 3.1 function map:remove(Map, key) => value
MapFunctionSet.MapSize	Implementation of the extension function map:size(map) => integer
MapItem	Interface supported by different implementations of an XDM map item
MapType	An instance of this class represents a specific map item type, for example map(x:integer, element(employee))
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.
RecordTest	An instance of this class represents a specific record item type, for example record(x as xs:double, y as element(employee)).
RecordTest.Field	Class representing one field definition within a record type definition, used only while constructing a record definition
RecordType	An instance of this class represents a specific record type, for example record(x as xs:double, y as element(employee)).
SelfReferenceRecordTest	An instance of this class represents a self-reference within a record type, that is the ".." construct in a record test such as record(data as xs:string, next? as ..).
SingleEntryMap	A key and a corresponding value to be held in a Map.