jsdai.lang
Class SdaiException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          jsdai.lang.SdaiException

All Implemented Interfaces:

java.io.Serializable

public class SdaiException

extends java.lang.Exception

implements java.io.Serializable

The SdaiException class describes JSDAI errors appearing as a result of a JSDAI operation that has failed to execute successfully. This class contains a list of possible error indicators and methods to access the private fields. For the specific error represented by an instance of this class, the following information can be obtained: error indicator, underlying SdaiException (if any), the instance related to or causing the error, called error base (if any), and error description.

See Also:

"ISO 10303-22::11 SDAI errors", Serialized Form

Field Summary

static int	AI_NEXS Error indicator with the description: Aggregate instance does not exist.
static int	AI_NSET Error indicator with the description: Aggregate instance is empty.
static int	AI_NVLD Error indicator with the description: Aggregate instance invalid.
static int	AT_NDEF Error indicator with the description: Attribute not defined.
static int	AT_NVLD Error indicator with the description: Attribute invalid.
static int	ED_NDEF Error indicator with the description: Entity definition not defined.
static int	ED_NDEQ Error indicator with the description: Entity definition not domain equivalent.
static int	ED_NVLD Error indicator with the description: Entity definition invalid.
static int	EI_NAVL Error indicator with the description: Entity instance not available.
static int	EI_NEXP Error indicator with the description: Entity instance not exported.
static int	EI_NEXS Error indicator with the description: Entity instance does not exist.
static int	EI_NVLD Error indicator with the description: Entity instance invalid.
static int	ER_NSET Error indicator with the description: Event recording not set.
static int	EX_NSUP Error indicator with the description: Expression evaluation not supported.
static int	FN_NAVL Error indicator with the description: Function not available.
static int	IR_NEXS Error indicator with the description: Iterator does not exist.
static int	IR_NSET Error indicator with the description: Current member is not defined.
static int	IX_NVLD Error indicator with the description: Index invalid.
static int	LC_NVLD Error indicator with the description: Location invalid.
static int	MO_DUP Error indicator with the description: SDAI-model duplicate.
static int	MO_LOCK Error indicator with the description: Model locked by another user.
static int	MO_NDEQ Error indicator with the description: SDAI-model not domain equivalent.
static int	MO_NEXS Error indicator with the description: SDAI-model does not exist.
static int	MO_NVLD Error indicator with the description: SDAI-model invalid.
static int	MX_NDEF Error indicator with the description: SDAI-model access not defined.
static int	MX_NRW Error indicator with the description: SDAI-model access not read-write.
static int	MX_RO Error indicator with the description: SDAI-model access read-only.
static int	MX_RW Error indicator with the description: SDAI-model access read-write.
static int	OP_NVLD Error indicator with the description: Operator invalid.
static int	RP_DUP Error indicator with the description: Repository duplicate.
static int	RP_LOCK Error indicator with the description: Repository locked by another user.
static int	RP_NAVL Error indicator with the description: Repository not available.
static int	RP_NEXS Error indicator with the description: Repository does not exist.
static int	RP_NOPN Error indicator with the description: Repository is not open.
static int	RP_OPN Error indicator with the description: Repository open.
static int	RP_RO Error indicator with the description: Read-only access to repository.
static int	RU_NDEF Error indicator with the description: Rule not defined.
static int	SD_NDEF Error indicator with the description: Schema definition not defined.
static int	SI_DUP Error indicator with the description: Schema instance duplicate.
static int	SY_ERR Error indicator with the description: Underlying system error.
static int	SY_LOC Error indicator with the description: Could not obtain lock.
static int	SI_LOCK Error indicator with the description: Schema instance locked by another user.
static int	SI_NEXS Error indicator with the description: Schema instance does not exist.
static int	SY_SEC Error indicator with the description: Security violation.
static int	SS_NAVL Error indicator with the description: Session not available.
static int	SS_NOPN Error indicator with the description: Session is not open.
static int	SS_OPN Error indicator with the description: Session open.
static int	SS_RO Error indicator with the description: Read-only access to remote session.
static int	TR_EAB Error indicator with the description: Transaction ended abnormally.
static int	TR_EXS Error indicator with the description: Transaction exists.
static int	TR_NAVL Error indicator with the description: Transaction currently not available.
static int	TR_NEXS Error indicator with the description: Transaction does not exist.
static int	TR_NRW Error indicator with the description: Transaction not read-write.
static int	TR_RW Error indicator with the description: Transaction read-write.
static int	VA_NEXS Error indicator with the description: Value does not exist.
static int	VA_NSET Error indicator with the description: Value not set.
static int	VA_NVLD Error indicator with the description: Value invalid.
static int	VT_NVLD Error indicator with the description: Value type invalid.

Constructor Summary

SdaiException()
Creates a new instance of SdaiException with error indicator SY_ERR.

SdaiException(int id)
Creates a new instance of SdaiException with specified error indicator.

SdaiException(int id, java.lang.Exception exception)
Creates a new instance of SdaiException with specified error indicator and specified underlying Exception.

SdaiException(int id, java.lang.Object base)
Creates a new instance of SdaiException with specified error indicator and specified instance related to or causing the error.

SdaiException(int id, java.lang.Object base, java.lang.Exception exception)
Creates a new instance of SdaiException with specified error indicator, the instance related to or causing the error, and underlying Exception.

SdaiException(int id, java.lang.Object base, java.lang.String text)
Creates a new instance of SdaiException with specified error indicator and specified instance related to or causing the error.

Method Summary

java.lang.Object	getErrorBase() Returns the instance related to or causing the error, if any.
static java.lang.String	getErrorDescription(int id) Returns the description of the error for the specified error indicator.
int	getErrorId() Returns the error indicator for this object of SdaiException.
java.lang.Exception	getUnderlyingException() Returns Exception (if any) that is underlying to this SdaiException.
void	printStackTrace(java.io.PrintStream ps) Prints the stack trace of the exception that occurred to the specified print stream.
void	printStackTrace(java.io.PrintWriter pw) Prints the stack trace of the exception that occurred to the specified print writer.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Field Detail

SS_OPN

public static final int SS_OPN

Error indicator with the description: Session open.

An attempt was made to open a session while a session was still open.

See Also:

Constant Field Values

SS_NAVL

public static final int SS_NAVL

Error indicator with the description: Session not available.

Access to an SDAI object is possible only when the session is open.

See Also:

Constant Field Values

SS_NOPN

public static final int SS_NOPN

Error indicator with the description: Session is not open.

Access to an SDAI object is possible only when the session is open.

See Also:

Constant Field Values

RP_NEXS

public static final int RP_NEXS

Error indicator with the description: Repository does not exist.

See Also:

Constant Field Values

RP_NAVL

public static final int RP_NAVL

Error indicator with the description: Repository not available.

See Also:

Constant Field Values

RP_OPN

public static final int RP_OPN

Error indicator with the description: Repository open.

See Also:

Constant Field Values

RP_NOPN

public static final int RP_NOPN

Error indicator with the description: Repository is not open.

See Also:

Constant Field Values

RP_DUP

public static final int RP_DUP

Error indicator with the description: Repository duplicate.

See Also:

Constant Field Values

TR_EAB

public static final int TR_EAB

Error indicator with the description: Transaction ended abnormally.

See Also:

Constant Field Values

TR_EXS

public static final int TR_EXS

Error indicator with the description: Transaction exists.

See Also:

Constant Field Values

TR_NAVL

public static final int TR_NAVL

Error indicator with the description: Transaction currently not available.

See Also:

Constant Field Values

TR_RW

public static final int TR_RW

Error indicator with the description: Transaction read-write.

See Also:

Constant Field Values

TR_NRW

public static final int TR_NRW

Error indicator with the description: Transaction not read-write.

See Also:

Constant Field Values

TR_NEXS

public static final int TR_NEXS

Error indicator with the description: Transaction does not exist.

See Also:

Constant Field Values

MO_NDEQ

public static final int MO_NDEQ

Error indicator with the description: SDAI-model not domain equivalent.

See Also:

Constant Field Values

MO_NEXS

public static final int MO_NEXS

Error indicator with the description: SDAI-model does not exist.

See Also:

Constant Field Values

MO_NVLD

public static final int MO_NVLD

Error indicator with the description: SDAI-model invalid.

See Also:

Constant Field Values

MO_DUP

public static final int MO_DUP

Error indicator with the description: SDAI-model duplicate.

See Also:

Constant Field Values

MX_NRW

public static final int MX_NRW

Error indicator with the description: SDAI-model access not read-write.

See Also:

Constant Field Values

MX_NDEF

public static final int MX_NDEF

Error indicator with the description: SDAI-model access not defined.

See Also:

Constant Field Values

MX_RW

public static final int MX_RW

Error indicator with the description: SDAI-model access read-write.

See Also:

Constant Field Values

MX_RO

public static final int MX_RO

Error indicator with the description: SDAI-model access read-only.

See Also:

Constant Field Values

SD_NDEF

public static final int SD_NDEF

Error indicator with the description: Schema definition not defined.

See Also:

Constant Field Values

ED_NDEF

public static final int ED_NDEF

Error indicator with the description: Entity definition not defined.

See Also:

Constant Field Values

ED_NDEQ

public static final int ED_NDEQ

Error indicator with the description: Entity definition not domain equivalent.

See Also:

Constant Field Values

ED_NVLD

public static final int ED_NVLD

Error indicator with the description: Entity definition invalid.

See Also:

Constant Field Values

RU_NDEF

public static final int RU_NDEF

Error indicator with the description: Rule not defined.

See Also:

Constant Field Values

EX_NSUP

public static final int EX_NSUP

Error indicator with the description: Expression evaluation not supported.

See Also:

Constant Field Values

AT_NVLD

public static final int AT_NVLD

Error indicator with the description: Attribute invalid.

See Also:

Constant Field Values

AT_NDEF

public static final int AT_NDEF

Error indicator with the description: Attribute not defined.

See Also:

Constant Field Values

SI_DUP

public static final int SI_DUP

Error indicator with the description: Schema instance duplicate.

See Also:

Constant Field Values

SI_NEXS

public static final int SI_NEXS

Error indicator with the description: Schema instance does not exist.

See Also:

Constant Field Values

EI_NEXS

public static final int EI_NEXS

Error indicator with the description: Entity instance does not exist.

See Also:

Constant Field Values

EI_NAVL

public static final int EI_NAVL

Error indicator with the description: Entity instance not available.

See Also:

Constant Field Values

EI_NVLD

public static final int EI_NVLD

Error indicator with the description: Entity instance invalid.

See Also:

Constant Field Values

EI_NEXP

public static final int EI_NEXP

Error indicator with the description: Entity instance not exported.

See Also:

Constant Field Values

AI_NEXS

public static final int AI_NEXS

Error indicator with the description: Aggregate instance does not exist.

See Also:

Constant Field Values

AI_NVLD

public static final int AI_NVLD

Error indicator with the description: Aggregate instance invalid.

See Also:

Constant Field Values

AI_NSET

public static final int AI_NSET

Error indicator with the description: Aggregate instance is empty.

See Also:

Constant Field Values

VA_NVLD

public static final int VA_NVLD

Error indicator with the description: Value invalid.

See Also:

Constant Field Values

VA_NEXS

public static final int VA_NEXS

Error indicator with the description: Value does not exist.

See Also:

Constant Field Values

VA_NSET

public static final int VA_NSET

Error indicator with the description: Value not set.

See Also:

Constant Field Values

VT_NVLD

public static final int VT_NVLD

Error indicator with the description: Value type invalid.

See Also:

Constant Field Values

IR_NEXS

public static final int IR_NEXS

Error indicator with the description: Iterator does not exist.

See Also:

Constant Field Values

IR_NSET

public static final int IR_NSET

Error indicator with the description: Current member is not defined.

See Also:

Constant Field Values

IX_NVLD

public static final int IX_NVLD

Error indicator with the description: Index invalid.

See Also:

Constant Field Values

ER_NSET

public static final int ER_NSET

Error indicator with the description: Event recording not set.

This SDAI error indicator is not used by JSDAI.

See Also:

Constant Field Values

OP_NVLD

public static final int OP_NVLD

Error indicator with the description: Operator invalid.

See Also:

Constant Field Values

FN_NAVL

public static final int FN_NAVL

Error indicator with the description: Function not available.

See Also:

Constant Field Values

LC_NVLD

public static final int LC_NVLD

Error indicator with the description: Location invalid.

See Also:

Constant Field Values

RP_RO

public static final int RP_RO

Error indicator with the description: Read-only access to repository.

See Also:

Constant Field Values

SI_LOCK

public static final int SI_LOCK

Error indicator with the description: Schema instance locked by another user.

See Also:

Constant Field Values

MO_LOCK

public static final int MO_LOCK

Error indicator with the description: Model locked by another user.

See Also:

Constant Field Values

RP_LOCK

public static final int RP_LOCK

Error indicator with the description: Repository locked by another user.

See Also:

Constant Field Values

SS_RO

public static final int SS_RO

Error indicator with the description: Read-only access to remote session.

See Also:

Constant Field Values

SY_ERR

public static final int SY_ERR

Error indicator with the description: Underlying system error.

See Also:

Constant Field Values

SY_SEC

public static final int SY_SEC

Error indicator with the description: Security violation.

Since:

4.0.0

See Also:

Constant Field Values

SY_LOC

public static final int SY_LOC

Error indicator with the description: Could not obtain lock.

Since:

4.1.0

See Also:

Constant Field Values

Constructor Detail

SdaiException

public SdaiException()

Creates a new instance of SdaiException with error indicator SY_ERR.

See Also:

SdaiException(int id), SdaiException(int id, Object base), SdaiException(int id, Object base, String text), SdaiException(int id, Exception exception), SdaiException(int id, Object base, Exception exception)

SdaiException

public SdaiException(int id)

Creates a new instance of SdaiException with specified error indicator.

Parameters:

id - the error indicator.

See Also:

SdaiException(), SdaiException(int id, Object base), SdaiException(int id, Object base, String text), SdaiException(int id, Exception exception), SdaiException(int id, Object base, Exception exception)

SdaiException

public SdaiException(int id,
                     java.lang.Object base)

Creates a new instance of SdaiException with specified error indicator and specified instance related to or causing the error.

Parameters:

id - the error indicator.

base - an instance related to or causing the error.

See Also:

SdaiException(), SdaiException(int id), SdaiException(int id, Object base, String text), SdaiException(int id, Exception exception), SdaiException(int id, Object base, Exception exception)

SdaiException

public SdaiException(int id,
                     java.lang.Object base,
                     java.lang.String text)

Creates a new instance of SdaiException with specified error indicator and specified instance related to or causing the error. Also, some text extending the standard error description can be submitted.

Parameters:

id - the error indicator.

base - an instance related to or causing the error.

text - some text to be added to the standard error description.

See Also:

SdaiException(), SdaiException(int id), SdaiException(int id, Object base), SdaiException(int id, Exception exception), SdaiException(int id, Object base, Exception exception)

SdaiException

public SdaiException(int id,
                     java.lang.Exception exception)

Creates a new instance of SdaiException with specified error indicator and specified underlying Exception.

Parameters:

id - the error indicator.

exception - underlying Exception.

See Also:

SdaiException(), SdaiException(int id), SdaiException(int id, Object base), SdaiException(int id, Object base, String text), SdaiException(int id, Object base, Exception exception)

SdaiException

public SdaiException(int id,
                     java.lang.Object base,
                     java.lang.Exception exception)

Creates a new instance of SdaiException with specified error indicator, the instance related to or causing the error, and underlying Exception.

Parameters:

id - the error indicator.

base - an instance related to or causing the error.

exception - underlying Exception.

See Also:

SdaiException(), SdaiException(int id), SdaiException(int id, Object base), SdaiException(int id, Object base, String text), SdaiException(int id, Exception exception)

Method Detail

getUnderlyingException

public final java.lang.Exception getUnderlyingException()

Returns Exception (if any) that is underlying to this SdaiException. If this object of SdaiException is for error which type does not assume the existence of such an Exception, then null is returned.

Returns:

either null or underlying Exception.

getErrorId

public final int getErrorId()

Returns the error indicator for this object of SdaiException. Most error indicators implemented in this class are taken from Table 2 of ISO 10303-22::11 SDAI errors. Some additional indicators are also included.

Returns:

an indicator for the error represented by this SdaiException object.

See Also:

"ISO 10303-22::11 SDAI errors"

getErrorBase

public final java.lang.Object getErrorBase()

Returns the instance related to or causing the error, if any. If this object of SdaiException is for error which type does not assume the existence of such an instance, then null is returned.

Returns:

either null or the instance related to or causing the error.

See Also:

"ISO 10303-22::11 SDAI errors"

getErrorDescription

public static java.lang.String getErrorDescription(int id)

Returns the description of the error for the specified error indicator.

Parameters:

id - an error indicator.

Returns:

a String providing an information about the error.

See Also:

"ISO 10303-22::11 SDAI errors"

printStackTrace

public void printStackTrace(java.io.PrintStream ps)

Prints the stack trace of the exception that occurred to the specified print stream.

printStackTrace

public void printStackTrace(java.io.PrintWriter pw)

Prints the stack trace of the exception that occurred to the specified print writer.