org.sbml.jsbml.validator.offline

Class LoggingValidationContext

java.lang.Object

org.sbml.jsbml.validator.offline.ValidationContext

org.sbml.jsbml.validator.offline.LoggingValidationContext

All Implemented Interfaces:

ValidationListener

public class LoggingValidationContext
extends ValidationContext
implements ValidationListener

A subclass of ValidationContext which implements the ValidationListener interface to track his own validation process.

A instance of this class creates a SBMLErrorLog which contains a SBMLError object for every broken constraint.

The level and version parameter are used to determine which rules will be checked.

For more informations about the SBML specifications look up sbml.org

Since:

1.2

Author:

Roman

Field Summary

Fields

Modifier and Type	Field and Description
private SBMLErrorLog	log

Fields inherited from class org.sbml.jsbml.validator.offline.ValidationContext

logger

Constructor Summary

Constructors

Constructor and Description
LoggingValidationContext(int level, int version)
LoggingValidationContext(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	clear() Clears the loaded constraints
void	clearErrorLog() Clears the error log.
void	didValidate(ValidationContext ctx, AnyConstraint<?> c, java.lang.Object o, boolean success) This function will be called after the constraint c had validate the object o.
SBMLErrorLog	getErrorLog() Gets the SBMLErrorLog of this context.
private void	logFailure(int id)
void	willValidate(ValidationContext ctx, AnyConstraint<?> c, java.lang.Object o) This function will be called before the constraint will validate the object.

Methods inherited from class org.sbml.jsbml.validator.offline.ValidationContext

addValidationListener, didValidate, enableCheckCategories, enableCheckCategory, getCheckCategories, getConstraintType, getHashMap, getLevel, getLevelAndVersion, getRootConstraint, getValidateRecursivly, getVersion, isLevelAndVersionEqualTo, isLevelAndVersionGreaterEqualThan, isLevelAndVersionGreaterThan, isLevelAndVersionLesserEqualThan, isLevelAndVersionLessThan, loadConstraints, loadConstraints, loadConstraints, loadConstraintsForAttribute, removeValidationListener, setLevel, setLevelAndVersion, setRootConstraint, setValidateRecursivly, setVersion, validate, validate, willValidate

Methods inherited from class java.lang.Object

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

Field Detail

log

private SBMLErrorLog log

Constructor Detail

LoggingValidationContext

public LoggingValidationContext(int level,
                                int version)

LoggingValidationContext

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

Method Detail

clear

public void clear()

Description copied from class: ValidationContext

Clears the loaded constraints

Overrides:

clear in class ValidationContext

clearErrorLog

public void clearErrorLog()

Clears the error log.

getErrorLog

public SBMLErrorLog getErrorLog()

Gets the SBMLErrorLog of this context.

Returns:

logFailure

private void logFailure(int id)

willValidate

public void willValidate(ValidationContext ctx,
                         AnyConstraint<?> c,
                         java.lang.Object o)

Description copied from interface: ValidationListener

This function will be called before the constraint will validate the object.

Specified by:

willValidate in interface ValidationListener

didValidate

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

Description copied from interface: ValidationListener

This function will be called after the constraint c had validate the object o.

Specified by:

didValidate in interface ValidationListener