org.ucl.xpath.function
Class FnError

java.lang.Object
  extended byorg.ucl.xpath.function.Function
      extended byorg.ucl.xpath.function.FnError

public class FnError
extends Function

The fn:error function causes the evaluation of the outermost XQuery or transformation to stop. While this function never returns a value, an error, if it occurs, is returned to the external processing environment as an xs:anyURI or an xs:QName. The error xs:anyURI is derived from the error xs:QName. An error xs:QName with namespace URI NS and local part LP will be returned as the xs:anyURI NS#LP. The method by which the xs:anyURI or xs:QName is returned to the external processing environment is implementation dependent.


Field Summary
 
Fields inherited from class org.ucl.xpath.function.Function
_arity, _fl, _name
 
Constructor Summary
FnError()
          Constructor for FnError.
 
Method Summary
static ResultSequence error(java.util.Collection args)
          Error operation.
 ResultSequence evaluate(java.util.Collection args)
          Evaluate arguments.
 
Methods inherited from class org.ucl.xpath.function.Function
arity, convert_argument, convert_arguments, dynamic_context, name, set_function_library, signature, signature, signature, static_context
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FnError

public FnError()
Constructor for FnError.

Method Detail

evaluate

public ResultSequence evaluate(java.util.Collection args)
                        throws DynamicError
Evaluate arguments.

Specified by:
evaluate in class Function
Parameters:
args - argument expressions.
Returns:
Result of evaluation.
Throws:
DynamicError - Dynamic error.

error

public static ResultSequence error(java.util.Collection args)
                            throws DynamicError
Error operation.

Parameters:
args - Result from the expressions evaluation.
Returns:
Result of fn:error operation.
Throws:
DynamicError - Dynamic error.