Package org.exolab.adaptx.xpath.functions

Class ExtensionFunctionCall

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.ExtensionFunctionCall

All Implemented Interfaces:

Parameters, XPathExpression

public class ExtensionFunctionCall
extends FunctionCallImpl

A class for representing an extension function call. An extension function call is one that is not part of the XPath 1.0 library.

Version:

$Revision: 3879 $

Author:

Keith Visco

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	FUNCTION_NOT_DEFINED

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

Constructors

Constructor	Description
ExtensionFunctionCall(java.lang.String name)	Creates a new ExtensionFunctionCall for the function with the given name

Method Summary

Modifier and Type	Method	Description
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 java.lang.Object

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

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

getExprType, getType

Field Detail

FUNCTION_NOT_DEFINED

public static final java.lang.String FUNCTION_NOT_DEFINED

See Also:

Constant Field Values

Constructor Detail

ExtensionFunctionCall

public ExtensionFunctionCall(java.lang.String name)

Creates a new ExtensionFunctionCall for the function with the given name

Parameters:

name - the name of the function to call when the execute method is invoked.

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.