java.io.Serializable
, java.lang.Cloneable
, javax.swing.tree.TreeNode
, SBasePlugin
, TreeNodeWithChangeSupport
public class FBCSpeciesPlugin extends AbstractFBCSBasePlugin
Species
class with the additional
attributes charge and chemicalFormula.Constructor | Description |
---|---|
FBCSpeciesPlugin(FBCSpeciesPlugin obj) |
Clone constructor
|
FBCSpeciesPlugin(Species species) |
Creates an
FBCSpeciesPlugin instance |
Modifier and Type | Method | Description |
---|---|---|
FBCSpeciesPlugin |
clone() |
Creates a new instance of
SBasePlugin from this SBasePlugin . |
boolean |
getAllowsChildren() |
|
int |
getCharge() |
Returns the value of
charge . |
java.lang.String |
getChemicalFormula() |
Returns the value of
chemicalFormula . |
javax.swing.tree.TreeNode |
getChildAt(int index) |
|
int |
getChildCount() |
|
ListOf<Species> |
getParent() |
|
ListOf<Species> |
getParentSBMLObject() |
Returns the parent
SBase object to which this plugin object connected. |
void |
initDefaults() |
Initializes the default values.
|
boolean |
isSetCharge() |
Returns whether
charge is set. |
boolean |
isSetChemicalFormula() |
Returns whether
chemicalFormula is set. |
boolean |
readAttribute(java.lang.String attributeName,
java.lang.String prefix,
java.lang.String value) |
Reads and sets the attribute if it is know from this
SBasePlugin . |
void |
setCharge(int charge) |
Sets the value of charge.
|
void |
setChemicalFormula(java.lang.String chemicalFormula) |
Sets the value of chemicalFormula.
|
boolean |
unsetCharge() |
Unsets the variable charge
|
boolean |
unsetChemicalFormula() |
Unsets the variable chemicalFormula
|
java.util.Map<java.lang.String,java.lang.String> |
writeXMLAttributes() |
Returns a
Map containing the XML attributes of this object. |
getPackageName, getPrefix, getURI
equals, fireNodeAddedEvent, fireNodeRemovedEvent, firePropertyChange, getElementNamespace, getExtendedSBase, getLevel, getPackageVersion, getSBMLDocument, getVersion, hashCode, isSetExtendedSBase, isSetPackageVersion, removeFromParent, setExtendedSBase, setNamespace, setPackageVersion
addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, children, clearUserObjects, containsUserObjectKey, filter, filter, filter, getIndex, getListOfTreeNodeChangeListeners, getNumChildren, getRoot, getTreeNodeChangeListenerCount, getUserObject, indexOf, isLeaf, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, toString, userObjectKeySet
addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, clearUserObjects, containsUserObjectKey, filter, filter, filter, getListOfTreeNodeChangeListeners, getRoot, getTreeNodeChangeListenerCount, getUserObject, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, userObjectKeySet
public FBCSpeciesPlugin(FBCSpeciesPlugin obj)
obj
- the instance to clonepublic FBCSpeciesPlugin(Species species)
FBCSpeciesPlugin
instancespecies
- the core Species
that is extended.public ListOf<Species> getParent()
getParent
in interface javax.swing.tree.TreeNode
getParent
in class AbstractTreeNode
public ListOf<Species> getParentSBMLObject()
SBasePlugin
SBase
object to which this plugin object connected.getParentSBMLObject
in interface SBasePlugin
getParentSBMLObject
in class AbstractSBasePlugin
SBase
object to which this plugin object connected.public FBCSpeciesPlugin clone()
SBasePlugin
SBasePlugin
from this SBasePlugin
.clone
in interface SBasePlugin
clone
in class AbstractSBasePlugin
SBasePlugin
from this SBasePlugin
.public boolean getAllowsChildren()
public java.lang.String getChemicalFormula()
chemicalFormula
.chemicalFormula
.public javax.swing.tree.TreeNode getChildAt(int index)
public int getChildCount()
public void initDefaults()
public boolean isSetCharge()
charge
is set.charge
is set.public boolean isSetChemicalFormula()
chemicalFormula
is set.chemicalFormula
is set.public boolean readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value)
SBasePlugin
SBasePlugin
.attributeName
- localName of the XML attributeprefix
- prefix of the XML attributevalue
- value of the XML attributetrue
if the attribute has been successfully read.public void setCharge(int charge)
The optional field charge takes an integer indicating
the charge on the species (in terms of electrons, not the SI unit coulombs).
This attribute can be used for charge balancing.
charge
- the value of charge.public void setChemicalFormula(java.lang.String chemicalFormula)
The format of chemical formula must consist only of atomic names (as in the Periodic Table) or user defined compounds either of which take the form of a single capital letter followed by zero or more lower-case letters. Where there is more than a single atom present, this is indicated with an integer. With regards to order (and enhance interoperability) it is recommended to use the Hill system order (Hill 1900, 2012).
chemicalFormula
- the chemical formulapublic boolean unsetCharge()
true
, if charge was set before,
otherwise false
public boolean unsetChemicalFormula()
true
if chemicalFormula was set before,
otherwise false
public java.util.Map<java.lang.String,java.lang.String> writeXMLAttributes()
SBasePlugin
Map
containing the XML attributes of this object.writeXMLAttributes
in interface SBasePlugin
writeXMLAttributes
in class AbstractSBasePlugin
Map
containing the XML attributes of this object.