org.sbml.jsbml

Interface Assignment

All Superinterfaces:

java.lang.Cloneable, MathContainer, SBase, SBaseWithDerivedUnit, java.io.Serializable, javax.swing.tree.TreeNode, TreeNodeWithChangeSupport

All Known Implementing Classes:

AssignmentRule, EventAssignment, ExplicitRule, InitialAssignment, RateRule, SBMLLevel1Rule

public interface Assignment
extends MathContainer

An Assignment can be seen as a mathematical equation with a Variable on the left hand side and an equation on the right hand side that assigns a value to the Variable.

Since:

0.8

Version:

$Rev: 1639 $

Author:

Andreas Dräger

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ILLEGAL_CONSTANT_VARIABLE_MSG Error message to be displayed in case that a Variable with constant property set to true is to be assigned to this Assignment.
static java.lang.String	ILLEGAL_VARIABLE_EXCEPTION_MSG Error message to indicate that a SpeciesReference cannot be used as the Variable in this Assignment because the SBML Level < 3.
static java.lang.String	NO_SUCH_VARIABLE_EXCEPTION_MSG Message to be displayed if no Variable can be found in the associated Model that would have the desired identifier.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getVariable() Returns the variableID of this Assignment.
Variable	getVariableInstance() Returns the Variable instance which has the variableID of this Assignment as id.
boolean	isSetVariable() Returns true if the variableID of this Assignment is not null.
boolean	isSetVariableInstance() Returns true if the Variable instance which has the variableID of this Assignment as id is not null.
void	setVariable(java.lang.String variableID) Sets the variableID of this Assignment to the given value.
void	setVariable(Variable variable) Sets the variableID of this Assignment to the id of the Variable 'variable'.Listeners are notified about this change.
void	unsetVariable() Removes the reference from this InitialAssignment to its Variable if there was any, i.e., the Variable is set to null.

Methods inherited from interface org.sbml.jsbml.MathContainer

getFormula, getMath, getMathMLString, isSetMath, setFormula, setMath, unsetFormula, unsetMath

Methods inherited from interface org.sbml.jsbml.SBaseWithDerivedUnit

containsUndeclaredUnits, getDerivedUnitDefinition, getDerivedUnits

Methods inherited from interface org.sbml.jsbml.SBase

addCVTerm, addDeclaredNamespace, addExtension, appendNotes, appendNotes, clone, createPlugin, disablePackage, enablePackage, enablePackage, equals, filterCVTerms, filterCVTerms, filterCVTerms, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementName, getExtension, getExtensionPackages, getHistory, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getVersion, hashCode, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, readAttribute, registerChild, removeTreeNodeChangeListener, setAnnotation, setHistory, setLevel, setMetaId, setNotes, setNotes, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregister, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, unsetNotes, unsetPlugin, unsetSBOTerm, writeXMLAttributes

Methods inherited from interface org.sbml.jsbml.util.TreeNodeWithChangeSupport

addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, fireNodeRemovedEvent, firePropertyChange, getListOfTreeNodeChangeListeners, getRoot, getTreeNodeChangeListenerCount, getUserObject, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeUserObject, userObjectKeySet

Methods inherited from interface javax.swing.tree.TreeNode

children, getAllowsChildren, getChildAt, getChildCount, getIndex, getParent, isLeaf

Field Detail

ILLEGAL_VARIABLE_EXCEPTION_MSG

static final java.lang.String ILLEGAL_VARIABLE_EXCEPTION_MSG

Error message to indicate that a SpeciesReference cannot be used as the Variable in this Assignment because the SBML Level < 3.

See Also:

Constant Field Values

ILLEGAL_CONSTANT_VARIABLE_MSG

static final java.lang.String ILLEGAL_CONSTANT_VARIABLE_MSG

Error message to be displayed in case that a Variable with constant property set to true is to be assigned to this Assignment.

See Also:

Constant Field Values

NO_SUCH_VARIABLE_EXCEPTION_MSG

static final java.lang.String NO_SUCH_VARIABLE_EXCEPTION_MSG

Message to be displayed if no Variable can be found in the associated Model that would have the desired identifier.

See Also:

Constant Field Values

Method Detail

getVariable

java.lang.String getVariable()

Returns the variableID of this Assignment. Returns an empty String if it is not set.

Returns:

the variableID of this Assignment. Returns an empty String if it is not set.

getVariableInstance

Variable getVariableInstance()

Returns the Variable instance which has the variableID of this Assignment as id. Return null if it doesn't exist.

Returns:

the Variable instance which has the variableID of this Assignment as id. Return null if it doesn't exist.

isSetVariable

boolean isSetVariable()

Returns true if the variableID of this Assignment is not null.

Returns:

true if the variableID of this Assignment is not null.

isSetVariableInstance

boolean isSetVariableInstance()

Returns true if the Variable instance which has the variableID of this Assignment as id is not null.

Returns:

true if the Variable instance which has the variableID of this Assignment as id is not null.

setVariable

void setVariable(java.lang.String variableID)

Sets the variableID of this Assignment to the given value. Listeners are notified about this change.

Parameters:

variableID - the variable to set

setVariable

void setVariable(Variable variable)

Sets the variableID of this Assignment to the id of the Variable 'variable'.Listeners are notified about this change.

Parameters:

variable - the variable to set

unsetVariable

void unsetVariable()

Removes the reference from this InitialAssignment to its Variable if there was any, i.e., the Variable is set to null. Listeners are notified about this change.