Package org.sbml.jsbml.math

Class ASTCSymbolAvogadroNode

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.math.AbstractASTNode

org.sbml.jsbml.math.ASTNumber

org.sbml.jsbml.math.ASTConstantNumber

org.sbml.jsbml.math.ASTCSymbolAvogadroNode

All Implemented Interfaces:

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

public class ASTCSymbolAvogadroNode
extends ASTConstantNumber
implements ASTCSymbolNode

An Abstract Syntax Tree (AST) node representing avogadro's number

Since:

1.0

Author:

Victor Kofia

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ASTCSymbolAvogadroNode()	Creates a new ASTCSymbolAvogadroNode.
ASTCSymbolAvogadroNode(ASTCSymbolAvogadroNode node)	Copy constructor; Creates a deep copy of the given ASTCSymbolAvogadroNode.

Method Summary

Modifier and Type	Method	Description
ASTCSymbolAvogadroNode	clone()	Clone ASTNode2
ASTNode2Value<?>	compile(ASTNode2Compiler compiler)	Compiles this ASTNode2 and returns the result.
boolean	equals(java.lang.Object obj)
java.lang.String	getDefinitionURL()	Returns the definitionURL of the MathML element represented by this ASTCSymbolBaseNode
java.lang.String	getEncoding()	Returns the encoding of the MathML element represented by this ASTCSymbolNode
java.lang.String	getName()	Returns the name of the MathML element represented by this ASTCSymbolBaseNode
double	getValue()	Get the value of this ASTConstantNumber
int	hashCode()
boolean	isAllowableType(ASTNode.Type type)	Returns true iff type is allowed in this ASTNode2
boolean	isSetDefinitionURL()	Returns True iff definitionURL has been set
boolean	isSetEncoding()	Returns true iff encoding has been set
boolean	isSetName()	Returns True iff name has been set
boolean	isSetType()	Returns true iff type has been set
boolean	refersTo(java.lang.String id)	Returns true if this node or one of its descendants contains some identifier with the given id.
void	setName(java.lang.String name)	Set the name of the MathML element represented by this ASTCSymbolBaseNode

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

getId, getMathMLClass, getParentSBMLObject, getStyle, getType, isSetId, isSetMathMLClass, isSetParentSBMLObject, isSetStyle, isStrict, 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, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, toString, userObjectKeySet

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

setValue, toFormula, toLaTeX, toMathML

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

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

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

getAllowsChildren, getChildAt, getChildCount

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.swing.tree.TreeNode

children, getAllowsChildren, getChildAt, getChildCount, getIndex, getParent, isLeaf

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

Constructor Detail

ASTCSymbolAvogadroNode

public ASTCSymbolAvogadroNode()

Creates a new ASTCSymbolAvogadroNode.

ASTCSymbolAvogadroNode

public ASTCSymbolAvogadroNode(ASTCSymbolAvogadroNode node)

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

Parameters:

node - the ASTCSymbolAvogadroNode to be copied.

Method Detail

clone

public ASTCSymbolAvogadroNode clone()

Description copied from interface: ASTNode2

Clone ASTNode2

Specified by:

clone in interface ASTNode2

Overrides:

clone in class ASTConstantNumber

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 ASTConstantNumber

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.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class AbstractASTNode

getDefinitionURL

public java.lang.String getDefinitionURL()

Description copied from interface: ASTCSymbolBaseNode

Returns the definitionURL of the MathML element represented by this ASTCSymbolBaseNode

Specified by:

getDefinitionURL in interface ASTCSymbolBaseNode

Returns:

String definitionURL

getEncoding

public java.lang.String getEncoding()

Description copied from interface: ASTCSymbolNode

Returns the encoding of the MathML element represented by this ASTCSymbolNode

Specified by:

getEncoding in interface ASTCSymbolNode

Returns:

String encoding

getName

public java.lang.String getName()

Description copied from interface: ASTCSymbolBaseNode

Returns the name of the MathML element represented by this ASTCSymbolBaseNode

Specified by:

getName in interface ASTCSymbolBaseNode

Returns:

String name

getValue

public double getValue()

Description copied from class: ASTConstantNumber

Get the value of this ASTConstantNumber

Overrides:

getValue in class ASTConstantNumber

Returns:

double value

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractASTNode

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 ASTConstantNumber

Returns:

isSetDefinitionURL

public boolean isSetDefinitionURL()

Description copied from interface: ASTCSymbolBaseNode

Returns True iff definitionURL has been set

Specified by:

isSetDefinitionURL in interface ASTCSymbolBaseNode

Returns:

boolean

isSetEncoding

public boolean isSetEncoding()

Description copied from interface: ASTCSymbolNode

Returns true iff encoding has been set

Specified by:

isSetEncoding in interface ASTCSymbolNode

Returns:

boolean

isSetName

public boolean isSetName()

Description copied from interface: ASTCSymbolBaseNode

Returns True iff name has been set

Specified by:

isSetName in interface ASTCSymbolBaseNode

Returns:

boolean

isSetType

public boolean isSetType()

Description copied from interface: ASTNode2

Returns true iff type has been set

Specified by:

isSetType in interface ASTNode2

Overrides:

isSetType in class ASTConstantNumber

Returns:

boolean

refersTo

public boolean refersTo(java.lang.String id)

Description copied from interface: ASTCSymbolBaseNode

Returns true if this node or one of its descendants contains some identifier with the given id. This method can be used to scan a formula for a specific parameter or species and detect whether this component is used by this formula. This search is done using a DFS.

Specified by:

refersTo in interface ASTCSymbolBaseNode

Parameters:

id - the id of an SBML element.

Returns:

true if this node or one of its descendants contains the given id.

setName

public void setName(java.lang.String name)

Description copied from interface: ASTCSymbolBaseNode

Set the name of the MathML element represented by this ASTCSymbolBaseNode

Specified by:

setName in interface ASTCSymbolBaseNode