org.exolab.adaptx.xpath.functions
Class FormatNumber

java.lang.Object
  |
  +--org.exolab.adaptx.xpath.expressions.PrimaryExpr
        |
        +--org.exolab.adaptx.xpath.expressions.FunctionCall
              |
              +--org.exolab.adaptx.xpath.functions.FunctionCallImpl
                    |
                    +--org.exolab.adaptx.xpath.functions.FormatNumber

All Implemented Interfaces:

XPathExpression

public class FormatNumber

extends FunctionCallImpl

A implementation of the "format-number()" function call.
method signature:
String format-number(number, string, string?)
The 3rd argument which is optional (string?) is currently not handled.

Version:

$Revision: 1.2 $

Author:

Keith Visco

Field Summary

Fields inherited from class org.exolab.adaptx.xpath.functions.FunctionCallImpl

INVALID_NUMBER_PARAMS, INVALID_RESULT

Fields inherited from class org.exolab.adaptx.xpath.expressions.PrimaryExpr

EXPR, FUNCTION_CALL, LITERAL, NUMBER, VARIABLE_REFERENCE

Fields inherited from interface org.exolab.adaptx.xpath.XPathExpression

BOOLEAN, ERROR, FILTER_EXPR, LOCATION_PATH, NODE_TEST, PATH_EXPR, PRIMARY, STEP, STRING, UNION_EXPR

Constructor Summary

FormatNumber()
Creates a new FormatNumber FunctionCall

Method Summary

XPathResult

evaluate(XPathContext context) Evaluates the expression and returns the XPath result.

Methods inherited from class org.exolab.adaptx.xpath.functions.FunctionCallImpl

addParameter, getFunctionName, getParameter, getParameterCount, toString

Methods inherited from class org.exolab.adaptx.xpath.expressions.PrimaryExpr

getExprType, getType

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FormatNumber

public FormatNumber()

Creates a new FormatNumber FunctionCall

Method Detail

evaluate

public XPathResult evaluate(XPathContext context)
                     throws XPathException

Evaluates the expression and returns the XPath result.

Parameters:

context - The XPathContext to use during evaluation.

Returns:

The XPathResult (not null).

Throws:

XPathException - if an error occured while evaluating this expression.