org.sbml.jsbml.validator.offline.constraints

Interface ConstraintDeclaration

All Known Implementing Classes:

AbstractConstraintDeclaration, AlgebraicRuleConstraints, AssignmentConstraints, AssignmentRuleConstraints, ASTNodeConstraints, CompartmentConstraints, CompartmentTypeConstraints, ConstraintConstraints, DelayConstraints, EventAssignmentConstraints, EventConstraints, ExplicitRuleConstraints, FunctionDefinitionConstraints, InitialAssignmentConstraints, KineticLawConstraints, LocalParameterConstraints, MathContainerConstraints, ModelConstraints, ParameterConstraints, PriorityConstraints, RateRuleConstraints, ReactionConstraints, RuleConstraints, SBaseConstraints, SBaseWithDerivedUnitConstraints, SBaseWithUnitConstraints, SBMLDocumentConstraints, SimpleSpeciesReferenceConstraints, SpeciesConstraints, SpeciesReferenceConstraints, SpeciesTypeConstraints, TreeNodeConstraints, TriggerConstraints, UnitConstraints, UnitDefinitionConstraints

public interface ConstraintDeclaration

Basic interface for constraint declarations. If you want to provide constraints for a custom class, consider to inherit from AbstractConstraintDeclaration instead. This abstract class has already a working implementation of most of the methods and supports caching

Since:

1.2

Author:

Roman

See Also:

AbstractConstraintDeclaration

Method Summary

Modifier and Type	Method and Description
void	addErrorCodesForAttribute(java.util.Set<java.lang.Integer> set, int level, int version, java.lang.String attributeName) Adds all error codes which are needed for a check the attribute to the set.
void	addErrorCodesForCheck(java.util.Set<java.lang.Integer> set, int level, int version, SBMLValidator.CHECK_CATEGORY category) Adds all error codes which are needed for a check in this category to the set.
<T> AnyConstraint<T>	createConstraint(int errorCode) Tries to create the constraint with the given error code
<T> ConstraintGroup<T>	createConstraints(int[] errorCodes) Tries to create the constraints with the given error codes
AnyConstraint<?>	createConstraints(int level, int version, SBMLValidator.CHECK_CATEGORY category) Creates all the constraints which are needed to validate this category in the given level and version of SBML.
<T> ConstraintGroup<T>	createConstraints(int level, int version, SBMLValidator.CHECK_CATEGORY[] categories) Creates all the constraints which are needed to validate the categories in the given level and version of SBML.
<T> ConstraintGroup<T>	createConstraints(int level, int version, java.lang.String attributeName) Creates all the constraints which are needed to validate the attribute in the given level and version of SBML.

Method Detail

createConstraints

<T> ConstraintGroup<T> createConstraints(int level,
                                         int version,
                                         SBMLValidator.CHECK_CATEGORY[] categories)

Creates all the constraints which are needed to validate the categories in the given level and version of SBML.

Parameters:

level -

version -

categories -

Returns:

A ConstraintGroup with at least 1 member or null if no constraint was loaded

See Also:

#createConstraints(int, int, CHECK_CATEGORY)

createConstraints

AnyConstraint<?> createConstraints(int level,
                                   int version,
                                   SBMLValidator.CHECK_CATEGORY category)

Creates all the constraints which are needed to validate this category in the given level and version of SBML.

Parameters:

level -

version -

categories -

Returns:

A ConstraintGroup with at least 1 member or null if no constraint was loaded

See Also:

#createConstraints(int, int, CHECK_CATEGORY[])

createConstraints

<T> ConstraintGroup<T> createConstraints(int level,
                                         int version,
                                         java.lang.String attributeName)

Creates all the constraints which are needed to validate the attribute in the given level and version of SBML. This should only be error codes which refer to a error with severities SBMLError.SEVERITY.ERROR or SBMLError.SEVERITY.FATAL.

Parameters:

level -

version -

categories -

Returns:

A ConstraintGroup with at least 1 member or null if no constraint was loaded

See Also:

#createConstraints(int, int, CHECK_CATEGORY[])

addErrorCodesForCheck

void addErrorCodesForCheck(java.util.Set<java.lang.Integer> set,
                           int level,
                           int version,
                           SBMLValidator.CHECK_CATEGORY category)

Adds all error codes which are needed for a check in this category to the set.

Parameters:

set -

level -

version -

category -

addErrorCodesForAttribute

void addErrorCodesForAttribute(java.util.Set<java.lang.Integer> set,
                               int level,
                               int version,
                               java.lang.String attributeName)

Adds all error codes which are needed for a check the attribute to the set.

Parameters:

set -

level -

version -

category -

createConstraints

<T> ConstraintGroup<T> createConstraints(int[] errorCodes)

Tries to create the constraints with the given error codes

Parameters:

errorCodes -

Returns:

A ConstraintGroup with at least 1 member or null if no constraint was loaded

See Also:

createConstraint(int)

createConstraint

<T> AnyConstraint<T> createConstraint(int errorCode)

Tries to create the constraint with the given error code

Parameters:

errorCode -

Returns:

@link AnyConstraint} or null if no constraint was loaded

See Also:

createConstraint(int)