MultiSpeciesPlugin (jsbml-multi 1.6.1 API)

java.lang.Object
- org.sbml.jsbml.AbstractTreeNode
- - org.sbml.jsbml.ext.AbstractSBasePlugin
  - - org.sbml.jsbml.ext.multi.MultiSpeciesPlugin

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, javax.swing.tree.TreeNode, SBasePlugin, TreeNodeWithChangeSupport
```
public class MultiSpeciesPlugin
extends AbstractSBasePlugin
```
A species in the Multi package is extended from a pool to a template or pattern which multiple pools may map to. An extended species can reference a speciesType that provides the backbone for the species such as components (including binding sites) and speciesFeatureTypes. When referencing a speciesType, a species can be further defined with regard to the binding statuses of its outwardBindingSites and the speciesFeatures. With the options to have variable values selected, such as 'either' for the bindingStatus attribute and multiple possibleSpeciesFeatureValues for a speciesFeature, an extended species can work as a template or pattern how species participate in reactions.

Since:

1.0

Author:

Nicolas Rodriguez

See Also:

Serialized Form

Field Summary
- Fields inherited from class org.sbml.jsbml.ext.AbstractSBasePlugin
  elementNamespace, extendedSBase, packageVersion
- Fields inherited from class org.sbml.jsbml.AbstractTreeNode
  listOfListeners, parent, resourceBundle

Constructor Summary

Constructors
Constructor	Description
`MultiSpeciesPlugin(MultiSpeciesPlugin multiSpecies)`	Creates a new `MultiSpeciesPlugin` instance copied from the given `MultiSpeciesPlugin`.
`MultiSpeciesPlugin(Species species)`	Creates a new `MultiSpeciesPlugin` instance, connected to the given 'core' `Species`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`addOutwardBindingSite(OutwardBindingSite outwardBindingSite)`	Adds a new `OutwardBindingSite` to the `listOfOutwardBindingSites`.
`boolean`	`addSpeciesFeature(SpeciesFeature speciesFeature)`	Adds a new `SpeciesFeature` to the `listOfSpeciesFeatures`.
`boolean`	`addSubListOfSpeciesFeature(SubListOfSpeciesFeature SubListOfSpeciesFeature)`	Adds a new `SubListOfSpeciesFeature` to the `listOfSubListOfSpeciesFeatures`.
`MultiSpeciesPlugin`	`clone()`
`OutwardBindingSite`	`createOutwardBindingSite()`	Creates a new OutwardBindingSite element and adds it to the `listOfOutwardBindingSites` list.
`SpeciesFeature`	`createSpeciesFeature()`	Creates a new SpeciesFeature element and adds it to the `listOfSpeciesFeatures` list.
`SpeciesFeature`	`createSpeciesFeature(java.lang.String id)`	Creates a new `SpeciesFeature` element and adds it to the `listOfSpeciesFeatures` list.
`SubListOfSpeciesFeature`	`createSubListOfSpeciesFeature()`	Creates a new SubListOfSpeciesFeature element and adds it to the `listOfSubListOfSpeciesFeatures` list.
`SubListOfSpeciesFeature`	`createSubListOfSpeciesFeature(java.lang.String id)`	Creates a new `SubListOfSpeciesFeature` element and adds it to the `listOfSubListOfSpeciesFeatures` list.
`boolean`	`equals(java.lang.Object obj)`
`boolean`	`getAllowsChildren()`
`SBase`	`getChildAt(int childIndex)`
`int`	`getChildCount()`
`ListOf<OutwardBindingSite>`	`getListOfOutwardBindingSites()`	Returns the `listOfOutwardBindingSites`.
`ListOf<SpeciesFeature>`	`getListOfSpeciesFeatures()`	Returns the `listOfSpeciesFeatures`.
`ListOf<SubListOfSpeciesFeature>`	`getListOfSubListOfSpeciesFeatures()`	Returns the `listOfSubListOfSpeciesFeatures`.
`int`	`getNumOutwardBindingSites()`	Returns the number of `OutwardBindingSite`s in this `MultiSpeciesPlugin`.
`int`	`getNumSpeciesFeatures()`	Returns the number of `SpeciesFeature`s in this `MultiSpeciesPlugin`.
`int`	`getNumSubListOfSpeciesFeatures()`	Returns the number of `SubListOfSpeciesFeature`s in this `MultiSpeciesPlugin`.
`OutwardBindingSite`	`getOutwardBindingSite(int i)`	Gets an element from the `listOfOutwardBindingSites` at the given index.
`int`	`getOutwardBindingSiteCount()`	Returns the number of `OutwardBindingSite`s in this `MultiSpeciesPlugin`.
`java.lang.String`	`getPackageName()`
`java.lang.String`	`getPrefix()`
`SpeciesFeature`	`getSpeciesFeature(int i)`	Gets an element from the `listOfSpeciesFeatures` at the given index.
`SpeciesFeature`	`getSpeciesFeature(java.lang.String speciesFeatureId)`	Gets an element from the listOfSpeciesFeatures, with the given id.
`int`	`getSpeciesFeatureCount()`	Returns the number of `SpeciesFeature`s in this `MultiSpeciesPlugin`.
`java.lang.String`	`getSpeciesType()`	Returns the value of `speciesType`.
`SubListOfSpeciesFeature`	`getSubListOfSpeciesFeature(int i)`	Gets an element from the `listOfSubListOfSpeciesFeatures` at the given index.
`SubListOfSpeciesFeature`	`getSubListOfSpeciesFeature(java.lang.String SubListOfSpeciesFeatureId)`	Gets an element from the listOfSubListOfSpeciesFeatures, with the given id.
`int`	`getSubListOfSpeciesFeatureCount()`	Returns the number of `SubListOfSpeciesFeature`s in this `MultiSpeciesPlugin`.
`java.lang.String`	`getURI()`
`int`	`hashCode()`
`boolean`	`isSetListOfOutwardBindingSites()`	Returns `true` if `listOfOutwardBindingSites` is not null.
`boolean`	`isSetListOfSpeciesFeatures()`	Returns `true` if `listOfSpeciesFeatures` is not null.
`boolean`	`isSetListOfSubListOfSpeciesFeatures()`	Returns `true` if `listOfSubListOfSpeciesFeatures` contains at least one element.
`boolean`	`isSetSpeciesType()`	Returns whether `speciesType` is set.
`boolean`	`readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value)`
`OutwardBindingSite`	`removeOutwardBindingSite(int i)`	Removes an element from the `listOfOutwardBindingSites` at the given index.
`boolean`	`removeOutwardBindingSite(OutwardBindingSite outwardBindingSite)`	Removes an element from the `listOfOutwardBindingSites`.
`SpeciesFeature`	`removeSpeciesFeature(int i)`	Removes an element from the `listOfSpeciesFeatures` at the given index.
`SpeciesFeature`	`removeSpeciesFeature(java.lang.String speciesFeatureId)`	Removes an element from the `listOfSpeciesFeatures`.
`boolean`	`removeSpeciesFeature(SpeciesFeature speciesFeature)`	Removes an element from the `listOfSpeciesFeatures`.
`SubListOfSpeciesFeature`	`removeSubListOfSpeciesFeature(int i)`	Removes an element from the `listOfSubListOfSpeciesFeatures` at the given index.
`SubListOfSpeciesFeature`	`removeSubListOfSpeciesFeature(java.lang.String SubListOfSpeciesFeatureId)`	Removes an element from the `listOfSubListOfSpeciesFeatures`.
`boolean`	`removeSubListOfSpeciesFeature(SubListOfSpeciesFeature SubListOfSpeciesFeature)`	Removes an element from the `listOfSubListOfSpeciesFeatures`.
`void`	`setListOfOutwardBindingSites(ListOf<OutwardBindingSite> listOfOutwardBindingSites)`	Sets the given `ListOf<OutwardBindingSite>`.
`void`	`setListOfSpeciesFeatures(ListOf<SpeciesFeature> listOfSpeciesFeatures)`	Sets the given `ListOf<SpeciesFeature>`.
`void`	`setListOfSubListOfSpeciesFeatures(ListOf<SubListOfSpeciesFeature> listOfSubListOfSpeciesFeatures)`	Sets the given `ListOf<SubListOfSpeciesFeature>`.
`void`	`setSpeciesType(java.lang.String speciesType)`	Sets the value of speciesType
`boolean`	`unsetListOfOutwardBindingSites()`	Returns `true` if `listOfOutwardBindingSites` contains at least one element, otherwise `false`.
`boolean`	`unsetListOfSpeciesFeatures()`	Returns `true` if `listOfSpeciesFeatures` contains at least one element, otherwise `false`.
`boolean`	`unsetListOfSubListOfSpeciesFeatures()`	Returns `true` if `listOfSubListOfSpeciesFeatures` contains at least one element, otherwise `false`.
`boolean`	`unsetSpeciesType()`	Unsets the variable speciesType.
`java.util.Map<java.lang.String,java.lang.String>`	`writeXMLAttributes()`

Methods inherited from class org.sbml.jsbml.ext.AbstractSBasePlugin
fireNodeAddedEvent, fireNodeRemovedEvent, firePropertyChange, getElementNamespace, getExtendedSBase, getLevel, getPackageVersion, getParentSBMLObject, getSBMLDocument, getVersion, isSetExtendedSBase, isSetPackageVersion, removeFromParent, setExtendedSBase, setNamespace, setPackageVersion

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.swing.tree.TreeNode
children, getIndex, getParent, isLeaf

- Constructor Detail
  - MultiSpeciesPlugin
```
public MultiSpeciesPlugin(Species species)
```
    Creates a new MultiSpeciesPlugin instance, connected to the given 'core' Species.
    
    Parameters:
    
    species - the core species that is extended
  - MultiSpeciesPlugin
```
public MultiSpeciesPlugin(MultiSpeciesPlugin multiSpecies)
```
    Creates a new MultiSpeciesPlugin instance copied from the given MultiSpeciesPlugin.
    
    Parameters:
    
    multiSpecies - the element to copy/clone.
- Method Detail
  - getPackageName
```
public java.lang.String getPackageName()
```
  - getPrefix
```
public java.lang.String getPrefix()
```
  - getURI
```
public java.lang.String getURI()
```
  - clone
```
public MultiSpeciesPlugin clone()
```
    Specified by:
    
    clone in interface SBasePlugin
    
    Specified by:
    
    clone in class AbstractSBasePlugin
  - isSetListOfOutwardBindingSites
```
public boolean isSetListOfOutwardBindingSites()
```
    Returns true if listOfOutwardBindingSites is not null.
    
    Returns:
    
    true if listOfOutwardBindingSites is not null, false otherwise.
  - getListOfOutwardBindingSites
```
public ListOf<OutwardBindingSite> getListOfOutwardBindingSites()
```
    Returns the listOfOutwardBindingSites. Creates it if it does not already exist.
    
    Returns:
    
    the listOfOutwardBindingSites.
  - setListOfOutwardBindingSites
```
public void setListOfOutwardBindingSites(ListOf<OutwardBindingSite> listOfOutwardBindingSites)
```
    Sets the given ListOf<OutwardBindingSite>. If listOfOutwardBindingSites was defined before and contains some elements, they are all unset.
    
    Parameters:
    
    listOfOutwardBindingSites - the list of OutwardBindingSite to set.
  - unsetListOfOutwardBindingSites
```
public boolean unsetListOfOutwardBindingSites()
```
    Returns true if listOfOutwardBindingSites contains at least one element, otherwise false.
    
    Returns:
    
    true if listOfOutwardBindingSites contains at least one element, otherwise false.
  - addOutwardBindingSite
```
public boolean addOutwardBindingSite(OutwardBindingSite outwardBindingSite)
```
    Adds a new OutwardBindingSite to the listOfOutwardBindingSites.
    The listOfOutwardBindingSites is initialized if necessary.
    
    Parameters:
    
    outwardBindingSite - the element to add to the list
    
    Returns:
    
    true (as specified by Collection.add(E))
    
    See Also:
    
    Collection.add(Object)
  - removeOutwardBindingSite
```
public boolean removeOutwardBindingSite(OutwardBindingSite outwardBindingSite)
```
    Removes an element from the listOfOutwardBindingSites.
    
    Parameters:
    
    outwardBindingSite - the element to be removed from the list.
    
    Returns:
    
    true if the list contained the specified element and it was removed.
    
    See Also:
    
    List.remove(Object)
  - removeOutwardBindingSite
```
public OutwardBindingSite removeOutwardBindingSite(int i)
```
    Removes an element from the listOfOutwardBindingSites at the given index.
    
    Parameters:
    
    i - the index where to remove the OutwardBindingSite.
    
    Returns:
    
    the specified element if it was successfully found and removed.
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the listOf is not set or if the index is out of bound ((i < 0) || (i > listOfOutwardBindingSites)).
  - createOutwardBindingSite
```
public OutwardBindingSite createOutwardBindingSite()
```
    Creates a new OutwardBindingSite element and adds it to the listOfOutwardBindingSites list.
    
    Returns:
    
    the newly created element, i.e., the last item in the listOfOutwardBindingSites
  - getOutwardBindingSite
```
public OutwardBindingSite getOutwardBindingSite(int i)
```
    Gets an element from the listOfOutwardBindingSites at the given index.
    
    Parameters:
    
    i - the index of the OutwardBindingSite element to get.
    
    Returns:
    
    an element from the listOfOutwardBindingSites at the given index.
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the listOf is not set or if the index is out of bound (index < 0 || index > list.size).
  - getOutwardBindingSiteCount
```
public int getOutwardBindingSiteCount()
```
    Returns the number of OutwardBindingSites in this MultiSpeciesPlugin.
    
    Returns:
    
    the number of OutwardBindingSites in this MultiSpeciesPlugin.
  - getNumOutwardBindingSites
```
public int getNumOutwardBindingSites()
```
    Returns the number of OutwardBindingSites in this MultiSpeciesPlugin.
    
    Returns:
    
    the number of OutwardBindingSites in this MultiSpeciesPlugin.
    
    Note: this method is kept here as it exist in libSBML.
    
    same as getOutwardBindingSiteCount()
  - isSetListOfSpeciesFeatures
```
public boolean isSetListOfSpeciesFeatures()
```
    Returns true if listOfSpeciesFeatures is not null.
    
    Returns:
    
    true if listOfSpeciesFeatures is not null, otherwise false.
  - getListOfSpeciesFeatures
```
public ListOf<SpeciesFeature> getListOfSpeciesFeatures()
```
    Returns the listOfSpeciesFeatures. Creates it if it does not already exist.
    
    Returns:
    
    the listOfSpeciesFeatures.
  - setListOfSpeciesFeatures
```
public void setListOfSpeciesFeatures(ListOf<SpeciesFeature> listOfSpeciesFeatures)
```
    Sets the given ListOf<SpeciesFeature>. If listOfSpeciesFeatures was defined before and contains some elements, they are all unset.
    
    Parameters:
    
    listOfSpeciesFeatures - the list of SpeciesFeature to set.
  - unsetListOfSpeciesFeatures
```
public boolean unsetListOfSpeciesFeatures()
```
    Returns true if listOfSpeciesFeatures contains at least one element, otherwise false.
    
    Returns:
    
    true if listOfSpeciesFeatures contains at least one element, otherwise false.
  - addSpeciesFeature
```
public boolean addSpeciesFeature(SpeciesFeature speciesFeature)
```
    Adds a new SpeciesFeature to the listOfSpeciesFeatures.
    The listOfSpeciesFeatures is initialized if necessary.
    
    Parameters:
    
    speciesFeature - the element to add to the list
    
    Returns:
    
    true (as specified by Collection.add(E))
    
    See Also:
    
    Collection.add(Object)
  - removeSpeciesFeature
```
public boolean removeSpeciesFeature(SpeciesFeature speciesFeature)
```
    Removes an element from the listOfSpeciesFeatures.
    
    Parameters:
    
    speciesFeature - the element to be removed from the list.
    
    Returns:
    
    true if the list contained the specified element and it was removed.
    
    See Also:
    
    List.remove(Object)
  - removeSpeciesFeature
```
public SpeciesFeature removeSpeciesFeature(java.lang.String speciesFeatureId)
```
    Removes an element from the listOfSpeciesFeatures.
    
    Parameters:
    
    speciesFeatureId - the id of the element to be removed from the list.
    
    Returns:
    
    the removed element, if it was successfully found and removed or null.
  - removeSpeciesFeature
```
public SpeciesFeature removeSpeciesFeature(int i)
```
    Removes an element from the listOfSpeciesFeatures at the given index.
    
    Parameters:
    
    i - the index where to remove the SpeciesFeature.
    
    Returns:
    
    the specified element if it was successfully found and removed.
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the listOf is not set or if the index is out of bound ((i < 0) || (i > listOfSpeciesFeatures)).
  - createSpeciesFeature
```
public SpeciesFeature createSpeciesFeature()
```
    Creates a new SpeciesFeature element and adds it to the listOfSpeciesFeatures list.
    
    Returns:
    
    the newly created element, i.e., the last item in the listOfSpeciesFeatures
  - createSpeciesFeature
```
public SpeciesFeature createSpeciesFeature(java.lang.String id)
```
    Creates a new SpeciesFeature element and adds it to the listOfSpeciesFeatures list.
    
    Parameters:
    
    id - the identifier that is to be applied to the new element.
    
    Returns:
    
    the newly created SpeciesFeature element, which is the last element in the listOfSpeciesFeatures.
  - getSpeciesFeature
```
public SpeciesFeature getSpeciesFeature(int i)
```
    Gets an element from the listOfSpeciesFeatures at the given index.
    
    Parameters:
    
    i - the index of the SpeciesFeature element to get.
    
    Returns:
    
    an element from the listOfSpeciesFeatures at the given index.
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the listOf is not set or if the index is out of bound (index < 0 || index > list.size).
  - getSpeciesFeature
```
public SpeciesFeature getSpeciesFeature(java.lang.String speciesFeatureId)
```
    Gets an element from the listOfSpeciesFeatures, with the given id.
    
    Parameters:
    
    speciesFeatureId - the id of the SpeciesFeature element to get.
    
    Returns:
    
    an element from the listOfSpeciesFeatures with the given id or null.
  - getSpeciesFeatureCount
```
public int getSpeciesFeatureCount()
```
    Returns the number of SpeciesFeatures in this MultiSpeciesPlugin.
    
    Returns:
    
    the number of SpeciesFeatures in this MultiSpeciesPlugin.
  - getNumSpeciesFeatures
```
public int getNumSpeciesFeatures()
```
    Returns the number of SpeciesFeatures in this MultiSpeciesPlugin.
    
    Returns:
    
    the number of SpeciesFeatures in this MultiSpeciesPlugin.
    
    Note: this method is kept here as it exist in libSBML.
    
    same as getSpeciesFeatureCount()
  - isSetListOfSubListOfSpeciesFeatures
```
public boolean isSetListOfSubListOfSpeciesFeatures()
```
    Returns true if listOfSubListOfSpeciesFeatures contains at least one element.
    
    Returns:
    
    true if listOfSubListOfSpeciesFeatures contains at least one element, otherwise false.
  - getListOfSubListOfSpeciesFeatures
```
public ListOf<SubListOfSpeciesFeature> getListOfSubListOfSpeciesFeatures()
```
    Returns the listOfSubListOfSpeciesFeatures. Creates it if it does not already exist.
    
    Returns:
    
    the listOfSubListOfSpeciesFeatures.
  - setListOfSubListOfSpeciesFeatures
```
public void setListOfSubListOfSpeciesFeatures(ListOf<SubListOfSpeciesFeature> listOfSubListOfSpeciesFeatures)
```
    Sets the given ListOf<SubListOfSpeciesFeature>. If listOfSubListOfSpeciesFeatures was defined before and contains some elements, they are all unset.
    
    Parameters:
    
    listOfSubListOfSpeciesFeatures - the list of SubListOfSpeciesFeatures
  - unsetListOfSubListOfSpeciesFeatures
```
public boolean unsetListOfSubListOfSpeciesFeatures()
```
    Returns true if listOfSubListOfSpeciesFeatures contains at least one element, otherwise false.
    
    Returns:
    
    true if listOfSubListOfSpeciesFeatures contains at least one element, otherwise false.
  - addSubListOfSpeciesFeature
```
public boolean addSubListOfSpeciesFeature(SubListOfSpeciesFeature SubListOfSpeciesFeature)
```
    Adds a new SubListOfSpeciesFeature to the listOfSubListOfSpeciesFeatures.
    The listOfSubListOfSpeciesFeatures is initialized if necessary.
    
    Parameters:
    
    SubListOfSpeciesFeature - the element to add to the list
    
    Returns:
    
    true (as specified by Collection.add(E))
    
    See Also:
    
    Collection.add(Object)
  - removeSubListOfSpeciesFeature
```
public boolean removeSubListOfSpeciesFeature(SubListOfSpeciesFeature SubListOfSpeciesFeature)
```
    Removes an element from the listOfSubListOfSpeciesFeatures.
    
    Parameters:
    
    SubListOfSpeciesFeature - the element to be removed from the list.
    
    Returns:
    
    true if the list contained the specified element and it was removed.
    
    See Also:
    
    List.remove(Object)
  - removeSubListOfSpeciesFeature
```
public SubListOfSpeciesFeature removeSubListOfSpeciesFeature(java.lang.String SubListOfSpeciesFeatureId)
```
    Removes an element from the listOfSubListOfSpeciesFeatures.
    
    Parameters:
    
    SubListOfSpeciesFeatureId - the id of the element to be removed from the list.
    
    Returns:
    
    the removed element, if it was successfully found and removed or null.
  - removeSubListOfSpeciesFeature
```
public SubListOfSpeciesFeature removeSubListOfSpeciesFeature(int i)
```
    Removes an element from the listOfSubListOfSpeciesFeatures at the given index.
    
    Parameters:
    
    i - the index where to remove the SubListOfSpeciesFeature.
    
    Returns:
    
    the specified element if it was successfully found and removed.
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the listOf is not set or if the index is out of bound ((i < 0) || (i > listOfSubListOfSpeciesFeatures)).
  - createSubListOfSpeciesFeature
```
public SubListOfSpeciesFeature createSubListOfSpeciesFeature()
```
    Creates a new SubListOfSpeciesFeature element and adds it to the listOfSubListOfSpeciesFeatures list.
    
    Returns:
    
    the newly created element, i.e., the last item in the listOfSubListOfSpeciesFeatures
  - createSubListOfSpeciesFeature
```
public SubListOfSpeciesFeature createSubListOfSpeciesFeature(java.lang.String id)
```
    Creates a new SubListOfSpeciesFeature element and adds it to the listOfSubListOfSpeciesFeatures list.
    
    Parameters:
    
    id - the identifier that is to be applied to the new element.
    
    Returns:
    
    the newly created SubListOfSpeciesFeature element, which is the last element in the listOfSubListOfSpeciesFeatures.
  - getSubListOfSpeciesFeature
```
public SubListOfSpeciesFeature getSubListOfSpeciesFeature(int i)
```
    Gets an element from the listOfSubListOfSpeciesFeatures at the given index.
    
    Parameters:
    
    i - the index of the SubListOfSpeciesFeature element to get.
    
    Returns:
    
    an element from the listOfSubListOfSpeciesFeatures at the given index.
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the listOf is not set or if the index is out of bound (index < 0 || index > list.size).
  - getSubListOfSpeciesFeature
```
public SubListOfSpeciesFeature getSubListOfSpeciesFeature(java.lang.String SubListOfSpeciesFeatureId)
```
    Gets an element from the listOfSubListOfSpeciesFeatures, with the given id.
    
    Parameters:
    
    SubListOfSpeciesFeatureId - the id of the SubListOfSpeciesFeature element to get.
    
    Returns:
    
    an element from the listOfSubListOfSpeciesFeatures with the given id or null.
  - getSubListOfSpeciesFeatureCount
```
public int getSubListOfSpeciesFeatureCount()
```
    Returns the number of SubListOfSpeciesFeatures in this MultiSpeciesPlugin.
    
    Returns:
    
    the number of SubListOfSpeciesFeatures in this MultiSpeciesPlugin.
  - getNumSubListOfSpeciesFeatures
```
public int getNumSubListOfSpeciesFeatures()
```
    Returns the number of SubListOfSpeciesFeatures in this MultiSpeciesPlugin.
    
    Returns:
    
    the number of SubListOfSpeciesFeatures in this MultiSpeciesPlugin.
    
    Note: this method is kept here as it exist in libSBML.
    
    same as getSubListOfSpeciesFeatureCount()
  - getSpeciesType
```
public java.lang.String getSpeciesType()
```
    Returns the value of speciesType.
    
    Returns:
    
    the value of speciesType.
  - isSetSpeciesType
```
public boolean isSetSpeciesType()
```
    Returns whether speciesType is set.
    
    Returns:
    
    whether speciesType is set.
  - setSpeciesType
```
public void setSpeciesType(java.lang.String speciesType)
```
    Sets the value of speciesType
    
    Parameters:
    
    speciesType - the value of speciesType to be set.
  - unsetSpeciesType
```
public boolean unsetSpeciesType()
```
    Unsets the variable speciesType.
    
    Returns:
    
    true if speciesType was set before, otherwise false.
  - getAllowsChildren
```
public boolean getAllowsChildren()
```
  - getChildAt
```
public SBase getChildAt(int childIndex)
```
  - getChildCount
```
public int getChildCount()
```
  - writeXMLAttributes
```
public java.util.Map<java.lang.String,java.lang.String> writeXMLAttributes()
```
    Specified by:
    
    writeXMLAttributes in interface SBasePlugin
    
    Overrides:
    
    writeXMLAttributes in class AbstractSBasePlugin
  - readAttribute
```
public boolean readAttribute(java.lang.String attributeName,
                             java.lang.String prefix,
                             java.lang.String value)
```
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface SBasePlugin
    
    Overrides:
    
    hashCode in class AbstractSBasePlugin
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Specified by:
    
    equals in interface SBasePlugin
    
    Overrides:
    
    equals in class AbstractSBasePlugin

Class MultiSpeciesPlugin

Field Summary

Fields inherited from class org.sbml.jsbml.ext.AbstractSBasePlugin

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

Constructor Summary

Method Summary

Methods inherited from class org.sbml.jsbml.ext.AbstractSBasePlugin

Methods inherited from class org.sbml.jsbml.AbstractTreeNode

Methods inherited from class java.lang.Object

Methods inherited from interface javax.swing.tree.TreeNode

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

Constructor Detail

MultiSpeciesPlugin

MultiSpeciesPlugin

Method Detail

getPackageName

getPrefix

getURI

clone

isSetListOfOutwardBindingSites

getListOfOutwardBindingSites

setListOfOutwardBindingSites

unsetListOfOutwardBindingSites

addOutwardBindingSite

removeOutwardBindingSite

removeOutwardBindingSite

createOutwardBindingSite

getOutwardBindingSite

getOutwardBindingSiteCount

getNumOutwardBindingSites

isSetListOfSpeciesFeatures

getListOfSpeciesFeatures

setListOfSpeciesFeatures

unsetListOfSpeciesFeatures

addSpeciesFeature

removeSpeciesFeature

removeSpeciesFeature

removeSpeciesFeature

createSpeciesFeature

createSpeciesFeature

getSpeciesFeature

getSpeciesFeature

getSpeciesFeatureCount

getNumSpeciesFeatures

isSetListOfSubListOfSpeciesFeatures

getListOfSubListOfSpeciesFeatures

setListOfSubListOfSpeciesFeatures

unsetListOfSubListOfSpeciesFeatures

addSubListOfSpeciesFeature

removeSubListOfSpeciesFeature

removeSubListOfSpeciesFeature

removeSubListOfSpeciesFeature

createSubListOfSpeciesFeature

createSubListOfSpeciesFeature

getSubListOfSpeciesFeature

getSubListOfSpeciesFeature

getSubListOfSpeciesFeatureCount

getNumSubListOfSpeciesFeatures

getSpeciesType

isSetSpeciesType

setSpeciesType

unsetSpeciesType

getAllowsChildren

getChildAt

getChildCount

writeXMLAttributes

readAttribute

hashCode

equals