UnitDefinition

java.lang.Object
- org.sbml.jsbml.AbstractTreeNode
- - org.sbml.jsbml.AbstractSBase
  - - org.sbml.jsbml.AbstractNamedSBase
    - - org.sbml.jsbml.UnitDefinition

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, javax.swing.tree.TreeNode, NamedSBase, SBase, TreeNodeWithChangeSupport
```
public class UnitDefinition
extends AbstractNamedSBase
```
Represents the unitDefinition XML element of a SBML file.

Since:

0.8

Author:

Andreas Dräger, Marine Dumousseau

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`AREA` Identifier of the (for SBML Level 2) predefined `UnitDefinition` `area`.
`static java.lang.String`	`BASE_UNIT_SUFFIX` The suffix used in `UnitDefinition` objects that represent a base `Unit.Kind` with offset = 0, multiplier = 1, scale = 0, and exponent = 1.
`static java.lang.String`	`EXTENT` Identifier of the (for SBML Level 3) `UnitDefinition` `extent`.
`static java.lang.String`	`LENGTH` Identifier of the (for SBML Level 2) predefined `UnitDefinition` `length`.
`private ListOf<Unit>`	`listOfUnits` Represents the 'listOfUnit' XML sub-element of a UnitDefinition.
`private static org.apache.log4j.Logger`	`logger` The logger for this class.
`static long`	`serialVersionUID` Generated serial version identifier.
`static java.lang.String`	`SUBSTANCE` Identifier of the (for the SBML Levels 1 and 2) predefined `UnitDefinition` `substance`.
`static java.lang.String`	`TIME` Identifier of the (for the SBML Levels 1 and 2) predefined `UnitDefinition` `time`.
`static java.lang.String`	`VOLUME` Identifier of the (for some SBML Levels 1 and 2) predefined `UnitDefinition` `volume`.

Fields inherited from class org.sbml.jsbml.AbstractSBase
ignoredExtensions, ignoredXMLElements, JSBML_WRONG_SBO_TERM, lv, packageName

Fields inherited from class org.sbml.jsbml.AbstractTreeNode
listOfListeners, parent, resourceBundle

Constructor Summary

Constructors
Constructor and Description
`UnitDefinition()` Creates an UnitDefinition instance.
`UnitDefinition(int level, int version)` Creates a new `UnitDefinition` instance.
`UnitDefinition(java.lang.String id)` Creates a new `UnitDefinition` instance.
`UnitDefinition(java.lang.String id, int level, int version)` Creates an `UnitDefinition` instance from an id, level and version.
`UnitDefinition(java.lang.String id, java.lang.String name, int level, int version)` Creates an `UnitDefinition` instance from an id, level and version.
`UnitDefinition(UnitDefinition unitDefinition)` Creates an `UnitDefinition` instance from a given UnitDefinition.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addUnit(java.lang.String unit)` Adds a new `Unit` instance, created from the given unit `Unit.Kind`, to this `UnitDefinition`.
`void`	`addUnit(Unit.Kind kind)` Adds a new `Unit` instance, with the given kind, to this `UnitDefinition`.
`void`	`addUnit(Unit u)` Adds a `Unit` to this `UnitDefinition`.
`static UnitDefinition`	`area(int level, int version)` Returns the predefined unit for area.
`static boolean`	`areCompatible(UnitDefinition ud1, UnitDefinition ud2)` Returns `true` or `false` depending on whether two UnitDefinition objects are compatible.
`static boolean`	`areEquivalent(UnitDefinition ud, java.lang.String units)` Checks whether the given `UnitDefinition` and the `UnitDefinition` or `Unit` represented by the given `String` are equivalent.
`static boolean`	`areEquivalent(UnitDefinition ud1, UnitDefinition ud2)` Returns true or false depending on whether two `UnitDefinition` objects are equivalent.
`static boolean`	`areIdentical(UnitDefinition ud1, UnitDefinition ud2)` Returns `true` or `false` depending on whether two `UnitDefinition` objects are identical.
`void`	`clear()` Removes all `Unit` elements from the list of Units in this object.
`UnitDefinition`	`clone()` Creates a deep copy of this object, i.e., a new `SBase` with the same properties like this one.
`void`	`convertToSIUnits()` This method converts this unit definition to a
`Unit`	`createInvalidUnit()` Creates a new `Unit` instance with the `Unit.Kind.INVALID` kind and adds it to this `UnitDefinition`.
`Unit`	`createUnit()` Creates a new `Unit` instance with the `Unit.Kind.INVALID` kind and adds it to this `UnitDefinition`.
`Unit`	`createUnit(Unit.Kind kind)` Creates a new `Unit` instance with the given `Unit.Kind` and adds it to this `UnitDefinition`.
`UnitDefinition`	`divideBy(UnitDefinition definition)` Divides this unit definition by the second unit definition.
`boolean`	`getAllowsChildren()`
`javax.swing.tree.TreeNode`	`getChildAt(int index)`
`int`	`getChildCount()`
`ListOf<Unit>`	`getListOfUnits()`
`int`	`getNumUnits()`
`ListOf<UnitDefinition>`	`getParent()` This is equivalent to calling `AbstractSBase.getParentSBMLObject()`, but this method is needed for `TreeNode`.
`static UnitDefinition`	`getPredefinedUnit(java.lang.String id, int level, int version)` Returns the predefined unit with the given identifier for the specified level and version combination or null if either for the given combination of level and version there is no such predefined unit or the identifier is not one of those belonging to the group of predefined unit definitions.
`Unit`	`getUnit(int i)` Returns a specific Unit instance belonging to this UnitDefinition.
`int`	`getUnitCount()`
`boolean`	`isBuiltIn()` Deprecated. use `isPredefined()`
`static boolean`	`isBuiltIn(UnitDefinition ud)` Deprecated. use `isPredefined()`
`boolean`	`isIdMandatory()` Returns `true` if the identifier of this `SBase` is required to be defined (i.e., not `null`) in the definition of SBML.
`boolean`	`isInvalid()` Checks if this UnitDefinition is invalid.
`boolean`	`isListOfUnitsEmpty()` Returns `true` if the listOfUnits is empty.
`boolean`	`isPredefined()` Tests if this unit definition is a predefined unit.
`static boolean`	`isPredefined(java.lang.String name, int level)` Tests if the given String is a predefined unit, meaning it is one of the five SBML predefined unit identifiers ('substance', 'volume', 'area', 'length' or 'time').
`static boolean`	`isPredefined(UnitDefinition ud)` Tests if the given unit is a predefined unit, meaning it is one of the five SBML predefined unit identifiers ('substance', 'volume', 'area', 'length' or 'time').
`boolean`	`isSetListOfUnits()` Returns `true` if the listOfUnits is not null and not empty.
`boolean`	`isUnitKind()` Tests whether this `UnitDefinition` contains exactly one `Unit` that itself represents a `Unit.Kind`, i.e., multiplier = 1, exponent = 1, scale = 1.
`boolean`	`isVariantOfArea()` Returns `true` if this UnitDefinition is a variant of Area
`boolean`	`isVariantOfDimensionless()` Tests if a given unit definition is a variant of the predefined unit identifier 'dimensionless'.
`boolean`	`isVariantOfLength()` Tests if a given unit definition is a variant of the predefined unit identifier 'length'.
`boolean`	`isVariantOfSubstance()` Tests if a given unit definition is a variant of the predefined unit identifier 'substance'.
`boolean`	`isVariantOfSubstancePerArea()` Tests if a given unit definition is a variant of the predefined unit identifier 'substance per area'.
`boolean`	`isVariantOfSubstancePerLength()` Tests if this UnitDefinition is a variant of substance per length.
`boolean`	`isVariantOfSubstancePerTime()` Tests if this UnitDefinition is a variant of substance per time.
`boolean`	`isVariantOfSubstancePerVolume()` Tests if this UnitDefinition is a variant of substance per volume.
`boolean`	`isVariantOfTime()` Tests if a given unit definition is a variant of the predefined unit identifier 'time'.
`boolean`	`isVariantOfVolume()` Tests if a given unit definition is a variant of the predefined unit identifier 'volume'.
`static UnitDefinition`	`length(int level, int version)` Returns the predefined unit for length.
`UnitDefinition`	`multiplyWith(UnitDefinition definition)` Multiplies this unit with the given unit definition, i.e., adds a clone of each unit object in the list of units of the given definition to the list of this unit.
`static java.lang.String`	`printUnits(UnitDefinition ud)` Returns a string that expresses the unit definition represented by this UnitDefinition object.
`static java.lang.String`	`printUnits(UnitDefinition ud, boolean compact)` Returns a string that expresses the unit definition represented by this UnitDefinition object.
`UnitDefinition`	`raiseByThePowerOf(double exponent)` Raises this unit definition by the power of the given exponent, i.e., the exponents of every unit contained by this unit definition are multiplied with the given exponent.
`Unit`	`removeUnit(int i)` Removes the nth `Unit` object from this `UnitDefinition` object and returns a pointer to it.
`static void`	`reorder(UnitDefinition ud)` Orders alphabetically the `Unit` objects within the `listOfUnits` of a `UnitDefinition`.
`void`	`setId(java.lang.String id)` Sets the id value with 'id'
`void`	`setListOfUnits(ListOf<Unit> listOfUnits)` Sets the `listOfUnits` of this `UnitDefinition`.
`UnitDefinition`	`simplify()` Simplifies the `UnitDefinition` so that any `Unit` objects occurring within the `listOfUnits` occurs only once.
`static UnitDefinition`	`simplify(UnitDefinition ud)` Returns a simplified version of the given `UnitDefinition`.
`static UnitDefinition`	`substance(int level, int version)` Returns the predefined unit for substance.
`static UnitDefinition`	`time(int level, int version)` Returns the predefined unit for time.
`java.lang.String`	`toString()` Returns a String representing this SBase with all the attributes that are defined.
`boolean`	`unsetListOfUnits()` Removes the `listOfUnits` from this `UnitDefinition` and notifies all registered instances of `TreeNodeChangeListener`.
`static UnitDefinition`	`volume(int level, int version)` Returns the predefined unit for volume.

Methods inherited from class org.sbml.jsbml.AbstractNamedSBase
isValidId

Methods inherited from class org.sbml.jsbml.AbstractSBase
addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendAnnotation, appendAnnotation, appendNotes, appendNotes, checkAndSetPackageNamespaceAndVersion, checkAndSetPackageNamespaceAndVersion, checkAttribute, checkIdentifier, checkLevelAndVersionCompatibility, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, equals, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getId, getIdManager, getLevel, getLevelAndVersion, getMetaId, getModel, getName, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hashCode, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetId, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetName, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, notifyChildChange, readAttribute, registerChild, removeCVTerm, removeCVTerm, setAnnotation, setAnnotation, setAnnotation, setHistory, setLevel, setLevelAndVersion, setMetaId, setName, setNamespace, setNotes, setNotes, setPackageNamespaceAndVersion, setPackageVersion, setParentSBML, setParentSBMLObject, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetId, unsetMetaId, unsetName, unsetNamespace, unsetNotes, unsetPlugin, unsetSBOTerm, writeXMLAttributes

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.sbml.jsbml.NamedSBase
getId, getName, isSetId, isSetName, setName, unsetId, unsetName

Methods inherited from interface org.sbml.jsbml.SBase
addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendAnnotation, appendAnnotation, appendNotes, appendNotes, createPlugin, disablePackage, enablePackage, enablePackage, equals, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, 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 javax.swing.tree.TreeNode
children, getIndex, isLeaf

- Field Detail
  - AREA
```
public static final java.lang.String AREA
```
    Identifier of the (for SBML Level 2) predefined UnitDefinition area.
    
    See Also:
    
    Constant Field Values
  - EXTENT
```
public static final java.lang.String EXTENT
```
    Identifier of the (for SBML Level 3) UnitDefinition extent.
    
    See Also:
    
    Constant Field Values
  - LENGTH
```
public static final java.lang.String LENGTH
```
    Identifier of the (for SBML Level 2) predefined UnitDefinition length.
    
    See Also:
    
    Constant Field Values
  - logger
```
private static final transient org.apache.log4j.Logger logger
```
    The logger for this class.
  - serialVersionUID
```
public static final long serialVersionUID
```
    Generated serial version identifier.
    
    See Also:
    
    Constant Field Values
  - SUBSTANCE
```
public static final java.lang.String SUBSTANCE
```
    Identifier of the (for the SBML Levels 1 and 2) predefined UnitDefinition substance.
    
    See Also:
    
    Constant Field Values
  - TIME
```
public static final java.lang.String TIME
```
    Identifier of the (for the SBML Levels 1 and 2) predefined UnitDefinition time.
    
    See Also:
    
    Constant Field Values
  - VOLUME
```
public static final java.lang.String VOLUME
```
    Identifier of the (for some SBML Levels 1 and 2) predefined UnitDefinition volume.
    
    See Also:
    
    Constant Field Values
  - BASE_UNIT_SUFFIX
```
public static final java.lang.String BASE_UNIT_SUFFIX
```
    The suffix used in UnitDefinition objects that represent a base Unit.Kind with offset = 0, multiplier = 1, scale = 0, and exponent = 1. Since SBML does not allow that the identifier of a UnitDefinition equals the name of a base unit, this suffix is used to internally store simple units in form of a composite UnitDefinition.
    
    See Also:
    
    Constant Field Values
  - listOfUnits
```
private ListOf<Unit> listOfUnits
```
    Represents the 'listOfUnit' XML sub-element of a UnitDefinition.
- Constructor Detail
  - UnitDefinition
```
public UnitDefinition()
```
    Creates an UnitDefinition instance. By default, the listOfUnit is null.
  - UnitDefinition
```
public UnitDefinition(int level,
                      int version)
```
    Creates a new UnitDefinition instance.
    
    Parameters:
    
    level - the SBML level
    
    version - the SBML version
  - UnitDefinition
```
public UnitDefinition(java.lang.String id)
```
    Creates a new UnitDefinition instance.
    
    Parameters:
    
    id - the unit definition id.
  - UnitDefinition
```
public UnitDefinition(java.lang.String id,
                      int level,
                      int version)
```
    Creates an UnitDefinition instance from an id, level and version. By default, the listOfUnit is null.
    
    Parameters:
    
    id - the unit definition id.
    
    level - the SBML level
    
    version - the SBML version
  - UnitDefinition
```
public UnitDefinition(java.lang.String id,
                      java.lang.String name,
                      int level,
                      int version)
```
    Creates an UnitDefinition instance from an id, level and version. By default, the listOfUnit is null.
    
    Parameters:
    
    id - the unit definition id.
    
    name - the unit definition name.
    
    level - the SBML level
    
    version - the SBML version
  - UnitDefinition
```
public UnitDefinition(UnitDefinition unitDefinition)
```
    Creates an UnitDefinition instance from a given UnitDefinition.
    
    Parameters:
    
    unitDefinition - the UnitDefinition to clone.
- Method Detail
  - area
```
public static final UnitDefinition area(int level,
                                        int version)
```
    Returns the predefined unit for area.
    
    Parameters:
    
    level - the SBML level
    
    version - the SBML version
    
    Returns:
    
    the predefined unit for area.
  - areCompatible
```
public static boolean areCompatible(UnitDefinition ud1,
                                    UnitDefinition ud2)
```
    Returns true or false depending on whether two UnitDefinition objects are compatible.
    
    For the purposes of performing this comparison, two UnitDefinition objects are considered compatible when they contain compatible list of Unit objects. This means two UnitDefinition objects are compatible if both satisfy the method areEquivalent(UnitDefinition, UnitDefinition) or one of both has Unit.Kind.INVALID as Unit.Kind
    
    Parameters:
    
    ud1 - the first UnitDefinition object to compare
    
    ud2 - the second UnitDefinition object to compare
    
    Returns:
    
    true if all the Unit objects in ud1 are compatible to the Unit objects in ud2, false otherwise.
    
    See Also:
    
    areIdentical(UnitDefinition, UnitDefinition), Unit.areEquivalent(Unit, Unit)
  - areEquivalent
```
public static boolean areEquivalent(UnitDefinition ud,
                                    java.lang.String units)
```
    Checks whether the given UnitDefinition and the UnitDefinition or Unit represented by the given String are equivalent.
    
    Parameters:
    
    ud - a UnitDefinition
    
    units - a String representing either a UnitDefinition id or a unit Unit.Kind.
    
    Returns:
    
    true if both units are equivalent
    
    See Also:
    
    areEquivalent(UnitDefinition, UnitDefinition), Unit.areEquivalent(Unit, Unit)
  - areEquivalent
```
public static boolean areEquivalent(UnitDefinition ud1,
                                    UnitDefinition ud2)
```
    Returns true or false depending on whether two UnitDefinition objects are equivalent.
    
    For the purposes of performing this comparison, two UnitDefinition objects are considered equivalent when they contain equivalent list of Unit objects. Unit objects are in turn considered equivalent if they satisfy the predicate Unit.areEquivalent(Unit, Unit). The predicate tests a subset of the objects's attributes.
    
    Parameters:
    
    ud1 - the first UnitDefinition object to compare
    
    ud2 - the second UnitDefinition object to compare
    
    Returns:
    
    true if all the Unit objects in ud1 are equivalent to the Unit objects in ud2, false otherwise.
    
    See Also:
    
    areIdentical(UnitDefinition, UnitDefinition), Unit.areEquivalent(Unit, String)
  - areIdentical
```
public static boolean areIdentical(UnitDefinition ud1,
                                   UnitDefinition ud2)
```
    Returns true or false depending on whether two UnitDefinition objects are identical.
    
    For the purposes of performing this comparison, two UnitDefinition objects are considered identical when they contain identical lists of Unit objects. Pairs of Unit objects in the lists are in turn considered identical if they satisfy the predicate Unit.areIdentical(Unit, Unit). The predicate compares every attribute of the Unit objects.
    
    Parameters:
    
    ud1 - the first UnitDefinition object to compare
    
    ud2 - the second UnitDefinition object to compare
    
    Returns:
    
    true if all the Unit objects in ud1 are identical to the Unit objects of ud2, false otherwise.
  - getPredefinedUnit
```
public static final UnitDefinition getPredefinedUnit(java.lang.String id,
                                                     int level,
                                                     int version)
```
    Returns the predefined unit with the given identifier for the specified level and version combination or null if either for the given combination of level and version there is no such predefined unit or the identifier is not one of those belonging to the group of predefined unit definitions.
    Parameters:
    id - one of the values
    
    substance
    
    volume
    
    area
    
    length
    
    time
    
    any of the basic kind
    level - a number greater than zero.
    
    version - a number greater than zero.
    
    Returns:
    
    The predefined unit definition with the given identifier for the specified level version combination or null if no such predefined unit exists.
  - isBuiltIn
```
@Deprecated
public static boolean isBuiltIn(UnitDefinition ud)
```
    Deprecated. use isPredefined()
    
    Tests if the given unit is a predefined unit, meaning it is one of the five SBML predefined unit identifiers ('substance', 'volume', 'area', 'length' or 'time').
    
    Parameters:
    
    ud - a unit definition
    
    Returns:
    
    true if the given unit is a predefined unit.
  - isPredefined
```
public static boolean isPredefined(java.lang.String name,
                                   int level)
```
    Tests if the given String is a predefined unit, meaning it is one of the five SBML predefined unit identifiers ('substance', 'volume', 'area', 'length' or 'time').
    
    Parameters:
    
    name - a unit String
    
    level - the SBML level
    
    Returns:
    
    true if the given unit is a predefined unit.
    
    See Also:
    
    Unit.isPredefined(String, int)
  - isPredefined
```
public static boolean isPredefined(UnitDefinition ud)
```
    Tests if the given unit is a predefined unit, meaning it is one of the five SBML predefined unit identifiers ('substance', 'volume', 'area', 'length' or 'time').
    
    Parameters:
    
    ud - a unit definition
    
    Returns:
    
    true if the given unit is a predefined unit.
  - length
```
public static final UnitDefinition length(int level,
                                          int version)
```
    Returns the predefined unit for length.
    
    Parameters:
    
    level - the SBML level
    
    version - the SBML version
    
    Returns:
    
    the predefined unit for length.
  - printUnits
```
public static java.lang.String printUnits(UnitDefinition ud)
```
    Returns a string that expresses the unit definition represented by this UnitDefinition object.
    
    Parameters:
    
    ud - the UnitDefinition object
    
    Returns:
    
    a string expressing the unit definition
  - printUnits
```
public static java.lang.String printUnits(UnitDefinition ud,
                                          boolean compact)
```
    Returns a string that expresses the unit definition represented by this UnitDefinition object.
    
    Parameters:
    
    ud - the UnitDefinition object
    
    compact - boolean indicating whether the compact form should be used (defaults to false)
    
    Returns:
    
    a string expressing the unit definition
  - reorder
```
public static void reorder(UnitDefinition ud)
```
    Orders alphabetically the Unit objects within the listOfUnits of a UnitDefinition.
    
    Parameters:
    
    ud - the UnitDefinition object whose Units are to be reordered.
  - simplify
```
public static UnitDefinition simplify(UnitDefinition ud)
```
    Returns a simplified version of the given UnitDefinition.
    
    Parameters:
    
    ud - a unit definition
    
    Returns:
    
    a simplified version of the given UnitDefinition. In order to make sure that the original UnitDefinition is not changed, it is cloned before the simplification.
  - substance
```
public static final UnitDefinition substance(int level,
                                             int version)
```
    Returns the predefined unit for substance.
    
    Parameters:
    
    level - the SBML level
    
    version - the SBML version
    
    Returns:
    
    the predefined unit for substance.
  - time
```
public static final UnitDefinition time(int level,
                                        int version)
```
    Returns the predefined unit for time.
    
    Parameters:
    
    level - the SBML level
    
    version - the SBML version
    
    Returns:
    
    the predefined unit for time.
  - volume
```
public static final UnitDefinition volume(int level,
                                          int version)
```
    Returns the predefined unit for volume.
    
    Parameters:
    
    level - the SBML level
    
    version - the SBML version
    
    Returns:
    
    the predefined unit for volume.
  - addUnit
```
public void addUnit(java.lang.String unit)
```
    Adds a new Unit instance, created from the given unit Unit.Kind, to this UnitDefinition.
    
    Parameters:
    
    unit - the unit kind.
  - addUnit
```
public void addUnit(Unit u)
```
    Adds a Unit to this UnitDefinition.
    
    Parameters:
    
    u - the unit to add.
  - addUnit
```
public void addUnit(Unit.Kind kind)
```
    Adds a new Unit instance, with the given kind, to this UnitDefinition.
    
    Parameters:
    
    kind - the unit kind.
  - clear
```
public void clear()
```
    Removes all Unit elements from the list of Units in this object.
  - clone
```
public UnitDefinition clone()
```
    Description copied from interface: SBase
    
    Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.
    
    Specified by:
    
    clone in interface SBase
    
    Specified by:
    
    clone in class AbstractSBase
    
    Returns:
    
    a copy of this object
  - convertToSIUnits
```
public void convertToSIUnits()
```
    This method converts this unit definition to a
  - createUnit
```
public Unit createUnit()
```
    Creates a new Unit instance with the Unit.Kind.INVALID kind and adds it to this UnitDefinition.
    
    Returns:
    
    a new Unit instance with the Unit.Kind.INVALID kind.
    
    See Also:
    
    createInvalidUnit()
  - createInvalidUnit
```
public Unit createInvalidUnit()
```
    Creates a new Unit instance with the Unit.Kind.INVALID kind and adds it to this UnitDefinition.
    
    Returns:
    
    a new Unit instance with the Unit.Kind.INVALID kind.
  - createUnit
```
public Unit createUnit(Unit.Kind kind)
```
    Creates a new Unit instance with the given Unit.Kind and adds it to this UnitDefinition.
    
    Parameters:
    
    kind - the kind to be set in the new Unit.
    
    Returns:
    
    a new Unit instance with the given Unit.Kind.
  - divideBy
```
public UnitDefinition divideBy(UnitDefinition definition)
```
    Divides this unit definition by the second unit definition.
    The current UnitDefinition will be modified in the process.
    
    Parameters:
    
    definition - a unit definition
    
    Returns:
    
    the modified UnitDefinition instance for convenience
  - getAllowsChildren
```
public boolean getAllowsChildren()
```
    Specified by:
    
    getAllowsChildren in interface javax.swing.tree.TreeNode
    
    Overrides:
    
    getAllowsChildren in class AbstractSBase
  - getChildAt
```
public javax.swing.tree.TreeNode getChildAt(int index)
```
    Specified by:
    
    getChildAt in interface javax.swing.tree.TreeNode
    
    Overrides:
    
    getChildAt in class AbstractSBase
  - getChildCount
```
public int getChildCount()
```
    Specified by:
    
    getChildCount in interface javax.swing.tree.TreeNode
    
    Overrides:
    
    getChildCount in class AbstractSBase
  - getListOfUnits
```
public ListOf<Unit> getListOfUnits()
```
    Returns:
    
    the listOfUnits of this UnitDefinition. Can be empty.
  - getNumUnits
```
public int getNumUnits()
```
    Returns:
    
    the number of Unit.
  - getUnitCount
```
public int getUnitCount()
```
    Returns:
    
    the number of Unit.
  - getParent
```
public ListOf<UnitDefinition> getParent()
```
    Description copied from class: AbstractSBase
    
    This is equivalent to calling AbstractSBase.getParentSBMLObject(), but this method is needed for TreeNode.
    
    Specified by:
    
    getParent in interface javax.swing.tree.TreeNode
    
    Overrides:
    
    getParent in class AbstractSBase
    
    Returns:
    
    the parent element of this element.
    
    See Also:
    
    AbstractSBase.getParentSBMLObject()
  - getUnit
```
public Unit getUnit(int i)
```
    Returns a specific Unit instance belonging to this UnitDefinition.
    
    Parameters:
    
    i - an integer, the index of the Unit to be returned.
    
    Returns:
    
    the ith Unit of this UnitDefinition
  - isBuiltIn
```
@Deprecated
public boolean isBuiltIn()
```
    Deprecated. use isPredefined()
    
    Tests if this unit definition is a predefined unit.
    
    Returns:
    
    true if this unit definition is a predefined unit.
  - isIdMandatory
```
public boolean isIdMandatory()
```
    Description copied from interface: SBase
    
    Returns true if the identifier of this SBase is required to be defined (i.e., not null) in the definition of SBML.
    
    Specified by:
    
    isIdMandatory in interface NamedSBase
    
    Specified by:
    
    isIdMandatory in interface SBase
    
    Overrides:
    
    isIdMandatory in class AbstractSBase
    
    Returns:
    
    true if the identifier of this element must be set in order to create a valid SBML representation. false otherwise, i.e., if the identifier can be understood as an optional attribute.
  - isInvalid
```
public boolean isInvalid()
```
    Checks if this UnitDefinition is invalid.
    
    Returns:
    
    true if this UnitDefinition is invalid.
  - isListOfUnitsEmpty
```
public boolean isListOfUnitsEmpty()
```
    Returns true if the listOfUnits is empty.
    
    Returns:
    
    true if the listOfUnits is empty.
  - isPredefined
```
public boolean isPredefined()
```
    Tests if this unit definition is a predefined unit.
    
    Returns:
    
    true if this unit definition is a predefined unit.
  - isSetListOfUnits
```
public boolean isSetListOfUnits()
```
    Returns true if the listOfUnits is not null and not empty.
    
    Returns:
    
    true if the listOfUnits is not null and not empty.
  - isUnitKind
```
public boolean isUnitKind()
```
    Tests whether this UnitDefinition contains exactly one Unit that itself represents a Unit.Kind, i.e., multiplier = 1, exponent = 1, scale = 1. Note that this method requires the level and version attributes of this UnitDefinition to be set.
    
    Returns:
    
    true if this UnitDefinition contains exactly one Unit that itself represents a simple Unit.Kind.
  - isVariantOfArea
```
public boolean isVariantOfArea()
```
    Returns true if this UnitDefinition is a variant of Area
    
    Returns:
    
    true if this UnitDefinition is a variant of Area
  - isVariantOfDimensionless
```
public boolean isVariantOfDimensionless()
```
    Tests if a given unit definition is a variant of the predefined unit identifier 'dimensionless'.
    
    Returns:
    
    true if this UnitDefinition is a variant of the predefined unit dimensionless; false otherwise.
  - isVariantOfLength
```
public boolean isVariantOfLength()
```
    Tests if a given unit definition is a variant of the predefined unit identifier 'length'.
    
    Returns:
    
    true if this UnitDefinition is a variant of the predefined unit length, meaning metres with only arbitrary variations in scale or multiplier values; false otherwise.
  - isVariantOfSubstance
```
public boolean isVariantOfSubstance()
```
    Tests if a given unit definition is a variant of the predefined unit identifier 'substance'.
    
    Returns:
    
    true if this UnitDefinition is a variant of the predefined unit substance, meaning moles or items (and grams or kilograms from SBML Level 2 Version 2 onwards) with only arbitrary variations in scale or multiplier values; false otherwise.
  - isVariantOfSubstancePerArea
```
public boolean isVariantOfSubstancePerArea()
```
    Tests if a given unit definition is a variant of the predefined unit identifier 'substance per area'.
    
    Returns:
    
    true if this UnitDefinition is a variant of the predefined unit 'substance per area'.
  - isVariantOfSubstancePerLength
```
public boolean isVariantOfSubstancePerLength()
```
    Tests if this UnitDefinition is a variant of substance per length.
    
    Returns:
    
    true if this UnitDefinition is a variant of substance per length.
  - isVariantOfSubstancePerTime
```
public boolean isVariantOfSubstancePerTime()
```
    Tests if this UnitDefinition is a variant of substance per time.
    
    Returns:
    
    true if this UnitDefinition is a variant of substance per time.
  - isVariantOfSubstancePerVolume
```
public boolean isVariantOfSubstancePerVolume()
```
    Tests if this UnitDefinition is a variant of substance per volume.
    
    Returns:
    
    true if this UnitDefinition is a variant of substance per volume.
  - isVariantOfTime
```
public boolean isVariantOfTime()
```
    Tests if a given unit definition is a variant of the predefined unit identifier 'time'.
    
    Returns:
    
    true if this UnitDefinition is a variant of the predefined unit time, meaning second with only arbitrary variations in scale or multiplier values; false otherwise.
  - isVariantOfVolume
```
public boolean isVariantOfVolume()
```
    Tests if a given unit definition is a variant of the predefined unit identifier 'volume'.
    
    Returns:
    
    true if this UnitDefinition is a variant of the predefined unit volume, meaning litre or cubic metre with only arbitrary variations in scale or multiplier values; false otherwise.
  - multiplyWith
```
public UnitDefinition multiplyWith(UnitDefinition definition)
```
    Multiplies this unit with the given unit definition, i.e., adds a clone of each unit object in the list of units of the given definition to the list of this unit.
    
    Parameters:
    
    definition - a unit definition
    
    Returns:
    
    the current (modified) UnitDefinition for convenience.
  - raiseByThePowerOf
```
public UnitDefinition raiseByThePowerOf(double exponent)
```
    Raises this unit definition by the power of the given exponent, i.e., the exponents of every unit contained by this unit definition are multiplied with the given exponent.
    
    Parameters:
    
    exponent - the exponent
    
    Returns:
    
    a pointer to this UnitDefinition.
  - removeUnit
```
public Unit removeUnit(int i)
```
    Removes the nth Unit object from this UnitDefinition object and returns a pointer to it. The caller owns the returned object and is responsible for deleting it.
    
    Parameters:
    
    i - the index of the Unit object to remove
    
    Returns:
    
    the Unit object removed. As mentioned above, the caller owns the returned item. null is returned if the given index is out of range.
  - setId
```
public void setId(java.lang.String id)
```
    Description copied from interface: SBase
    
    Sets the id value with 'id'
    
    Specified by:
    
    setId in interface NamedSBase
    
    Specified by:
    
    setId in interface SBase
    
    Overrides:
    
    setId in class AbstractSBase
    
    Parameters:
    
    id - the id to set
  - setListOfUnits
```
public void setListOfUnits(ListOf<Unit> listOfUnits)
```
    Sets the listOfUnits of this UnitDefinition.
    Automatically sets the parent SBML object of the list to this UnitDefinition instance.
    
    Parameters:
    
    listOfUnits - the new list of Units.
  - simplify
```
public UnitDefinition simplify()
```
    Simplifies the UnitDefinition so that any Unit objects occurring within the listOfUnits occurs only once. Units of Unit.Kind Unit.Kind.INVALID are treated like Unit.Kind.DIMENSIONLESS units and will therefore tend to disappear by merging with other units.
    
    Returns:
    
    a pointer to the simplified UnitDefinition.
  - toString
```
public java.lang.String toString()
```
    Description copied from class: AbstractSBase
    
    Returns a String representing this SBase with all the attributes that are defined.
    
    Overrides:
    
    toString in class AbstractSBase
    
    Returns:
    
    a String representing this SBase with all its attributes
  - unsetListOfUnits
```
public boolean unsetListOfUnits()
```
    Removes the listOfUnits from this UnitDefinition and notifies all registered instances of TreeNodeChangeListener.
    
    Returns:
    
    true if calling this method lead to a change in this data structure.

Class UnitDefinition

Field Summary

Fields inherited from class org.sbml.jsbml.AbstractSBase

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

Constructor Summary

Method Summary

Methods inherited from class org.sbml.jsbml.AbstractNamedSBase

Methods inherited from class org.sbml.jsbml.AbstractSBase

Methods inherited from class org.sbml.jsbml.AbstractTreeNode

Methods inherited from class java.lang.Object

Methods inherited from interface org.sbml.jsbml.NamedSBase

Methods inherited from interface org.sbml.jsbml.SBase

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

Methods inherited from interface javax.swing.tree.TreeNode

Field Detail

AREA

EXTENT

LENGTH

logger

serialVersionUID

SUBSTANCE

TIME

VOLUME

BASE_UNIT_SUFFIX

listOfUnits

Constructor Detail

UnitDefinition

UnitDefinition

UnitDefinition

UnitDefinition

UnitDefinition

UnitDefinition

Method Detail

area

areCompatible

areEquivalent

areEquivalent

areIdentical

getPredefinedUnit

isBuiltIn

isPredefined

isPredefined

length

printUnits

printUnits

reorder

simplify

substance

time

volume

addUnit

addUnit

addUnit

clear

clone

convertToSIUnits

createUnit

createInvalidUnit

createUnit

divideBy

getAllowsChildren

getChildAt

getChildCount

getListOfUnits

getNumUnits

getUnitCount

getParent

getUnit

isBuiltIn

isIdMandatory

isInvalid

isListOfUnitsEmpty

isPredefined

isSetListOfUnits

isUnitKind

isVariantOfArea

isVariantOfDimensionless

isVariantOfLength

isVariantOfSubstance

isVariantOfSubstancePerArea