com.sleepycat.dbxml
Class XmlException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.sleepycat.db.DatabaseException
              com.sleepycat.dbxml.XmlException

All Implemented Interfaces:

Serializable

public class XmlException
extends DatabaseException

A represention of an error condition that has occurred within the Berkeley DB XML system. The system throws an XmlException if an API method call results in an error condition.

This object is not thread-safe, and can only be safely used by one thread at a time in an application.

See Also:

Serialized Form

Field Summary

static int	CONTAINER_CLOSED Container is closed and operation requires an open Container
static int	CONTAINER_EXISTS Container exists
static int	CONTAINER_NOT_FOUND Requested container could not be found
static int	CONTAINER_OPEN Container is open and operation requires a closed Container
static int	DATABASE_ERROR Unmapped error from the Berkeley DB database layer
static int	DOCUMENT_NOT_FOUND Named document not found
static int	EVENT_ERROR Error during XmlEventReader or XmlEventWriter processing
static int	INDEXER_PARSER_ERROR Error while parsing a document for indexing
static int	INTERNAL_ERROR Internal system error
static int	INVALID_VALUE An invalid parameter value was passed to an interface
static int	LAZY_EVALUATION Attempt to add an XmlValue object to a lazy result set
static int	NO_MEMORY_ERROR Out of memory error
static int	NULL_POINTER An attempt was made to access an uninitialized object
static int	OPERATION_INTERRUPTED Operation was interrupted by the application
static int	OPERATION_TIMEOUT Operation timed out
static int	QUERY_EVALUATION_ERROR Error evaluating an XQuery expression
static int	QUERY_PARSER_ERROR Error parsing an XQuery expression
static int	TRANSACTION_ERROR Invalid operation on XmlTransaction
static int	UNIQUE_ERROR Violation of uniqueness constraint on an index
static int	UNKNOWN_INDEX Requested index either not valid or not found
static int	VERSION_MISMATCH Library version and database version are not compatible

Constructor Summary

XmlException(int errcode, String description, DatabaseException dbex, int dberr)
Construct an XmlException.

Method Summary

DatabaseException	getDatabaseException() Retrieves the Berkeley DB exception object for an XmlException with error code DATABASE_ERROR.
int	getErrorCode() Returns the exception code: one of the XmlException class constants.
int	getQueryColumn() Returns the column within the line of the XQuery expression that contains the error causing the exception, in the case of QUERY_PARSER_ERROR.
int	getQueryLine() Returns the line of the XQuery expression that contains the error causing the exception, in the case of QUERY_PARSER_ERROR.

Methods inherited from class com.sleepycat.db.DatabaseException

getEnvironment, getErrno, toString

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CONTAINER_CLOSED

public static final int CONTAINER_CLOSED

Container is closed and operation requires an open Container

See Also:

Constant Field Values

CONTAINER_EXISTS

public static final int CONTAINER_EXISTS

Container exists

See Also:

Constant Field Values

CONTAINER_OPEN

public static final int CONTAINER_OPEN

Container is open and operation requires a closed Container

See Also:

Constant Field Values

DATABASE_ERROR

public static final int DATABASE_ERROR

Unmapped error from the Berkeley DB database layer

See Also:

Constant Field Values

DOCUMENT_NOT_FOUND

public static final int DOCUMENT_NOT_FOUND

Named document not found

See Also:

Constant Field Values

INDEXER_PARSER_ERROR

public static final int INDEXER_PARSER_ERROR

Error while parsing a document for indexing

See Also:

Constant Field Values

INTERNAL_ERROR

public static final int INTERNAL_ERROR

Internal system error

See Also:

Constant Field Values

INVALID_VALUE

public static final int INVALID_VALUE

An invalid parameter value was passed to an interface

See Also:

Constant Field Values

NULL_POINTER

public static final int NULL_POINTER

An attempt was made to access an uninitialized object

See Also:

Constant Field Values

VERSION_MISMATCH

public static final int VERSION_MISMATCH

Library version and database version are not compatible

See Also:

Constant Field Values

LAZY_EVALUATION

public static final int LAZY_EVALUATION

Attempt to add an XmlValue object to a lazy result set

See Also:

Constant Field Values

UNKNOWN_INDEX

public static final int UNKNOWN_INDEX

Requested index either not valid or not found

See Also:

Constant Field Values

QUERY_EVALUATION_ERROR

public static final int QUERY_EVALUATION_ERROR

Error evaluating an XQuery expression

See Also:

Constant Field Values

QUERY_PARSER_ERROR

public static final int QUERY_PARSER_ERROR

Error parsing an XQuery expression

See Also:

Constant Field Values

EVENT_ERROR

public static final int EVENT_ERROR

Error during XmlEventReader or XmlEventWriter processing

See Also:

Constant Field Values

CONTAINER_NOT_FOUND

public static final int CONTAINER_NOT_FOUND

Requested container could not be found

See Also:

Constant Field Values

TRANSACTION_ERROR

public static final int TRANSACTION_ERROR

Invalid operation on XmlTransaction

See Also:

Constant Field Values

UNIQUE_ERROR

public static final int UNIQUE_ERROR

Violation of uniqueness constraint on an index

See Also:

Constant Field Values

NO_MEMORY_ERROR

public static final int NO_MEMORY_ERROR

Out of memory error

See Also:

Constant Field Values

OPERATION_TIMEOUT

public static final int OPERATION_TIMEOUT

Operation timed out

See Also:

Constant Field Values

OPERATION_INTERRUPTED

public static final int OPERATION_INTERRUPTED

Operation was interrupted by the application

See Also:

Constant Field Values

Constructor Detail

XmlException

public XmlException(int errcode,
                    String description,
                    DatabaseException dbex,
                    int dberr)

Construct an XmlException.

Method Detail

getDatabaseException

public DatabaseException getDatabaseException()

Retrieves the Berkeley DB exception object for an XmlException with error code DATABASE_ERROR.

getErrorCode

public int getErrorCode()

Returns the exception code: one of the XmlException class constants.

getQueryLine

public int getQueryLine()

Returns the line of the XQuery expression that contains the error causing the exception, in the case of QUERY_PARSER_ERROR.

getQueryColumn

public int getQueryColumn()

Returns the column within the line of the XQuery expression that contains the error causing the exception, in the case of QUERY_PARSER_ERROR.