Unit

java.lang.Object
- org.sbml.jsbml.AbstractTreeNode
- - org.sbml.jsbml.AbstractSBase
  - - org.sbml.jsbml.Unit

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, javax.swing.tree.TreeNode, SBase, UniqueSId, TreeNodeWithChangeSupport
```
public class Unit
extends AbstractSBase
implements UniqueSId
```
Represents the unit XML element of a SBML file.

Since:

0.8

Author:

Andreas Dräger

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Unit.Kind` This enumeration contains an exhaustive list of all available unit kinds within all Levels and Versions of SBML.

Field Summary

Fields
Modifier and Type	Field and Description
`private java.lang.Double`	`exponent` Represents the 'exponent' XML attribute of an unit element.
`private boolean`	`isSetExponent`
`private boolean`	`isSetMultiplier`
`private boolean`	`isSetOffset`
`private boolean`	`isSetScale`
`private Unit.Kind`	`kind` Represents the 'kind' XML attribute of an unit element.
`private static org.apache.log4j.Logger`	`logger` A `Logger` for this class.
`private java.lang.Double`	`multiplier` Represents the 'multiplier' XML attribute of an unit element.
`private java.lang.Double`	`offset` Deprecated. the offset attribute should no longer be used.
`private java.lang.Integer`	`scale` Represents the 'scale' XML attribute of an unit element.
`private static long`	`serialVersionUID` Generated serial version identifier.

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
`Unit()` Creates a Unit instance.
`Unit(double multiplier, int scale, Unit.Kind kind, double exponent, int level, int version)` Creates a `Unit` instance from a multiplier, scale, kind and exponent.
`Unit(int level, int version)` Creates a `Unit` instance from a level and version.
`Unit(int scale, Unit.Kind kind, double exponent, int level, int version)` Creates a Unit instance from a scale, kind, exponent, level and version.
`Unit(int scale, Unit.Kind kind, int level, int version)` Creates a Unit instance from a scale, kind, level and version.
`Unit(java.lang.String units, int level, int version)`
`Unit(Unit.Kind kind, double exponent, int level, int version)` Creates a Unit instance from a kind, exponent, level and version.
`Unit(Unit.Kind kind, int level, int version)` Creates a Unit instance from a kind, level and version.
`Unit(Unit unit)` Creates a Unit instance from a given Unit.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static boolean`	`areEquivalent(Unit unit, java.lang.String units)` Checks whether the given `Unit` and the `Unit` represented by the given `String` are equivalent.
`static boolean`	`areEquivalent(Unit unit1, Unit unit2)` Predicate returning true or false depending on whether Unit objects are equivalent.
`static boolean`	`areIdentical(Unit unit1, Unit unit2)` Predicate returning true or false depending on whether two Unit objects are identical.
`Unit`	`clone()` Creates a deep copy of this object, i.e., a new `SBase` with the same properties like this one.
`static UnitDefinition`	`convertToSI(Unit unit)` Returns a UnitDefinition object which contains the argument Unit converted to the appropriate SI unit.
`boolean`	`equals(java.lang.Object object)` Returns `true` if and only if the given `SBase` has exactly the same properties like this `SBase` instance.
`double`	`getExponent()`
`double`	`getExponentAsDouble()` Deprecated. use `getExponent()`
`Unit.Kind`	`getKind()`
`double`	`getMultiplier()`
`double`	`getOffset()` Deprecated.
`ListOf<Unit>`	`getParent()` This is equivalent to calling `AbstractSBase.getParentSBMLObject()`, but this method is needed for `TreeNode`.
`java.lang.String`	`getPrefix()`
`java.lang.String`	`getPrefixAsWord()`
`int`	`getScale()`
`int`	`hashCode()` Returns a hash code value for this `SBase` instance.
`boolean`	`hasRequiredAttributes()` Predicate returning true or false depending on whether all the required attributes for this Unit object have been set.
`void`	`initDefaults()` Initializes the default values using the current Level/Version configuration.
`void`	`initDefaults(int level, int version)` Initializes the attributes of this Unit (except for 'kind') to their defaults values.
`void`	`initDefaults(int level, int version, boolean explicit)`
`boolean`	`isAmpere()` Predicate for testing whether this Unit is of the kind ampere.
`boolean`	`isAvogadro()` Predicate for testing whether this Unit is of the kind avogadro.
`boolean`	`isBecquerel()` Predicate for testing whether this Unit is of the kind becquerel.
`static boolean`	`isBuiltIn(java.lang.String name, int level)` Deprecated. use `isPredefined(String, int)`
`boolean`	`isCandela()` Predicate for testing whether this Unit is of the kind candela
`boolean`	`isCelsius()` Deprecated. `Unit.Kind.CELSIUS` should no longer be used.
`boolean`	`isCoulomb()` Predicate for testing whether this Unit is of the kind coulomb.
`boolean`	`isDimensionless()` Predicate for testing whether this Unit is of the `Unit.Kind` `Unit.Kind.DIMENSIONLESS`.
`boolean`	`isFarad()` Predicate for testing whether this Unit is of the kind farad
`boolean`	`isGram()` Predicate for testing whether this Unit is of the kind gram
`boolean`	`isGray()` Predicate for testing whether this Unit is of the kind gray
`boolean`	`isHenry()` Predicate for testing whether this Unit is of the kind henry
`boolean`	`isHertz()` Predicate for testing whether this Unit is of the kind hertz
`boolean`	`isInvalid()` Predicate for testing whether this Unit is of the kind invalid.
`boolean`	`isItem()` Predicate for testing whether this Unit is of the kind item
`boolean`	`isJoule()` Predicate for testing whether this Unit is of the kind Joule
`boolean`	`isKatal()` Predicate for testing whether this Unit is of the kind katal
`boolean`	`isKelvin()` Predicate for testing whether this Unit is of the kind kelvin
`boolean`	`isKilogram()` Predicate for testing whether this Unit is of the kind kilogram
`boolean`	`isLitre()` Predicate for testing whether this Unit is of the kind litre.
`boolean`	`isLumen()` Predicate for testing whether this Unit is of the kind lumen
`boolean`	`isLux()` Predicate for testing whether this Unit is of the kind lux
`boolean`	`isMetre()` Predicate for testing whether this Unit is of the kind metre
`boolean`	`isMole()` Predicate for testing whether this Unit is of the kind mole.
`boolean`	`isNewton()` Predicate for testing whether this Unit is of the kind newton
`boolean`	`isOhm()` Predicate for testing whether this Unit is of the kind ohm
`boolean`	`isPascal()` Predicate for testing whether this Unit is of the kind pascal
`static boolean`	`isPredefined(java.lang.String name, int level)` Predicate to test whether a given string is the name of a predefined SBML unit.
`static boolean`	`isPredefined(UnitDefinition ud)` Tests whether the given `UnitDefinition` belongs to the predefined SBML units.
`boolean`	`isRadian()` Predicate for testing whether this Unit is of the kind radian
`boolean`	`isSecond()` Predicate for testing whether this Unit is of the kind second
`boolean`	`isSetExponent()`
`boolean`	`isSetKind()` Predicate to test whether the 'kind' attribute of this `Unit` has been set.
`boolean`	`isSetMultiplier()`
`boolean`	`isSetOffset()` Deprecated. the offset attribute should no longer be used.
`boolean`	`isSetScale()`
`boolean`	`isSiemens()` Predicate for testing whether this Unit is of the kind siemens
`boolean`	`isSievert()` Predicate for testing whether this Unit is of the kind sievert
`boolean`	`isSteradian()` Predicate for testing whether this Unit is of the kind steradian
`boolean`	`isTesla()` Predicate for testing whether this Unit is of the kind tesla
`static boolean`	`isUnitKind(java.lang.String name, int level, int version)` Predicate to test whether a given string is the name of a valid base unit in SBML (such as 'gram' or 'mole').
`static boolean`	`isUnitKind(Unit.Kind kind, int level, int version)`
`static boolean`	`isValidUnit(Model model, java.lang.String unit)` Returns `true` if the `unit` is a valid unit kind name or an identifier of an existing `UnitDefinition`.
`boolean`	`isVariantOfArea()`
`boolean`	`isVariantOfLength()`
`boolean`	`isVariantOfSubstance()`
`boolean`	`isVariantOfTime()`
`boolean`	`isVariantOfVolume()`
`boolean`	`isVolt()` Predicate for testing whether this Unit is of the kind volt
`boolean`	`isWatt()` Predicate for testing whether this Unit is of the kind watt
`boolean`	`isWeber()` Predicate for testing whether this Unit is of the kind weber
`static void`	`merge(Unit unit1, Unit unit2)` Merges two `Unit` objects with the same 'kind' attribute value into a single `Unit`.
`java.lang.String`	`printUnit()` Produces a text formula representation of this unit.
`boolean`	`readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value)` Sets the given attribute in this `SBase`.
`Unit`	`removeMultiplier()` This method tries to remove the `multiplier` of this unit.
`Unit`	`removeOffset()` We remove the offset by expressing it within a new `multiplier`, m':
`Unit`	`removeScale()` Manipulates the attributes of the Unit to express the unit with the value of the scale attribute reduced to zero.
`static void`	`removeScale(Unit unit)` Manipulates the attributes of the Unit to express the unit with the value of the scale attribute reduced to zero.
`void`	`setExponent(double exponent)` Sets the exponent of this `Unit`
`void`	`setExponent(int exponent)` Deprecated. use `setExponent(double)`
`void`	`setKind(Unit.Kind kind)` Sets the `Unit.Kind` of this `Unit`
`void`	`setMultiplier(double multiplier)` Sets the multiplier of this `Unit`
`void`	`setOffset(double offset)` Deprecated. Only defined for SBML Level 2 Version 1.
`void`	`setScale(int scale)` Sets the scale of this Unit
`void`	`unsetExponent()`
`void`	`unsetKind()`
`void`	`unsetMultiplier()`
`void`	`unsetOffset()` Deprecated. the offset attribute should no longer be used.
`void`	`unsetScale()`
`java.util.Map<java.lang.String,java.lang.String>`	`writeXMLAttributes()` Returns a map with all the attributes of this `SBase` that need to be written out in XML.

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, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAllowsChildren, getAnnotation, getAnnotationString, getChildAt, getChildCount, 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, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isIdMandatory, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetId, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetName, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, notifyChildChange, registerChild, removeCVTerm, removeCVTerm, setAnnotation, setAnnotation, setAnnotation, setHistory, setId, setLevel, setLevelAndVersion, setMetaId, setName, setNamespace, setNotes, setNotes, setPackageNamespaceAndVersion, setPackageVersion, setParentSBML, setParentSBMLObject, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, toString, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetId, unsetMetaId, unsetName, unsetNamespace, unsetNotes, unsetPlugin, unsetSBOTerm

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

Methods inherited from interface org.sbml.jsbml.SBase
removeTreeNodeChangeListener

Methods inherited from interface javax.swing.tree.TreeNode
children, getIndex, isLeaf

- Field Detail
  - logger
```
private static final transient org.apache.log4j.Logger logger
```
    A Logger for this class.
  - serialVersionUID
```
private static final long serialVersionUID
```
    Generated serial version identifier.
    
    See Also:
    
    Constant Field Values
  - exponent
```
private java.lang.Double exponent
```
    Represents the 'exponent' XML attribute of an unit element.
  - isSetExponent
```
private boolean isSetExponent
```
  - isSetMultiplier
```
private boolean isSetMultiplier
```
  - isSetOffset
```
private boolean isSetOffset
```
  - isSetScale
```
private boolean isSetScale
```
  - kind
```
private Unit.Kind kind
```
    Represents the 'kind' XML attribute of an unit element.
  - multiplier
```
private java.lang.Double multiplier
```
    Represents the 'multiplier' XML attribute of an unit element.
  - offset
```
@Deprecated
private java.lang.Double offset
```
    Deprecated. the offset attribute should no longer be used.
    
    Represents the 'offset' XML attribute of an unit element.
  - scale
```
private java.lang.Integer scale
```
    Represents the 'scale' XML attribute of an unit element.
- Constructor Detail
  - Unit
```
public Unit()
```
    Creates a Unit instance. If the level is set and is superior or equal to 3 the multiplier, scale, kind and exponent are null.
  - Unit
```
public Unit(double multiplier,
            int scale,
            Unit.Kind kind,
            double exponent,
            int level,
            int version)
```
    Creates a Unit instance from a multiplier, scale, kind and exponent. The offset is null.
    
    Parameters:
    
    multiplier -
    
    scale -
    
    kind -
    
    exponent -
    
    level -
    
    version -
  - Unit
```
public Unit(int level,
            int version)
```
    Creates a Unit instance from a level and version. If the level is set and is superior or equal to 3 the multiplier, scale, kind, offset and exponent are null.
    
    Parameters:
    
    level -
    
    version -
  - Unit
```
public Unit(int scale,
            Unit.Kind kind,
            double exponent,
            int level,
            int version)
```
    Creates a Unit instance from a scale, kind, exponent, level and version.
    
    Parameters:
    
    scale -
    
    kind -
    
    exponent -
    
    level -
    
    version -
  - Unit
```
public Unit(int scale,
            Unit.Kind kind,
            int level,
            int version)
```
    Creates a Unit instance from a scale, kind, level and version.
    
    Parameters:
    
    scale -
    
    kind -
    
    level -
    
    version -
  - Unit
```
public Unit(Unit.Kind kind,
            double exponent,
            int level,
            int version)
```
    Creates a Unit instance from a kind, exponent, level and version.
    
    Parameters:
    
    kind -
    
    exponent -
    
    level -
    
    version -
  - Unit
```
public Unit(Unit.Kind kind,
            int level,
            int version)
```
    Creates a Unit instance from a kind, level and version. If the level is set and is superior or equal to 3 the multiplier, scale, offset and exponent are null.
    
    Parameters:
    
    kind -
    
    level -
    
    version -
  - Unit
```
public Unit(java.lang.String units,
            int level,
            int version)
```
    Parameters:
    
    units -
    
    level -
    
    version -
  - Unit
```
public Unit(Unit unit)
```
    Creates a Unit instance from a given Unit.
    
    Parameters:
    
    unit -
- Method Detail
  - areEquivalent
```
public static boolean areEquivalent(Unit unit,
                                    java.lang.String units)
```
    Checks whether the given Unit and the Unit represented by the given String are equivalent.
    
    Parameters:
    
    unit -
    
    units -
    
    Returns:
    
    See Also:
    
    areEquivalent(Unit, Unit)
  - areEquivalent
```
public static boolean areEquivalent(Unit unit1,
                                    Unit unit2)
```
    Predicate returning true or false depending on whether Unit objects are equivalent.
    
    Two Unit objects are considered to be equivalent if their 'kind' and 'exponent' attributes are equal. (Contrast this to the method areIdentical(Unit unit1, Unit unit2), which compares Unit objects with respect to all attributes, not just the kind and exponent.)
    
    Parameters:
    
    unit1 - the first Unit object to compare
    
    unit2 - the second Unit object to compare
    
    Returns:
    
    if the 'kind' and 'exponent' attributes of unit1 are identical to the kind and exponent attributes of unit2, false otherwise.
  - areIdentical
```
public static boolean areIdentical(Unit unit1,
                                   Unit unit2)
```
    Predicate returning true or false depending on whether two Unit objects are identical.
    
    Two Unit objects are considered to be identical if they match in all attributes. (Contrast this to the method areEquivalent(Unit unit1, Unit unit2), which compares Unit objects only with respect to certain attributes.)
    
    Parameters:
    
    unit1 - the first Unit object to compare
    
    unit2 - the second Unit object to compare
    
    Returns:
    
    true if all the attributes of unit1 are identical to the attributes of unit2, false otherwise.
    
    See Also:
    
    areEquivalent(org.sbml.jsbml.Unit, java.lang.String)
  - convertToSI
```
public static UnitDefinition convertToSI(Unit unit)
```
    Returns a UnitDefinition object which contains the argument Unit converted to the appropriate SI unit.
    
    Parameters:
    
    unit - the Unit object to convert to SI
    
    Returns:
    
    a UnitDefinition object containing the SI unit.
  - isBuiltIn
```
@Deprecated
public static boolean isBuiltIn(java.lang.String name,
                                            int level)
```
    Deprecated. use isPredefined(String, int)
    
    Predicate to test whether a given string is the name of a predefined SBML unit.
    
    Parameters:
    
    name - a String to be tested against the predefined unit names
    
    level - the Level of SBML for which the determination should be made. This is necessary because there are a few small differences in allowed units between SBML Level 1 and Level 2.
    
    Returns:
    
    true, if name is one of the five SBML predefined unit identifiers ('substance', 'volume', 'area', 'length' or 'time'), false otherwise. The predefined unit identifiers 'length' and 'area' were added in Level 2 Version 1
  - isPredefined
```
public static boolean isPredefined(java.lang.String name,
                                   int level)
```
    Predicate to test whether a given string is the name of a predefined SBML unit.
    
    Parameters:
    
    name - a String to be tested against the predefined unit names
    
    level - the Level of SBML for which the determination should be made. This is necessary because there are a few small differences in allowed units between SBML Level 1 and Level 2.
    
    Returns:
    
    true, if name is one of the five SBML predefined unit identifiers ('substance', 'volume', 'area', 'length' or 'time'), false otherwise. The predefined unit identifiers 'length' and 'area' were added in Level 2 Version 1
  - isPredefined
```
public static boolean isPredefined(UnitDefinition ud)
```
    Tests whether the given UnitDefinition belongs to the predefined SBML units.
    
    Parameters:
    
    ud - the UnitDefinition to test.
    
    Returns:
    
    true, if name is one of the five SBML predefined unit identifiers ('substance', 'volume', 'area', 'length' or 'time'), false otherwise. The predefined unit identifiers 'length' and 'area' were added in Level 2 Version 1
    
    See Also:
    
    isPredefined(String, int)
  - isUnitKind
```
public static boolean isUnitKind(Unit.Kind kind,
                                 int level,
                                 int version)
```
    Parameters:
    
    kind -
    
    level -
    
    version -
    
    Returns:
  - isUnitKind
```
public static boolean isUnitKind(java.lang.String name,
                                 int level,
                                 int version)
```
    Predicate to test whether a given string is the name of a valid base unit in SBML (such as 'gram' or 'mole').
    
    This method exists because prior to SBML Level 2 Version 3, an enumeration called UnitKind was defined by SBML. This enumeration was removed in SBML Level 2 Version 3 and its values were folded into the space of values of a type called UnitSId. This method therefore has less significance in SBML Level 2 Version 3 and Level 2 Version 4, but remains for backward compatibility and support for reading models in older Versions of Level 2.
    
    Parameters:
    
    name - a string to be tested
    
    level - an integer representing the SBML specification Level
    
    version - an integer representing the SBML specification Version
    
    Returns:
    
    true if name is a valid UnitKind, false otherwise
  - isValidUnit
```
public static boolean isValidUnit(Model model,
                                  java.lang.String unit)
```
    Returns true if the unit is a valid unit kind name or an identifier of an existing UnitDefinition. If either the unit or model are null, it will return false.
    
    Parameters:
    
    unit - the identifier of a UnitDefinition or a valid Unit.Kind identifier for the current level/version combination of the model.
    
    model - the model where to look for the unit.
    
    Returns:
    
    true if the unit is a valid unit kind name or an identifier of an existing UnitDefinition.
  - merge
```
public static void merge(Unit unit1,
                         Unit unit2)
```
    Merges two Unit objects with the same 'kind' attribute value into a single Unit.
    
    Parameters:
    
    unit1 - the first Unit object; the result of the operation is left as a new version of this Unit, modified in-place.
    
    unit2 - the second Unit object to merge with the first
  - removeScale
```
public static void removeScale(Unit unit)
```
    Manipulates the attributes of the Unit to express the unit with the value of the scale attribute reduced to zero. For example, 1 millimetre can be expressed as a Unit with kind= 'metre' multiplier='1' scale='-3' exponent='1'. It can also be expressed as a Unit with kind='metre' multiplier='0.001' scale='0' exponent='1'.
    
    Parameters:
    
    unit - the Unit object to manipulate.
  - clone
```
public Unit 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
  - equals
```
public boolean equals(java.lang.Object object)
```
    Description copied from interface: SBase
    
    Returns true if and only if the given SBase has exactly the same properties like this SBase instance.
    
    Specified by:
    
    equals in interface SBase
    
    Overrides:
    
    equals in class AbstractSBase
    
    Parameters:
    
    object - the SBase to be compared to.
    
    Returns:
    
    true if and only if the given Object is an instance of SBase that has exactly the same properties like this SBase instance.
  - getExponent
```
public double getExponent()
```
    Returns:
    
    the exponent of this Unit if it is set, 1 otherwise.
  - getExponentAsDouble
```
@Deprecated
public double getExponentAsDouble()
```
    Deprecated. use getExponent()
    
    Returns the exponent of this Unit. This method is provided for compatibility to libSBML only.
    
    Returns:
  - getKind
```
public Unit.Kind getKind()
```
    Returns:
    
    the kind of this Unit if it is set, null otherwise.
  - getMultiplier
```
public double getMultiplier()
```
    Returns:
    
    the multiplier of this Unit if it is set, 1 otherwise.
  - getOffset
```
@Deprecated
public double getOffset()
```
    Deprecated.
    
    Returns:
    
    the offset of this Unit if it is set, 0 otherwise.
  - getParent
```
public ListOf<Unit> 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()
  - getPrefix
```
public java.lang.String getPrefix()
```
    Returns:
    
    This method returns the abbreviated prefix of this Unit, for instance, "m" for milli, i.e., if the scale is -3. In case that the scale equals zero, an empty String is returned. If no defined prefix exists for the current scale, the String 10^(%d) is returned, where %d denotes the scale.
    
    See Also:
    
    getPrefixAsWord()
  - getPrefixAsWord
```
public java.lang.String getPrefixAsWord()
```
    Returns:
    
    the prefix of this Unit, for instance, "milli" if the scale is -3. In case that the scale equals zero, an empty String is returned. If no defined prefix exists for the current scale, the String 10^(%d) is returned, where %d denotes the scale.
    
    See Also:
    
    getPrefix()
  - getScale
```
public int getScale()
```
    Returns:
    
    the scale of this Unit if it is set, 0 otherwise.
  - hashCode
```
public int hashCode()
```
    Description copied from interface: SBase
    
    Returns a hash code value for this SBase instance.
    
    Specified by:
    
    hashCode in interface SBase
    
    Overrides:
    
    hashCode in class AbstractSBase
    
    Returns:
    
    a hash code value for this SBase instance.
    
    See Also:
    
    Object.hashCode()
  - hasRequiredAttributes
```
public boolean hasRequiredAttributes()
```
    Predicate returning true or false depending on whether all the required attributes for this Unit object have been set.
    
    Returns:
    
    a boolean value indicating whether all the required elements for this object have been defined.
  - initDefaults
```
public void initDefaults()
```
    Initializes the default values using the current Level/Version configuration.
  - initDefaults
```
public void initDefaults(int level,
                         int version)
```
    Initializes the attributes of this Unit (except for 'kind') to their defaults values. The default values are as follows:
    - exponent = 1
    - scale = 0
    - multiplier = 1.0
    The 'kind' attribute is left unchanged.
    Parameters:
    
    level -
    
    version -
  - initDefaults
```
public void initDefaults(int level,
                         int version,
                         boolean explicit)
```
    Parameters:
    
    level -
    
    version -
    
    explicit - switch to decide if all properties that are set by this method should also be explicitly marked as being set. For instance, if this method is invoked for Level 2 Version 4, there is a default value for most properties. If a value is not explicitly defined, the default value is used and the XML serialization can omit this attribute. Note that if the level argument exceeds two, this boolean argument is ignored, because then there is no default and everything will be set to null by this method anyway. Only the offset will not be affected by the explicit parameter because this value is optional or not even defined in certain levels of SBML and can therefore always be omitted. It has been recognized that the offset field produces more problems if it is being explicitly defined, so here it is set to zero if the level surpasses 3, but it won't be written to SBML, unless it is modified later on by the user.
  - isAmpere
```
public boolean isAmpere()
```
    Predicate for testing whether this Unit is of the kind ampere.
    
    Returns:
  - isAvogadro
```
public boolean isAvogadro()
```
    Predicate for testing whether this Unit is of the kind avogadro.
    
    Returns:
    
    true if the kind of this Unit is avogadro, false otherwise.
  - isBecquerel
```
public boolean isBecquerel()
```
    Predicate for testing whether this Unit is of the kind becquerel.
    
    Returns:
  - isCandela
```
public boolean isCandela()
```
    Predicate for testing whether this Unit is of the kind candela
    
    Returns:
  - isCelsius
```
@Deprecated
public boolean isCelsius()
```
    Deprecated. Unit.Kind.CELSIUS should no longer be used.
    
    Predicate for testing whether this Unit is of the kind Celsius
    
    Returns:
  - isCoulomb
```
public boolean isCoulomb()
```
    Predicate for testing whether this Unit is of the kind coulomb.
    
    Returns:
  - isDimensionless
```
public boolean isDimensionless()
```
    Predicate for testing whether this Unit is of the Unit.Kind Unit.Kind.DIMENSIONLESS. A unit is also dimensionless if it does not declare an offset and at the same time its exponent is zero. In this case the unit represents a dimensionless quantity.
    
    Returns:
    
    True if this unit represents a dimensionless quantity, i.e., its Unit.Kind is Unit.Kind.DIMENSIONLESS or offset = exponent = 0
  - isFarad
```
public boolean isFarad()
```
    Predicate for testing whether this Unit is of the kind farad
    
    Returns:
  - isGram
```
public boolean isGram()
```
    Predicate for testing whether this Unit is of the kind gram
    
    Returns:
  - isGray
```
public boolean isGray()
```
    Predicate for testing whether this Unit is of the kind gray
    
    Returns:
  - isHenry
```
public boolean isHenry()
```
    Predicate for testing whether this Unit is of the kind henry
    
    Returns:
  - isHertz
```
public boolean isHertz()
```
    Predicate for testing whether this Unit is of the kind hertz
    
    Returns:
  - isInvalid
```
public boolean isInvalid()
```
    Predicate for testing whether this Unit is of the kind invalid.
    
    Returns:
  - isItem
```
public boolean isItem()
```
    Predicate for testing whether this Unit is of the kind item
    
    Returns:
  - isJoule
```
public boolean isJoule()
```
    Predicate for testing whether this Unit is of the kind Joule
    
    Returns:
  - isKatal
```
public boolean isKatal()
```
    Predicate for testing whether this Unit is of the kind katal
    
    Returns:
  - isKelvin
```
public boolean isKelvin()
```
    Predicate for testing whether this Unit is of the kind kelvin
    
    Returns:
  - isKilogram
```
public boolean isKilogram()
```
    Predicate for testing whether this Unit is of the kind kilogram
    
    Returns:
  - isLitre
```
public boolean isLitre()
```
    Predicate for testing whether this Unit is of the kind litre.
    
    Returns:
    
    true if the kind of this Unit is litre or 'liter', false otherwise.
  - isLumen
```
public boolean isLumen()
```
    Predicate for testing whether this Unit is of the kind lumen
    
    Returns:
  - isLux
```
public boolean isLux()
```
    Predicate for testing whether this Unit is of the kind lux
    
    Returns:
  - isMetre
```
public boolean isMetre()
```
    Predicate for testing whether this Unit is of the kind metre
    
    Returns:
  - isMole
```
public boolean isMole()
```
    Predicate for testing whether this Unit is of the kind mole.
    
    Returns:
    
    true if the kind of this Unit is mole, false otherwise.
  - isNewton
```
public boolean isNewton()
```
    Predicate for testing whether this Unit is of the kind newton
    
    Returns:
  - isOhm
```
public boolean isOhm()
```
    Predicate for testing whether this Unit is of the kind ohm
    
    Returns:
  - isPascal
```
public boolean isPascal()
```
    Predicate for testing whether this Unit is of the kind pascal
    
    Returns:
  - isRadian
```
public boolean isRadian()
```
    Predicate for testing whether this Unit is of the kind radian
    
    Returns:
  - isSecond
```
public boolean isSecond()
```
    Predicate for testing whether this Unit is of the kind second
    
    Returns:
  - isSetExponent
```
public boolean isSetExponent()
```
    Returns:
    
    true if the exponent of this Unit is not null.
  - isSetKind
```
public boolean isSetKind()
```
    Predicate to test whether the 'kind' attribute of this Unit has been set.
    
    Returns:
  - isSetMultiplier
```
public boolean isSetMultiplier()
```
    Returns:
    
    true if the multiplier of this Unit is not null.
  - isSetOffset
```
@Deprecated
public boolean isSetOffset()
```
    Deprecated. the offset attribute should no longer be used.
    
    Returns:
  - isSetScale
```
public boolean isSetScale()
```
    Returns:
    
    true if the scale of this Unit is not null.
  - isSiemens
```
public boolean isSiemens()
```
    Predicate for testing whether this Unit is of the kind siemens
    
    Returns:
  - isSievert
```
public boolean isSievert()
```
    Predicate for testing whether this Unit is of the kind sievert
    
    Returns:
  - isSteradian
```
public boolean isSteradian()
```
    Predicate for testing whether this Unit is of the kind steradian
    
    Returns:
  - isTesla
```
public boolean isTesla()
```
    Predicate for testing whether this Unit is of the kind tesla
    
    Returns:
  - isVariantOfArea
```
public boolean isVariantOfArea()
```
    Returns:
    
    true if this Unit is a variant of area.
  - isVariantOfLength
```
public boolean isVariantOfLength()
```
    Returns:
    
    true if this Unit is a variant of length.
  - isVariantOfSubstance
```
public boolean isVariantOfSubstance()
```
    Returns:
    
    true if this Unit is a variant of substance.
  - isVariantOfTime
```
public boolean isVariantOfTime()
```
    Returns:
  - isVariantOfVolume
```
public boolean isVariantOfVolume()
```
    Returns:
    
    true if this Unit is a variant of volume.
  - isVolt
```
public boolean isVolt()
```
    Predicate for testing whether this Unit is of the kind volt
    
    Returns:
  - isWatt
```
public boolean isWatt()
```
    Predicate for testing whether this Unit is of the kind watt
    
    Returns:
  - isWeber
```
public boolean isWeber()
```
    Predicate for testing whether this Unit is of the kind weber
    
    Returns:
  - readAttribute
```
public boolean readAttribute(java.lang.String attributeName,
                             java.lang.String prefix,
                             java.lang.String value)
```
    Description copied from interface: SBase
    
    Sets the given attribute in this SBase.
    If the given attribute name is not recognized, nothing is done and false is returned.
    
    Specified by:
    
    readAttribute in interface SBase
    
    Overrides:
    
    readAttribute in class AbstractSBase
    
    Parameters:
    
    attributeName - localName of the XML attribute
    
    prefix - prefix of the XML attribute
    
    value - value of the XML attribute
    
    Returns:
    
    true if the attribute has been successfully read.
  - removeMultiplier
```
public Unit removeMultiplier()
```
    This method tries to remove the multiplier of this unit. Nothing will happen in the case that there is no multiplier. Otherwise, it first computes the decadic logarithm of the multiplier. If this logarithm is either an integer or nearly an integer (with an accepted error of 10^-15), it is added to the scale and the multiplier is set to 1. Note that it is not always possible to remove the multiplier without loosing information. In order to avoid computational errors, nothing is done if the rounding error would be too large.
    
    Returns:
    
    a pointer to this Unit.
  - removeOffset
```
public Unit removeOffset()
```
    We remove the offset by expressing it within a new multiplier, m':
    m' = offset / 10^scale + multiplier
    When inserting this again into the unit formula, the offset vanishes:
    ((offset + multiplier * 10^scale) * kind)^exponent
    then becomes
    (0 + (offset / 10^scale + multiplier) * 10^scale * kind)^exponent =
    (m' * 10^scale * kind)^exponent
    This is possible because offset and multiplier are real double numbers.
    
    Returns:
    
    this Unit whose offset and multiplier might have been changed in case that there was an offset defined that was different to zero.
  - removeScale
```
public Unit removeScale()
```
    Manipulates the attributes of the Unit to express the unit with the value of the scale attribute reduced to zero. For example, 1 millimetre can be expressed as a Unit with kind= 'metre' multiplier='1' scale='-3' exponent='1'. It can also be expressed as a Unit with kind='metre' multiplier='0.001' scale='0' exponent='1'.
    
    Returns:
  - setExponent
```
public void setExponent(double exponent)
```
    Sets the exponent of this Unit
    
    Parameters:
    
    exponent -
  - setExponent
```
@Deprecated
public void setExponent(int exponent)
```
    Deprecated. use setExponent(double)
    
    Sets the exponent of this Unit
    
    Parameters:
    
    exponent -
  - setKind
```
public void setKind(Unit.Kind kind)
```
    Sets the Unit.Kind of this Unit
    
    Parameters:
    
    kind -
  - setMultiplier
```
public void setMultiplier(double multiplier)
```
    Sets the multiplier of this Unit
    
    Parameters:
    
    multiplier -
    
    Throws:
    
    PropertyNotAvailableException - if Level < 2 and the given multiplier != 1.
  - setOffset
```
@Deprecated
public void setOffset(double offset)
```
    Deprecated. Only defined for SBML Level 2 Version 1.
    
    Sets the offset of this Unit
    
    Parameters:
    
    offset -
    
    Throws:
    
    PropertyNotAvailableException - if Level/Version combination is not 2.1.
  - setScale
```
public void setScale(int scale)
```
    Sets the scale of this Unit
    
    Parameters:
    
    scale -
  - printUnit
```
public java.lang.String printUnit()
```
    Produces a text formula representation of this unit.
  - unsetExponent
```
public void unsetExponent()
```
  - unsetKind
```
public void unsetKind()
```
  - unsetMultiplier
```
public void unsetMultiplier()
```
  - unsetOffset
```
@Deprecated
public void unsetOffset()
```
    Deprecated. the offset attribute should no longer be used.
  - unsetScale
```
public void unsetScale()
```
  - writeXMLAttributes
```
public java.util.Map<java.lang.String,java.lang.String> writeXMLAttributes()
```
    Description copied from interface: SBase
    
    Returns a map with all the attributes of this SBase that need to be written out in XML.
    The attribute name is used as a key and the attribute value as value. If a prefix is needed for the attribute name, it need to be set directly in this map.
    
    Specified by:
    
    writeXMLAttributes in interface SBase
    
    Overrides:
    
    writeXMLAttributes in class AbstractSBase
    
    Returns:
    
    a Map containing the XML attributes of this object.

Class Unit

Nested Class Summary

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.AbstractSBase

Methods inherited from class org.sbml.jsbml.AbstractTreeNode

Methods inherited from class java.lang.Object

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

logger

serialVersionUID

exponent

isSetExponent

isSetMultiplier

isSetOffset

isSetScale

kind

multiplier

offset

scale

Constructor Detail

Unit

Unit

Unit

Unit

Unit

Unit

Unit

Unit

Unit

Method Detail

areEquivalent

areEquivalent

areIdentical

convertToSI

isBuiltIn

isPredefined

isPredefined

isUnitKind

isUnitKind

isValidUnit

merge

removeScale

clone

equals

getExponent

getExponentAsDouble

getKind

getMultiplier

getOffset

getParent

getPrefix

getPrefixAsWord

getScale

hashCode

hasRequiredAttributes

initDefaults

initDefaults

initDefaults

isAmpere

isAvogadro

isBecquerel

isCandela

isCelsius

isCoulomb

isDimensionless

isFarad

isGram

isGray

isHenry

isHertz

isInvalid

isItem

isJoule

isKatal