org.exolab.adaptx.xpath

Class XPathFunction

public abstract class XPathFunction extends Object

Abstract class representing an XPath function.

Author: Keith Visco Assaf Arkin

Method Summary
abstract XPathResultcall(XPathContext context, XPathResult[] args)
Invokes the function and returns the XPath result.
XPathResultcall(XPathContext context, XPathResult[] args, FunctionState state)
Invokes the function and returns the XPath result.
abstract StringgetFunctionName()
Returns the name of this function.
abstract StringgetNamespaceURI()
Returns the namespace URI of this function.

Method Detail

call

public abstract XPathResult call(XPathContext context, XPathResult[] args)
Invokes the function and returns the XPath result.

Parameters: context The XPath context params A list of zero or more arguments

Returns: An XPath result (not null)

Throws: XPathException if an error occured while invoking this function

call

public XPathResult call(XPathContext context, XPathResult[] args, FunctionState state)
Invokes the function and returns the XPath result.

Parameters: context The XPath context params A list of zero or more arguments state the FunctionState for obtaining additional information about the Function call, such as the actual parameter expressions.

Returns: An XPath result (not null)

Throws: XPathException if an error occured while invoking this function

getFunctionName

public abstract String getFunctionName()
Returns the name of this function.

Returns: The name of this function

getNamespaceURI

public abstract String getNamespaceURI()
Returns the namespace URI of this function.

Returns: The namespace URI of this function