org.sbml.jsbml.validator.offline.constraints.helper

Class ValidationTools

java.lang.Object

org.sbml.jsbml.validator.offline.constraints.helper.ValidationTools

public final class ValidationTools
extends java.lang.Object

Collection of helpful functions and variables for validation.

Since:

1.2

Author:

Roman

Field Summary

Fields

Modifier and Type	Field and Description
static ValidationFunction<SBaseWithDerivedUnit>	checkDerivedUnit
static byte	DT_BOOLEAN
static byte	DT_NUMBER
static byte	DT_STRING
static byte	DT_UNKNOWN
static byte	DT_VECTOR
static Filter	FILTER_IS_FUNCTION
static Filter	FILTER_IS_NAME
static java.lang.String	KEY_META_ID_SET

Constructor Summary

Constructors

Constructor and Description
ValidationTools()

Method Summary

Modifier and Type	Method and Description
static boolean	containsMathOnlyPredefinedFunctions(ASTNode math)
static byte	getDataType(ASTNode node) Returns the data type of an ASTNode.
static java.util.Set<java.lang.String>	getDefinedSpecies(Reaction r)
static boolean	haveEquivalentUnits(Assignment assignment, Variable var) Returns true if the given Assignment and Variable have equivalent derived units.
static boolean	isBigLetter(char c) A big letter is a ASCII symbol between 'A' and 'Z'.
static boolean	isDigit(char c) A digit is a ASCII symbol between '0' and '9'.
static boolean	isId(java.lang.String s, int level, int version) A SId starts with a letter or '-' and can be followed by a various amout of idChars.
static boolean	isIdChar(char c) A idChar is a letter, digit or '-'.
static boolean	isLetter(char c) A letter is either a small letter or big letter.
static boolean	isLocalParameter(ASTNode node, java.lang.String name)
static boolean	isNameChar(char c) A NameChar (defined in the XML Schema 1.0) can be a letter, a digit, '.', '-', '_', ':', a CombiningChar or Extender.
static boolean	isSboTerm(java.lang.String s) A SBOTerm begins with 'SBO:' followed by exactly 7 digits
static boolean	isSmallLetter(char c) A small letter is a ASCII symbol between 'a' and 'z'.
static boolean	isSpeciesReference(Model m, java.lang.String name)
static boolean	isValidVariable(Variable var, int level)
static boolean	isXmlId(java.lang.String s) A XML ID (defined in the XML Schema 1.0) starts with a letter, '-' or ':' which can be followed by a unlimited amout of NameChars.

Methods inherited from class java.lang.Object

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

Field Detail

DT_UNKNOWN

public static final byte DT_UNKNOWN

See Also:

Constant Field Values

DT_NUMBER

public static final byte DT_NUMBER

See Also:

Constant Field Values

DT_BOOLEAN

public static final byte DT_BOOLEAN

See Also:

Constant Field Values

DT_STRING

public static final byte DT_STRING

See Also:

Constant Field Values

DT_VECTOR

public static final byte DT_VECTOR

See Also:

Constant Field Values

KEY_META_ID_SET

public static final java.lang.String KEY_META_ID_SET

See Also:

Constant Field Values

FILTER_IS_FUNCTION

public static Filter FILTER_IS_FUNCTION

FILTER_IS_NAME

public static Filter FILTER_IS_NAME

checkDerivedUnit

public static ValidationFunction<SBaseWithDerivedUnit> checkDerivedUnit

Constructor Detail

ValidationTools

public ValidationTools()

Method Detail

containsMathOnlyPredefinedFunctions

public static boolean containsMathOnlyPredefinedFunctions(ASTNode math)

getDefinedSpecies

public static java.util.Set<java.lang.String> getDefinedSpecies(Reaction r)

getDataType

public static byte getDataType(ASTNode node)

Returns the data type of an ASTNode.

It can be DT_NUMBER, DT_BOOLEAN, DT_STRING, DT_VECTOR or DT_UNKNOWN.

Parameters:

node - an ASTNode

Returns:

the data type of a ASTNode.

isLocalParameter

public static boolean isLocalParameter(ASTNode node,
                                       java.lang.String name)

isSpeciesReference

public static boolean isSpeciesReference(Model m,
                                         java.lang.String name)

isValidVariable

public static boolean isValidVariable(Variable var,
                                      int level)

isLetter

public static boolean isLetter(char c)

A letter is either a small letter or big letter.

Parameters:

c -

Returns:

isSmallLetter

public static boolean isSmallLetter(char c)

A small letter is a ASCII symbol between 'a' and 'z'.

Parameters:

c -

Returns:

isBigLetter

public static boolean isBigLetter(char c)

A big letter is a ASCII symbol between 'A' and 'Z'.

Parameters:

c -

Returns:

isIdChar

public static boolean isIdChar(char c)

A idChar is a letter, digit or '-'.

Parameters:

c -

Returns:

isDigit

public static boolean isDigit(char c)

A digit is a ASCII symbol between '0' and '9'.

Parameters:

c -

Returns:

isNameChar

public static boolean isNameChar(char c)

A NameChar (defined in the XML Schema 1.0) can be a letter, a digit, '.', '-', '_', ':', a CombiningChar or Extender.

Parameters:

c -

Returns:

isId

public static boolean isId(java.lang.String s,
                           int level,
                           int version)

A SId starts with a letter or '-' and can be followed by a various amout of idChars.

Parameters:

s -

Returns:

isSboTerm

public static boolean isSboTerm(java.lang.String s)

A SBOTerm begins with 'SBO:' followed by exactly 7 digits

Parameters:

s -

Returns:

true or false

isXmlId

public static boolean isXmlId(java.lang.String s)

A XML ID (defined in the XML Schema 1.0) starts with a letter, '-' or ':' which can be followed by a unlimited amout of NameChars.

Parameters:

s -

Returns:

haveEquivalentUnits

public static boolean haveEquivalentUnits(Assignment assignment,
                                          Variable var)

Returns true if the given Assignment and Variable have equivalent derived units.

Parameters:

assignment - the assignment to check

var - the variable to check

Returns:

true if the given Assignment and Variable have equivalent derived units.