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
public class ArrayFunctionSet extends BuiltInFunctionSet
Function signatures (and pointers to implementations) of the functions defined in XPath 2.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classArrayFunctionSet.ArrayAppendImplementation of the function array:append(array, item()*) => arraystatic classArrayFunctionSet.ArrayFilterImplementation of the function array:filter(array, function) => arraystatic classArrayFunctionSet.ArrayFlattenImplementation of the function array:flatten => item()*static classArrayFunctionSet.ArrayFoldLeftImplementation of the function array:fold-left(array, item()*, function) => arraystatic classArrayFunctionSet.ArrayFoldRightImplementation of the function array:fold-left(array, item()*, function) => arraystatic classArrayFunctionSet.ArrayForEachImplementation of the function array:for-each(array, function) => arraystatic classArrayFunctionSet.ArrayForEachPairImplementation of the function array:for-each-pair(array, array, function) => arraystatic classArrayFunctionSet.ArrayFromSequenceImplementation of the function array:_from-sequence(item()*) => array(*) which is used internally for the implementation of array{} and of the saxon:array extensionstatic classArrayFunctionSet.ArrayGetImplementation of the function array:get(array, xs:integer) => item()*static classArrayFunctionSet.ArrayHeadImplementation of the function array:head(array) => item()*static classArrayFunctionSet.ArrayInsertBeforeImplementation of the function array:insert-before(array, xs:integer, item()*) => arraystatic classArrayFunctionSet.ArrayJoinImplementation of the function array:join(arrays) => arraystatic classArrayFunctionSet.ArrayPutImplementation of the function array:put(arrays, index, newValue) => arraystatic classArrayFunctionSet.ArrayRemoveImplementation of the function array:remove(array, xs:integer) => arraystatic classArrayFunctionSet.ArrayReverseImplementation of the function array:reverse(array, xs:integer, xs:integer) => arraystatic classArrayFunctionSet.ArraySizeImplementation of the function array:size(array) => integerstatic classArrayFunctionSet.ArraySubarrayImplementation of the function array:subarray(array, xs:integer, xs:integer) => arraystatic classArrayFunctionSet.ArrayTailImplementation of the function array:tail(array) => item()*static classArrayFunctionSet.ArrayToSequenceImplementation of the function array:_to-sequence(array) => item()* which is used internally for the implementation of array?*-
Nested classes/interfaces inherited from class net.sf.saxon.functions.registry.BuiltInFunctionSet
BuiltInFunctionSet.Entry
-
-
Field Summary
Fields Modifier and Type Field Description static ArrayFunctionSetTHE_INSTANCE
-
Constructor Summary
Constructors Constructor Description ArrayFunctionSet()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static intcheckSubscript(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 intjava.lang.StringgetConventionalPrefix()Return a conventional prefix for use with this namespace, typically the prefix used in the documentation of these functions.static ArrayFunctionSetgetInstance()java.lang.StringgetNamespace()Return the namespace URI for the functions local to this function set.-
Methods inherited from class net.sf.saxon.functions.registry.BuiltInFunctionSet
bind, copy, getFunctionDetails, getFunctionItem, importFunctionSet, isAvailable, makeFunction, register, registerReducedArityVariants
-
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 Detail
-
THE_INSTANCE
public static ArrayFunctionSet THE_INSTANCE
-
-
Method Detail
-
getInstance
public static ArrayFunctionSet getInstance()
-
getNamespace
public java.lang.String getNamespace()
Description copied from class:BuiltInFunctionSetReturn the namespace URI for the functions local to this function set.- Overrides:
getNamespacein 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
public java.lang.String getConventionalPrefix()
Description copied from class:BuiltInFunctionSetReturn a conventional prefix for use with this namespace, typically the prefix used in the documentation of these functions.- Overrides:
getConventionalPrefixin classBuiltInFunctionSet
-
checkSubscript
public static int checkSubscript(IntegerValue subscript, int limit) throws XPathException
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
-
-