org.sbml.jsbml.ext.multi

Class SpeciesTypeComponentIndex

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.AbstractNamedSBase

org.sbml.jsbml.ext.multi.SpeciesTypeComponentIndex

All Implemented Interfaces:

Serializable, Cloneable, TreeNode, NamedSBase, SBase, TreeNodeWithChangeSupport

public class SpeciesTypeComponentIndex
extends AbstractNamedSBase

Provides a way to identify or index a component within a 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 and Description
SpeciesTypeComponentIndex() Creates an SpeciesTypeComponentIndex instance
SpeciesTypeComponentIndex(int level, int version) Creates a SpeciesTypeComponentIndex instance with a level and version.
SpeciesTypeComponentIndex(SpeciesTypeComponentIndex obj) Clone constructor
SpeciesTypeComponentIndex(String id) Creates a SpeciesTypeComponentIndex instance with an id.
SpeciesTypeComponentIndex(String id, int level, int version) Creates a SpeciesTypeComponentIndex instance with an id, level, and version.
SpeciesTypeComponentIndex(String id, String name, int level, int version) Creates a SpeciesTypeComponentIndex instance with an id, name, level, and version.

Method Summary

Modifier and Type	Method and Description
SpeciesTypeComponentIndex	clone() clones this class
boolean	equals(Object obj)
String	getComponent() Returns the value of component.
String	getIndentifyingParent() Returns the value of identifyingParent.
int	hashCode()
void	initDefaults() Initializes the default values using the namespace.
boolean	isIdMandatory()
boolean	isSetComponent() Returns whether component is set.
boolean	isSetIndentifyingParent() Returns whether identifyingParent is set.
boolean	readAttribute(String attributeName, String prefix, String value)
void	setComponent(String component) Sets the value of component
void	setIndentifyingParent(String identifyingParent) Sets the value of identifyingParent
boolean	unsetComponent() Unsets the variable component.
boolean	unsetIndentifyingParent() Unsets the variable identifyingParent.
Map<String,String>	writeXMLAttributes()

Methods inherited from class org.sbml.jsbml.AbstractNamedSBase

isValidId

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, 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.NamedSBase

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

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, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, registerChild, removeCVTerm, removeCVTerm, removeTreeNodeChangeListener, 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 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

Constructor Detail

SpeciesTypeComponentIndex

public SpeciesTypeComponentIndex()

Creates an SpeciesTypeComponentIndex instance

SpeciesTypeComponentIndex

public SpeciesTypeComponentIndex(String id)

Creates a SpeciesTypeComponentIndex instance with an id.

Parameters:

id - the identifier for the new element.

SpeciesTypeComponentIndex

public SpeciesTypeComponentIndex(int level,
                                 int version)

Creates a SpeciesTypeComponentIndex instance with a level and version.

Parameters:

level - SBML Level

version - SBML Version

SpeciesTypeComponentIndex

public SpeciesTypeComponentIndex(String id,
                                 int level,
                                 int version)

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

Parameters:

id - the identifier for this element.

level - the SBML Level

version - the SBML Version

SpeciesTypeComponentIndex

public SpeciesTypeComponentIndex(String id,
                                 String name,
                                 int level,
                                 int version)

Creates a SpeciesTypeComponentIndex 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

SpeciesTypeComponentIndex

public SpeciesTypeComponentIndex(SpeciesTypeComponentIndex obj)

Clone constructor

Parameters:

obj - the SpeciesTypeComponentIndex instance to clone

Method Detail

clone

public SpeciesTypeComponentIndex 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

isIdMandatory

public boolean isIdMandatory()

Specified by:

isIdMandatory in interface NamedSBase

Specified by:

isIdMandatory in interface SBase

Overrides:

isIdMandatory in class AbstractSBase

getComponent

public String getComponent()

Returns the value of component.

Returns:

the value of component.

isSetComponent

public boolean isSetComponent()

Returns whether component is set.

Returns:

whether component is set.

setComponent

public void setComponent(String component)

Sets the value of component

Parameters:

component - the value of component to be set.

unsetComponent

public boolean unsetComponent()

Unsets the variable component.

Returns:

true if component was set before, otherwise false.

getIndentifyingParent

public String getIndentifyingParent()

Returns the value of identifyingParent.

Returns:

the value of identifyingParent.

isSetIndentifyingParent

public boolean isSetIndentifyingParent()

Returns whether identifyingParent is set.

Returns:

whether identifyingParent is set.

setIndentifyingParent

public void setIndentifyingParent(String identifyingParent)

Sets the value of identifyingParent

Parameters:

identifyingParent - the value of identifyingParent to be set.

unsetIndentifyingParent

public boolean unsetIndentifyingParent()

Unsets the variable identifyingParent.

Returns:

true if identifyingParent 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