org.sbml.jsbml

Enum SBMLException.Category

java.lang.Object

java.lang.Enum<SBMLException.Category>

org.sbml.jsbml.SBMLException.Category

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SBMLException.Category>

Enclosing class:

SBMLException

public static enum SBMLException.Category
extends java.lang.Enum<SBMLException.Category>

Category of this exception.

Author:

Andreas Dräger

Enum Constant Summary

Enum Constants

Enum Constant and Description
GENERAL_CONSISTENCY Category of errors that can occur while validating general SBML constructs.
IDENTIFIER_CONSISTENCY Category of errors that can occur while validating symbol identifiers in a model.
INTERNAL This category of errors are basically a catch for something completely unexpected so as to avoid just crashing.
INTERNAL_CONSISTENCY Category of errors that can occur while validating libSBML's internal representation of SBML constructs.
MATHML_CONSISTENCY Category of errors that can occur while validating MathML formulas in a model.
MODELING_PRACTICE Category of warnings about recommended good practices involving SBML and computational modeling.
OVERDETERMINED_MODEL Error in the system of equations in the model: the system is overdetermined, therefore violating a tenet of proper SBML.
SBML General error not falling into another category below.
SBML_L1_COMPAT Category of errors that can only occur during attempted translation from one Level/Version of SBML to another.
SBML_L2V1_COMPAT Category of errors that can only occur during attempted translation from one Level/Version of SBML to another.
SBML_L2V2_COMPAT Category of errors that can only occur during attempted translation from one Level/Version of SBML to another.
SBML_L2V3_COMPAT Category of errors that can only occur during attempted translation from one Level/Version of SBML to another.
SBML_L2V4_COMPAT Category of errors that can only occur during attempted translation from one Level/Version of SBML to another.
SBO_CONSISTENCY Category of errors that can occur while validating SBO identifiers in a model.
SYSTEM These are operating system errors - like 'out of memory' and would have numbers in the range 00001 - 00005.
UNITS_CONSISTENCY Category of errors that can occur while validating the units of measurement on quantities in a model.
XML These are errors in the XML syntax that cause the underlying XML parsers to fail like a missing " or tag.

Method Summary

Methods

Modifier and Type	Method and Description
static SBMLException.Category	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SBMLException.Category[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

GENERAL_CONSISTENCY

public static final SBMLException.Category GENERAL_CONSISTENCY

Category of errors that can occur while validating general SBML constructs. With respect to the SBML specification, these concern failures in applying the validation rules numbered 2xxxx in the Level 2 Versions 2 and 3 specifications.

IDENTIFIER_CONSISTENCY

public static final SBMLException.Category IDENTIFIER_CONSISTENCY

Category of errors that can occur while validating symbol identifiers in a model. With respect to the SBML specification, these concern failures in applying the validation rules numbered 103xx in the Level 2 Versions 2 and 3 specifications.

INTERNAL

public static final SBMLException.Category INTERNAL

This category of errors are basically a catch for something completely unexpected so as to avoid just crashing.

INTERNAL_CONSISTENCY

public static final SBMLException.Category INTERNAL_CONSISTENCY

Category of errors that can occur while validating libSBML's internal representation of SBML constructs. (These are tests performed by libSBML and do not have equivalent SBML validation rules.)

MATHML_CONSISTENCY

public static final SBMLException.Category MATHML_CONSISTENCY

Category of errors that can occur while validating MathML formulas in a model. With respect to the SBML specification, these concern failures in applying the validation rules numbered 102xx in the Level 2 Versions 2 and 3 specifications.

MODELING_PRACTICE

public static final SBMLException.Category MODELING_PRACTICE

Category of warnings about recommended good practices involving SBML and computational modeling. (These are tests performed by libSBML and do not have equivalent SBML validation rules.)

OVERDETERMINED_MODEL

public static final SBMLException.Category OVERDETERMINED_MODEL

Error in the system of equations in the model: the system is overdetermined, therefore violating a tenet of proper SBML. With respect to the SBML specification, this is validation rule #10601 in the SBML Level 2 Versions 2 and 3 specifications.

SBML

public static final SBMLException.Category SBML

General error not falling into another category below.

SBML_L1_COMPAT

public static final SBMLException.Category SBML_L1_COMPAT

Category of errors that can only occur during attempted translation from one Level/Version of SBML to another. This particular category applies to errors encountered while trying to convert a model from SBML Level 2 to SBML Level 1.

SBML_L2V1_COMPAT

public static final SBMLException.Category SBML_L2V1_COMPAT

Category of errors that can only occur during attempted translation from one Level/Version of SBML to another. This particular category applies to errors encountered while trying to convert a model to SBML Level 2 Version 1.

SBML_L2V2_COMPAT

public static final SBMLException.Category SBML_L2V2_COMPAT

Category of errors that can only occur during attempted translation from one Level/Version of SBML to another. This particular category applies to errors encountered while trying to convert a model to SBML Level 2 Version 2.

SBML_L2V3_COMPAT

public static final SBMLException.Category SBML_L2V3_COMPAT

Category of errors that can only occur during attempted translation from one Level/Version of SBML to another. This particular category applies to errors encountered while trying to convert a model to SBML Level 2 Version 3.

SBML_L2V4_COMPAT

public static final SBMLException.Category SBML_L2V4_COMPAT

Category of errors that can only occur during attempted translation from one Level/Version of SBML to another. This particular category applies to errors encountered while trying to convert a model to SBML Level 2 Version 4.

SBO_CONSISTENCY

public static final SBMLException.Category SBO_CONSISTENCY

Category of errors that can occur while validating SBO identifiers in a model. With respect to the SBML specification, these concern failures in applying the validation rules numbered 107xx in the Level 2 Versions 2 and 3 specifications.

SYSTEM

public static final SBMLException.Category SYSTEM

These are operating system errors - like 'out of memory' and would have numbers in the range 00001 - 00005.

UNITS_CONSISTENCY

public static final SBMLException.Category UNITS_CONSISTENCY

Category of errors that can occur while validating the units of measurement on quantities in a model. With respect to the SBML specification, these concern failures in applying the validation rules numbered 105xx in the Level 2 Versions 2 and 3 specifications.

XML

public static final SBMLException.Category XML

These are errors in the XML syntax that cause the underlying XML parsers to fail like a missing " or tag. These have numbers 01001 - 01036 and libsbml does put a fair amount of effort in making sure the same error is reported regardless of which XML parser is being used.

Method Detail

values

public static SBMLException.Category[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SBMLException.Category c : SBMLException.Category.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SBMLException.Category valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null