org.sbml.jsbml.ext.multi

Class SpeciesTypeComponentMapInProduct

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.ext.multi.SpeciesTypeComponentMapInProduct

All Implemented Interfaces:

Serializable, Cloneable, TreeNode, SBase, TreeNodeWithChangeSupport

public class SpeciesTypeComponentMapInProduct
extends AbstractSBase

A speciesTypeComponentMapInProduct defines the mapping between a component in a reactant and a component in a product. The identifications of a component and the speciesReference should be sufficient to identify the component in the context of a reaction. The attributes reactant and reactantComponent can identify the component in a reactant, and the productComponent attribute and the product storing the mapping information can identify the component in a product.

Since:

1.1

Author:

Nicolas Rodriguez

See Also:

Serialized Form

Field Summary

Fields inherited from class org.sbml.jsbml.AbstractSBase

ignoredExtensions, ignoredXMLElements, JSBML_WRONG_SBO_TERM, packageName

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, resourceBundle

Constructor Summary

Constructors

Constructor and Description
SpeciesTypeComponentMapInProduct() Creates an SpeciesTypeComponentMapInProduct instance
SpeciesTypeComponentMapInProduct(int level, int version) Creates a SpeciesTypeComponentMapInProduct instance with a level and version.
SpeciesTypeComponentMapInProduct(SpeciesTypeComponentMapInProduct obj) Clone constructor

Method Summary

Modifier and Type	Method and Description
SpeciesTypeComponentMapInProduct	clone() clones this class
boolean	equals(Object obj)
String	getProductComponent() Returns the value of productComponent.
String	getReactant() Returns the value of reactant.
String	getReactantComponent() Returns the value of reactantComponent.
int	hashCode()
void	initDefaults() Initializes the default values using the namespace.
boolean	isSetProductComponent() Returns whether productComponent is set.
boolean	isSetReactant() Returns whether reactant is set.
boolean	isSetReactantComponent() Returns whether reactantComponent is set.
boolean	readAttribute(String attributeName, String prefix, String value)
void	setProductComponent(String productComponent) Sets the value of productComponent
void	setReactant(String reactant) Sets the value of reactant
void	setReactantComponent(String reactantComponent) Sets the value of reactantComponent
boolean	unsetProductComponent() Unsets the variable productComponent.
boolean	unsetReactant() Unsets the variable reactant.
boolean	unsetReactantComponent() Unsets the variable reactantComponent.
Map<String,String>	writeXMLAttributes()

Methods inherited from class org.sbml.jsbml.AbstractSBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendAnnotation, appendAnnotation, appendNotes, appendNotes, checkAndSetPackageNamespaceAndVersion, checkAndSetPackageNamespaceAndVersion, checkAttribute, checkLevelAndVersionCompatibility, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAllowsChildren, getAnnotation, getAnnotationString, getChildAt, getChildCount, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getId, getIdManager, getLevel, getLevelAndVersion, getMetaId, getModel, getName, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isIdMandatory, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetId, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetName, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, notifyChildChange, registerChild, removeCVTerm, removeCVTerm, setAnnotation, setAnnotation, setAnnotation, setHistory, setId, setLevel, setMetaId, setName, setNamespace, setNotes, setNotes, setPackageVersion, setParentSBML, setParentSBMLObject, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, toString, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetId, unsetMetaId, unsetName, unsetNamespace, unsetNotes, unsetPlugin, unsetSBOTerm

Methods inherited from class org.sbml.jsbml.AbstractTreeNode

addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, children, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, getIndex, getListOfTreeNodeChangeListeners, getNumChildren, getRoot, getTreeNodeChangeListenerCount, getUserObject, indexOf, isLeaf, isReadingInProgress, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, userObjectKeySet

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.sbml.jsbml.SBase

removeTreeNodeChangeListener

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

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

Methods inherited from interface javax.swing.tree.TreeNode

children, getIndex, isLeaf

Constructor Detail

SpeciesTypeComponentMapInProduct

public SpeciesTypeComponentMapInProduct()

Creates an SpeciesTypeComponentMapInProduct instance

SpeciesTypeComponentMapInProduct

public SpeciesTypeComponentMapInProduct(int level,
                                        int version)

Creates a SpeciesTypeComponentMapInProduct instance with a level and version.

Parameters:

level - SBML Level

version - SBML Version

SpeciesTypeComponentMapInProduct

public SpeciesTypeComponentMapInProduct(SpeciesTypeComponentMapInProduct obj)

Clone constructor

Method Detail

clone

public SpeciesTypeComponentMapInProduct clone()

clones this class

Specified by:

clone in interface SBase

Overrides:

clone in class AbstractSBase

initDefaults

public void initDefaults()

Initializes the default values using the namespace.

hashCode

public int hashCode()

Specified by:

hashCode in interface SBase

Overrides:

hashCode in class AbstractSBase

equals

public boolean equals(Object obj)

Specified by:

equals in interface SBase

Overrides:

equals in class AbstractSBase

getReactant

public String getReactant()

Returns the value of reactant.

Returns:

the value of reactant.

isSetReactant

public boolean isSetReactant()

Returns whether reactant is set.

Returns:

whether reactant is set.

setReactant

public void setReactant(String reactant)

Sets the value of reactant

Parameters:

reactant - the value of reactant to be set.

unsetReactant

public boolean unsetReactant()

Unsets the variable reactant.

Returns:

true if reactant was set before, otherwise false.

getReactantComponent

public String getReactantComponent()

Returns the value of reactantComponent.

Returns:

the value of reactantComponent.

isSetReactantComponent

public boolean isSetReactantComponent()

Returns whether reactantComponent is set.

Returns:

whether reactantComponent is set.

setReactantComponent

public void setReactantComponent(String reactantComponent)

Sets the value of reactantComponent

Parameters:

reactantComponent - the value of reactantComponent to be set.

unsetReactantComponent

public boolean unsetReactantComponent()

Unsets the variable reactantComponent.

Returns:

true if reactantComponent was set before, otherwise false.

getProductComponent

public String getProductComponent()

Returns the value of productComponent.

Returns:

the value of productComponent.

isSetProductComponent

public boolean isSetProductComponent()

Returns whether productComponent is set.

Returns:

whether productComponent is set.

setProductComponent

public void setProductComponent(String productComponent)

Sets the value of productComponent

Parameters:

productComponent - the value of productComponent to be set.

unsetProductComponent

public boolean unsetProductComponent()

Unsets the variable productComponent.

Returns:

true if productComponent was set before, otherwise false.

writeXMLAttributes

public Map<String,String> writeXMLAttributes()

Specified by:

writeXMLAttributes in interface SBase

Overrides:

writeXMLAttributes in class AbstractSBase

readAttribute

public boolean readAttribute(String attributeName,
                             String prefix,
                             String value)

Specified by:

readAttribute in interface SBase

Overrides:

readAttribute in class AbstractSBase