org.sbml.jsbml.ext.multi

Class StateFeatureInstance

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.AbstractNamedSBase

org.sbml.jsbml.ext.multi.StateFeatureInstance

All Implemented Interfaces:

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

public class StateFeatureInstance
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 ListOf<StateFeatureValue>	listOfStateFeatureValues
private static long	serialVersionUID Generated serial version identifier.
private java.lang.String	stateFeature

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
StateFeatureInstance() Creates a new StateFeatureInstance.

Method Summary

Methods

Modifier and Type	Method and Description
void	addStateFeatureValue(StateFeatureValue stateFeatureValue) Adds a StateFeatureValue.
AbstractSBase	clone() Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.
StateFeatureValue	createStateFeatureValue() Creates a new StateFeatureValue inside this StateFeatureInstance and returns it.
javax.swing.tree.TreeNode	getChildAt(int index)
int	getChildCount()
ListOf<StateFeatureValue>	getListOfStateFeatureValues() Returns the listOfStateFeatureValues
java.lang.String	getStateFeature() Returns the stateFeature.
StateFeatureValue	getStateFeatureValue(int i) Gets the ith StateFeatureValue.
StateFeatureValue	getStateFeatureValue(java.lang.String id) Gets the StateFeatureValue that has the given id.
void	initDefaults()
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	isSetListOfStateFeatureValues() Returns true if the listOfStateFeatureValue is set.
boolean	isSetStateFeature() Returns true if the stateFeature id is defined.
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value) Sets the given attribute in this SBase.
void	setStateFeature(java.lang.String stateFeature) Sets the stateFeature.
boolean	unsetListOfStateFeatureValues() Sets the listOfStateFeatureValues to null
java.util.Map<java.lang.String,java.lang.String>	writeXMLAttributes() Returns a map with all the attributes of this SBase that need to be written out in XML.

Methods inherited from class org.sbml.jsbml.AbstractNamedSBase

equals, getId, getName, hashCode, isSetId, isSetName, isValidId, 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.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, getIndex, getParent, isLeaf

Field Detail

serialVersionUID

private static final long serialVersionUID

Generated serial version identifier.

See Also:

Constant Field Values

stateFeature

private java.lang.String stateFeature

listOfStateFeatureValues

private ListOf<StateFeatureValue> listOfStateFeatureValues

Constructor Detail

StateFeatureInstance

public StateFeatureInstance()

Creates a new StateFeatureInstance.

Method Detail

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

getStateFeature

public java.lang.String getStateFeature()

Returns the stateFeature.

Returns:

the stateFeature

setStateFeature

public void setStateFeature(java.lang.String stateFeature)

Sets the stateFeature.

Parameters:

stateFeature - the stateFeature to set

isSetStateFeature

public boolean isSetStateFeature()

Returns true if the stateFeature id is defined.

Returns:

true if the stateFeature id is defined.

getListOfStateFeatureValues

public ListOf<StateFeatureValue> getListOfStateFeatureValues()

Returns the listOfStateFeatureValues

Returns:

the listOfStateFeatureValues

addStateFeatureValue

public void addStateFeatureValue(StateFeatureValue stateFeatureValue)

Adds a StateFeatureValue.

Parameters:

stateFeatureValue - the StateFeatureValue to add

createStateFeatureValue

public StateFeatureValue createStateFeatureValue()

Creates a new StateFeatureValue inside this StateFeatureInstance and returns it.

Returns:

the StateFeatureValue object created

getStateFeatureValue

public StateFeatureValue getStateFeatureValue(int i)

Gets the ith StateFeatureValue.

Parameters:

i -

Returns:

the ith StateFeatureValue

Throws:

java.lang.IndexOutOfBoundsException - if the index is invalid.

getStateFeatureValue

public StateFeatureValue getStateFeatureValue(java.lang.String id)

Gets the StateFeatureValue that has the given id.

Parameters:

id -

Returns:

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

isSetListOfStateFeatureValues

public boolean isSetListOfStateFeatureValues()

Returns true if the listOfStateFeatureValue is set.

Returns:

true if the listOfStateFeatureValue is set.

unsetListOfStateFeatureValues

public boolean unsetListOfStateFeatureValues()

Sets the listOfStateFeatureValues to null

Returns:

true is successful

initDefaults

public void initDefaults()

getChildAt

public javax.swing.tree.TreeNode getChildAt(int index)

Specified by:

getChildAt in interface javax.swing.tree.TreeNode

Overrides:

getChildAt in class AbstractSBase

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface javax.swing.tree.TreeNode

Overrides:

getChildCount in class AbstractSBase

readAttribute

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

Description copied from interface: SBase

Sets the given attribute in this SBase.

If the given attribute name is not recognized, nothing is done and false is returned.

Specified by:

readAttribute in interface SBase

Overrides:

readAttribute in class AbstractNamedSBase

Parameters:

attributeName - localName of the XML attribute

prefix - prefix of the XML attribute

value - value of the XML attribute

Returns:

true if the attribute has been successfully read.

writeXMLAttributes

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

Description copied from interface: SBase

Returns a map with all the attributes of this SBase that need to be written out in XML.

The attribute name is used as a key and the attribute value as value. If a prefix is needed for the attribute name, it need to be set directly in this map.

Specified by:

writeXMLAttributes in interface SBase

Overrides:

writeXMLAttributes in class AbstractNamedSBase

Returns:

a Map containing the XML attributes of this object.