com.ddtek.jxtr
Class JXTRException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--com.ddtek.jxtr.JXTRException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

JXTRSingleTableUpdateException, JXTRUpdateException, JXTRWarning

public class JXTRException

extends java.lang.Exception

Any unexpected occurrences encountered during the processing of a Connect for SQL/XML class method will cause an JXTRException to be thrown.

Each exception is identified by a numeric code (getCode()).

A text message describing the JXTRException can be retrieved using getMessage().

A JXTRException may contain a cause. For example, when a table referred to in a Connect for SQL/XML statement does not exist, a java.sql.SQLException is thrown. Connect for SQL/XML captures the SQLException and creates a JXTRException. The cause of this exception can be accessed using getCause().

See Also:

Serialized Form

Field Summary
static int	ACTIVE_RESULSTSET           Requested execute is not allowed because a result set is active.
static int	BATCHES_NOT_SUPPORTED           Batches are not supported for this rewrite algorithm.
static int	CALL_OUT_OF_SEQUENCE           The invoked method is not allowed at this time.
static int	CLASS_NOT_LOADED           The Java class cannot be loaded.
static int	CONVERTION_FAILED           Conversion from dataype A to B is not supported.
static int	DATABASE_LIMITATIONS           Because of a database limitation, the requested algorithm cannot be used to process the Connect for SQL/XML statement.
static int	DEMO_LICENSE_EXPIRED           The Connect for SQL/XML evaluation period has expired.
static int	DTD_NAMESPACE_CONFLICT           Conflicting namespace URIs were detected while generating DTD.
static int	DTD_REFERENCE_ALREADY_SET           The DTD reference has been set previously.
static int	EXECUTE_REQUIRED           Before the DTD or XML Schema can be generated, an execute method must be called.
static int	GET_OUT_OF_SEQUENCE           Request to retrieve column information was issued out of sequence.
static int	INTERNAL_ERROR           An internal error occurred.
static int	INVALID_BASE64_LENGTH           The length of the Base64 buffer is invalid.
static int	INVALID_DOM_NODE_TYPE           The evaluation of a XPath expression returned a invalid DOM node type.
static int	INVALID_HEX_CHARACTER           An invalid character was encountered while parsing a hexadecimal string.
static int	INVALID_HEX_LENGTH           The length of the hexadecimal string is invalid.
static int	INVALID_IGNORE_WS_VALUE           An invalid ignore whitespace value was provided.
static int	INVALID_JAVA_SQL_TYPE_NAME           An invalid java SQL type name was provided.
static int	INVALID_PARAMETER_INDEX           A parameter with an invalid index was set.
static int	INVALID_PARAMETER_LABEL           A parameter with an invalid name was set.
static int	INVALID_PARAMETERS           An invalid parameter value was passed to a Connect for SQL/XML method.
static int	INVALID_XML_NAME           The XML name for this attribute, element, or namespace is not a valid XML name.
static int	INVALID_XPATH_RETURN_TYPE           The evaluation of a XPath expression returned an invalid return type.
static int	IO_EXCEPTION           An IO exception was encountered.
static int	ISO8601_ERROR_INVALID_TIMEZONE_TOKENS           An invalid token in the timezone part was encountered while parsing an ISO8601 date value.
static int	ISO8601_ERROR_MISSING_TOKEN           A missing token was encountered while parsing an ISO8601 date value.
static int	ISO8601_ERROR_NO_HOURS           No hour field was encountered while parsing an ISO8601 date value.
static int	ISO8601_ERROR_NO_INTEGER           A non-integer value was encountered while parsing an ISO8601 date value.
static int	ISO8601_ERROR_NO_MINUTES           No minutes field was encountered while parsing an ISO8601 date value.
static int	ISO8601_ERROR_NO_SECONDS           No seconds field was encountered while parsing an ISO8601 date value.
static int	LICENSE_NOT_VALID           No valid Connect for SQL/XML license found.
static int	NESTEDAGGREGATES_DETECTED           Connect for SQL/XML statements that contain nested aggregate queries cannot be processed using the sorted outer union algorithm.
static int	NO_AGGREGATE_OR_GROUPED_EXPRESSION           The expression is invalid because it is not an aggregate function or found in the GROUP BY clause of the referenced query.
static int	NO_NODE_SET           The specified XML row pattern does not return a node set.
static int	NO_QUERY_STATEMENT           A statement was detected that was not an xml_document or a Select statement.
static int	NO_RESULSTSET_SUPPORT           Result set access is not supported for this query.
static int	NO_SELECTLIST_ITEMS_UNDER_ROOT           The for xml explicit rewrite algorithm does not allow a Select list item under the XML root element.
static int	NO_UPDATE_STATEMENT           A statement was detected that was not an Insert, Update, or Delete statement.
static int	NO_XML_DOCUMENT           No XML document is set.
static int	NO_XML_ROW_PATTERN           No XML row pattern is set.
static int	NOT_NESTED_IN_XML_TAG           An XML tag cannot be nested in another XML tag.
static int	OBJECT_CLOSED           Object closed.
static int	OEM_LICENSE_ONLY           The Connect for SQL/XML installation is locked.
static int	ONE_ATTRIBUTE_COLUMN           An attribute query selected more than one column.
static int	ONLY_COLUMN_INDEXES           The outer union rewrite algorithm only supports column indexes in the Order By clause.
static int	ONLY_CONSTANT_NS_URI_ALLOWED           The provided namespace URI value is not valid.
static int	ONLY_ODBC_TIMESTAMP_ENCODING           XML Explicit rewrite algorithm only supports ODBC type timestamp encoding.
static int	ORDER_BY_DETECTED           Connect for SQL/XML statements containing Order By clauses cannot be processed using the sorted outer union algorithm.
static int	ORDER_BY_ORDINAL_INVALID           Cannot sort on provided ordinal number.
static int	ORDER_BY_ORDINAL_RESET           Order by ordinal behavior cannot be reset.
static int	ORDER_BY_OUT_OF_RANGE           The Order By position number is not compatible with the number of items in the Select list.
static int	PARAMETER_NOT_SET           The value for the parameter was not set.
static int	PARAMETER_VALUE_NO_INTEGER           The value for the parameter was not an integer value.
static int	PARAMETER_VALUE_NO_INTEGER_OR_STRING           The value for the parameter was not an integer or string value.
static int	PARAMETER_VALUE_NO_STRING           The value for the parameter was not a string value.
static int	PARAMETER_VALUE_NO_XML_SOURCE           The value for the parameter was not an XML document source.
static int	PARSE_ERROR           A Connect for SQL/XML statement contained a syntax error.
static int	QUERY_SELECT_ONE_COLUMN           A query must select at least one column.
static int	ROOT_TAG_ALREADY_SET           The root element tag name has been set previously.
static int	SAX_EXCEPTION           A SAX exception was encountered.
static int	SQL_CONSTRUCT_NOT_SUPPORTED           The provided SQL construct is not supported.
static int	SQL_EXCEPTION           An SQL exception was encountered.
static int	SQL_WARNING           A SQL warning was encountered.
static int	SQLXML_EXPRESSION_NOT_SUPPORTED           The provided SQL/XML expression is only supported as a Select list item or nested in another SQL/XML expression.
static int	TABLE_ALIAS_NOT_UNIQUE           Table aliases must be unique.
static int	TABLE_ALIAS_REQUIRED           Table references must contain a table alias.
static int	UNEXPECTED_TOKEN           A Connect for SQL/XML statement contained a syntax error.
static int	UNSUPPORTED_CONVERTION           Conversion from dataype A to B is not supported.
static int	UNSUPPORTED_DRIVER           The provided connection was not established through a supported driver.
static int	UNSUPPORTED_TYPE           While fetching results from the database, a JDBC data type was retrieved that is not supported by Connect for SQL/XML.
static int	UPDATE_EXCEPTION           An exception has occured while updating.
static int	XML_KEY_ELEMENT_SELECT_ONE_COLUMN           No columns were selected from the database.

 

Method Summary
java.lang.Throwable	getCause()           Returns the cause of this JXTRException or null if the cause is nonexistent or unknown.
int	getCode()           Returns the numeric code associated with the JXTRException.
java.lang.String	getMessage()           Returns the message associated with the JXTRException.
java.lang.Exception	getNestedException()           Deprecated.
java.lang.Throwable	initCause(java.lang.Throwable cause)           Initializes the cause of this JXTRException to the specified value.

 

Methods inherited from class java.lang.Throwable

fillInStackTrace, getLocalizedMessage, getStackTrace, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Field Detail

INTERNAL_ERROR

public static final int INTERNAL_ERROR

An internal error occurred.

See Also:

Constant Field Values

SQL_EXCEPTION

public static final int SQL_EXCEPTION

An SQL exception was encountered. The SQL exception can be accessed using getCause().

See Also:

Constant Field Values

IO_EXCEPTION

public static final int IO_EXCEPTION

An IO exception was encountered. The IO exception can be accessed using getCause().

See Also:

Constant Field Values

INVALID_PARAMETERS

public static final int INVALID_PARAMETERS

An invalid parameter value was passed to a Connect for SQL/XML method.

See Also:

Constant Field Values

UNSUPPORTED_TYPE

public static final int UNSUPPORTED_TYPE

While fetching results from the database, a JDBC data type was retrieved that is not supported by Connect for SQL/XML.

See Also:

Constant Field Values

UNEXPECTED_TOKEN

public static final int UNEXPECTED_TOKEN

A Connect for SQL/XML statement contained a syntax error. A token was recognized but was not expected.

See Also:

Constant Field Values

PARSE_ERROR

public static final int PARSE_ERROR

A Connect for SQL/XML statement contained a syntax error.

See Also:

Constant Field Values

ONE_ATTRIBUTE_COLUMN

public static final int ONE_ATTRIBUTE_COLUMN

An attribute query selected more than one column. Attribute queries must select only one column.

See Also:

Constant Field Values

QUERY_SELECT_ONE_COLUMN

public static final int QUERY_SELECT_ONE_COLUMN

A query must select at least one column.

See Also:

Constant Field Values

ORDER_BY_DETECTED

public static final int ORDER_BY_DETECTED

Connect for SQL/XML statements containing Order By clauses cannot be processed using the sorted outer union algorithm.

See Also:

Constant Field Values

DATABASE_LIMITATIONS

public static final int DATABASE_LIMITATIONS

Because of a database limitation, the requested algorithm cannot be used to process the Connect for SQL/XML statement.

See Also:

Constant Field Values

NOT_NESTED_IN_XML_TAG

public static final int NOT_NESTED_IN_XML_TAG

An XML tag cannot be nested in another XML tag.

See Also:

Constant Field Values

TABLE_ALIAS_REQUIRED

public static final int TABLE_ALIAS_REQUIRED

Table references must contain a table alias.

See Also:

Constant Field Values

TABLE_ALIAS_NOT_UNIQUE

public static final int TABLE_ALIAS_NOT_UNIQUE

Table aliases must be unique.

See Also:

Constant Field Values

NESTEDAGGREGATES_DETECTED

public static final int NESTEDAGGREGATES_DETECTED

Connect for SQL/XML statements that contain nested aggregate queries cannot be processed using the sorted outer union algorithm.

See Also:

Constant Field Values

CLASS_NOT_LOADED

public static final int CLASS_NOT_LOADED

The Java class cannot be loaded. The exception can be accessed using getCause().

See Also:

Constant Field Values

SAX_EXCEPTION

public static final int SAX_EXCEPTION

A SAX exception was encountered. The SAX exception can be accessed using getNestedException().

See Also:

Constant Field Values

BATCHES_NOT_SUPPORTED

public static final int BATCHES_NOT_SUPPORTED

Batches are not supported for this rewrite algorithm.

See Also:

Constant Field Values

NO_SELECTLIST_ITEMS_UNDER_ROOT

public static final int NO_SELECTLIST_ITEMS_UNDER_ROOT

The for xml explicit rewrite algorithm does not allow a Select list item under the XML root element.

See Also:

Constant Field Values

INVALID_XML_NAME

public static final int INVALID_XML_NAME

The XML name for this attribute, element, or namespace is not a valid XML name.

See Also:

Constant Field Values

ROOT_TAG_ALREADY_SET

public static final int ROOT_TAG_ALREADY_SET

The root element tag name has been set previously.

See Also:

Constant Field Values

DTD_REFERENCE_ALREADY_SET

public static final int DTD_REFERENCE_ALREADY_SET

The DTD reference has been set previously.

See Also:

Constant Field Values

EXECUTE_REQUIRED

public static final int EXECUTE_REQUIRED

Before the DTD or XML Schema can be generated, an execute method must be called.

See Also:

Constant Field Values

DTD_NAMESPACE_CONFLICT

public static final int DTD_NAMESPACE_CONFLICT

Conflicting namespace URIs were detected while generating DTD.

See Also:

Constant Field Values

ONLY_ODBC_TIMESTAMP_ENCODING

public static final int ONLY_ODBC_TIMESTAMP_ENCODING

XML Explicit rewrite algorithm only supports ODBC type timestamp encoding.

See Also:

Constant Field Values

XML_KEY_ELEMENT_SELECT_ONE_COLUMN

public static final int XML_KEY_ELEMENT_SELECT_ONE_COLUMN

No columns were selected from the database. XML key elements must select at least one column from the database.

See Also:

Constant Field Values

ORDER_BY_OUT_OF_RANGE

public static final int ORDER_BY_OUT_OF_RANGE

The Order By position number is not compatible with the number of items in the Select list.

See Also:

Constant Field Values

ONLY_COLUMN_INDEXES

public static final int ONLY_COLUMN_INDEXES

The outer union rewrite algorithm only supports column indexes in the Order By clause.

See Also:

Constant Field Values

CALL_OUT_OF_SEQUENCE

public static final int CALL_OUT_OF_SEQUENCE

The invoked method is not allowed at this time. Call is ignored.

See Also:

Constant Field Values

NO_XML_DOCUMENT

public static final int NO_XML_DOCUMENT

No XML document is set.

See Also:

Constant Field Values

NO_XML_ROW_PATTERN

public static final int NO_XML_ROW_PATTERN

No XML row pattern is set.

See Also:

Constant Field Values

NO_NODE_SET

public static final int NO_NODE_SET

The specified XML row pattern does not return a node set.

See Also:

Constant Field Values

UPDATE_EXCEPTION

public static final int UPDATE_EXCEPTION

An exception has occured while updating.

See Also:

Constant Field Values

INVALID_XPATH_RETURN_TYPE

public static final int INVALID_XPATH_RETURN_TYPE

The evaluation of a XPath expression returned an invalid return type.

See Also:

Constant Field Values

INVALID_DOM_NODE_TYPE

public static final int INVALID_DOM_NODE_TYPE

The evaluation of a XPath expression returned a invalid DOM node type.

See Also:

Constant Field Values

INVALID_HEX_LENGTH

public static final int INVALID_HEX_LENGTH

The length of the hexadecimal string is invalid.

See Also:

Constant Field Values

INVALID_HEX_CHARACTER

public static final int INVALID_HEX_CHARACTER

An invalid character was encountered while parsing a hexadecimal string.

See Also:

Constant Field Values

INVALID_BASE64_LENGTH

public static final int INVALID_BASE64_LENGTH

The length of the Base64 buffer is invalid.

See Also:

Constant Field Values

INVALID_JAVA_SQL_TYPE_NAME

public static final int INVALID_JAVA_SQL_TYPE_NAME

An invalid java SQL type name was provided.

See Also:

Constant Field Values

INVALID_PARAMETER_INDEX

public static final int INVALID_PARAMETER_INDEX

A parameter with an invalid index was set.

See Also:

Constant Field Values

PARAMETER_NOT_SET

public static final int PARAMETER_NOT_SET

The value for the parameter was not set.

See Also:

Constant Field Values

PARAMETER_VALUE_NO_XML_SOURCE

public static final int PARAMETER_VALUE_NO_XML_SOURCE

The value for the parameter was not an XML document source.

See Also:

Constant Field Values

PARAMETER_VALUE_NO_INTEGER

public static final int PARAMETER_VALUE_NO_INTEGER

The value for the parameter was not an integer value. Use setInt(...) to set the correct value.

See Also:

Constant Field Values

PARAMETER_VALUE_NO_STRING

public static final int PARAMETER_VALUE_NO_STRING

The value for the parameter was not a string value. Use setString(...) to set the correct value.

See Also:

Constant Field Values

PARAMETER_VALUE_NO_INTEGER_OR_STRING

public static final int PARAMETER_VALUE_NO_INTEGER_OR_STRING

The value for the parameter was not an integer or string value. Use setInt(...) or setString(...) to set the correct value.

See Also:

Constant Field Values

INVALID_IGNORE_WS_VALUE

public static final int INVALID_IGNORE_WS_VALUE

An invalid ignore whitespace value was provided. Allowed values are 0 or 1.

See Also:

Constant Field Values

NO_QUERY_STATEMENT

public static final int NO_QUERY_STATEMENT

A statement was detected that was not an xml_document or a Select statement.

See Also:

Constant Field Values

NO_UPDATE_STATEMENT

public static final int NO_UPDATE_STATEMENT

A statement was detected that was not an Insert, Update, or Delete statement.

See Also:

Constant Field Values

ISO8601_ERROR_MISSING_TOKEN

public static final int ISO8601_ERROR_MISSING_TOKEN

A missing token was encountered while parsing an ISO8601 date value.

See Also:

Constant Field Values

ISO8601_ERROR_NO_INTEGER

public static final int ISO8601_ERROR_NO_INTEGER

A non-integer value was encountered while parsing an ISO8601 date value.

See Also:

Constant Field Values

ISO8601_ERROR_NO_SECONDS

public static final int ISO8601_ERROR_NO_SECONDS

No seconds field was encountered while parsing an ISO8601 date value.

See Also:

Constant Field Values

ISO8601_ERROR_INVALID_TIMEZONE_TOKENS

public static final int ISO8601_ERROR_INVALID_TIMEZONE_TOKENS

An invalid token in the timezone part was encountered while parsing an ISO8601 date value.

See Also:

Constant Field Values

ISO8601_ERROR_NO_HOURS

public static final int ISO8601_ERROR_NO_HOURS

No hour field was encountered while parsing an ISO8601 date value.

See Also:

Constant Field Values

ISO8601_ERROR_NO_MINUTES

public static final int ISO8601_ERROR_NO_MINUTES

No minutes field was encountered while parsing an ISO8601 date value.

See Also:

Constant Field Values

UNSUPPORTED_DRIVER

public static final int UNSUPPORTED_DRIVER

The provided connection was not established through a supported driver. Only DataDirect Technologies JDBC drivers are supported.

See Also:

Constant Field Values

OBJECT_CLOSED

public static final int OBJECT_CLOSED

Object closed. Requested operation is invalid on a closed object.

See Also:

Constant Field Values

NO_RESULSTSET_SUPPORT

public static final int NO_RESULSTSET_SUPPORT

Result set access is not supported for this query.

See Also:

Constant Field Values

ACTIVE_RESULSTSET

public static final int ACTIVE_RESULSTSET

Requested execute is not allowed because a result set is active.

See Also:

Constant Field Values

GET_OUT_OF_SEQUENCE

public static final int GET_OUT_OF_SEQUENCE

Request to retrieve column information was issued out of sequence.

See Also:

Constant Field Values

UNSUPPORTED_CONVERTION

public static final int UNSUPPORTED_CONVERTION

Conversion from dataype A to B is not supported.

See Also:

Constant Field Values

CONVERTION_FAILED

public static final int CONVERTION_FAILED

Conversion from dataype A to B is not supported.

See Also:

Constant Field Values

INVALID_PARAMETER_LABEL

public static final int INVALID_PARAMETER_LABEL

A parameter with an invalid name was set.

See Also:

Constant Field Values

ORDER_BY_ORDINAL_RESET

public static final int ORDER_BY_ORDINAL_RESET

Order by ordinal behavior cannot be reset.

See Also:

Constant Field Values

ORDER_BY_ORDINAL_INVALID

public static final int ORDER_BY_ORDINAL_INVALID

Cannot sort on provided ordinal number.

See Also:

Constant Field Values

NO_AGGREGATE_OR_GROUPED_EXPRESSION

public static final int NO_AGGREGATE_OR_GROUPED_EXPRESSION

The expression is invalid because it is not an aggregate function or found in the GROUP BY clause of the referenced query.

See Also:

Constant Field Values

SQL_WARNING

public static final int SQL_WARNING

A SQL warning was encountered. The SQL warning can be accessed using getCause().

See Also:

Constant Field Values

ONLY_CONSTANT_NS_URI_ALLOWED

public static final int ONLY_CONSTANT_NS_URI_ALLOWED

The provided namespace URI value is not valid. Only constants are allowed. using getCause().

See Also:

Constant Field Values

SQL_CONSTRUCT_NOT_SUPPORTED

public static final int SQL_CONSTRUCT_NOT_SUPPORTED

The provided SQL construct is not supported.

See Also:

Constant Field Values

SQLXML_EXPRESSION_NOT_SUPPORTED

public static final int SQLXML_EXPRESSION_NOT_SUPPORTED

The provided SQL/XML expression is only supported as a Select list item or nested in another SQL/XML expression.

See Also:

Constant Field Values

DEMO_LICENSE_EXPIRED

public static final int DEMO_LICENSE_EXPIRED

The Connect for SQL/XML evaluation period has expired.

See Also:

Constant Field Values

OEM_LICENSE_ONLY

public static final int OEM_LICENSE_ONLY

The Connect for SQL/XML installation is locked.

See Also:

Constant Field Values

LICENSE_NOT_VALID

public static final int LICENSE_NOT_VALID

No valid Connect for SQL/XML license found.

See Also:

Constant Field Values

getCode

public int getCode()

Returns the numeric code associated with the JXTRException.

Returns:

int The numeric exception code

getMessage

public java.lang.String getMessage()

Returns the message associated with the JXTRException.

Overrides:

getMessage in class java.lang.Throwable

Returns:

String The message associated with the exception.

getNestedException

public java.lang.Exception getNestedException()

Deprecated.  

Returns the exception embedded in the JXTRException.

Returns:

Exception The embedded exception.

initCause

public java.lang.Throwable initCause(java.lang.Throwable cause)

Initializes the cause of this JXTRException to the specified value.

Overrides:

initCause in class java.lang.Throwable

Parameters:

cause - The cause, which is saved for later retrieval by the getCause() method. A null value is permitted and indicates that the cause is nonexistent or unknown.

Returns:

a reference to this Throwable instance.

Throws:

java.lang.IllegalArgumentException - if cause is this throwable. (A throwable cannot be its own cause.)

java.lang.IllegalStateException - if this throwable has a cause already associated with it.

getCause

public java.lang.Throwable getCause()

Returns the cause of this JXTRException or null if the cause is nonexistent or unknown. (The cause is the throwable that caused this throwable to be thrown.)

Overrides:

getCause in class java.lang.Throwable

Returns:

the cause of this throwable or null if the cause is nonexistent or unknown.