org.sbml.jsbml.ext.multi

Class ReactionRule

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.AbstractNamedSBase

org.sbml.jsbml.ext.multi.ReactionRule

All Implemented Interfaces:

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

public class ReactionRule
extends AbstractNamedSBase

Since:

1.0

Version:

$Rev: 1639 $

Author:

Nicolas Rodriguez

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private KineticLaw	kineticLaw
(package private) ListOf<SpeciesTypeRestrictionReference>	listOfConditions
(package private) ListOf<SpeciesTypeRestrictionReference>	listOfResults
private static long	serialVersionUID Generated serial version identifier.

Fields inherited from class org.sbml.jsbml.AbstractSBase

ignoredExtensions, ignoredXMLElements

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, UNKNOWN_ATTRIBUTES, UNKNOWN_ELEMENTS

Constructor Summary

Constructors

Constructor and Description
ReactionRule()

Method Summary

Methods

Modifier and Type	Method and Description
void	addCondition(SpeciesTypeRestrictionReference condition) Adds a condition.
void	addResult(SpeciesTypeRestrictionReference result) Adds a result.
AbstractSBase	clone() Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.
KineticLaw	createKineticLaw() Creates a new KineticLaw object, installs it as this ReactionRule's 'kineticLaw' sub-element, and returns it.
KineticLaw	getKineticLaw()
ListOf<SpeciesTypeRestrictionReference>	getListOfConditions() Returns the list of conditions (SpeciesTypeRestrictionReference).
ListOf<SpeciesTypeRestrictionReference>	getListOfResults() Returns the list of results (SpeciesTypeRestrictionReference).
boolean	isIdMandatory() This method can be used to query if the identifier of this NamedSBase is required to be defined (i.e., not null) in the definition of SBML.
boolean	isSetKineticLaw()
void	setKineticLaw(KineticLaw kineticLaw) Sets the kineticLaw of this ReactionRule.
boolean	unsetKineticLaw() Sets the KineticLaw of this ReactionRule to null and notifies all TreeNodeChangeListener about changes.

Methods inherited from class org.sbml.jsbml.AbstractNamedSBase

equals, getId, getName, hashCode, isSetId, isSetName, isValidId, readAttribute, setId, setName, toString, unsetId, unsetName, writeXMLAttributes

Methods inherited from class org.sbml.jsbml.AbstractSBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendNotes, appendNotes, checkLevelAndVersionCompatibility, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAllowsChildren, getAnnotation, getAnnotationString, getChildAt, getChildCount, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getIdManager, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, notifyChildChange, registerChild, removeCVTerm, removeCVTerm, setAnnotation, setHistory, setLevel, setMetaId, setNamespace, setNotes, setNotes, setParentSBML, setParentSBMLObject, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, 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, 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

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendNotes, appendNotes, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, registerChild, removeCVTerm, removeCVTerm, removeTreeNodeChangeListener, setAnnotation, setHistory, setLevel, setMetaId, setNotes, setNotes, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, unsetNotes, unsetPlugin, unsetSBOTerm

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

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

Methods inherited from interface javax.swing.tree.TreeNode

children, getAllowsChildren, getChildAt, getChildCount, getIndex, getParent, isLeaf

Field Detail

serialVersionUID

private static final long serialVersionUID

Generated serial version identifier.

See Also:

Constant Field Values

listOfConditions

ListOf<SpeciesTypeRestrictionReference> listOfConditions

listOfResults

ListOf<SpeciesTypeRestrictionReference> listOfResults

kineticLaw

private KineticLaw kineticLaw

Constructor Detail

ReactionRule

public ReactionRule()

Method Detail

getListOfConditions

public ListOf<SpeciesTypeRestrictionReference> getListOfConditions()

Returns the list of conditions (SpeciesTypeRestrictionReference).

Returns:

the list of conditions (SpeciesTypeRestrictionReference).

addCondition

public void addCondition(SpeciesTypeRestrictionReference condition)

Adds a condition.

Parameters:

condition - the condition to add

getListOfResults

public ListOf<SpeciesTypeRestrictionReference> getListOfResults()

Returns the list of results (SpeciesTypeRestrictionReference).

Returns:

the list of results (SpeciesTypeRestrictionReference).

addResult

public void addResult(SpeciesTypeRestrictionReference result)

Adds a result.

Parameters:

results - the result to add

createKineticLaw

public KineticLaw createKineticLaw()

Creates a new KineticLaw object, installs it as this ReactionRule's 'kineticLaw' sub-element, and returns it. If this ReactionRule had a previous KineticLaw, it will be destroyed.

Returns:

the new KineticLaw object

getKineticLaw

public KineticLaw getKineticLaw()

Returns:

the kineticLaw of this ReactionRule. Can be null if not set.

isSetKineticLaw

public boolean isSetKineticLaw()

Returns:

true if the kineticLaw of this ReactionRule is not null.

setKineticLaw

public void setKineticLaw(KineticLaw kineticLaw)

Sets the kineticLaw of this ReactionRule.

Parameters:

kineticLaw -

unsetKineticLaw

public boolean unsetKineticLaw()

Sets the KineticLaw of this ReactionRule to null and notifies all TreeNodeChangeListener about changes.

Returns:

true if calling this method changed the properties of this element.

isIdMandatory

public boolean isIdMandatory()

Description copied from interface: NamedSBase

This method can be used to query if the identifier of this NamedSBase is required to be defined (i.e., not null) in the definition of SBML.

Returns:

true if the identifier of this element must be set in order to create a valid SBML representation. false otherwise, i.e., if the identifier can be understood as an optional attribute.

clone

public AbstractSBase clone()

Description copied from interface: SBase

Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.

Specified by:

clone in interface SBase

Specified by:

clone in class AbstractSBase

Returns:

a copy of this object