org.sbml.jsbml

Interface SBaseWithDerivedUnit

All Superinterfaces:

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

All Known Subinterfaces:

Assignment, CallableSBase, MathContainer, NamedSBaseWithDerivedUnit, Quantity, SBaseWithUnit, Variable

All Known Implementing Classes:

AbstractMathContainer, AbstractNamedSBaseWithUnit, AlgebraicRule, AssignmentRule, Compartment, Constraint, Delay, Event, EventAssignment, ExplicitRule, FunctionDefinition, InitialAssignment, KineticLaw, LocalParameter, Parameter, Priority, QuantityWithUnit, RateRule, Reaction, Rule, SBMLLevel1Rule, Species, SpeciesReference, StoichiometryMath, Symbol, Trigger

public interface SBaseWithDerivedUnit
extends SBase

This type represents an SBase object that is associated to a unit. This may be a directly defined unit or a unit that has to be derived by evaluating other elements within this object.

Since:

0.8

Version:

$Rev$

Author:

Andreas Dräger, Nicolas Rodriguez

Method Summary

Modifier and Type	Method and Description
boolean	containsUndeclaredUnits() Returns true or false depending on whether this SBaseWithDerivedUnit refers to elements such as parameters or numbers with undeclared units.
UnitDefinition	getDerivedUnitDefinition() Derives the unit of this quantity and tries to identify an equivalent UnitDefinition within the corresponding Model.
java.lang.String	getDerivedUnits() Derives the unit of this quantity.

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

containsUndeclaredUnits

boolean containsUndeclaredUnits()

Returns true or false depending on whether this SBaseWithDerivedUnit refers to elements such as parameters or numbers with undeclared units. A return value of true indicates that the UnitDefinition returned by getDerivedUnitDefinition() may not accurately represent the units of the expression.

Returns:

true if the math expression of this SBaseWithDerivedUnit includes parameters/numbers with undeclared units, false otherwise.

getDerivedUnitDefinition

UnitDefinition getDerivedUnitDefinition()

Derives the unit of this quantity and tries to identify an equivalent UnitDefinition within the corresponding Model. If no equivalent unit definition can be found, a new unit definition will be created that is not part of the model but represents the unit of this quantity. If it is not possible to derive a unit for this quantity, null will be returned.

Returns:

a UnitDefinition that represent the derived unit of this quantity, or null if it is not possible to derive a unit.

getDerivedUnits

java.lang.String getDerivedUnits()

Derives the unit of this quantity. If the model that contains this quantity already contains a unit that is equivalent to the derived unit, the corresponding identifier will be returned. In case that the unit cannot be derived or that no equivalent unit exists within the model, or if the model has not been defined yet, null will be returned. In case that this quantity represents a basic Unit.Kind this method will return the String representation of this Unit.Kind.

Returns:

a String that represent the id of a UnitDefinition. This UnitDefinition represent the derived unit of this quantity. If it is not possible to derive a unit for this quantity or if no equivalent UnitDefinition can be found in the Model, null is returned.