org.sbml.jsbml.math

Class ASTCnExponentialNode

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.math.AbstractASTNode

org.sbml.jsbml.math.ASTNumber

org.sbml.jsbml.math.ASTCnNumberNode<ValuePair<java.lang.Integer,java.lang.Double>>

org.sbml.jsbml.math.ASTCnExponentialNode

All Implemented Interfaces:

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

public class ASTCnExponentialNode
extends ASTCnNumberNode<ValuePair<java.lang.Integer,java.lang.Double>>

An Abstract Syntax Tree (AST) node representing an exponent in a mathematical expression

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.
private static long	serialVersionUID

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

number

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, UNKNOWN_ATTRIBUTES, UNKNOWN_ELEMENTS

Constructor Summary

Constructors

Constructor and Description
ASTCnExponentialNode() Creates a new ASTCnExponentialNode that lacks a pointer to its containing MathContainer.
ASTCnExponentialNode(ASTCnExponentialNode node) Copy constructor; Creates a deep copy of the given ASTCnExponentialNode.

Method Summary

Modifier and Type	Method and Description
ASTCnExponentialNode	clone() Clone ASTNode2
ASTNode2Value<?>	compile(ASTNode2Compiler compiler) Compiles this ASTNode2 and returns the result.
int	getExponent() Get the exponent value of this node.
double	getMantissa() Get the mantissa value of this node.
boolean	isAllowableType(ASTNode.Type type) Returns true iff type is allowed in this ASTNode2
boolean	isSetExponent() Returns True iff exponent has been set
boolean	isSetMantissa() Returns true iff mantissa has been set
void	setExponent(int exponent) Set the exponent value of this node
void	setMantissa(double mantissa) Get the mantissa value of this node
java.lang.String	toFormula() Converts this ASTNode2 to a text string using a specific syntax for mathematical formulas.
java.lang.String	toLaTeX() Converts this node recursively into a LaTeX formatted String.
java.lang.String	toMathML() Converts this node recursively into a MathML string that corresponds to the subset of MathML defined in the SBML specification.
java.lang.String	toString()

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

deriveUnit, equals, getNumber, getUnits, getUnitsInstance, getVariable, hashCode, hasUnits, isSetNumber, isSetUnits, isSetVariable, setNumber, setUnits, setVariable, unsetUnits

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, 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, isRoot, isSetParent, isSetUserObjects, notifyChildChange, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, userObjectKeySet

Methods inherited from class java.lang.Object

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

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.

Constructor Detail

ASTCnExponentialNode

public ASTCnExponentialNode()

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

ASTCnExponentialNode

public ASTCnExponentialNode(ASTCnExponentialNode node)

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

Parameters:

node - the ASTCnExponentialNode to be copied.

Method Detail

clone

public ASTCnExponentialNode clone()

Description copied from interface: ASTNode2

Clone ASTNode2

Specified by:

clone in interface ASTNode2

Overrides:

clone in class ASTCnNumberNode<ValuePair<java.lang.Integer,java.lang.Double>>

Returns:

ASTNode2 node

compile

public ASTNode2Value<?> compile(ASTNode2Compiler compiler)

Description copied from interface: ASTNode2

Compiles this ASTNode2 and returns the result.

Specified by:

compile in interface ASTNode2

Overrides:

compile in class ASTCnNumberNode<ValuePair<java.lang.Integer,java.lang.Double>>

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.

getExponent

public int getExponent()

Get the exponent value of this node.

Returns:

int exponent

getMantissa

public double getMantissa()

Get the mantissa value of this node.

Returns:

double mantissa

isAllowableType

public boolean isAllowableType(ASTNode.Type type)

Description copied from interface: ASTNode2

Returns true iff type is allowed in this ASTNode2

Specified by:

isAllowableType in interface ASTNode2

Overrides:

isAllowableType in class ASTCnNumberNode<ValuePair<java.lang.Integer,java.lang.Double>>

Returns:

isSetExponent

public boolean isSetExponent()

Returns True iff exponent has been set

Returns:

boolean

isSetMantissa

public boolean isSetMantissa()

Returns true iff mantissa has been set

Returns:

boolean

setExponent

public void setExponent(int exponent)

Set the exponent value of this node

Parameters:

exponent -

setMantissa

public void setMantissa(double mantissa)

Get the mantissa value of this node

Parameters:

mantissa -

toFormula

public java.lang.String toFormula()
                           throws SBMLException

Description copied from interface: ASTNode2

Converts this ASTNode2 to a text string using a specific syntax for mathematical formulas.

The text-string form of mathematical formulas produced by formulaToString() and read by parseFormula() are simple C-inspired infix notation taken from SBML Level 1. A formula in this text-string form therefore can be handed to a program that understands SBML Level 1 mathematical expressions, or used as part of a formula translation system. The syntax is described in detail in the documentation for ASTNode.

Specified by:

toFormula in interface ASTNode2

Overrides:

toFormula in class AbstractASTNode

Returns:

the formula from the given AST as an SBML Level 1 text-string mathematical formula. The caller owns the returned string and is responsible for freeing it when it is no longer needed. null is returned if the given argument is null.

Throws:

SBMLException - if there is a problem in the ASTNode2 tree.

toLaTeX

public java.lang.String toLaTeX()
                         throws SBMLException

Description copied from interface: ASTNode2

Converts this node recursively into a LaTeX formatted String.

Specified by:

toLaTeX in interface ASTNode2

Overrides:

toLaTeX in class AbstractASTNode

Returns:

A String representing the LaTeX code necessary to write the formula corresponding to this node in a document.

Throws:

SBMLException - if there is a problem in the AbstractASTNode tree.

toMathML

public java.lang.String toMathML()

Description copied from interface: ASTNode2

Converts this node recursively into a MathML string that corresponds to the subset of MathML defined in the SBML specification.

Specified by:

toMathML in interface ASTNode2

Overrides:

toMathML in class AbstractASTNode

Returns:

the representation of this node in MathML.

toString

public java.lang.String toString()

Specified by:

toString in interface ASTNode2

Overrides:

toString in class ASTCnNumberNode<ValuePair<java.lang.Integer,java.lang.Double>>