Package net.sf.saxon.ma.arrays
Class ArrayFunctionSet
java.lang.Object
net.sf.saxon.functions.registry.BuiltInFunctionSet
net.sf.saxon.ma.arrays.ArrayFunctionSet
- All Implemented Interfaces:
FunctionLibrary
Function signatures (and pointers to implementations) of the functions defined in XPath 3.1
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Implementation of the function array:append(array, item()*) => arraystatic class
Implementation of the proposed XP40 function array:build()static class
Implementation of the proposed 4.0 function array:empty(array)static class
Implementation of the proposed 4.0 function array:exists(array)static class
Implementation of the function array:filter(array, function) => arraystatic class
Implementation of the function array:flatten => item()*static class
Implementation of the function array:fold-left(array, item()*, function) => arraystatic class
Implementation of the function array:fold-left(array, item()*, function) => arraystatic class
Implementation of the proposed 4.0 function array:foot(array) => item()*static class
Implementation of the function array:for-each(array, function) => arraystatic class
Implementation of the function array:for-each-pair(array, array, function) => arraystatic class
Implementation of the function array:_from-sequence(item()*) => array(*) which is used internally for the implementation of array{} and of the saxon:array extensionstatic class
Abstract superclass for functions that produce an array, and that decide what kind of array implementation to use based on past experience.static class
Implementation of the function array:get(array, xs:integer) => item()*static class
Implementation of the function array:head(array) => item()*static class
Implementation of the function array:for-each-pair(array, array, function) => arraystatic class
Implementation of the function array:insert-before(array, xs:integer, item()*) => arraystatic class
Implementation of the function array:join(arrays) => arraystatic class
Implementation of the proposed XP40 function array:members(array(*)) => record(value)*static class
Implementation of the proposed XP40 function array:of(parcel*) => arraystatic class
Implementation of the function array:put(arrays, index, newValue) => arraystatic class
Implementation of the function array:remove(array, xs:integer) => arraystatic class
Implementation of the function array:replace(array, position, action) => arraystatic class
Implementation of the function array:reverse(array, xs:integer, xs:integer) => arraystatic class
Implementation of the function array:size(array) => integerstatic class
Implementation of the function array:slice(array, start, end, step) => arraystatic class
Implementation of the function array:slice(array, start, end, step) => arraystatic class
Implementation of the function array:subarray(array, xs:integer, xs:integer) => arraystatic class
Implementation of the function array:tail(array) => item()*static class
Implementation of the function array:_to-sequence(array) => item()* which is used internally for the implementation of array?*static class
Implementation of the function array:trunk(array) => item()*Nested classes/interfaces inherited from class net.sf.saxon.functions.registry.BuiltInFunctionSet
BuiltInFunctionSet.Entry
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic int
checkSubscript
(IntegerValue subscript, int limit) Check that a number proposed for use as a subscript is greater than zero and less than the maximum subscript allowed by the implementation (2^31-1), returning the value as a Java intReturn a conventional prefix for use with this namespace, typically the prefix used in the documentation of these functions.static ArrayFunctionSet
getInstance
(int version) 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
-
Method Details
-
getInstance
-
getNamespace
Description copied from class:BuiltInFunctionSet
Return the namespace URI for the functions local to this function set.- Overrides:
getNamespace
in classBuiltInFunctionSet
- 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
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 classBuiltInFunctionSet
- Returns:
- the string "fn"
-
checkSubscript
Check that a number proposed for use as a subscript is greater than zero and less than the maximum subscript allowed by the implementation (2^31-1), returning the value as a Java int- Parameters:
subscript
- the proposed subscript (one-based)limit
- the upper limit allowed (usually the size of the array, sometimes arraysize + 1)- Returns:
- the proposed subscript as an int, if it is in range (still one-based)
- Throws:
XPathException
- if the subscript is 0, negative, or outside the permitted range
-