com.saxonica.functions.map

Interface MapItem

All Superinterfaces:

Callable, FunctionItem, GroundedValue, Item, Iterable<KeyValuePair>, PullEvent, Sequence

All Known Implementing Classes:

HashTrieMap, RangeKey

public interface MapItem
extends FunctionItem, Iterable<KeyValuePair>

Interface supported by different implementations of an XDM map item

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MapItem.TimeZoneStatus

Method Summary

Methods

Modifier and Type	Method and Description
Sequence	get(AtomicValue key) Get an entry from the Map
AtomicType	getKeyType() Get the lowest common item type of the keys in the map
MapItem.TimeZoneStatus	getTimeZoneStatus() Ask whether the map includes calendar values with a timezone, calendar values without a timezone, or neither.
SequenceType	getValueType() Get the lowest common sequence type of all the values in the map
boolean	isEmpty() Ask whether the map is empty
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.FunctionItem

call, deepEquals, getArity, getFunctionItemType, getFunctionName, iterate

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

getStringValue, getStringValueCS, head

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

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

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

getTimeZoneStatus

MapItem.TimeZoneStatus getTimeZoneStatus()

Ask whether the map includes calendar values with a timezone, calendar values without a timezone, or neither. Maps are not allowed to mix keys that have a timezone and keys that do not. Here "calendar values" means any of the types dateTime, date, time, gYear, gYearMonth, gMonth, gMonthDay, or gDay

Returns:

the time zone status of the map contents.

iterator

Iterator<KeyValuePair> iterator()

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

Specified by:

iterator in interface Iterable<KeyValuePair>

Returns:

an iterator over the key-value pairs

remove

MapItem remove(AtomicValue key)
               throws XPathException

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

Throws:

XPathException - if a dynamic error occurs

getKeyType

AtomicType getKeyType()

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 ErrorType.getInstance() (the type with no instances)

getValueType

SequenceType getValueType()

Get the lowest common sequence type of all the values in the map

Returns:

the most specific sequence type to which all the values belong. If the map is empty, return SequenceType.VOID