Package com.saxonica.functions.extfn

Class KeyMap

java.lang.Object

net.sf.saxon.functions.AbstractFunction

net.sf.saxon.functions.SystemFunction

com.saxonica.functions.extfn.KeyMap

All Implemented Interfaces:

Callable, Function, GroundedValue, Item, Sequence

public class KeyMap
extends SystemFunction

Implementation of the saxon:key-map() extension function. Introduced in 9.5. Views an index, as built using xsl:key, as a map, allowing queries to get the values corresponding to a range of key values, in sorted order.

Constructor Summary

Constructors

Constructor	Description
KeyMap()

Method Summary

Modifier and Type	Method	Description
MapItem	call(XPathContext context, Sequence[] arguments)	Invoke the function

Methods inherited from class net.sf.saxon.functions.SystemFunction

dependsOnContextItem, dynamicCall, equals, export, exportAdditionalArguments, exportAttributes, fixArguments, getArity, getCardinality, getCompilerName, getContextNode, getDescription, getDetails, getErrorCodeForTypeErrors, getFunctionItemType, getFunctionName, getIntegerBounds, getNetCost, getOperandRoles, getRequiredType, getResultItemType, getResultItemType, getRetainedStaticContext, getSpecialProperties, getStaticBaseUriString, getStreamerName, importAttributes, isTrustedResultType, makeCall, makeFunction, makeFunctionCall, makeOptimizedFunctionCall, resultIfEmpty, setArity, setDetails, setRetainedStaticContext, supplyTypeInformation, toShortString, toString, typeCheckCaller

Methods inherited from class net.sf.saxon.functions.AbstractFunction

atomize, deepEquals, effectiveBooleanValue, getAnnotations, getStringValue, getStringValueCS, isArray, isMap, makeNewContext, simplify, typeCheck

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getGenre

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

asIterable, concatenate, containsNode, materialize

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

getLength, head, isStreamed, itemAt, iterate, reduce, subsequence

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

makeRepeatable

Constructor Detail

KeyMap

public KeyMap()

Method Detail

call

public MapItem call(XPathContext context,
                    Sequence[] arguments)
             throws XPathException

Description copied from interface: Function

Invoke the function

Parameters:

context - the XPath dynamic evaluation context

arguments - the actual arguments to be supplied

Returns:

the result of invoking the function

Throws:

XPathException - if a dynamic error occurs within the function