org.sbml.jsbml.ext.multi

Class StateFeature

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.AbstractNamedSBase

org.sbml.jsbml.ext.multi.StateFeature

All Implemented Interfaces:

Serializable, Cloneable, TreeNode, NamedSBase, SBase, UniqueNamedSBase, TreeNodeWithChangeSupport

public class StateFeature
extends AbstractNamedSBase
implements UniqueNamedSBase

A species type (SpeciesType) can carry any number of state features (StateFeature), which are characteristic properties specific for this type of species (Species). The element StateFeature of SBML Level 3 Version 1 multi Version 1 corresponds to the "state variable" of the SBGN Entity Relationship language. A StateFeature is identified by an id and an optional name. A StateFeature is linked to a list of PossibleValues.

Since:

1.0

Version:

$Rev$

Author:

Nicolas Rodriguez

See Also:

Serialized Form

Field Summary

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
StateFeature()

Method Summary

Modifier and Type	Method and Description
void	addPossibleValue(PossibleValue possibleValue) Adds a PossibleValue.
AbstractSBase	clone()
PossibleValue	createPossibleValue() Creates a new PossibleValue inside this StateFeature and returns it.
PossibleValue	createPossibleValue(String id) Creates a new PossibleValue inside this StateFeature and returns it.
TreeNode	getChildAt(int index)
int	getChildCount()
ListOf<PossibleValue>	getListOfPossibleValues() Returns the listOfPossibleValues
PossibleValue	getPossibleValue(int i) Gets the ith PossibleValue.
PossibleValue	getPossibleValue(String id) Gets the PossibleValue that has the given id.
void	initDefaults()
boolean	isIdMandatory()
boolean	isSetListOfPossibleValues() Returns true if the listOfPossibleValue is set.
boolean	unsetListOfPossibleValues() Sets the listOfPossibleValues to null
Map<String,String>	writeXMLAttributes()

Methods inherited from class org.sbml.jsbml.AbstractNamedSBase

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

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

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

Methods inherited from interface org.sbml.jsbml.SBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendNotes, appendNotes, createPlugin, disablePackage, enablePackage, enablePackage, equals, 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, hashCode, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, readAttribute, 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, getIndex, getParent, isLeaf

Constructor Detail

StateFeature

public StateFeature()

Method Detail

isIdMandatory

public boolean isIdMandatory()

Specified by:

isIdMandatory in interface NamedSBase

clone

public AbstractSBase clone()

Specified by:

clone in interface SBase

Overrides:

clone in class AbstractSBase

getListOfPossibleValues

public ListOf<PossibleValue> getListOfPossibleValues()

Returns the listOfPossibleValues

Returns:

the listOfPossibleValues

addPossibleValue

public void addPossibleValue(PossibleValue possibleValue)

Adds a PossibleValue.

Parameters:

possibleValue - the PossibleValue to add

createPossibleValue

public PossibleValue createPossibleValue()

Creates a new PossibleValue inside this StateFeature and returns it.

Returns:

the PossibleValue object created

See Also:

addPossibleValue(PossibleValue r)

createPossibleValue

public PossibleValue createPossibleValue(String id)

Creates a new PossibleValue inside this StateFeature and returns it.

Parameters:

id - the id of the new element to create

Returns:

the PossibleValue object created

getPossibleValue

public PossibleValue getPossibleValue(int i)

Gets the ith PossibleValue.

Parameters:

i -

Returns:

the ith PossibleValue

Throws:

IndexOutOfBoundsException - if the index is invalid.

getPossibleValue

public PossibleValue getPossibleValue(String id)

Gets the PossibleValue that has the given id.

Parameters:

id -

Returns:

the PossibleValue that has the given id or null if no PossibleValue are found that match id.

isSetListOfPossibleValues

public boolean isSetListOfPossibleValues()

Returns true if the listOfPossibleValue is set.

Returns:

true if the listOfPossibleValue is set.

unsetListOfPossibleValues

public boolean unsetListOfPossibleValues()

Sets the listOfPossibleValues to null

Returns:

true is successful

initDefaults

public void initDefaults()

getChildAt

public TreeNode getChildAt(int index)

Specified by:

getChildAt in interface TreeNode

Overrides:

getChildAt in class AbstractSBase

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface TreeNode

Overrides:

getChildCount in class AbstractSBase

writeXMLAttributes

public Map<String,String> writeXMLAttributes()

Specified by:

writeXMLAttributes in interface SBase

Overrides:

writeXMLAttributes in class AbstractNamedSBase