net.sf.saxon.functions

Class NumberFn

java.lang.Object

net.sf.saxon.expr.ComputedExpression

net.sf.saxon.expr.FunctionCall

net.sf.saxon.functions.SystemFunction

net.sf.saxon.functions.NumberFn

All Implemented Interfaces:

java.io.Serializable, javax.xml.transform.SourceLocator, Container, Expression, ItemMappingFunction, InstructionInfoProvider

public class NumberFn
extends SystemFunction
implements ItemMappingFunction

Implements the XPath number() function. This can also be used as a mapping function in a MappingIterator to map a sequence of values to numbers.

See Also:

Serialized Form

Field Summary

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

operation

Fields inherited from class net.sf.saxon.expr.FunctionCall

argument

Fields inherited from class net.sf.saxon.expr.ComputedExpression

locationId, staticProperties

Fields inherited from interface net.sf.saxon.expr.Expression

EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD

Constructor Summary

Constructors

Constructor and Description
NumberFn()

Method Summary

Modifier and Type	Method and Description
static DoubleValue	convert(AtomicValue value) Static method to perform the same conversion as the number() function.
Item	evaluateItem(XPathContext context) Evaluate in a general context
Item	map(Item item) Mapping function for use when converting a sequence of atomic values to doubles using the rules of the number() function
Expression	simplify(StaticContext env) Simplify and validate.

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

addContextDocumentArgument, checkArguments, computeCardinality, computeSpecialProperties, display, getDetails, getErrorCodeForTypeErrors, getItemType, getRequiredType, main, makeSystemFunction, setDetails, useContextItemAsDefault

Methods inherited from class net.sf.saxon.expr.FunctionCall

checkArgumentCount, getArguments, getDisplayName, getFunctionNameCode, getNumberOfArguments, iterateSubExpressions, optimize, preEvaluate, promote, replaceSubExpression, setArguments, setFunctionNameCode, simplifyArguments, typeCheck

Methods inherited from class net.sf.saxon.expr.ComputedExpression

adoptChildExpression, checkPermittedContents, computeDependencies, computeStaticProperties, doPromotion, dynamicError, effectiveBooleanValue, evaluateAsString, getCardinality, getColumnNumber, getConstructType, getDependencies, getExecutable, getHostLanguage, getImplementationMethod, getInstructionInfo, getIntrinsicDependencies, getLineNumber, getLocationId, getLocationProvider, getParentExpression, getPublicId, getSlotsUsed, getSpecialProperties, getSystemId, hasBadParentPointer, iterate, markTailFunctionCalls, process, resetStaticProperties, setLocationId, setParentExpression, setParentExpression, suppressValidation, typeError

Methods inherited from class java.lang.Object

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

Constructor Detail

NumberFn

public NumberFn()

Method Detail

simplify

public Expression simplify(StaticContext env)
                    throws XPathException

Simplify and validate. This is a pure function so it can be simplified in advance if the arguments are known

Specified by:

simplify in interface Expression

Overrides:

simplify in class FunctionCall

Parameters:

env - the static context

Returns:

the simplified expression

Throws:

XPathException - if an error is discovered during expression rewriting

evaluateItem

public Item evaluateItem(XPathContext context)
                  throws XPathException

Evaluate in a general context

Specified by:

evaluateItem in interface Expression

Overrides:

evaluateItem in class ComputedExpression

Parameters:

context - The context in which the expression is to be evaluated

Returns:

the node or atomic value that results from evaluating the expression; or null to indicate that the result is an empty sequence

Throws:

XPathException - if any dynamic error occurs evaluating the expression

convert

public static DoubleValue convert(AtomicValue value)

Static method to perform the same conversion as the number() function. This is different from the convert(Type.DOUBLE) in that it produces NaN rather than an error for non-numeric operands.

map

public Item map(Item item)
         throws XPathException

Mapping function for use when converting a sequence of atomic values to doubles using the rules of the number() function

Specified by:

map in interface ItemMappingFunction

Parameters:

item - The input item to be mapped.

Returns:

either the output item, or null.

Throws:

XPathException