org.exolab.adaptx.xpath.functions
Class ErrorFunctionCall

java.lang.Object
  extended by org.exolab.adaptx.xpath.expressions.PrimaryExpr
      extended by org.exolab.adaptx.xpath.expressions.FunctionCall
          extended by org.exolab.adaptx.xpath.functions.FunctionCallImpl
              extended by org.exolab.adaptx.xpath.functions.ErrorFunctionCall
All Implemented Interfaces:
Parameters, XPathExpression

public class ErrorFunctionCall
extends FunctionCallImpl

A function to allow invalid expr's to go unnoticed until called. Since Adaptx parses the expressions up front this FunctionCall is useful in saving error messages for a later invocation!

Version:
$Revision: 3736 $ $Date: 2003-05-13 03:57:04 -0400 (Tue, 13 May 2003) $
Author:
Keith Visco

Field Summary
static java.lang.String ERROR_FN
           
 
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
ErrorFunctionCall()
          Creates a new ErrorFunctionCall
 
Method Summary
 XPathResult evaluate(XPathContext context)
          Evaluates the expression and returns the XPath result.
 void setError(java.lang.String error)
           
 
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
 

Field Detail

ERROR_FN

public static final java.lang.String ERROR_FN
See Also:
Constant Field Values
Constructor Detail

ErrorFunctionCall

public ErrorFunctionCall()
Creates a new ErrorFunctionCall

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.

setError

public void setError(java.lang.String error)