Package org.sbml.jsbml.ext.multi

Class MultiSpeciesReferencePlugin

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.ext.AbstractSBasePlugin

org.sbml.jsbml.ext.multi.MultiSimpleSpeciesReferencePlugin

org.sbml.jsbml.ext.multi.MultiSpeciesReferencePlugin

All Implemented Interfaces:

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

public class MultiSpeciesReferencePlugin
extends MultiSimpleSpeciesReferencePlugin

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
MultiSpeciesReferencePlugin()	Creates an MultiSpeciesReferencePlugin instance
MultiSpeciesReferencePlugin(MultiSpeciesReferencePlugin obj)	Clone constructor
MultiSpeciesReferencePlugin(SpeciesReference sp)	Creates a MultiSpeciesReferencePlugin instance with a SpeciesReference.

Method Summary

Modifier and Type	Method	Description
boolean	addSpeciesTypeComponentMapInProduct(SpeciesTypeComponentMapInProduct speciesTypeComponentMapInProduct)	Adds a new SpeciesTypeComponentMapInProduct to the listOfSpeciesTypeComponentMapInProducts.
MultiSpeciesReferencePlugin	clone()	clones this class
SpeciesTypeComponentMapInProduct	createSpeciesTypeComponentMapInProduct()	Creates a new SpeciesTypeComponentMapInProduct element and adds it to the listOfSpeciesTypeComponentMapInProducts list.
boolean	equals(java.lang.Object obj)
boolean	getAllowsChildren()
javax.swing.tree.TreeNode	getChildAt(int index)
int	getChildCount()
ListOf<SpeciesTypeComponentMapInProduct>	getListOfSpeciesTypeComponentMapInProducts()	Returns the listOfSpeciesTypeComponentMapInProducts.
int	getNumSpeciesTypeComponentMapInProducts()	Returns the number of SpeciesTypeComponentMapInProducts in this MultiSpeciesReferencePlugin.
SpeciesTypeComponentMapInProduct	getSpeciesTypeComponentMapInProduct(int i)	Gets an element from the listOfSpeciesTypeComponentMapInProducts at the given index.
int	getSpeciesTypeComponentMapInProductCount()	Returns the number of SpeciesTypeComponentMapInProducts in this MultiSpeciesReferencePlugin.
int	hashCode()
void	initDefaults()	Initializes the default values using the namespace.
boolean	isSetListOfSpeciesTypeComponentMapInProducts()	Returns true if listOfSpeciesTypeComponentMapInProducts contains at least one element.
SpeciesTypeComponentMapInProduct	removeSpeciesTypeComponentMapInProduct(int i)	Removes an element from the listOfSpeciesTypeComponentMapInProducts at the given index.
boolean	removeSpeciesTypeComponentMapInProduct(SpeciesTypeComponentMapInProduct speciesTypeComponentMapInProduct)	Removes an element from the listOfSpeciesTypeComponentMapInProducts.
void	setListOfSpeciesTypeComponentMapInProducts(ListOf<SpeciesTypeComponentMapInProduct> listOfSpeciesTypeComponentMapInProducts)	Sets the given ListOf<SpeciesTypeComponentMapInProduct>.
boolean	unsetListOfSpeciesTypeComponentMapInProducts()	Returns true if listOfSpeciesTypeComponentMapInProducts contains at least one element, otherwise false.

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

addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, children, clearUserObjects, containsUserObjectKey, filter, filter, filter, getIndex, getListOfTreeNodeChangeListeners, getNumChildren, getParent, getRoot, getTreeNodeChangeListenerCount, getUserObject, indexOf, isCloningInProgress, isInvalidSBMLAllowed, isLeaf, isReadingInProgress, isRoot, isSetParent, isSetUserObjects, notifyChildChange, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, toString, userObjectKeySet

Methods inherited from class org.sbml.jsbml.ext.multi.MultiSimpleSpeciesReferencePlugin

getCompartmentReference, getPackageName, getPrefix, getURI, isSetCompartmentReference, readAttribute, setCompartmentReference, unsetCompartmentReference, writeXMLAttributes

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

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

addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, clearUserObjects, containsUserObjectKey, filter, filter, filter, getListOfTreeNodeChangeListeners, getRoot, getTreeNodeChangeListenerCount, getUserObject, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, userObjectKeySet

Constructor Detail

MultiSpeciesReferencePlugin

public MultiSpeciesReferencePlugin()

Creates an MultiSpeciesReferencePlugin instance

MultiSpeciesReferencePlugin

public MultiSpeciesReferencePlugin(SpeciesReference sp)

Creates a MultiSpeciesReferencePlugin instance with a SpeciesReference.

Parameters:

sp - the SpeciesReference for the new element.

MultiSpeciesReferencePlugin

public MultiSpeciesReferencePlugin(MultiSpeciesReferencePlugin obj)

Clone constructor

Method Detail

clone

public MultiSpeciesReferencePlugin clone()

clones this class

Specified by:

clone in interface SBasePlugin

Overrides:

clone in class MultiSimpleSpeciesReferencePlugin

initDefaults

public void initDefaults()

Initializes the default values using the namespace.

Overrides:

initDefaults in class MultiSimpleSpeciesReferencePlugin

hashCode

public int hashCode()

Specified by:

hashCode in interface SBasePlugin

Overrides:

hashCode in class MultiSimpleSpeciesReferencePlugin

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface SBasePlugin

Overrides:

equals in class MultiSimpleSpeciesReferencePlugin

isSetListOfSpeciesTypeComponentMapInProducts

public boolean isSetListOfSpeciesTypeComponentMapInProducts()

Returns true if listOfSpeciesTypeComponentMapInProducts contains at least one element.

Returns:

true if listOfSpeciesTypeComponentMapInProducts contains at least one element, otherwise false.

getListOfSpeciesTypeComponentMapInProducts

public ListOf<SpeciesTypeComponentMapInProduct> getListOfSpeciesTypeComponentMapInProducts()

Returns the listOfSpeciesTypeComponentMapInProducts. Creates it if it does not already exist.

Returns:

the listOfSpeciesTypeComponentMapInProducts.

setListOfSpeciesTypeComponentMapInProducts

public void setListOfSpeciesTypeComponentMapInProducts(ListOf<SpeciesTypeComponentMapInProduct> listOfSpeciesTypeComponentMapInProducts)

Sets the given ListOf<SpeciesTypeComponentMapInProduct>. If listOfSpeciesTypeComponentMapInProducts was defined before and contains some elements, they are all unset.

Parameters:

listOfSpeciesTypeComponentMapInProducts - the list of SpeciesTypeComponentMapInProduct

unsetListOfSpeciesTypeComponentMapInProducts

public boolean unsetListOfSpeciesTypeComponentMapInProducts()

Returns true if listOfSpeciesTypeComponentMapInProducts contains at least one element, otherwise false.

Returns:

true if listOfSpeciesTypeComponentMapInProducts contains at least one element, otherwise false.

addSpeciesTypeComponentMapInProduct

public boolean addSpeciesTypeComponentMapInProduct(SpeciesTypeComponentMapInProduct speciesTypeComponentMapInProduct)

Adds a new SpeciesTypeComponentMapInProduct to the listOfSpeciesTypeComponentMapInProducts.

The listOfSpeciesTypeComponentMapInProducts is initialized if necessary.

Parameters:

speciesTypeComponentMapInProduct - the element to add to the list

Returns:

true (as specified by Collection.add(E))

See Also:

Collection.add(Object)

removeSpeciesTypeComponentMapInProduct

public boolean removeSpeciesTypeComponentMapInProduct(SpeciesTypeComponentMapInProduct speciesTypeComponentMapInProduct)

Removes an element from the listOfSpeciesTypeComponentMapInProducts.

Parameters:

speciesTypeComponentMapInProduct - 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)

removeSpeciesTypeComponentMapInProduct

public SpeciesTypeComponentMapInProduct removeSpeciesTypeComponentMapInProduct(int i)

Removes an element from the listOfSpeciesTypeComponentMapInProducts at the given index.

Parameters:

i - the index where to remove the SpeciesTypeComponentMapInProduct.

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 > listOfSpeciesTypeComponentMapInProducts)).

createSpeciesTypeComponentMapInProduct

public SpeciesTypeComponentMapInProduct createSpeciesTypeComponentMapInProduct()

Creates a new SpeciesTypeComponentMapInProduct element and adds it to the listOfSpeciesTypeComponentMapInProducts list.

Returns:

the newly created element, i.e., the last item in the listOfSpeciesTypeComponentMapInProducts

getSpeciesTypeComponentMapInProduct

public SpeciesTypeComponentMapInProduct getSpeciesTypeComponentMapInProduct(int i)

Gets an element from the listOfSpeciesTypeComponentMapInProducts at the given index.

Parameters:

i - the index of the SpeciesTypeComponentMapInProduct element to get.

Returns:

an element from the listOfSpeciesTypeComponentMapInProducts 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).

getSpeciesTypeComponentMapInProductCount

public int getSpeciesTypeComponentMapInProductCount()

Returns the number of SpeciesTypeComponentMapInProducts in this MultiSpeciesReferencePlugin.

Returns:

the number of SpeciesTypeComponentMapInProducts in this MultiSpeciesReferencePlugin.

getNumSpeciesTypeComponentMapInProducts

public int getNumSpeciesTypeComponentMapInProducts()

Returns the number of SpeciesTypeComponentMapInProducts in this MultiSpeciesReferencePlugin.

Returns:

the number of SpeciesTypeComponentMapInProducts in this MultiSpeciesReferencePlugin.

Note: this method is kept here as it exist in libSBML.

same as getSpeciesTypeComponentMapInProductCount()

getAllowsChildren

public boolean getAllowsChildren()

Specified by:

getAllowsChildren in interface javax.swing.tree.TreeNode

Overrides:

getAllowsChildren in class MultiSimpleSpeciesReferencePlugin

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface javax.swing.tree.TreeNode

Overrides:

getChildCount in class MultiSimpleSpeciesReferencePlugin

getChildAt

public javax.swing.tree.TreeNode getChildAt(int index)

Specified by:

getChildAt in interface javax.swing.tree.TreeNode

Overrides:

getChildAt in class MultiSimpleSpeciesReferencePlugin