net.windward.env

Class DataSourceException

java.lang.Object

java.lang.Throwable

java.lang.Exception

net.windward.env.WindwardException

net.windward.env.DataSourceException

All Implemented Interfaces:

java.io.Serializable

public class DataSourceException
extends WindwardException

All exceptions thrown by the datasource classes (except connection exceptions - those are in DataConnectionException) are wrapped in this exception. The isInvalidSelect means that the command (usually a select) passed to the underlying data system was an invalid command. This is an expected possibility when processing multiple data sources. A SQL select will be garbage to an XPath select and vice versa. In env so that the J# one can take a System.Exception.

Version:

2.0 2 January 2004

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataSourceException.ForEachInfo The info on a forEach tag used to return this info in the DataSourceException.
static class	DataSourceException.QueryInfo The info on a query tag used to return this info in the DataSourceException.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHART_DATASET_ERROR
static int	CHART_INVALID_SCHEMA
static int	CHART_MISMATCHED_GRAPHS
static int	CHART_NULL_DATA_ITEM
static int	CHART_TAG_ERROR
static int	EQUATION_ERROR
static int	FILTER_ON_STORED_PROCEDURE
static int	ILLEGAL_VAR
static int	INVALID_DATE
static int	INVALID_FILENAME Import tag, failed to read the filename that the select returned.
static int	INVALID_INDEX
static int	INVALID_NUMBER
static int	INVALID_SELECT
static int	IO_ERROR
static int	MISMATCHED_VARIABLE Does not have matching ${ ...
static int	NOT_SUPPORT
static int	SELECT_ON_A_VAR
static int	UNKNOWN
static int	UNKNOWN_VAR
static int	UNSUPPORTED_TAG_PROPERTY

Constructor Summary

Constructors

Constructor and Description
DataSourceException(java.lang.String message, int subType) Constructs a new exception with the specified detail message and cause.
DataSourceException(java.lang.String message, java.lang.String finalSelect, int subType) Constructs a new exception with the specified detail message and cause.
DataSourceException(java.lang.String message, java.lang.String finalSelect, java.lang.Throwable cause, int subType) Constructs a new exception with the specified detail message and cause.
DataSourceException(java.lang.String message, java.lang.Throwable cause, int subType) Constructs a new exception with the specified detail message and cause.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFinalSelect() The final select that caused this exception.
java.util.List<DataSourceException.ForEachInfo>	getForEachTags() The forEach stack in place when this exception occured.
java.lang.String	getMessage() Returns the detail message string of this throwable.
java.util.Map	getParameters() The names of all parameters in scope.
java.util.List<DataSourceException.QueryInfo>	getQueryTags() The query tags in scope when this exception occured.
int	getSubType() The sub-type of the exception.
BaseTag	getTag() The tag that caused this exception.
boolean	isSelectType() Returns true if this is from a select.
void	setProperties(BaseTag tag) Set the tag property.
void	setProperties(BaseTag tag, java.util.Map parameters, DataSourceException.ForEachInfo[] forEachTags, DataSourceException.QueryInfo[] queryTags) Set the remaining properties.
java.lang.String	toString()

Methods inherited from class net.windward.env.WindwardException

getDocPos, getFullTag, setDocPos, setFullTag

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN

public static final int UNKNOWN

See Also:

Constant Field Values

INVALID_SELECT

public static final int INVALID_SELECT

See Also:

Constant Field Values

INVALID_INDEX

public static final int INVALID_INDEX

See Also:

Constant Field Values

INVALID_NUMBER

public static final int INVALID_NUMBER

See Also:

Constant Field Values

INVALID_DATE

public static final int INVALID_DATE

See Also:

Constant Field Values

ILLEGAL_VAR

public static final int ILLEGAL_VAR

See Also:

Constant Field Values

IO_ERROR

public static final int IO_ERROR

See Also:

Constant Field Values

UNKNOWN_VAR

public static final int UNKNOWN_VAR

See Also:

Constant Field Values

EQUATION_ERROR

public static final int EQUATION_ERROR

See Also:

Constant Field Values

SELECT_ON_A_VAR

public static final int SELECT_ON_A_VAR

See Also:

Constant Field Values

FILTER_ON_STORED_PROCEDURE

public static final int FILTER_ON_STORED_PROCEDURE

See Also:

Constant Field Values

UNSUPPORTED_TAG_PROPERTY

public static final int UNSUPPORTED_TAG_PROPERTY

See Also:

Constant Field Values

CHART_INVALID_SCHEMA

public static final int CHART_INVALID_SCHEMA

See Also:

Constant Field Values

CHART_TAG_ERROR

public static final int CHART_TAG_ERROR

See Also:

Constant Field Values

CHART_DATASET_ERROR

public static final int CHART_DATASET_ERROR

See Also:

Constant Field Values

CHART_MISMATCHED_GRAPHS

public static final int CHART_MISMATCHED_GRAPHS

See Also:

Constant Field Values

CHART_NULL_DATA_ITEM

public static final int CHART_NULL_DATA_ITEM

See Also:

Constant Field Values

NOT_SUPPORT

public static final int NOT_SUPPORT

See Also:

Constant Field Values

MISMATCHED_VARIABLE

public static final int MISMATCHED_VARIABLE

Does not have matching ${ ... }

See Also:

Constant Field Values

INVALID_FILENAME

public static final int INVALID_FILENAME

Import tag, failed to read the filename that the select returned.

See Also:

Constant Field Values

Constructor Detail

DataSourceException

public DataSourceException(java.lang.String message,
                           java.lang.String finalSelect,
                           java.lang.Throwable cause,
                           int subType)

Constructs a new exception with the specified detail message and cause. Sets isInvalidSelect too (usually set to true as the default is false).

Parameters:

message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).

finalSelect - the final select passed to the datasource. Set to null if n/a or unknown.

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

subType - sub-type of exception.

DataSourceException

public DataSourceException(java.lang.String message,
                           java.lang.Throwable cause,
                           int subType)

Constructs a new exception with the specified detail message and cause. Sets isInvalidSelect too (usually set to true as the default is false).

Parameters:

message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).

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

subType - sub-type of exception.

DataSourceException

public DataSourceException(java.lang.String message,
                           java.lang.String finalSelect,
                           int subType)

Constructs a new exception with the specified detail message and cause. Sets isInvalidSelect too (usually set to true as the default is false).

Parameters:

message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).

finalSelect - the final select passed to the datasource. Set to null if n/a or unknown.

subType - sub-type of exception.

DataSourceException

public DataSourceException(java.lang.String message,
                           int subType)

Constructs a new exception with the specified detail message and cause. Sets isInvalidSelect too (usually set to true as the default is false).

Parameters:

message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).

subType - sub-type of exception.

Method Detail

setProperties

public void setProperties(BaseTag tag,
                          java.util.Map parameters,
                          DataSourceException.ForEachInfo[] forEachTags,
                          DataSourceException.QueryInfo[] queryTags)

Set the remaining properties. Only sets properties that are not yet set.

Parameters:

tag - The tag that caused this exception. Set to null if n/a or unknown.

parameters - the parameters known at this time. Set to null if n/a or unknown.

forEachTags - The forEach tags in scope. Set to null if n/a or unknown.

queryTags - The query tags in scope. Set to null if n/a or unknown.

setProperties

public void setProperties(BaseTag tag)

Set the tag property.

Parameters:

tag - The tag that caused this exception. Set to null if n/a or unknown.

getTag

public BaseTag getTag()

The tag that caused this exception. Can be null.

Returns:

The tag that caused this exception.

getSubType

public int getSubType()

The sub-type of the exception.

Returns:

sub-type of the exception.

isSelectType

public boolean isSelectType()

Returns true if this is from a select. true on INVALID_SELECT, INVALID_INDEX, SELECT_ON_A_VAR & EQUATION_ERROR.

getFinalSelect

public java.lang.String getFinalSelect()

The final select that caused this exception. null if n/a or unknown.

Returns:

The final select that caused this exception.

getParameters

public java.util.Map getParameters()

The names of all parameters in scope. null n/a or if unknown.

Returns:

The names of all parameters in scope.

getForEachTags

public java.util.List<DataSourceException.ForEachInfo> getForEachTags()

The forEach stack in place when this exception occured. Element[0] is the outermost.

Returns:

The forEach stack in place when this exception occured.

getQueryTags

public java.util.List<DataSourceException.QueryInfo> getQueryTags()

The query tags in scope when this exception occured.

Returns:

The query tags in scope when this exception occured.

getMessage

public java.lang.String getMessage()

Returns the detail message string of this throwable.

Overrides:

getMessage in class java.lang.Throwable

Returns:

the detail message string of this Throwable instance (which may be null).

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Throwable