org.sbml.jsbml.validator.offline

Class ValidationContext

java.lang.Object

org.sbml.jsbml.validator.offline.ValidationContext

Direct Known Subclasses:

LoggingValidationContext

public class ValidationContext
extends java.lang.Object

A ValidationContext object is used to perform offline validation.

To prepare the context for the validation use the loadConstraints(Class) method, which will loads all the required constraints to validate a object from this class. By default the context will try to validate recursive by searching for the TreeNode interface. This behavior can be changed with setValidateRecursivly(boolean).

To start the validation process call validate(Object) with a object which is a instance of the class for which the constraints were loaded. If not constraints were loaded or the object doesn't match the class, no validation process is started.

To track the validation process in real-time you can add a ValidationListener to this context by using the addValidationListener(ValidationListener) method.

The level and version parameter determine which SBML specifications are used. For more informations look up sbml.org

Since:

1.2

Version:

$Rev$

Author:

Roman

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Set<SBMLValidator.CHECK_CATEGORY>	categories
private java.lang.Class<?>	constraintType
private java.util.HashMap<java.lang.String,java.lang.Object>	hashMap
private int	level
private java.util.Set<ValidationListener>	listener
protected static org.apache.log4j.Logger	logger Log4j logger
private boolean	recursiv
private AnyConstraint<java.lang.Object>	rootConstraint
private int	version

Constructor Summary

Constructors

Constructor and Description
ValidationContext(int level, int version)
ValidationContext(int level, int version, AnyConstraint<java.lang.Object> rootConstraint, java.util.Set<SBMLValidator.CHECK_CATEGORY> categories)

Method Summary

Modifier and Type	Method and Description
void	addValidationListener(ValidationListener listener) Adds a ValidationListener.
void	clear() Clears the loaded constraints
void	didValidate(AnyConstraint<?> constraint, java.lang.Object o, boolean success) Will be called every time before a constraints starts his tests.
void	enableCheckCategories(SBMLValidator.CHECK_CATEGORY[] categories, boolean enable) Calls #enableCheckCategory(CheckCategory, boolean) for every CheckCategory in the array.
void	enableCheckCategory(SBMLValidator.CHECK_CATEGORY category, boolean enable) Enables or disables the selected category.
SBMLValidator.CHECK_CATEGORY[]	getCheckCategories() Returns the list of all enabled check categories.
java.lang.Class<?>	getConstraintType() Gets the Class on which the root constraint is typed.
java.util.HashMap<java.lang.String,java.lang.Object>	getHashMap() Constraints can use this HashMap to store additional information.
int	getLevel() Returns the used level of SBML
ValuePair<java.lang.Integer,java.lang.Integer>	getLevelAndVersion() This value determines which constraints will be loaded and in which way broken constraints will be logged.
AnyConstraint<java.lang.Object>	getRootConstraint() Returns the root constraint from this context.
boolean	getValidateRecursivly() Returns true if the validation also validate every child of a TreeNode
int	getVersion() Returns the used version of SBML
boolean	isLevelAndVersionEqualTo(int level, int version) Checks if the level and version of this context are both the same as the given values.
boolean	isLevelAndVersionGreaterEqualThan(int level, int version) Checks if the level and version of this context is greater or equal to the given values.
boolean	isLevelAndVersionGreaterThan(int level, int version) Checks if the level and version of this context is greater than the given level and version.
boolean	isLevelAndVersionLesserEqualThan(int level, int version) Checks if the level and version of this context is lesser or equal to the given values.
boolean	isLevelAndVersionLessThan(int level, int version) Checks if the level and version of this context is less then the given level and version.
void	loadConstraints(java.lang.Class<?> clazz) Loads the constraints to validate a Object from the class.
void	loadConstraints(java.lang.Class<?> clazz, int level, int version) Sets the level and version and loads the constraints.
void	loadConstraints(java.lang.Class<?> clazz, int level, int version, SBMLValidator.CHECK_CATEGORY[] categories)
void	loadConstraintsForAttribute(java.lang.Class<?> clazz, java.lang.String attributeName) Validates a single attribute.
boolean	removeValidationListener(ValidationListener listener) Removes a ValidationListener from this context.
void	setLevel(int level) Calls setLevelAndVersion(int, int)
void	setLevelAndVersion(int level, int version) Sets the level/version and clears the root constraint if one of these values differs from the current values.
void	setRootConstraint(AnyConstraint<java.lang.Object> rootConstraint, java.lang.Class<?> constraintType)
void	setValidateRecursivly(boolean recursiv) If set to true, the validation context will try to validate also the childs of a TreeNode interface.
void	setVersion(int version) Set the version of the context and clears the root constraint.
boolean	validate(java.lang.Object o) Validates the object against the loaded constraints.
boolean	validate(java.lang.Object o, boolean clearMap) Validates the object with the loaded constraints and clears the HashMap afterwards if the clearMap is set true.
void	willValidate(AnyConstraint<?> constraint, java.lang.Object o)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final transient org.apache.log4j.Logger logger

Log4j logger

rootConstraint

private AnyConstraint<java.lang.Object> rootConstraint

categories

private java.util.Set<SBMLValidator.CHECK_CATEGORY> categories

constraintType

private java.lang.Class<?> constraintType

listener

private java.util.Set<ValidationListener> listener

hashMap

private java.util.HashMap<java.lang.String,java.lang.Object> hashMap

level

private int level

version

private int version

recursiv

private boolean recursiv

Constructor Detail

ValidationContext

public ValidationContext(int level,
                         int version)

ValidationContext

public ValidationContext(int level,
                         int version,
                         AnyConstraint<java.lang.Object> rootConstraint,
                         java.util.Set<SBMLValidator.CHECK_CATEGORY> categories)

Method Detail

addValidationListener

public void addValidationListener(ValidationListener listener)

Adds a ValidationListener. A ValidationContext can have multiple listeners and every attached listener will receive the events from the validation.

Parameters:

listener -

clear

public void clear()

Clears the loaded constraints

didValidate

public void didValidate(AnyConstraint<?> constraint,
                        java.lang.Object o,
                        boolean success)

Will be called every time before a constraints starts his tests.

Parameters:

constraint -

o -

success -

enableCheckCategory

public void enableCheckCategory(SBMLValidator.CHECK_CATEGORY category,
                                boolean enable)

Enables or disables the selected category.

The enabled categories determines which constraints will be loaded in #loadConstraints(Class, int, int, CheckCategory[]). This function won't change the root constraint.

Parameters:

catergoy -

enable -

See Also:

#loadConstraints(Class, int, int, CheckCategory[])

enableCheckCategories

public void enableCheckCategories(SBMLValidator.CHECK_CATEGORY[] categories,
                                  boolean enable)

Calls #enableCheckCategory(CheckCategory, boolean) for every CheckCategory in the array.

Parameters:

categories -

enable -

See Also:

CheckCategory

loadConstraints

public void loadConstraints(java.lang.Class<?> clazz)

Loads the constraints to validate a Object from the class. Uses the CheckCategories, level and version of this context. Resets the root constraint.

Parameters:

clazz -

loadConstraints

public void loadConstraints(java.lang.Class<?> clazz,
                            int level,
                            int version)

Sets the level and version and loads the constraints.

Parameters:

cclass -

level -

version -

See Also:

loadConstraints(Class)

loadConstraints

public void loadConstraints(java.lang.Class<?> clazz,
                            int level,
                            int version,
                            SBMLValidator.CHECK_CATEGORY[] categories)

Parameters:

class -

level -

version -

categories -

loadConstraintsForAttribute

public void loadConstraintsForAttribute(java.lang.Class<?> clazz,
                                        java.lang.String attributeName)

Validates a single attribute. The object must have set the new value already.

Parameters:

pkg -

attributeName -

object -

getCheckCategories

public SBMLValidator.CHECK_CATEGORY[] getCheckCategories()

Returns the list of all enabled check categories.

Returns:

getConstraintType

public java.lang.Class<?> getConstraintType()

Gets the Class on which the root constraint is typed.

Returns:

getHashMap

public java.util.HashMap<java.lang.String,java.lang.Object> getHashMap()

Constraints can use this HashMap to store additional information.

Notice that this method doesn't return a copy, but a reference to the actual instance.

Returns:

Reference of HashMap

getLevel

public int getLevel()

Returns the used level of SBML

Returns:

a positive int

See Also:

getVersion(), getLevelAndVersion()

getLevelAndVersion

public ValuePair<java.lang.Integer,java.lang.Integer> getLevelAndVersion()

This value determines which constraints will be loaded and in which way broken constraints will be logged.

Returns:

the level and version this validation context used.

See Also:

getLevel(), getVersion()

getRootConstraint

public AnyConstraint<java.lang.Object> getRootConstraint()

Returns the root constraint from this context. The value may be null if no constraint was loaded. The AnyConstraint.check(ValidationContext, Object) will be called in validate(Object)

Returns:

the root constraint or null if no constraints were loaded

See Also:

#loadConstraints(Class, int, int, CheckCategory[])

getVersion

public int getVersion()

Returns the used version of SBML

Returns:

a positive int

See Also:

getLevel(), getLevelAndVersion()

getValidateRecursivly

public boolean getValidateRecursivly()

Returns true if the validation also validate every child of a TreeNode

Returns:

isLevelAndVersionLessThan

public boolean isLevelAndVersionLessThan(int level,
                                         int version)

Checks if the level and version of this context is less then the given level and version. A level and version pair is less if either the level is smaller or the level is equal but the version is smaller.

Parameters:

level -

version -

Returns:

isLevelAndVersionGreaterThan

public boolean isLevelAndVersionGreaterThan(int level,
                                            int version)

Checks if the level and version of this context is greater than the given level and version. A level and version pair is greater if either the level is smaller or the level is equal but the version is smaller.

Parameters:

level -

version -

Returns:

isLevelAndVersionEqualTo

public boolean isLevelAndVersionEqualTo(int level,
                                        int version)

Checks if the level and version of this context are both the same as the given values.

Parameters:

level -

version -

Returns:

isLevelAndVersionGreaterEqualThan

public boolean isLevelAndVersionGreaterEqualThan(int level,
                                                 int version)

Checks if the level and version of this context is greater or equal to the given values.

Parameters:

level -

version -

Returns:

See Also:

isLevelAndVersionGreaterThan(int, int), isLevelAndVersionEqualTo(int, int)

isLevelAndVersionLesserEqualThan

public boolean isLevelAndVersionLesserEqualThan(int level,
                                                int version)

Checks if the level and version of this context is lesser or equal to the given values.

Parameters:

level -

version -

Returns:

See Also:

isLevelAndVersionLessThan(int, int), isLevelAndVersionEqualTo(int, int)

removeValidationListener

public boolean removeValidationListener(ValidationListener listener)

Removes a ValidationListener from this context. Returns true if the listener was removed.

Parameters:

listener -

Returns:

setLevel

public void setLevel(int level)

Calls setLevelAndVersion(int, int)

Parameters:

level -

See Also:

setLevelAndVersion(int, int)

setLevelAndVersion

public void setLevelAndVersion(int level,
                               int version)

Sets the level/version and clears the root constraint if one of these values differs from the current values.

Parameters:

level -

version -

setRootConstraint

public void setRootConstraint(AnyConstraint<java.lang.Object> rootConstraint,
                              java.lang.Class<?> constraintType)

setValidateRecursivly

public void setValidateRecursivly(boolean recursiv)

If set to true, the validation context will try to validate also the childs of a TreeNode interface.

Parameters:

recursiv -

setVersion

public void setVersion(int version)

Set the version of the context and clears the root constraint.

Parameters:

version -

validate

public boolean validate(java.lang.Object o)

Validates the object against the loaded constraints.

Parameters:

o, - object to be validated

Returns:

true if no constraint was broken

validate

public boolean validate(java.lang.Object o,
                        boolean clearMap)

Validates the object with the loaded constraints and clears the HashMap afterwards if the clearMap is set true.

Parameters:

o -

clearMap, - clears HashMap after validation

Returns:

willValidate

public void willValidate(AnyConstraint<?> constraint,
                         java.lang.Object o)