Package net.sf.saxon.functions
Class FormatNumber
- java.lang.Object
-
- net.sf.saxon.expr.Expression
-
- net.sf.saxon.expr.FunctionCall
-
- net.sf.saxon.functions.SystemFunction
-
- net.sf.saxon.functions.FormatNumber
-
- All Implemented Interfaces:
java.io.Serializable,javax.xml.transform.SourceLocator,LocationProvider,SaxonLocator,CallableExpression,InstructionInfo,org.xml.sax.Locator
public class FormatNumber extends SystemFunction implements CallableExpression
XSLT 2.0 implementation of format-number() function - removes the dependence on the JDK.- 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.Expression
EFFECTIVE_BOOLEAN_VALUE, EVALUATE_METHOD, EVENT_FEED_METHOD, ITEM_FEED_METHOD, ITERATE_METHOD, locationId, MAX_SEQUENCE_LENGTH, MAX_STRING_LENGTH, PROCESS_METHOD, PUSH_SELECTION, staticProperties, UNBOUNDED_LOWER, UNBOUNDED_UPPER, WATCH_METHOD
-
-
Constructor Summary
Constructors Constructor Description FormatNumber()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static java.math.BigDecimaladjustToDecimal(double value, int precision)Convert a double to a BigDecimal.SequenceIteratorcall(SequenceIterator[] arguments, XPathContext context)Evaluate the expressionvoidcheckArguments(ExpressionVisitor visitor)Method called during static type checkingExpressioncopy()Copy an expression.booleanequals(java.lang.Object o)Determine whether two expressions are equivalentjava.lang.CharSequenceevaluateAsString(XPathContext context)Evaluate in a context where a string is wantedItemevaluateItem(XPathContext c)Evaluate in a general contextExpressionpreEvaluate(ExpressionVisitor visitor)preEvaluate: this method suppresses compile-time evaluation by doing nothing.voidsetNamespaceResolver(SavedNamespaceContext savedNamespaceContext)-
Methods inherited from class net.sf.saxon.functions.SystemFunction
addContextDocumentArgument, addDocToPathMap, computeCardinality, computeSpecialProperties, getDetails, getErrorCodeForTypeErrors, getImplementationMethod, getItemType, getOperation, getRequiredType, makeSystemFunction, optimize, setDetails, useContextItemAsDefault
-
Methods inherited from class net.sf.saxon.expr.FunctionCall
addExternalFunctionCallToPathMap, checkArgumentCount, explain, getArguments, getDisplayName, getExpressionName, getFunctionName, getNumberOfArguments, hashCode, iterateSubExpressions, promote, replaceSubExpression, setArguments, setFunctionName, simplify, simplifyArguments, toString, typeCheck
-
Methods inherited from class net.sf.saxon.expr.Expression
addToPathMap, adoptChildExpression, checkForUpdatingSubexpressions, checkPermittedContents, computeDependencies, computeStaticProperties, doPromotion, dynamicError, effectiveBooleanValue, evaluatePendingUpdates, explain, getCardinality, getColumnNumber, getColumnNumber, getConstructType, getContainer, getDependencies, getEvaluationMethod, getExecutable, getHostLanguage, getIntegerBounds, getIntrinsicDependencies, getLineNumber, getLineNumber, getLocationId, getLocationProvider, getObjectName, getProperties, getProperty, getPublicId, getSlotsUsed, getSpecialProperties, getSystemId, getSystemId, hasLoopingSubexpression, hasVariableBinding, implementsStaticTypeCheck, isSubtreeExpression, isUpdatingExpression, isVacuousExpression, iterate, iterateEvents, iterateSameFocusSubExpressions, markTailFunctionCalls, process, resetLocalStaticProperties, setContainer, setEvaluationMethod, setFiltered, setFlattened, setLocationId, staticTypeCheck, suppressValidation, typeError
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface net.sf.saxon.expr.CallableExpression
getArguments
-
-
-
-
Method Detail
-
setNamespaceResolver
public void setNamespaceResolver(SavedNamespaceContext savedNamespaceContext)
-
checkArguments
public void checkArguments(ExpressionVisitor visitor) throws XPathException
Description copied from class:SystemFunctionMethod called during static type checking- Overrides:
checkArgumentsin classSystemFunction- Parameters:
visitor- the expression visitor- Throws:
XPathException- if the arguments are incorrect
-
preEvaluate
public Expression preEvaluate(ExpressionVisitor visitor) throws XPathException
preEvaluate: this method suppresses compile-time evaluation by doing nothing. We can't evaluate early because we don't have access to the DecimalFormatManager.- Overrides:
preEvaluatein classFunctionCall- Parameters:
visitor- the expression visitor- Returns:
- the result of the early evaluation, or the original expression, or potentially a simplified expression
- Throws:
XPathException- if evaluation fails
-
copy
public Expression copy()
Copy an expression. This makes a deep copy.- Overrides:
copyin classSystemFunction- Returns:
- the copy of the original expression
-
equals
public boolean equals(java.lang.Object o)
Determine whether two expressions are equivalent- Overrides:
equalsin classSystemFunction
-
evaluateAsString
public java.lang.CharSequence evaluateAsString(XPathContext context) throws XPathException
Evaluate in a context where a string is wanted- Overrides:
evaluateAsStringin classExpression- Parameters:
context- The context in which the expression is to be evaluated- Returns:
- the value of the expression, evaluated in the current context. The expression must return a string or (); if the value of the expression is (), this method returns "".
- Throws:
XPathException- if any dynamic error occurs evaluating the expression
-
evaluateItem
public Item evaluateItem(XPathContext c) throws XPathException
Evaluate in a general context- Overrides:
evaluateItemin classExpression- Parameters:
c- 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
-
adjustToDecimal
public static java.math.BigDecimal adjustToDecimal(double value, int precision)Convert a double to a BigDecimal. In general there will be several BigDecimal values that are equal to the supplied value, and the one we want to choose is the one with fewest non-zero digits. The algorithm used is rather pragmatic: look for a string of zeroes or nines, try rounding the number down or up as approriate, then convert the adjusted value to a double to see if it's equal to the original: if not, use the original value unchanged.- Parameters:
value- the double to be convertedprecision- 2 for a double, 1 for a float- Returns:
- the result of conversion to a double
-
call
public SequenceIterator call(SequenceIterator[] arguments, XPathContext context) throws XPathException
Description copied from interface:CallableExpressionEvaluate the expression- Specified by:
callin interfaceCallableExpression- Parameters:
arguments- the values of the arguments, supplied as SequenceIteratorscontext- the dynamic evaluation context- Returns:
- the result of the evaluation, in the form of a SequenceIterator
- Throws:
XPathException- if a dynamic error occurs during the evaluation of the expression
-
-