MultiModel (jsbml-multi 1.0 API)

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

All Implemented Interfaces:

Serializable, Cloneable, TreeNode, SBasePlugin, TreeNodeWithChangeSupport
```
public class MultiModel
extends AbstractSBasePlugin
```
In order to encode the structures needed to define and use multistate and multi-component complexes, the element model is extended to be linked to a list of SpeciesTypes and a list of Selectors.

Author:

Nicolas Rodriguez

See Also:

Serialized Form

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

Constructor Summary

Constructors
Constructor and Description

MultiModel(Model model)

MultiModel(MultiModel multiModel)

Constructors
Constructor and Description
`MultiModel(Model model)`
`MultiModel(MultiModel multiModel)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSelector(Selector selector)` Adds a `Selector`.
`boolean`	`addSpeciesType(SpeciesType speciesType)` Adds a `SpeciesType`.
`MultiModel`	`clone()`
`Selector`	`createSelector()` Creates a new `Selector` inside this `MultiModel` and returns it.
`Selector`	`createSelector(String id)` Creates a new `Selector` inside this `MultiModel` and returns it.
`SpeciesType`	`createSpeciesType()` Creates a new `SpeciesType` inside this `MultiModel` and returns it.
`SpeciesType`	`createSpeciesType(String id)` Creates a new `SpeciesType` inside this `MultiModel` and returns it.
`boolean`	`getAllowsChildren()`
`SBase`	`getChildAt(int childIndex)`
`int`	`getChildCount()`
`String`	`getElementNamespace()`
`ListOf<Selector>`	`getListOfSelectors()` Returns the listOfSelectors.
`ListOf<SpeciesType>`	`getListOfSpeciesTypes()` Returns the listOfSpeciesTypes.
`Model`	`getModel()` Returns the `Model`
`String`	`getPackageName()`
`SBMLDocument`	`getParent()`
`SBMLDocument`	`getParentSBMLObject()`
`String`	`getPrefix()`
`Selector`	`getSelector(int i)` Gets the ith `Selector`.
`Selector`	`getSelector(String id)` Gets the `Selector` that has the given id.
`SpeciesType`	`getSpeciesType(int i)` Gets the ith `SpeciesType`.
`SpeciesType`	`getSpeciesType(String id)` Gets the `SpeciesType` that has the given id.
`String`	`getURI()`
`boolean`	`isSetListOfSelectors()` Returns `true` if the listOfSelector is set.
`boolean`	`isSetListOfSpeciesTypes()` Returns `true` if the listOfSpeciesType is set.
`boolean`	`readAttribute(String attributeName, String prefix, String value)`
`boolean`	`unsetListOfSelectors()` Sets the listOfSelectors to null
`boolean`	`unsetListOfSpeciesTypes()` Sets the listOfSpeciesTypes to null
`Map<String,String>`	`writeXMLAttributes()`

Methods inherited from class org.sbml.jsbml.ext.AbstractSBasePlugin
equals, fireNodeAddedEvent, fireNodeRemovedEvent, firePropertyChange, getExtendedSBase, getLevel, getPackageVersion, getSBMLDocument, getVersion, hashCode, isSetExtendedSBase, removeFromParent, setExtendedSBase

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

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

- Constructor Detail
  - MultiModel
```
public MultiModel(Model model)
```
    Parameters:
    
    model -
  - MultiModel
```
public MultiModel(MultiModel multiModel)
```
    Parameters:
    
    multiModel -
- Method Detail
  - getElementNamespace
```
public String getElementNamespace()
```
  - getPackageName
```
public String getPackageName()
```
  - getPrefix
```
public String getPrefix()
```
  - getURI
```
public String getURI()
```
  - getParent
```
public SBMLDocument getParent()
```
    Specified by:
    
    getParent in interface TreeNode
    
    Overrides:
    
    getParent in class AbstractTreeNode
  - getParentSBMLObject
```
public SBMLDocument getParentSBMLObject()
```
    Specified by:
    
    getParentSBMLObject in interface SBasePlugin
    
    Overrides:
    
    getParentSBMLObject in class AbstractSBasePlugin
  - clone
```
public MultiModel clone()
```
    Specified by:
    
    clone in interface SBasePlugin
    
    Overrides:
    
    clone in class AbstractSBasePlugin
  - getModel
```
public Model getModel()
```
    Returns the Model
    
    Returns:
    
    the Model
  - getListOfSpeciesTypes
```
public ListOf<SpeciesType> getListOfSpeciesTypes()
```
    Returns the listOfSpeciesTypes.
    
    Returns:
    
    the listOfSpeciesTypes
  - addSpeciesType
```
public boolean addSpeciesType(SpeciesType speciesType)
```
    Adds a SpeciesType.
    
    Parameters:
    
    speciesType - the speciesType to add
    
    Returns:
  - createSpeciesType
```
public SpeciesType createSpeciesType()
```
    Creates a new SpeciesType inside this MultiModel and returns it.
    
    Returns:
    
    the SpeciesType object created
    
    See Also:
    
    addSpeciesType(SpeciesType r)
  - createSpeciesType
```
public SpeciesType createSpeciesType(String id)
```
    Creates a new SpeciesType inside this MultiModel and returns it.
    
    Parameters:
    
    id - the id of the new element to create
    
    Returns:
    
    the SpeciesType object created
  - getSpeciesType
```
public SpeciesType getSpeciesType(int i)
```
    Gets the ith SpeciesType.
    
    Parameters:
    
    i -
    
    Returns:
    
    the ith SpeciesType
    
    Throws:
    
    IndexOutOfBoundsException - if the index is invalid.
  - getSpeciesType
```
public SpeciesType getSpeciesType(String id)
```
    Gets the SpeciesType that has the given id.
    
    Parameters:
    
    id -
    
    Returns:
    
    the SpeciesType that has the given id or null if no SpeciesType are found that match id.
  - isSetListOfSpeciesTypes
```
public boolean isSetListOfSpeciesTypes()
```
    Returns true if the listOfSpeciesType is set.
    
    Returns:
    
    true if the listOfSpeciesType is set.
  - unsetListOfSpeciesTypes
```
public boolean unsetListOfSpeciesTypes()
```
    Sets the listOfSpeciesTypes to null
    
    Returns:
    
    true is successful
  - getListOfSelectors
```
public ListOf<Selector> getListOfSelectors()
```
    Returns the listOfSelectors.
    
    Returns:
    
    the listOfSelectors
  - addSelector
```
public void addSelector(Selector selector)
```
    Adds a Selector.
    
    Parameters:
    
    selector - the selector to add
  - createSelector
```
public Selector createSelector()
```
    Creates a new Selector inside this MultiModel and returns it.
    
    Returns:
    
    the Selector object created
    
    See Also:
    
    addSelector(Selector r)
  - createSelector
```
public Selector createSelector(String id)
```
    Creates a new Selector inside this MultiModel and returns it.
    
    Parameters:
    
    id - the id of the new element to create
    
    Returns:
    
    the Selector object created
  - getSelector
```
public Selector getSelector(int i)
```
    Gets the ith Selector.
    
    Parameters:
    
    i -
    
    Returns:
    
    the ith Selector
    
    Throws:
    
    IndexOutOfBoundsException - if the index is invalid.
  - getSelector
```
public Selector getSelector(String id)
```
    Gets the Selector that has the given id.
    
    Parameters:
    
    id -
    
    Returns:
    
    the Selector that has the given id or null if no Selector are found that match id.
  - isSetListOfSelectors
```
public boolean isSetListOfSelectors()
```
    Returns true if the listOfSelector is set.
    
    Returns:
    
    true if the listOfSelector is set.
  - unsetListOfSelectors
```
public boolean unsetListOfSelectors()
```
    Sets the listOfSelectors to null
    
    Returns:
    
    true is successful
  - readAttribute
```
public boolean readAttribute(String attributeName,
                             String prefix,
                             String value)
```
  - getChildAt
```
public SBase getChildAt(int childIndex)
```
  - getChildCount
```
public int getChildCount()
```
  - getAllowsChildren
```
public boolean getAllowsChildren()
```
  - writeXMLAttributes
```
public Map<String,String> writeXMLAttributes()
```
    Specified by:
    
    writeXMLAttributes in interface SBasePlugin
    
    Overrides:
    
    writeXMLAttributes in class AbstractSBasePlugin

Class MultiModel

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 org.sbml.jsbml.util.TreeNodeWithChangeSupport

Methods inherited from interface javax.swing.tree.TreeNode

Constructor Detail

MultiModel

MultiModel

Method Detail

getElementNamespace

getPackageName

getPrefix

getURI

getParent

getParentSBMLObject

clone

getModel

getListOfSpeciesTypes

addSpeciesType

createSpeciesType

createSpeciesType

getSpeciesType

getSpeciesType

isSetListOfSpeciesTypes

unsetListOfSpeciesTypes

getListOfSelectors

addSelector

createSelector

createSelector

getSelector

getSelector

isSetListOfSelectors

unsetListOfSelectors

readAttribute

getChildAt

getChildCount

getAllowsChildren

writeXMLAttributes