Package org.sbml.jsbml.ext.arrays.validator.constraints

Class ArraysConstraint

java.lang.Object

org.sbml.jsbml.ext.arrays.validator.constraints.ArraysConstraint

Direct Known Subclasses:

ArraysMathCheck, DimensionArrayDimCheck, DimensionIDCheck, DimensionSizeCheck, IndexArrayDimCheck, IndexAttributesCheck, SBaseWithDimensionCheck

public abstract class ArraysConstraint
extends java.lang.Object

An ArraysConstraint object ensures that a given Model doesn't violate a certain validation rule defined in the arrays specification.

Since:

1.0

Author:

Leandro Watanabe

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.List<org.sbml.jsbml.SBMLError>	listOfErrors	This is used to track SBMLErrors that are detected in the model.
protected org.sbml.jsbml.Model	model	A Model to be checked.

Constructor Summary

Constructors

Constructor	Description
ArraysConstraint()	Constructs an ArraysConstraint.
ArraysConstraint(org.sbml.jsbml.Model model)	Constructs an ArraysConstraint with a model.

Method Summary

Modifier and Type	Method	Description
abstract void	check()	Checks if the given model doesn't violate the constraint specified by this object.
java.util.List<org.sbml.jsbml.SBMLError>	getListOfErrors()	Gets the listOfErrors after checking the model.
protected void	logFailure(int code, int severity, int category, int line, int column, java.lang.String pkg, java.lang.String msg, java.lang.String shortMsg)	Logs an error when checking the given model.

Methods inherited from class java.lang.Object

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

Field Detail

listOfErrors

protected java.util.List<org.sbml.jsbml.SBMLError> listOfErrors

This is used to track SBMLErrors that are detected in the model.

model

protected org.sbml.jsbml.Model model

A Model to be checked.

Constructor Detail

ArraysConstraint

public ArraysConstraint()

Constructs an ArraysConstraint.

ArraysConstraint

public ArraysConstraint(org.sbml.jsbml.Model model)

Constructs an ArraysConstraint with a model.

Parameters:

model - a core Model

Method Detail

check

public abstract void check()

Checks if the given model doesn't violate the constraint specified by this object.

getListOfErrors

public java.util.List<org.sbml.jsbml.SBMLError> getListOfErrors()

Gets the listOfErrors after checking the model.

Returns:

the list of SBMLErrors after checking the model.

logFailure

protected void logFailure(int code,
                          int severity,
                          int category,
                          int line,
                          int column,
                          java.lang.String pkg,
                          java.lang.String msg,
                          java.lang.String shortMsg)

Logs an error when checking the given model.

Parameters:

code - the error code

severity - the error severity

category - the error category

line - the line number

column - the column number

pkg - the SBML package the SBMLError belong to.

msg - the message

shortMsg - the short message