Package net.sf.saxon.ma.arrays

Class ArraySort

java.lang.Object

net.sf.saxon.functions.AbstractFunction

net.sf.saxon.functions.SystemFunction

net.sf.saxon.ma.arrays.ArrayFunctionSet.ArrayGeneratingFunction

net.sf.saxon.ma.arrays.ArraySort

All Implemented Interfaces:

Callable, Pingable, FunctionItem, GroundedValue, Item, Sequence

public class ArraySort
extends ArrayFunctionSet.ArrayGeneratingFunction

Implementation of the extension function array:sort(array, function) => array

Constructor Summary

Constructors

Constructor	Description
ArraySort()

Method Summary

Modifier and Type	Method	Description
ArrayItem	call(XPathContext context, Sequence[] arguments)	Create a call on this function.
static int	compareSortKeys(GroundedValue a, GroundedValue b, AtomicComparer comparer)

Methods inherited from class net.sf.saxon.ma.arrays.ArrayFunctionSet.ArrayGeneratingFunction

expectedSize, makeArray, ping

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

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

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

atomize, deepEqual40, deepEquals, effectiveBooleanValue, getAnnotations, getUnicodeStringValue, isArray, isMap, makeNewContext, simplify, typeCheck

Methods inherited from class java.lang.Object

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

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

getGenre

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

asIterable, concatenate, containsNode, materialize

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

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

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

makeRepeatable

Constructor Detail

ArraySort

public ArraySort()

Method Detail

call

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

Create a call on this function. This method is called by the compiler when it identifies a function call that calls this function.

Parameters:

context - the dynamic evaluation context

arguments - the values of the arguments, supplied as Sequences.

Generally it is advisable, if calling iterate() to process a supplied sequence, to call it only once; if the value is required more than once, it should first be converted to a GroundedValue by calling the utility method SequenceTool.toGroundedValue().

If the expected value is a single item, the item should be obtained by calling Sequence.head(): it cannot be assumed that the item will be passed as an instance of Item or AtomicValue.

It is the caller's responsibility to perform any type conversions required to convert arguments to the type expected by the callee. An exception is where this Callable is explicitly an argument-converting wrapper around the original Callable.

Returns:

an expression representing a call of this extension function

Throws:

XPathException - if a dynamic error occurs during the evaluation of the expression

compareSortKeys

public static int compareSortKeys(GroundedValue a,
                                  GroundedValue b,
                                  AtomicComparer comparer)