org.sbml.jsbml.math

Class ASTUnaryFunctionNode

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.math.AbstractASTNode

org.sbml.jsbml.math.ASTFunction

org.sbml.jsbml.math.ASTUnaryFunctionNode

All Implemented Interfaces:

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

Direct Known Subclasses:

ASTHyperbolicNode, ASTTrigonometricNode

public class ASTUnaryFunctionNode
extends ASTFunction

An Abstract Syntax Tree (AST) node representing a function with only one parameter

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

listOfNodes

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
ASTUnaryFunctionNode() Creates a new ASTUnaryFunctionNode.
ASTUnaryFunctionNode(ASTNode.Type type) Creates a new ASTUnaryFunctionNode of type ASTNode.Type
ASTUnaryFunctionNode(ASTUnaryFunctionNode node) Copy constructor; Creates a deep copy of the given ASTUnaryFunctionNode.

Method Summary

Modifier and Type	Method and Description
void	addChild(ASTNode2 child) Adds a child to this node.
ASTUnaryFunctionNode	clone() Clone ASTNode2
ASTNode2Value<?>	compile(ASTNode2Compiler compiler) Compiles this ASTNode2 and returns the result.
ASTNode2	getChild() Get the child of this node
ASTNode2	getChildAt(int childIndex)
void	insertChild(int n, ASTNode2 newChild) Inserts the given ASTNode2 at point n in the list of children of this ASTNode2.
boolean	isAllowableType(ASTNode.Type type) Returns true iff type is allowed in this ASTNode2
boolean	isSetChild() Returns true iff the child of this node has been set
void	prependChild(ASTNode2 child) Adds the given node as a child of this ASTFunction.
boolean	removeChild(int n) Removes child n of this ASTFunction.
void	setChild(ASTNode2 child) Set the child of this node
void	swapChildren(ASTFunction that) Swaps the children of this ASTFunction with the children of that ASTFunction.
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.

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

equals, findReferencedCallableSBases, getAllowsChildren, getChildCount, getChildren, getListOfNodes, getListOfNodes, getName, hashCode, hasUnits, isSetList, isSetName, replaceChild, setName, setParentSBMLObject

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

getId, getMathMLClass, getParentSBMLObject, getStyle, getType, isSetId, isSetMathMLClass, isSetParentSBMLObject, isSetStyle, isSetType, isStrict, processValue, setId, setMathMLClass, setParent, 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, 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, toString, 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.

Constructor Detail

ASTUnaryFunctionNode

public ASTUnaryFunctionNode()

Creates a new ASTUnaryFunctionNode.

ASTUnaryFunctionNode

public ASTUnaryFunctionNode(ASTUnaryFunctionNode node)

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

Parameters:

node - the ASTUnaryFunctionNode to be copied.

ASTUnaryFunctionNode

public ASTUnaryFunctionNode(ASTNode.Type type)

Creates a new ASTUnaryFunctionNode of type ASTNode.Type

Parameters:

type -

Method Detail

addChild

public void addChild(ASTNode2 child)

Description copied from class: ASTFunction

Adds a child to this node.

Overrides:

addChild in class ASTFunction

Parameters:

child - the node to add as child.

clone

public ASTUnaryFunctionNode clone()

Description copied from interface: ASTNode2

Clone ASTNode2

Specified by:

clone in interface ASTNode2

Overrides:

clone in class ASTFunction

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 ASTFunction

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.

getChild

public ASTNode2 getChild()

Get the child of this node

Returns:

ASTNode2 child

getChildAt

public ASTNode2 getChildAt(int childIndex)

Specified by:

getChildAt in interface javax.swing.tree.TreeNode

Overrides:

getChildAt in class ASTFunction

insertChild

public void insertChild(int n,
                        ASTNode2 newChild)

Description copied from class: ASTFunction

Inserts the given ASTNode2 at point n in the list of children of this ASTNode2. Inserting a child within an ASTNode2 may result in an inaccurate representation.

Overrides:

insertChild in class ASTFunction

Parameters:

n - long the index of the ASTNode2 being added

newChild - ASTNode2 to insert as the n^th child

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 ASTFunction

Returns:

isSetChild

public boolean isSetChild()

Returns true iff the child of this node has been set

Returns:

boolean

prependChild

public void prependChild(ASTNode2 child)

Description copied from class: ASTFunction

Adds the given node as a child of this ASTFunction. This method adds child nodes from right to left.

Overrides:

prependChild in class ASTFunction

Parameters:

child - an ASTNode2

removeChild

public boolean removeChild(int n)

Description copied from class: ASTFunction

Removes child n of this ASTFunction. Removing a child from an ASTFunction may result in an inaccurate representation.

Overrides:

removeChild in class ASTFunction

Parameters:

n - the index of the child to remove

Returns:

boolean indicating the success or failure of the operation

setChild

public void setChild(ASTNode2 child)

Set the child of this node

Parameters:

child -

swapChildren

public void swapChildren(ASTFunction that)

Description copied from class: ASTFunction

Swaps the children of this ASTFunction with the children of that ASTFunction.

Unfortunately, when swapping child nodes, we have to recursively traverse the entire subtrees in order to make sure that all pointers to the parent SBML object are correct. However, this must only be done if the parent SBML object of that differs from the one surrounding this node.

In any case, the pointer from each sub-node to its parent must be changed. In contrast to other SBML elements, ASTFunctions have sub-nodes as direct children, i.e., there is no child called 'ListOfNodes'. The setParent method is also not recursive.

However, this might cause many calls to listeners.

Overrides:

swapChildren in class ASTFunction

Parameters:

that - the other node whose children should be used to replace this node's children

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.