org.sbml.jsbml.validator

Enum SBMLValidator.CHECK_CATEGORY

java.lang.Object

java.lang.Enum<SBMLValidator.CHECK_CATEGORY>

org.sbml.jsbml.validator.SBMLValidator.CHECK_CATEGORY

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SBMLValidator.CHECK_CATEGORY>

Enclosing class:

SBMLValidator

public static enum SBMLValidator.CHECK_CATEGORY
extends java.lang.Enum<SBMLValidator.CHECK_CATEGORY>

Enumerates the different possible check categories when performing the validation of an SBML document.

Enum Constant Summary

Enum Constants

Enum Constant and Description
GENERAL_CONSISTENCY Correctness and consistency of specific SBML language constructs.
IDENTIFIER_CONSISTENCY Correctness and consistency of identifiers used for model entities.
MATHML_CONSISTENCY Syntax of MathML constructs.
MODELING_PRACTICE Additional checks for recommended good modeling practice.
OVERDETERMINED_MODEL Static analysis of whether the system of equations implied by a model is mathematically overdetermined.
SBO_CONSISTENCY Consistency and validity of SBO identifiers (if any) used in the model.
UNITS_CONSISTENCY Consistency of measurement units associated with quantities in a model.

Method Summary

Methods

Modifier and Type	Method and Description
static SBMLValidator.CHECK_CATEGORY	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SBMLValidator.CHECK_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 SBMLValidator.CHECK_CATEGORY GENERAL_CONSISTENCY

Correctness and consistency of specific SBML language constructs. Performing this set of checks is highly recommended. With respect to the SBML specification, these concern failures in applying the validation rules numbered 2xxxx in the Level 2 or Level 3 specifications.

IDENTIFIER_CONSISTENCY

public static final SBMLValidator.CHECK_CATEGORY IDENTIFIER_CONSISTENCY

Correctness and consistency of identifiers used for model entities. An example of inconsistency would be using a species identifier in a reaction rate formula without first having declared the species. With respect to the SBML specification, these concern failures in applying the validation rules numbered 103xx in the Level 2 or Level 3 specifications.

SBO_CONSISTENCY

public static final SBMLValidator.CHECK_CATEGORY SBO_CONSISTENCY

Consistency and validity of SBO identifiers (if any) used in the model. With respect to the SBML specification, these concern failures in applying the validation rules numbered 107xx in the Level 2 or Level 3 specifications.

MATHML_CONSISTENCY

public static final SBMLValidator.CHECK_CATEGORY MATHML_CONSISTENCY

Syntax of MathML constructs. With respect to the SBML specification, these concern failures in applying the validation rules numbered 102xx in the Level 2 or Level 3 specifications.

UNITS_CONSISTENCY

public static final SBMLValidator.CHECK_CATEGORY UNITS_CONSISTENCY

Consistency of measurement units associated with quantities in a model. With respect to the SBML specification, these concern failures in applying the validation rules numbered 105xx in the Level 2 or Level 3 specifications.

OVERDETERMINED_MODEL

public static final SBMLValidator.CHECK_CATEGORY OVERDETERMINED_MODEL

Static analysis of whether the system of equations implied by a model is mathematically overdetermined. With respect to the SBML specification, this is validation rule #10601 in the SBML Level 2 or Level 3 specifications.

MODELING_PRACTICE

public static final SBMLValidator.CHECK_CATEGORY MODELING_PRACTICE

Additional checks for recommended good modeling practice. (These are tests performed by libSBML and do not have equivalent SBML validation rules.)

Method Detail

values

public static SBMLValidator.CHECK_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 (SBMLValidator.CHECK_CATEGORY c : SBMLValidator.CHECK_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 SBMLValidator.CHECK_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