javax.xml.xquery

Class XQQueryException

public class XQQueryException 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:
Constructor Summary
XQQueryException(String message)
Constructs an XQQueryException object with a given message.
XQQueryException(String message, QName errorCode)
Constructs an XQQueryException object with a given message, and error code.
XQQueryException(String message, 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(String message, String vendorCode, 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(String message, String vendorCode, QName errorCode, int line, int column, int position, 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
intgetColumnNumber()
Gets the column number in the query string where the error occurred.
QNamegetErrorCode()
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().
XQSequencegetErrorObject()
Gets an XQSequence representing the error object passed to fn:error().
intgetLineNumber()
Gets the line number in the query string where the error occurred.
StringgetModuleURI()
Gets the module URI of the module in which the error occurred.
intgetPosition()
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.

Constructor Detail

XQQueryException

public XQQueryException(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(String message, 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(String message, 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(String message, String vendorCode, 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(String message, String vendorCode, QName errorCode, int line, int column, int position, 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

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

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

getErrorCode

public 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

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

getModuleURI

public 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

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