org.sbml.jsbml

Interface MathContainer

All Superinterfaces:

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

All Known Subinterfaces:

Assignment

All Known Implementing Classes:

AbstractMathContainer, AlgebraicRule, AssignmentRule, Constraint, Delay, EventAssignment, ExplicitRule, FunctionDefinition, InitialAssignment, KineticLaw, Priority, RateRule, Rule, SBMLLevel1Rule, StoichiometryMath, Trigger

public interface MathContainer
extends SBaseWithDerivedUnit

Base interface for all the SBML components which contain MathML nodes.

Since:

0.8

Version:

$Rev$

Author:

Andreas Dräger

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFormula() Deprecated. As this is part of SBML Level 1, it is strongly recommended not to work with the String representation of a formula, but to deal with a more flexible ASTNode.
ASTNode	getMath() If isSetMath() returns true, this method returns the ASTNode belonging to this MathContainer.
java.lang.String	getMathMLString() If isSetMath() returns true, this method returns the corresponding MathML String, otherwise an empty String will be returned.
boolean	isSetMath() Checks if an ASTNode has been set for this MathContainer.
void	setFormula(java.lang.String formula) Deprecated. As this is part of SBML Level 1, it is strongly recommended not to work with the String representation of a formula, but to deal with a more flexible ASTNode. Please use ASTNode.parseFormula(String) to create an ASTNode object from your formula String.
void	setMath(ASTNode math) Sets the math ASTNode of this MathContainer to the given value.
void	unsetFormula() Deprecated. use unsetMath()
void	unsetMath() Sets the current ASTNode math element of this MathContainer to null and notifies all TreeNodeChangeListeners assigned to this object about this change.

Methods inherited from interface org.sbml.jsbml.SBaseWithDerivedUnit

containsUndeclaredUnits, getDerivedUnitDefinition, getDerivedUnits

Methods inherited from interface org.sbml.jsbml.SBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendAnnotation, appendAnnotation, appendNotes, appendNotes, clone, createPlugin, disablePackage, enablePackage, enablePackage, equals, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getId, getLevel, getLevelAndVersion, getMetaId, getModel, getName, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hashCode, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isIdMandatory, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetId, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetName, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, readAttribute, registerChild, removeCVTerm, removeCVTerm, removeTreeNodeChangeListener, setAnnotation, setAnnotation, setAnnotation, setHistory, setId, setLevel, setMetaId, setName, setNotes, setNotes, setPackageVersion, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetId, unsetMetaId, unsetName, unsetNotes, unsetPlugin, unsetSBOTerm, writeXMLAttributes

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

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

Methods inherited from interface javax.swing.tree.TreeNode

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

Method Detail

getFormula

@Deprecated
java.lang.String getFormula()

Deprecated. As this is part of SBML Level 1, it is strongly recommended not to work with the String representation of a formula, but to deal with a more flexible ASTNode.

Converts this MathContainer's internal ASTNode to a C-like String according to the SBML Level 1 specifications and returns it.

Returns:

the math ASTNode of this object as a String. It returns the empty String if the math ASTNode is not set.

See Also:

getMath()

getMath

ASTNode getMath()

If isSetMath() returns true, this method returns the ASTNode belonging to this MathContainer.

Returns:

the math ASTNode of this object. It return null if the math ASTNode is not set.

getMathMLString

java.lang.String getMathMLString()

If isSetMath() returns true, this method returns the corresponding MathML String, otherwise an empty String will be returned.

Returns:

the MathML representation of this MathContainer's math element.

isSetMath

boolean isSetMath()

Checks if an ASTNode has been set for this MathContainer.

Returns:

true if the math ASTNode of this object is not null.

setFormula

@Deprecated
void setFormula(java.lang.String formula)
                     throws ParseException

Deprecated. As this is part of SBML Level 1, it is strongly recommended not to work with the String representation of a formula, but to deal with a more flexible ASTNode. Please use ASTNode.parseFormula(String) to create an ASTNode object from your formula String.

Sets the mathematical expression of this MathContainer instance to the given formula. This method parses the given String and stores the result in an ASTNode object.

Parameters:

formula - a C-like String according to the definition in the SBML Level 1 specifications.

Throws:

ParseException - If the given formula is invalid or cannot be parsed properly.

PropertyNotAvailableException - When trying to set this attribute and the Level is set to a value other than 1, this will throw an error.

setMath

void setMath(ASTNode math)

Sets the math ASTNode of this MathContainer to the given value.

Parameters:

math - an abstract syntax tree.

unsetFormula

@Deprecated
void unsetFormula()

Deprecated. use unsetMath()

unsetMath

void unsetMath()

Sets the current ASTNode math element of this MathContainer to null and notifies all TreeNodeChangeListeners assigned to this object about this change.