Package com.saxonica.functions.extfn

Class Ending

java.lang.Object

net.sf.saxon.functions.AbstractFunction

net.sf.saxon.functions.SystemFunction

com.saxonica.functions.extfn.Ending

All Implemented Interfaces:

Callable, Function, GroundedValue, Item, Sequence

Direct Known Subclasses:

Ending.ItemsBefore, Ending.ItemsUntil

public abstract class Ending
extends SystemFunction

This class supports the two extension functions saxon:ending-where and saxon:ending-before. These functions take two arguments: the first is a sequence of items, the second is a function used as a predicate to determine the last item to be included in the result. The functions differ in whether the matching item is included in the result or not.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Ending.ItemsBefore
static class	Ending.ItemsUntil

Constructor Summary

Constructors

Constructor	Description
Ending()

Method Summary

Modifier and Type	Method	Description
Sequence	call(XPathContext context, Sequence[] arguments)	Evaluate this function call at run-time
protected abstract boolean	includeMatchingItem()

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

Ending

public Ending()

Method Detail

includeMatchingItem

protected abstract boolean includeMatchingItem()

call

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

Evaluate this function call at run-time

Parameters:

context - The XPath dynamic evaluation context

arguments - The values of the arguments to the function call.

Returns:

the results of the function, as a sequence of arrays

Throws:

XPathException - if a dynamic error occurs during evaluation of the function. The Saxon run-time code will add information about the error location.