org.sbml.jsbml.math

Class ASTCnNumberNode<T>

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.math.AbstractASTNode

org.sbml.jsbml.math.ASTNumber

org.sbml.jsbml.math.ASTCnNumberNode<T>

Type Parameters:

T -

All Implemented Interfaces:

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

Direct Known Subclasses:

ASTCnExponentialNode, ASTCnIntegerNode, ASTCnRationalNode, ASTCnRealNode

public class ASTCnNumberNode<T>
extends ASTNumber

An Abstract Syntax Tree (AST) node representing a MathML cn element in a mathematical expression. cn elements are used to specify actual numerical constants.

Since:

1.0

Version:

$Rev$

Author:

Victor Kofia

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static org.apache.log4j.Logger	logger A Logger for this class.
protected T	number Numerical base for MathML element
private static long	serialVersionUID
private java.lang.String	units units attribute for MathML element
private java.lang.String	variable variable attribute for MathML element

Fields inherited from class org.sbml.jsbml.math.AbstractASTNode

id, mathMLClass, parentSBMLObject, strict, style, type

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, resourceBundle

Constructor Summary

Constructors

Constructor and Description
ASTCnNumberNode() Creates a new ASTCnNumberNode that lacks a pointer to its containing MathContainer.
ASTCnNumberNode(ASTCnNumberNode<T> node) Copy constructor; Creates a deep copy of the given ASTCnNumberNode.
ASTCnNumberNode(java.lang.String variable) Creates a new ASTCnNumberNode that lacks a pointer to its containing MathContainer and has a variable String.

Method Summary

Modifier and Type	Method and Description
ASTCnNumberNode<T>	clone() Clone ASTNode2
ASTNode2Value<?>	compile(ASTNode2Compiler compiler) Compiles this ASTNode2 and returns the result.
UnitDefinition	deriveUnit() Evaluates recursively this ASTCnNumberNode and creates a new UnitDefinition with respect to all referenced elements.
boolean	equals(java.lang.Object obj)
T	getNumber() Get the numerical base of MathML element.
java.lang.String	getUnits() Returns the units of the MathML element represented by this ASTCnNumberNode
UnitDefinition	getUnitsInstance() Creates or obtains a UnitDefinition corresponding to the unit that has been set for this ASTCnNumberNode and returns a pointer to it.
java.lang.String	getVariable() Get the variable for this ASTNumber node
int	hashCode()
boolean	hasUnits() Returns true if the current ASTCnNumberNode or any of its descendants has a unit defined.
boolean	isAllowableType(ASTNode.Type type) Returns true iff type is allowed in this ASTNode2
protected boolean	isSetNumber() Returns True iff base has been set
boolean	isSetUnits() Returns True iff units has been set
protected boolean	isSetVariable() Returns true iff this ASTNumber node represents a variable.
void	setNumber(T number) Set the numerical base of MathML element.
void	setUnits(java.lang.String units) Set the units of the MathML element represented by this ASTCnNumberNode
void	setVariable(java.lang.String variable) Set the variable for this ASTNumber node
void	unsetUnits() Unset the units attribute.

Methods inherited from class org.sbml.jsbml.math.ASTNumber

getAllowsChildren, getChildAt, getChildCount

Methods inherited from class org.sbml.jsbml.math.AbstractASTNode

getId, getMathMLClass, getParentSBMLObject, getStyle, getType, isSetId, isSetMathMLClass, isSetParentSBMLObject, isSetStyle, isSetType, isStrict, processValue, setId, setMathMLClass, setParent, setParentSBMLObject, setStrictness, setStyle, setType, setType, toFormula, toLaTeX, toMathML, unsetParentSBMLObject

Methods inherited from class org.sbml.jsbml.AbstractTreeNode

addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, children, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, fireNodeRemovedEvent, firePropertyChange, getIndex, getListOfTreeNodeChangeListeners, getNumChildren, getParent, getRoot, getTreeNodeChangeListenerCount, getUserObject, indexOf, isLeaf, isReadingInProgress, isRoot, isSetParent, isSetUserObjects, notifyChildChange, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, toString, userObjectKeySet

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.sbml.jsbml.math.ASTNode2

toString

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

addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, fireNodeRemovedEvent, firePropertyChange, getListOfTreeNodeChangeListeners, getRoot, getTreeNodeChangeListenerCount, getUserObject, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, userObjectKeySet

Methods inherited from interface javax.swing.tree.TreeNode

children, getIndex, getParent, isLeaf

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

logger

private static final org.apache.log4j.Logger logger

A Logger for this class.

number

protected T number

Numerical base for MathML element

units

private java.lang.String units

units attribute for MathML element

variable

private java.lang.String variable

variable attribute for MathML element

Constructor Detail

ASTCnNumberNode

public ASTCnNumberNode()

Creates a new ASTCnNumberNode that lacks a pointer to its containing MathContainer.

ASTCnNumberNode

public ASTCnNumberNode(ASTCnNumberNode<T> node)

Copy constructor; Creates a deep copy of the given ASTCnNumberNode.

Parameters:

node - the ASTCnNumberNode to be copied.

ASTCnNumberNode

public ASTCnNumberNode(java.lang.String variable)

Creates a new ASTCnNumberNode that lacks a pointer to its containing MathContainer and has a variable String.

Parameters:

variable -

Method Detail

clone

public ASTCnNumberNode<T> clone()

Description copied from interface: ASTNode2

Clone ASTNode2

Specified by:

clone in interface ASTNode2

Specified by:

clone in class ASTNumber

Returns:

ASTNode2 node

compile

public ASTNode2Value<?> compile(ASTNode2Compiler compiler)

Description copied from interface: ASTNode2

Compiles this ASTNode2 and returns the result.

Parameters:

compiler - An instance of an ASTNode2Compiler that provides methods to translate this ASTNode2 into something different.

Returns:

Some value wrapped in an ASTNode2Value. The content of the wrapper depends on the ASTNode2Compiler used to create it. However, this ASTNode2 will ensure that level and version are set appropriately according to this node's parent SBML object.

deriveUnit

public UnitDefinition deriveUnit()
                          throws SBMLException

Evaluates recursively this ASTCnNumberNode and creates a new UnitDefinition with respect to all referenced elements.

Returns:

the derived unit of the node.

Throws:

SBMLException - if they are problems going through the ASTNode2 tree.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class AbstractASTNode

getNumber

public T getNumber()

Get the numerical base of MathML element. Number (CDATA for XML DTD) between 2 and 36.

Returns:

T number

Throws:

PropertyUndefinedError

getUnits

public java.lang.String getUnits()

Returns the units of the MathML element represented by this ASTCnNumberNode

Returns:

String units

getUnitsInstance

public UnitDefinition getUnitsInstance()

Creates or obtains a UnitDefinition corresponding to the unit that has been set for this ASTCnNumberNode and returns a pointer to it. Note that in case that this ASTCnNumberNode is associated with a Kind, the created UnitDefinition will not be part of the model, it is just a container for the Kind.

Returns:

A UnitDefinition or null.

getVariable

public java.lang.String getVariable()

Get the variable for this ASTNumber node

Returns:

variable String

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractASTNode

hasUnits

public boolean hasUnits()

Returns true if the current ASTCnNumberNode or any of its descendants has a unit defined.

Returns:

true if the current ASTCnNumberNode or any of its descendants has a unit defined.

isAllowableType

public boolean isAllowableType(ASTNode.Type type)

Description copied from interface: ASTNode2

Returns true iff type is allowed in this ASTNode2

Returns:

isSetNumber

protected boolean isSetNumber()

Returns True iff base has been set

Returns:

boolean

isSetUnits

public boolean isSetUnits()

Returns True iff units has been set

Returns:

boolean

isSetVariable

protected boolean isSetVariable()

Returns true iff this ASTNumber node represents a variable.

Returns:

setNumber

public void setNumber(T number)

Set the numerical base of MathML element. Number (CDATA for XML DTD) between 2 and 36

Parameters:

number -

setUnits

public void setUnits(java.lang.String units)

Set the units of the MathML element represented by this ASTCnNumberNode

Parameters:

units -

setVariable

public void setVariable(java.lang.String variable)

Set the variable for this ASTNumber node

Parameters:

variable - String

unsetUnits

public void unsetUnits()

Unset the units attribute.