org.sbml.jsbml

Interface SBaseWithUnit

All Superinterfaces:

Cloneable, SBase, SBaseWithDerivedUnit, Serializable, TreeNode, TreeNodeWithChangeSupport

All Known Implementing Classes:

AbstractNamedSBaseWithUnit, AssignmentRule, Compartment, CoordinateComponent, Event, ExplicitRule, KineticLaw, LocalParameter, Parameter, QuantityWithUnit, RateRule, Species, Symbol

public interface SBaseWithUnit
extends SBaseWithDerivedUnit

Defines a kind of SBase that is equipped with a defined unit. This means, instances of this interface have a derived unit and a defined unit and provide methods to manipulate the kind of Unit or UnitDefinition associated with this data type.

Since:

0.8

Version:

$Rev: 2109 $

Author:

Andreas Dräger

Last modified:

2010-12-15

Method Summary

Methods

Modifier and Type	Method and Description
String	getUnits()
UnitDefinition	getUnitsInstance()
boolean	isSetUnits()
boolean	isSetUnitsInstance() Checks whether the element referenced by the unitsID attribute of this SBaseWithUnit is either an existing base Unit, i.e., a simple Unit that can directly be addressed via its Unit.Kind element, or the identifier of an existing UnitDefinition in the Model to which this SBaseWithUnit belongs.
void	setUnits(String units) Sets the unitsID of this SBaseWithUnit.
void	setUnits(Unit.Kind unitKind) Sets the unit of this SBaseWithUnit.
void	setUnits(Unit unit) Sets the Unit of this SBaseWithUnit.
void	setUnits(UnitDefinition units) Set the unit attribute of this SBaseWithUnit to the given unit definition.
void	unsetUnits() Sets the unitsID of this SBaseWithUnit to null.

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, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hashCode, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, readAttribute, registerChild, removeCVTerm, removeCVTerm, removeTreeNodeChangeListener, setAnnotation, setAnnotation, setAnnotation, setHistory, setLevel, setMetaId, setNotes, setNotes, setPackageVersion, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, 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

getUnits

String getUnits()

Returns:

the unitsID of this SBaseWithUnit. The empty String if it is not set.

getUnitsInstance

UnitDefinition getUnitsInstance()

Returns:

The UnitDefinition instance which has the unitsID of this SBaseWithUnit as id. Null if it doesn't exist. In case that the unit of this SBaseWithUnit represents a base Unit, a new UnitDefinition will be created and returned by this method. This new UnitDefinition will only contain the one unit represented by the unit identifier in this SBaseWithUnit. Note that the corresponding model will not contain this UnitDefinition. The identifier of this new UnitDefinition will be set to the same value as the name of the base Unit.

isSetUnits

boolean isSetUnits()

Returns:

true if the unitsID of this element is not null.

isSetUnitsInstance

boolean isSetUnitsInstance()

Checks whether the element referenced by the unitsID attribute of this SBaseWithUnit is either an existing base Unit, i.e., a simple Unit that can directly be addressed via its Unit.Kind element, or the identifier of an existing UnitDefinition in the Model to which this SBaseWithUnit belongs.

Returns:

true if either a UnitDefinition, which has the unitsID of this SBaseWithUnit, can be found in the Model to which this SBaseWithUnit belongs, or if this element's unitsID as a corresponding base Unit for the given Level/Version combination.

setUnits

void setUnits(String units)

Sets the unitsID of this SBaseWithUnit. Only valid unit kind names or identifiers of already existing UnitDefinitions are allowed arguments of this function.

Parameters:

units - the identifier of an already existing UnitDefinition or an Unit.Kind identifier for the current level/version combination of this unit. Passing a null value to this method is equivalent to calling unsetUnits().

setUnits

void setUnits(Unit unit)

Sets the Unit of this SBaseWithUnit.

Parameters:

unit -

setUnits

void setUnits(Unit.Kind unitKind)

Sets the unit of this SBaseWithUnit. A new unit will be created base on this kind.

Parameters:

unitKind -

setUnits

void setUnits(UnitDefinition units)

Set the unit attribute of this SBaseWithUnit to the given unit definition.

Parameters:

units -

unsetUnits

void unsetUnits()

Sets the unitsID of this SBaseWithUnit to null.