net.sf.saxon.ma.map

Interface MapItem

All Superinterfaces:

Callable, Function, GroundedValue, Item, java.lang.Iterable<KeyValuePair>, Sequence

All Known Implementing Classes:

HashTrieMap, RangeKey

public interface MapItem
extends Function, java.lang.Iterable<KeyValuePair>

Interface supported by different implementations of an XDM map item

Method Summary

Modifier and Type	Method and Description
MapItem	addEntry(AtomicValue key, Sequence value) Create a new map containing the existing entries in the map plus an additional entry, without modifying the original.
boolean	conforms(AtomicType keyType, SequenceType valueType, TypeHierarchy th) Ask whether the map conforms to a given map type
Sequence	get(AtomicValue key) Get an entry from the Map
MapType	getItemType(TypeHierarchy th) Get the type of the map.
UType	getKeyUType() Get the lowest common item type of the keys in the map
boolean	isEmpty() Ask whether the map is empty
java.util.Iterator<KeyValuePair>	iterator() Get the set of all key-value pairs in the map
AtomicIterator	keys() Get the set of all key values in the map.
MapItem	remove(AtomicValue key) Remove an entry from the map
int	size() Get the size of the map

Methods inherited from interface net.sf.saxon.om.Function

call, deepEquals, export, getAnnotations, getArity, getDescription, getFunctionItemType, getFunctionName, getOperandRoles, isArray, isMap, isTrustedResultType, iterate, makeNewContext

Methods inherited from interface net.sf.saxon.om.Item

atomize, getStringValue, getStringValueCS, head

Methods inherited from interface net.sf.saxon.om.GroundedValue

effectiveBooleanValue, getLength, getStringValue, getStringValueCS, head, itemAt, reduce, subsequence

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

get

Sequence get(AtomicValue key)

Get an entry from the Map

Parameters:

key - the value of the key

Returns:

the value associated with the given key, or null if the key is not present in the map

size

int size()

Get the size of the map

Returns:

the number of keys/entries present in this map

isEmpty

boolean isEmpty()

Ask whether the map is empty

Returns:

true if and only if the size of the map is zero

keys

AtomicIterator keys()

Get the set of all key values in the map.

Returns:

a set containing all the key values present in the map, in unpredictable order

iterator

java.util.Iterator<KeyValuePair> iterator()

Get the set of all key-value pairs in the map

Specified by:

iterator in interface java.lang.Iterable<KeyValuePair>

Returns:

an iterator over the key-value pairs

addEntry

MapItem addEntry(AtomicValue key,
                 Sequence value)

Create a new map containing the existing entries in the map plus an additional entry, without modifying the original. If there is already an entry with the specified key, this entry is replaced by the new entry.

Parameters:

key - the key of the new entry

value - the value associated with the new entry

Returns:

the new map containing the additional entry

remove

MapItem remove(AtomicValue key)

Remove an entry from the map

Parameters:

key - the key of the entry to be removed

Returns:

a new map in which the requested entry has been removed; or this map unchanged if the specified key was not present

conforms

boolean conforms(AtomicType keyType,
                 SequenceType valueType,
                 TypeHierarchy th)

Ask whether the map conforms to a given map type

Parameters:

keyType - the required keyType

valueType - the required valueType

th - the type hierarchy cache for the configuration

Returns:

true if the map conforms to the required type

getItemType

MapType getItemType(TypeHierarchy th)

Get the type of the map. This method is used largely for diagnostics, to report the type of a map when it differs from the required type.

Returns:

the type of this map

getKeyUType

UType getKeyUType()

Get the lowest common item type of the keys in the map

Returns:

the most specific type to which all the keys belong. If the map is empty, return UType.VOID