Package net.sf.saxon.ma.map

Class MapFunctionSet

java.lang.Object

net.sf.saxon.functions.registry.BuiltInFunctionSet

net.sf.saxon.ma.map.MapFunctionSet

All Implemented Interfaces:

FunctionLibrary

public class MapFunctionSet
extends BuiltInFunctionSet

Function signatures (and pointers to implementations) of the functions defined in the map namespace in XPath 3.1 and 4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MapFunctionSet.MapBuild	Implementation of the proposed XPath 4.0 function map:build($sequence, $key, $value, $options) => map(*)
static class	MapFunctionSet.MapContains	Implementation of the XPath 3.1 function map:contains(Map, key) => boolean
static class	MapFunctionSet.MapEmpty	Implementation of the proposed 4.0 function map:empty(Map) => boolean
static class	MapFunctionSet.MapEntries	Implementation of the proposed 4.0 function map:entries(Map) => map(*)*
static class	MapFunctionSet.MapEntry	Implementation of the function map:entry(key, value) => Map
static class	MapFunctionSet.MapFilter	Implementation of the proposed XPath 4.0 function map:filter(Map, function(*)) => Map
static class	MapFunctionSet.MapFind	Implementation of the XPath 3.1 function map:find(item()*, key) => array
static class	MapFunctionSet.MapForEach	Implementation of the function map:for-each(Map, Function) => item()*
static class	MapFunctionSet.MapGet	Implementation of the XPath 3.1 function map:get(Map, key) => value
static class	MapFunctionSet.MapItems	Implementation of the proposed 4.0 function map:items(Map) => item()*
static class	MapFunctionSet.MapKeys	Implementation of the XPath 3.1 function map:keys(Map) => atomicValue*
static class	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.
static class	MapFunctionSet.MapPut	Implementation of the function map:put() => Map
static class	MapFunctionSet.MapRemove	Implementation of the XPath 3.1 function map:remove(Map, key) => value
static class	MapFunctionSet.MapSize	Implementation of the extension function map:size(map) => integer
static interface	MapFunctionSet.OnDuplicatesAction

Nested classes/interfaces inherited from class net.sf.saxon.functions.registry.BuiltInFunctionSet

BuiltInFunctionSet.Entry

Field Summary

Fields

Modifier and Type	Field	Description
static final RecordType	KVP_TYPE_EXTENSIBLE
static final RecordType	KVP_TYPE_INEXTENSIBLE

Fields inherited from class net.sf.saxon.functions.registry.BuiltInFunctionSet

ABS, AS_ARG0, AS_NUM_ARG0, BASE, CARD0, CDOC, CITEM, CTRL, DCOLL, DEPENDS_ON_STATIC_CONTEXT, DLANG, EMPTY, FILTER, FOCUS, INS, LAST, LATE, NAV, NEW, NS, ONE, OPT, PLUS, POSN, SEQV, SIDE, STAR, TRA, UO

Method Summary

Modifier and Type	Method	Description
String	getConventionalPrefix()	Return a conventional prefix for use with this namespace, typically the prefix used in the documentation of these functions.
static MapFunctionSet.OnDuplicatesAction	getDuplicatesCombiner(Map<String,GroundedValue> options, String defaultAction, String duplicatesErrorCode)
static MapFunctionSet	getInstance(int version)	Get the set of functions defined in the F&O spec in the "map" namespace
NamespaceUri	getNamespace()	Return the namespace URI for the functions local to this function set.

Methods inherited from class net.sf.saxon.functions.registry.BuiltInFunctionSet

bind, copy, field, getFunctionDetails, getFunctionItem, importFunctionSet, isAvailable, makeFunction, register, register, registerVariadic

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.saxon.functions.FunctionLibrary

setConfiguration

Field Details

KVP_TYPE_INEXTENSIBLE

public static final RecordType KVP_TYPE_INEXTENSIBLE

KVP_TYPE_EXTENSIBLE

public static final RecordType KVP_TYPE_EXTENSIBLE

Method Details

getInstance

public static MapFunctionSet getInstance(int version)

Get the set of functions defined in the F&O spec in the "map" namespace

Parameters:

version - the XPath version (eg 31, 40). Currently any version less than 40 is treated as 31, and any version greater than 40 is treated as 40.

Returns:

the function library

getDuplicatesCombiner

public static MapFunctionSet.OnDuplicatesAction getDuplicatesCombiner(Map<String,GroundedValue> options,
 String defaultAction,
 String duplicatesErrorCode)
                                                               throws XPathException

Throws:

XPathException

getNamespace

public NamespaceUri getNamespace()

Description copied from class: BuiltInFunctionSet

Return the namespace URI for the functions local to this function set.

Overrides:

getNamespace in class BuiltInFunctionSet

Returns:

the namespace URI of the functions local to this function set. Note that functions imported from another function set may have a different namespace URI.

getConventionalPrefix

public String getConventionalPrefix()

Description copied from class: BuiltInFunctionSet

Return a conventional prefix for use with this namespace, typically the prefix used in the documentation of these functions.

Overrides:

getConventionalPrefix in class BuiltInFunctionSet

Returns:

the string "fn"