XQQueryException (JSR 225: XQuery API for Java (XQJ))

Overview

Package

Class

Tree

Deprecated

Index

Help

XQJ v1.0, Jan 14, 2008

PREV CLASS NEXT CLASS

FRAMES NO FRAMES All Classes

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.xml.xquery
Class XQQueryException

java.lang.Object
 extended by java.lang.Throwable
 extended by java.lang.Exception
 extended by javax.xml.xquery.XQException
 extended by javax.xml.xquery.XQQueryException

All Implemented Interfaces:: java.io.Serializable

Direct Known Subclasses:: XQCancelledException

public class XQQueryException
extends XQException
extends XQException

An exception that provides information on errors occurring during the evaluation of an xquery.

Each XQQueryException provides several kinds of optional information, in addition to the properties inherited from XQException:

an error code. This QName identifies the error according to the standard as described in Appendix F, XQuery 1.0: An XML Query language, Appendix C, XQuery 1.0 and XPath 2.0 Functions and Operators, and and its associated specifications; implementation-defined errors may be raised.
a position. This identifies the character position of the failing expression in the query text. This is a 0 based position. -1 if unknown.
the line number in the query string where the error occured. Line numbering starts at 1. -1 if unknown
the column number in the query string where the error occured. Column numbering starts at 1. -1 if unknown
the module uri. This identifies the module in which the error occurred, null when the error is located in the main module.
the XQuery error object of this exception. This is the $error-object argument specified through the fn:error() function. May be null if not specified.
the XQuery stack trace. This provides additional dynamic information where the exception occurred in the XQuery expression.

See Also:: Serialized Form

Constructor Summary
`XQQueryException(java.lang.String message)` Constructs an `XQQueryException` object with a given message.
`XQQueryException(java.lang.String message, javax.xml.namespace.QName errorCode)` Constructs an `XQQueryException` object with a given message, and error code.
`XQQueryException(java.lang.String message, javax.xml.namespace.QName errorCode, int line, int column, int position)` Constructs an `XQQueryException` object with a given message, error code, line number, column number, and position.
`XQQueryException(java.lang.String message, java.lang.String vendorCode, javax.xml.namespace.QName errorCode, int line, int column, int position)` Constructs an `XQQueryException` object with a given message, vendor code, error code, line number, column number, and position.
`XQQueryException(java.lang.String message, java.lang.String vendorCode, javax.xml.namespace.QName errorCode, int line, int column, int position, java.lang.String moduleURI, XQSequence errorObject, XQStackTraceElement[] stackTrace)` Constructs an `XQQueryException` object with a given message, vendor code, error code, line number, column number, position, module URI, error object, and stack trace.

Method Summary
`int`	`getColumnNumber()` Gets the column number in the query string where the error occurred.
`javax.xml.namespace.QName`	`getErrorCode()` Gets the code identifying the error according to the standard as described in Appendix F, XQuery 1.0: An XML Query language, Appendix C, XQuery 1.0 and XPath 2.0 Functions and Operators, and its associated specifications; imlementation-defined errors may also be raised; finally the error code may also be specified in the query using `fn:error()`.
`XQSequence`	`getErrorObject()` Gets an `XQSequence` representing the error object passed to `fn:error()`.
`int`	`getLineNumber()` Gets the line number in the query string where the error occurred.
`java.lang.String`	`getModuleURI()` Gets the module URI of the module in which the error occurred.
`int`	`getPosition()` Gets the character position in the query string where this exception occurred.
`XQStackTraceElement[]`	`getQueryStackTrace()` Returns the query stack stackTrace when the exception occurred, or null if none.

Methods inherited from class javax.xml.xquery.XQException
`getNextException, getVendorCode, setNextException`

Methods inherited from class java.lang.Throwable
`fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

XQQueryException

public XQQueryException(java.lang.String message)

Constructs an XQQueryException object with a given message.

Parameters:: message - the description of the error. null indicates that the message string is non existant

XQQueryException

public XQQueryException(java.lang.String message,
 javax.xml.namespace.QName errorCode)

Constructs an XQQueryException object with a given message, and error code.

Parameters:: message - the description of the error. null indicates that the message string is non existant; errorCode - QName which identifies the error according to the standard as described in Appendix F, XQuery 1.0: An XML Query language, Appendix C, XQuery 1.0 and XPath 2.0 Functions and Operators, and its associated specifications; implementation-defined errors may be raised.

XQQueryException

public XQQueryException(java.lang.String message,
 javax.xml.namespace.QName errorCode,
 int line,
 int column,
 int position)

Constructs an XQQueryException object with a given message, error code, line number, column number, and position.

Parameters:: message - the description of the error. null indicates that the message string is non existant; errorCode - QName which identifies the error according to the standard as described in Appendix F, XQuery 1.0: An XML Query language, Appendix C, XQuery 1.0 and XPath 2.0 Functions and Operators, and its associated specifications; implementation-defined errors may be raised; line - the line number in the query string where the error occured. Line numbering starts at 1. -1 if unknown; column - the column number in the query string where the error occured. Column numbering starts at 1. -1 if unknown; position - the position in the query string where the error occured. This is a 0 based position. -1 if unknown

XQQueryException

public XQQueryException(java.lang.String message,
 java.lang.String vendorCode,
 javax.xml.namespace.QName errorCode,
 int line,
 int column,
 int position)

Constructs an XQQueryException object with a given message, vendor code, error code, line number, column number, and position.

Parameters:: message - the description of the error. null indicates that the message string is non existant; vendorCode - a vendor-specific string identifying the error. null indicates there is no vendor code or it is unknown; errorCode - QName which identifies the error according to the standard as described in Appendix F, XQuery 1.0: An XML Query language, Appendix C, XQuery 1.0 and XPath 2.0 Functions and Operators, and its associated specifications; implementation-defined errors may be raised; line - the line number in the query string where the error occured. Line numbering starts at 1. -1 if unknown; column - the column number in the query string where the error occured. Column numbering starts at 1. -1 if unknown; position - the position in the query string where the error occured. This is a 0 based position. -1 if unknown

XQQueryException

public XQQueryException(java.lang.String message,
 java.lang.String vendorCode,
 javax.xml.namespace.QName errorCode,
 int line,
 int column,
 int position,
 java.lang.String moduleURI,
 XQSequence errorObject,
 XQStackTraceElement[] stackTrace)

Constructs an XQQueryException object with a given message, vendor code, error code, line number, column number, position, module URI, error object, and stack trace.

Parameters:: message - the description of the error. null indicates that the message string is non existant; vendorCode - a vendor-specific string identifying the error. null indicates there is no vendor code or it is unknown; errorCode - QName which identifies the error according to the standard as described in Appendix F, XQuery 1.0: An XML Query language, Appendix C, XQuery 1.0 and XPath 2.0 Functions and Operators, and its associated specifications; implementation-defined errors may be raised; line - the line number in the query string where the error occured. Line numbering starts at 1. -1 if unknown; column - the column number in the query string where the error occured. Column numbering starts at 1. -1 if unknown; position - the position in the query string where the error occured. This is a 0 based position. -1 if unknown; moduleURI - the module URI of the module in which the error occurred. null when it is the main module or when the module is unknown; errorObject - an XQSequence representing the error object passed to fn:error(). null if this error was not triggered by fn:error() or when the error object is not available.; stackTrace - the XQuery stack trace where the error occurred. null if not available

Method Detail

getErrorCode

public javax.xml.namespace.QName getErrorCode()

Gets the code identifying the error according to the standard as described in Appendix F, XQuery 1.0: An XML Query language, Appendix C, XQuery 1.0 and XPath 2.0 Functions and Operators, and its associated specifications; imlementation-defined errors may also be raised; finally the error code may also be specified in the query using fn:error().

Returns:: the code identifying the error, or null if not available

getErrorObject

public XQSequence getErrorObject()

Gets an XQSequence representing the error object passed to fn:error(). Returns null if this error was not triggered by fn:error() or when the error object is not available.

Returns:: the sequence passed to fn:error(), null if not available

getPosition

public int getPosition()

Gets the character position in the query string where this exception occurred.

This is a 0 based position. -1 if unknown.

Returns:: the character position in the query string where the exception occurred

getQueryStackTrace

public XQStackTraceElement[] getQueryStackTrace()

Returns the query stack stackTrace when the exception occurred, or null if none. On some implementations only the top frame may be visible.

Returns:: the stackTrace where the exception occurred

getModuleURI

public java.lang.String getModuleURI()

Gets the module URI of the module in which the error occurred. null when it is the main module or when the module is unknown.

Returns:: the module URI or null

getLineNumber

public int getLineNumber()

Gets the line number in the query string where the error occurred.

Line numbering starts at 1. -1 is returned if the line number is unknown. If the implementation does not support this method, it must return -1

Returns:: the line number in the query string where the error occurred

getColumnNumber

public int getColumnNumber()

Gets the column number in the query string where the error occurred.

Column numbering starts at 1. -1 is returned if the column number is unknown. If the implementation does not support this method, it must return -1