ASTNodeValue

java.lang.Object
- org.sbml.jsbml.util.compilers.ASTNodeValue

```
public class ASTNodeValue
extends java.lang.Object
```
When interpreting ASTNodes, the ASTNodeCompiler takes elements of this class as arguments and performs its operations on it. Hence, this class represents the union of all possible types to which an abstract syntax tree can be evaluated, i.e., Boolean, CallableSBase, Number, or String. This class does not define what to do with these values or how to perform any operations on it. It is just the container of a value. The type of this value tells the ASTNodeCompiler which operation was performed to obtain the value stored in this object.

Since:

0.8

Version:

$Rev$

Author:

Andreas Dräger

Field Summary

Fields
Modifier and Type	Field and Description
`private ASTNodeCompiler`	`compiler` An `ASTNodeCompiler` that is needed in the case that this `ASTNodeValue` contains a derivative of `CallableSBase` as value to translate this value into a double.
`private int`	`level` The level of the underlying `SBMLDocument`.
`private ASTNode.Type`	`type` The type of the underlying `ASTNode`.
`private boolean`	`uFlag` Flag to indicate whether the underlying `ASTNode` was an unary node.
`private UnitDefinition`	`unitDef` The unit associated to the value of this object.
`private java.lang.Object`	`value` The actual value of this element.
`private int`	`version` The version of the underlying `SBMLDocument`.

Constructor Summary

Constructors
Constructor and Description
`ASTNodeValue(ASTNode.Type type, ASTNodeCompiler compiler)`
`ASTNodeValue(ASTNodeCompiler compiler)`
`ASTNodeValue(boolean value, ASTNodeCompiler compiler)`
`ASTNodeValue(CallableSBase value, ASTNodeCompiler compiler)`
`ASTNodeValue(double value, ASTNodeCompiler compiler)`
`ASTNodeValue(float value, ASTNodeCompiler compiler)`
`ASTNodeValue(int value, ASTNodeCompiler compiler)`
`ASTNodeValue(long value, ASTNodeCompiler compiler)`
`ASTNodeValue(org.w3c.dom.Node node, ASTNodeCompiler compiler)`
`ASTNodeValue(java.lang.Number value, ASTNodeCompiler compiler)`
`ASTNodeValue(java.lang.String value, ASTNodeCompiler compiler)`
`ASTNodeValue(UnitDefinition unit, ASTNodeCompiler compiler)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`containsUndeclaredUnits()` Flag to indicate whether or not units have been fully declared for this value.
`int`	`getLevel()` Returns the level of the SBML document that was the basis to create this `ASTNodeValue`.
`ASTNode.Type`	`getType()`
`UnitDefinition`	`getUnits()`
`java.lang.Object`	`getValue()`
`int`	`getVersion()`
`boolean`	`isBoolean()`
`boolean`	`isCallableSBase()`
`boolean`	`isDifference()`
`boolean`	`isNode()` Checks whether the value encapsulated in this `ASTNodeValue` is an instance of `Node`.
`boolean`	`isNumber()`
`boolean`	`isSetUnit()` Test if this value can be evaluated to a `UnitDefinition`
`boolean`	`isString()`
`boolean`	`isSum()`
`boolean`	`isUMinus()`
`boolean`	`isUnary()`
`java.lang.String`	`printValueAndUnit()`
`void`	`setLevel(int level)`
`void`	`setType(ASTNode.Type type)`
`void`	`setUIFlag(boolean uiFlag)`
`void`	`setUnits(UnitDefinition unit)`
`void`	`setValue(boolean value)`
`void`	`setValue(java.lang.Boolean value)`
`void`	`setValue(CallableSBase value)`
`void`	`setValue(double d)`
`void`	`setValue(int i)`
`void`	`setValue(long l)`
`void`	`setValue(org.w3c.dom.Node value)`
`void`	`setValue(java.lang.Number value)`
`void`	`setValue(short s)`
`void`	`setValue(java.lang.String value)`
`void`	`setVersion(int version)`
`boolean`	`toBoolean()` Analog to the toDouble() method but this method tries to evaluate the value contained in this object to a boolean value.
`CallableSBase`	`toCallableSBase()`
`double`	`toDouble()`
`float`	`toFloat()`
`int`	`toInteger()` This method is analog to the toDouble method but tries to convert this value into an integer.
`long`	`toLong()`
`org.w3c.dom.Node`	`toNode()`
`java.lang.Number`	`toNumber()` Tries to convert the value contained in this object into a double number.
`java.lang.String`	`toString()`
`void`	`unsetUnit()` Removes the unit of this element, i.e., the unit will become invalid.

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

- Field Detail
  - compiler
```
private ASTNodeCompiler compiler
```
    An ASTNodeCompiler that is needed in the case that this ASTNodeValue contains a derivative of CallableSBase as value to translate this value into a double. If the compiler does not convert instances of CallableSBase to double numbers, a ClassCastException will be thrown..
  - level
```
private int level
```
    The level of the underlying SBMLDocument.
  - type
```
private ASTNode.Type type
```
    The type of the underlying ASTNode.
  - uFlag
```
private boolean uFlag
```
    Flag to indicate whether the underlying ASTNode was an unary node.
  - unitDef
```
private UnitDefinition unitDef
```
    The unit associated to the value of this object.
  - value
```
private java.lang.Object value
```
    The actual value of this element. This is an Object, but indeed we restrict the possibilities to store only certain types here.
  - version
```
private int version
```
    The version of the underlying SBMLDocument.
- Constructor Detail
  - ASTNodeValue
```
public ASTNodeValue(ASTNodeCompiler compiler)
```
    Parameters:
    
    compiler -
  - ASTNodeValue
```
public ASTNodeValue(boolean value,
                    ASTNodeCompiler compiler)
```
    Parameters:
    
    value -
    
    compiler -
  - ASTNodeValue
```
public ASTNodeValue(double value,
                    ASTNodeCompiler compiler)
```
    Parameters:
    
    value -
    
    compiler -
  - ASTNodeValue
```
public ASTNodeValue(float value,
                    ASTNodeCompiler compiler)
```
    Parameters:
    
    value -
    
    compiler -
  - ASTNodeValue
```
public ASTNodeValue(long value,
                    ASTNodeCompiler compiler)
```
    Parameters:
    
    value -
    
    compiler -
  - ASTNodeValue
```
public ASTNodeValue(int value,
                    ASTNodeCompiler compiler)
```
    Parameters:
    
    value -
    
    compiler -
  - ASTNodeValue
```
public ASTNodeValue(CallableSBase value,
                    ASTNodeCompiler compiler)
```
    Parameters:
    
    value -
    
    compiler -
  - ASTNodeValue
```
public ASTNodeValue(org.w3c.dom.Node node,
                    ASTNodeCompiler compiler)
```
    Parameters:
    
    node -
    
    compiler -
  - ASTNodeValue
```
public ASTNodeValue(java.lang.Number value,
                    ASTNodeCompiler compiler)
```
    Parameters:
    
    value -
    
    compiler -
  - ASTNodeValue
```
public ASTNodeValue(java.lang.String value,
                    ASTNodeCompiler compiler)
```
    Parameters:
    
    value -
    
    compiler -
  - ASTNodeValue
```
ASTNodeValue(ASTNode.Type type,
             ASTNodeCompiler compiler)
```
    Parameters:
    
    type -
    
    compiler -
  - ASTNodeValue
```
public ASTNodeValue(UnitDefinition unit,
                    ASTNodeCompiler compiler)
```
    Parameters:
    
    unit -
    
    compiler -
- Method Detail
  - containsUndeclaredUnits
```
public boolean containsUndeclaredUnits()
```
    Flag to indicate whether or not units have been fully declared for this value.
    
    Returns:
  - getLevel
```
public int getLevel()
```
    Returns the level of the SBML document that was the basis to create this ASTNodeValue.
    
    Returns:
  - getType
```
public ASTNode.Type getType()
```
    Returns:
  - getUnits
```
public UnitDefinition getUnits()
```
    Returns:
  - getValue
```
public java.lang.Object getValue()
```
    Returns:
  - getVersion
```
public int getVersion()
```
    Returns:
    
    the version
  - isBoolean
```
public boolean isBoolean()
```
    Returns:
  - isDifference
```
public boolean isDifference()
```
    Returns:
  - isCallableSBase
```
public boolean isCallableSBase()
```
    Returns:
  - isNode
```
public boolean isNode()
```
    Checks whether the value encapsulated in this ASTNodeValue is an instance of Node.
    
    Returns:
  - isNumber
```
public boolean isNumber()
```
    Returns:
  - isSetUnit
```
public boolean isSetUnit()
```
    Test if this value can be evaluated to a UnitDefinition
    
    Returns:
  - isString
```
public boolean isString()
```
    Returns:
  - isSum
```
public boolean isSum()
```
    Returns:
  - isUMinus
```
public boolean isUMinus()
```
    Returns:
  - isUnary
```
public boolean isUnary()
```
    Returns:
  - printValueAndUnit
```
public java.lang.String printValueAndUnit()
```
    Returns:
  - setLevel
```
public void setLevel(int level)
```
    Parameters:
    
    level - the level to set
  - setType
```
public void setType(ASTNode.Type type)
```
    Parameters:
    
    type -
  - setUIFlag
```
public void setUIFlag(boolean uiFlag)
```
    Parameters:
    
    uiFlag -
  - setUnits
```
public void setUnits(UnitDefinition unit)
```
    Parameters:
    
    unit -
  - setValue
```
public void setValue(boolean value)
```
    Parameters:
    
    value -
  - setValue
```
public void setValue(java.lang.Boolean value)
```
    Parameters:
    
    value -
  - setValue
```
public void setValue(double d)
```
    Parameters:
    
    d -
  - setValue
```
public void setValue(int i)
```
    Parameters:
    
    i -
  - setValue
```
public void setValue(long l)
```
    Parameters:
    
    l -
  - setValue
```
public void setValue(CallableSBase value)
```
    Parameters:
    
    value -
  - setValue
```
public void setValue(org.w3c.dom.Node value)
```
    Parameters:
    
    value -
  - setValue
```
public void setValue(java.lang.Number value)
```
    Parameters:
    
    value -
  - setValue
```
public void setValue(short s)
```
    Parameters:
    
    s -
  - setValue
```
public void setValue(java.lang.String value)
```
    Parameters:
    
    value -
  - setVersion
```
public void setVersion(int version)
```
    Parameters:
    
    version - the version to set
  - toBoolean
```
public boolean toBoolean()
                  throws SBMLException
```
    Analog to the toDouble() method but this method tries to evaluate the value contained in this object to a boolean value. In case of numbers, one is considered true, all other values represent false.
    
    Returns:
    
    A boolean representing the value of this container. Note that if the value is an instance of CallableSBase, it can only be converted into a boolean value if the ASTNodeCompiler associated with this object compiles this value to an ASTNodeValue that contains a boolean or at least a Number value.
    
    Throws:
    
    SBMLException
  - toDouble
```
public double toDouble()
                throws SBMLException
```
    Returns:
    
    Throws:
    
    SBMLException
  - toFloat
```
public float toFloat()
              throws SBMLException
```
    Returns:
    
    Throws:
    
    SBMLException
  - toInteger
```
public int toInteger()
              throws SBMLException
```
    This method is analog to the toDouble method but tries to convert this value into an integer.
    
    Returns:
    
    Throws:
    
    SBMLException
  - toLong
```
public long toLong()
            throws SBMLException
```
    Returns:
    
    Throws:
    
    SBMLException
  - toCallableSBase
```
public CallableSBase toCallableSBase()
```
    Returns:
  - toNode
```
public org.w3c.dom.Node toNode()
```
    Returns:
  - toNumber
```
public java.lang.Number toNumber()
                          throws SBMLException
```
    Tries to convert the value contained in this object into a double number.
    
    Returns:
    
    The number value represented by this given ASTNodeValue. In case this ASTNodeValue contains an instance of Boolean, zero is returned for false and one for true. If the value is null or cannot be converted to any number, Double.NaN will be returned. Note that if the value of this container is an instance of CallableSBase, the value can only be converted to a number if the compiler associated with this ASTNodeValue compiles this CallableSBase to an ASTNodeValue that contains a Number.
    
    Throws:
    
    SBMLException
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - unsetUnit
```
public void unsetUnit()
```
    Removes the unit of this element, i.e., the unit will become invalid.

Class ASTNodeValue

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

compiler

level

type

uFlag

unitDef

value

version

Constructor Detail

ASTNodeValue

ASTNodeValue

ASTNodeValue

ASTNodeValue

ASTNodeValue

ASTNodeValue

ASTNodeValue

ASTNodeValue

ASTNodeValue

ASTNodeValue

ASTNodeValue

ASTNodeValue

Method Detail

containsUndeclaredUnits

getLevel

getType

getUnits

getValue

getVersion

isBoolean

isDifference

isCallableSBase

isNode

isNumber

isSetUnit

isString

isSum

isUMinus

isUnary

printValueAndUnit

setLevel

setType

setUIFlag

setUnits

setValue

setValue

setValue

setValue

setValue

setValue

setValue

setValue

setValue

setValue

setVersion

toBoolean

toDouble

toFloat

toInteger

toLong

toCallableSBase

toNode

toNumber

toString

unsetUnit