net.sf.saxon.functions

Class Average

java.lang.Object

net.sf.saxon.om.AbstractItem

net.sf.saxon.functions.AbstractFunction

net.sf.saxon.functions.SystemFunction

net.sf.saxon.functions.FoldingFunction

net.sf.saxon.functions.Average

All Implemented Interfaces:

PullEvent, Callable, Function, GroundedValue, Item, Sequence

public class Average
extends FoldingFunction

Implementation of the fn:avg function

Constructor Summary

Constructors

Constructor and Description
Average()

Method Summary

Methods

Modifier and Type	Method and Description
int	getCardinality(Expression[] arguments) Determine the cardinality of the function.
Fold	getFold(XPathContext context, Sequence... additionalArguments) Create the Fold object which actually performs the evaluation.

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

call, getStreamingAdjunct

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

equals, export, exportAttributes, getArity, getContextNode, getDescription, getDetails, getErrorCodeForTypeErrors, getExpressionCompiler, getFunctionItemType, getFunctionName, getIntegerBounds, getOperandRoles, getRequiredType, getResultItemType, getResultItemType, getRetainedStaticContext, getSpecialProperties, getStaticBaseUriString, importAttributes, makeCall, makeFunction, makeFunctionCall, makeOptimizedFunctionCall, resultIfEmpty, setArity, setDetails, setRetainedStaticContext, supplyTypeInformation, typeCheckCaller

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

atomize, deepEquals, effectiveBooleanValue, getStringValue, getStringValueCS, isArray, isMap, optimize, simplify, typeCheck

Methods inherited from class net.sf.saxon.om.AbstractItem

getLength, head, itemAt, iterate, reduce, subsequence

Methods inherited from class java.lang.Object

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

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

iterate

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

head

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

getLength, head, itemAt, reduce, subsequence

Constructor Detail

Average

public Average()

Method Detail

getCardinality

public int getCardinality(Expression[] arguments)

Determine the cardinality of the function.

Overrides:

getCardinality in class SystemFunction

Parameters:

arguments - the actual arguments supplied

Returns:

the most precise available cardinality that the function will return

getFold

public Fold getFold(XPathContext context,
           Sequence... additionalArguments)
             throws XPathException

Create the Fold object which actually performs the evaluation.

Specified by:

getFold in class FoldingFunction

Parameters:

context - the dynamic evaluation context

additionalArguments - the values of all arguments other than the first.

Returns:

the Fold object used to compute the function

Throws:

XPathException - if a dynamic error occurs