Module dev.metaschema.core

Package dev.metaschema.core.metapath.item.function

package dev.metaschema.core.metapath.item.function

Provides support for Metapath function items, including arrays and maps.

This package implements the XPath 3.1 function item types, including arrays and maps. These are first-class values in Metapath that can be passed as arguments, returned from functions, and stored in sequences.

Array Items

Arrays are ordered collections of values, where each value is a sequence.

• IArrayItem - The main interface for array items, implementing List

Arrays are immutable once created and support operations like getting members by position (1-indexed), determining size, and conversion to sequences. Factory methods are provided for creating arrays with various numbers of members.

Map Items

Maps are unordered collections of key-value pairs, where keys must be atomic items and values are sequences.

• IMapItem - The main interface for map items, implementing Map
• IMapKey - The key type used in maps, wrapping atomic items with proper equality semantics
• IKeySpecifier - Interface for computing map keys from items

Maps are immutable once created and support operations like getting values by key, determining size, and merging maps. Factory methods are provided for creating maps with various numbers of entries.

Map Key Types

Different atomic types use different equality semantics for map keys:

• IStringMapKey - Keys for string-based types (string, anyURI)
• IDecimalMapKey - Keys for numeric types (decimal, integer, float, double)
• ITemporalMapKey - Keys for date/time types (date, dateTime, time)
• ICalendarMapKey - Keys for calendar-based types
• IOpaqueMapKey - Keys for types with identity-based equality (boolean, QName, etc.)

Exceptions

• IndexOutOfBoundsArrayMetapathException - Thrown when accessing an array with an out-of-bounds index
• NegativeLengthArrayMetapathException - Thrown when attempting to create an array with a negative length

See Also:

• IArrayItem
• IMapItem

Related Packages

Package	Description
dev.metaschema.core.metapath.item	Core interfaces and classes for the Metapath item type system.
dev.metaschema.core.metapath.item.atomic	Atomic item types representing indivisible values in the Metapath type system.
dev.metaschema.core.metapath.item.node	Node item types representing structured data in the Metapath type system.

Class	Description
IArrayItem<ITEM extends ICollectionValue>	A representation of a Metapath array item type.
ICalendarMapKey	An IMapItem key based on an ICalendarTemporalItem.
IDecimalMapKey	An IMapItem key based on an IDecimalItem.
IKeySpecifier	A common interface for all key specifier implementations.
IMapItem<VALUE extends ICollectionValue>	Represents a mapping of IMapKey keys to values.
IMapKey	The key value used in an IMapItem.
IndexOutOfBoundsArrayMetapathException	err:FOAY0001: This error is raised when an integer used to select a member of an array is outside the range of values for that array.
IOpaqueMapKey	Represents a map key with no special handling based on the key value's data type.
IStringMapKey	An IMapItem key based on a text value.
ITemporalMapKey	An IMapItem key based on an ITemporalItem value.
NegativeLengthArrayMetapathException	err:FOAY0001: This error is raised when an integer used to select a member of an array is outside the range of values for that array.