Package org.sbml.jsbml.ext.multi

Class InSpeciesTypeBond

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.AbstractNamedSBase

org.sbml.jsbml.ext.multi.InSpeciesTypeBond

All Implemented Interfaces:

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

public class InSpeciesTypeBond
extends AbstractNamedSBase

Defines a bond existing within a MultiSpeciesType. The bond therefore exists in every Species that references the MultiSpeciesType.

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	Description
InSpeciesTypeBond()	Creates an InSpeciesTypeBond instance
InSpeciesTypeBond(int level, int version)	Creates a InSpeciesTypeBond instance with a level and version.
InSpeciesTypeBond(java.lang.String id)	Creates a InSpeciesTypeBond instance with an id.
InSpeciesTypeBond(java.lang.String id, int level, int version)	Creates a InSpeciesTypeBond instance with an id, level, and version.
InSpeciesTypeBond(java.lang.String id, java.lang.String name, int level, int version)	Creates a InSpeciesTypeBond instance with an id, name, level, and version.
InSpeciesTypeBond(InSpeciesTypeBond obj)	Clone constructor

Method Summary

Modifier and Type	Method	Description
InSpeciesTypeBond	clone()	clones this class
boolean	equals(java.lang.Object obj)
java.lang.String	getBindingSite1()	Returns the value of bindingSite1.
java.lang.String	getBindingSite2()	Returns the value of bindingSite2.
int	hashCode()
void	initDefaults()	Initializes the default values using the namespace.
boolean	isIdMandatory()
boolean	isSetBindingSite1()	Returns whether bindingSite1 is set.
boolean	isSetBindingSite2()	Returns whether bindingSite2 is set.
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value)
void	setBindingSite1(java.lang.String bindingSite1)	Sets the value of bindingSite1
void	setBindingSite2(java.lang.String bindingSite2)	Sets the value of bindingSite2
boolean	unsetBindingSite1()	Unsets the variable bindingSite1.
boolean	unsetBindingSite2()	Unsets the variable bindingSite2.
java.util.Map<java.lang.String,java.lang.String>	writeXMLAttributes()

Methods inherited from class org.sbml.jsbml.AbstractNamedSBase

isValidId

Methods inherited from class org.sbml.jsbml.AbstractSBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, addResources, appendAnnotation, appendAnnotation, appendNotes, appendNotes, checkAndSetPackageNamespaceAndVersion, checkAndSetPackageNamespaceAndVersion, checkAttribute, checkIdentifier, checkLevelAndVersionCompatibility, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAllDeclaredNamespaces, getAllowsChildren, getAnnotation, getAnnotationString, getChildAt, getChildCount, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getElementName, getExtension, getExtensionCount, getExtensionPackages, getFirstElementIndex, getHistory, getId, getIdManager, getLevel, getLevelAndVersion, getMetaId, getModel, getName, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasExtension, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetId, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetName, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, notifyChildChange, registerChild, removeCVTerm, removeCVTerm, removeDeclaredNamespaceByNamespace, removeDeclaredNamespaceByPrefix, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, 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, isCloningInProgress, isInvalidSBMLAllowed, isLeaf, isReadingInProgress, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, userObjectKeySet

Methods inherited from interface org.sbml.jsbml.NamedSBase

getId, getName, isSetId, isSetName, setId, setName, unsetId, unsetName

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, appendAnnotation, appendAnnotation, appendNotes, appendNotes, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasExtension, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, registerChild, removeCVTerm, removeCVTerm, removeDeclaredNamespaceByNamespace, removeDeclaredNamespaceByPrefix, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTreeNodeChangeListener, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setAnnotation, setHistory, setLevel, setMetaId, setNotes, setNotes, setPackageVersion, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, unsetNotes, unsetPlugin, unsetSBOTerm

Methods inherited from interface javax.swing.tree.TreeNode

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

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

Constructor Detail

InSpeciesTypeBond

public InSpeciesTypeBond()

Creates an InSpeciesTypeBond instance

InSpeciesTypeBond

public InSpeciesTypeBond(java.lang.String id)

Creates a InSpeciesTypeBond instance with an id.

Parameters:

id - the identifier for the new element.

InSpeciesTypeBond

public InSpeciesTypeBond(int level,
                         int version)

Creates a InSpeciesTypeBond instance with a level and version.

Parameters:

level - SBML Level

version - SBML Version

InSpeciesTypeBond

public InSpeciesTypeBond(java.lang.String id,
                         int level,
                         int version)

Creates a InSpeciesTypeBond instance with an id, level, and version.

Parameters:

id - the identifier for this element.

level - the SBML Level

version - the SBML Version

InSpeciesTypeBond

public InSpeciesTypeBond(java.lang.String id,
                         java.lang.String name,
                         int level,
                         int version)

Creates a InSpeciesTypeBond instance with an id, name, level, and version.

Parameters:

id - the identifier for this element.

name - a human-readable name for this element that can be used for display purposes.

level - the SBML Level

version - the SBML Version

InSpeciesTypeBond

public InSpeciesTypeBond(InSpeciesTypeBond obj)

Clone constructor

Method Detail

clone

public InSpeciesTypeBond clone()

clones this class

Specified by:

clone in interface SBase

Specified by:

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(java.lang.Object obj)

Specified by:

equals in interface SBase

Overrides:

equals in class AbstractSBase

getBindingSite1

public java.lang.String getBindingSite1()

Returns the value of bindingSite1.

Returns:

the value of bindingSite1.

isSetBindingSite1

public boolean isSetBindingSite1()

Returns whether bindingSite1 is set.

Returns:

whether bindingSite1 is set.

setBindingSite1

public void setBindingSite1(java.lang.String bindingSite1)

Sets the value of bindingSite1

Parameters:

bindingSite1 - the value of bindingSite1 to be set.

unsetBindingSite1

public boolean unsetBindingSite1()

Unsets the variable bindingSite1.

Returns:

true if bindingSite1 was set before, otherwise false.

getBindingSite2

public java.lang.String getBindingSite2()

Returns the value of bindingSite2.

Returns:

the value of bindingSite2.

isSetBindingSite2

public boolean isSetBindingSite2()

Returns whether bindingSite2 is set.

Returns:

whether bindingSite2 is set.

setBindingSite2

public void setBindingSite2(java.lang.String bindingSite2)

Sets the value of bindingSite2

Parameters:

bindingSite2 - the value of bindingSite2 to be set.

unsetBindingSite2

public boolean unsetBindingSite2()

Unsets the variable bindingSite2.

Returns:

true if bindingSite2 was set before, otherwise false.

readAttribute

public boolean readAttribute(java.lang.String attributeName,
                             java.lang.String prefix,
                             java.lang.String value)

Specified by:

readAttribute in interface SBase

Overrides:

readAttribute in class AbstractSBase

writeXMLAttributes

public java.util.Map<java.lang.String,java.lang.String> writeXMLAttributes()

Specified by:

writeXMLAttributes in interface SBase

Overrides:

writeXMLAttributes in class AbstractSBase

isIdMandatory

public boolean isIdMandatory()

Specified by:

isIdMandatory in interface NamedSBase

Specified by:

isIdMandatory in interface SBase

Overrides:

isIdMandatory in class AbstractSBase