java.io.Serializable, java.lang.Cloneable, javax.swing.tree.TreeNode, MathContainer, NamedSBase, SBase, SBaseWithDerivedUnit, org.sbml.jsbml.util.TreeNodeWithChangeSupportUncertSpanpublic class UncertParameter extends AbstractDistribSBase implements MathContainer
It has one required attribute 'type' which defines what statistic it describes (i.e. 'mean', 'standardDeviation', 'distribution', etc.). Its other attributes (value, var, units, and definitionURL), and children (math and listOfUncertParameters) are all optional, each usable according to which type it is.
| Modifier and Type | Class | Description |
|---|---|---|
static class |
UncertParameter.Type |
The different
UncertParameter and UncertSpan type values. |
ignoredExtensions, ignoredXMLElements, JSBML_WRONG_SBO_TERM, packageNamelistOfListeners, parent, resourceBundle| Constructor | Description |
|---|---|
UncertParameter() |
Creates an UncertParameter instance
|
UncertParameter(int level,
int version) |
Creates a UncertParameter instance with a level and version.
|
UncertParameter(java.lang.String id) |
Creates a UncertParameter instance with an id.
|
UncertParameter(java.lang.String id,
int level,
int version) |
Creates a UncertParameter instance with an id, level, and version.
|
UncertParameter(java.lang.String id,
java.lang.String name,
int level,
int version) |
Creates a UncertParameter instance with an id, name, level, and version.
|
UncertParameter(UncertParameter obj) |
Clone constructor
|
| Modifier and Type | Method | Description |
|---|---|---|
boolean |
addUncertParameter(UncertParameter uncertParameter) |
Adds a new
UncertParameter to the listOfUncertParameters. |
UncertParameter |
clone() |
Clones this class
|
boolean |
containsUndeclaredUnits() |
|
UncertParameter |
createUncertParameter() |
Creates a new UncertParameter element and adds it to the
listOfUncertParameters list. |
UncertParameter |
createUncertParameter(java.lang.String id) |
Creates a new
UncertParameter element and adds it to the
listOfUncertParameters list. |
boolean |
equals(java.lang.Object obj) |
|
boolean |
getAllowsChildren() |
|
javax.swing.tree.TreeNode |
getChildAt(int index) |
|
int |
getChildCount() |
|
java.lang.String |
getDefinitionURL() |
Returns the value of
definitionURL. |
UnitDefinition |
getDerivedUnitDefinition() |
|
java.lang.String |
getDerivedUnits() |
|
java.lang.String |
getFormula() |
Deprecated.
|
ListOf<UncertParameter> |
getListOfUncertParameters() |
Returns the
listOfUncertParameters. |
ASTNode |
getMath() |
|
java.lang.String |
getMathMLString() |
|
int |
getNumUncertParameters() |
Returns the number of
UncertParameters in this
UncertParameter. |
UncertParameter.Type |
getType() |
Returns the value of
type. |
UncertParameter |
getUncertParameter(int i) |
Gets an element from the
listOfUncertParameters at the given index. |
UncertParameter |
getUncertParameter(java.lang.String uncertParameterId) |
Gets an element from the listOfUncertParameters, with the given id.
|
int |
getUncertParameterCount() |
Returns the number of
UncertParameters in this
UncertParameter. |
java.lang.String |
getUnits() |
Returns the value of
units. |
double |
getValue() |
Returns the value of
value. |
java.lang.String |
getVar() |
Returns the value of
var. |
int |
hashCode() |
|
void |
initDefaults() |
Initializes the default values using the namespace.
|
boolean |
isSetDefinitionURL() |
Returns whether
definitionURL is set. |
boolean |
isSetListOfUncertParameters() |
Returns
true if listOfUncertParameters contains at least
one element. |
boolean |
isSetMath() |
|
boolean |
isSetType() |
Returns whether
type is set. |
boolean |
isSetUnits() |
Returns whether
units is set. |
boolean |
isSetValue() |
Returns whether
value is set. |
boolean |
isSetVar() |
Returns whether
var is set. |
boolean |
readAttribute(java.lang.String attributeName,
java.lang.String prefix,
java.lang.String value) |
|
UncertParameter |
removeUncertParameter(int i) |
Removes an element from the
listOfUncertParameters at the given index. |
UncertParameter |
removeUncertParameter(java.lang.String uncertParameterId) |
Removes an element from the
listOfUncertParameters. |
boolean |
removeUncertParameter(UncertParameter uncertParameter) |
Removes an element from the
listOfUncertParameters. |
void |
setDefinitionURL(java.lang.String definitionURL) |
Sets the value of definitionURL
|
void |
setFormula(java.lang.String formula) |
Deprecated.
|
void |
setListOfUncertParameters(ListOf<UncertParameter> listOfUncertParameters) |
Sets the given
ListOf<UncertParameter>. |
void |
setMath(ASTNode math) |
|
void |
setType(UncertParameter.Type type) |
Sets the value of type
|
void |
setUnits(java.lang.String units) |
Sets the value of units
|
void |
setValue(double value) |
Sets the value of value
|
void |
setVar(java.lang.String var) |
Sets the value of var
|
boolean |
unsetDefinitionURL() |
Unsets the variable definitionURL.
|
void |
unsetFormula() |
Deprecated.
|
boolean |
unsetListOfUncertParameters() |
|
void |
unsetMath() |
|
boolean |
unsetType() |
Unsets the variable type.
|
boolean |
unsetUnits() |
Unsets the variable units.
|
boolean |
unsetValue() |
Unsets the variable value.
|
boolean |
unsetVar() |
Unsets the variable var.
|
java.util.Map<java.lang.String,java.lang.String> |
writeXMLAttributes() |
getPackageNameaddCVTerm, 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, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getElementName, getExtension, getExtensionCount, getExtensionPackages, getFirstElementIndex, getHistory, getId, getIdManager, getLevel, getLevelAndVersion, getMetaId, getModel, getName, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageVersion, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasExtension, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isIdMandatory, 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, unsetSBOTermaddAllChangeListeners, 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, userObjectKeySetgetId, getName, isIdMandatory, isSetId, isSetName, setId, setName, unsetId, unsetNamefinalize, getClass, notify, notifyAll, wait, wait, waitaddCVTerm, 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, getId, getLevel, getLevelAndVersion, getMetaId, getModel, getName, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasExtension, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isIdMandatory, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetId, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetName, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, registerChild, removeCVTerm, removeCVTerm, removeDeclaredNamespaceByNamespace, removeDeclaredNamespaceByPrefix, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTreeNodeChangeListener, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setAnnotation, setHistory, setId, setLevel, setMetaId, setName, setNotes, setNotes, setPackageVersion, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetId, unsetMetaId, unsetName, unsetNotes, unsetPlugin, unsetSBOTermaddAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, fireNodeRemovedEvent, firePropertyChange, getListOfTreeNodeChangeListeners, getRoot, getTreeNodeChangeListenerCount, getUserObject, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeUserObject, userObjectKeySetpublic UncertParameter()
public UncertParameter(java.lang.String id)
id - the identifier for the new element.public UncertParameter(int level,
int version)
level - SBML Levelversion - SBML Versionpublic UncertParameter(java.lang.String id,
int level,
int version)
id - the identifier for this element.level - the SBML Levelversion - the SBML Versionpublic UncertParameter(java.lang.String id,
java.lang.String name,
int level,
int version)
id - the identifier for this element.name - a human-readable name for this element that can be used for display purposes.level - the SBML Levelversion - the SBML Versionpublic UncertParameter(UncertParameter obj)
public UncertParameter clone()
clone in interface SBaseclone in class AbstractSBasepublic void initDefaults()
public UncertParameter.Type getType()
type.type.public void setType(UncertParameter.Type type)
type - the value of type to be set.public boolean unsetType()
true if type was set before, otherwise false.public boolean isSetValue()
value is set.value is set.public void setValue(double value)
value - the value of value to be set.public boolean unsetValue()
true if value was set before, otherwise false.public void setVar(java.lang.String var)
var - the value of var to be set.public boolean unsetVar()
true if var was set before, otherwise false.public java.lang.String getUnits()
units.units.public boolean isSetUnits()
units is set.units is set.public void setUnits(java.lang.String units)
units - the value of units to be set.public boolean unsetUnits()
true if units was set before, otherwise false.public java.lang.String getDefinitionURL()
definitionURL.definitionURL.public boolean isSetDefinitionURL()
definitionURL is set.definitionURL is set.public void setDefinitionURL(java.lang.String definitionURL)
definitionURL - the value of definitionURL to be set.public boolean unsetDefinitionURL()
true if definitionURL was set before, otherwise false.public int hashCode()
hashCode in interface SBasehashCode in class AbstractSBasepublic boolean equals(java.lang.Object obj)
equals in interface SBaseequals in class AbstractSBasepublic boolean containsUndeclaredUnits()
containsUndeclaredUnits in interface SBaseWithDerivedUnitpublic UnitDefinition getDerivedUnitDefinition()
getDerivedUnitDefinition in interface SBaseWithDerivedUnitpublic java.lang.String getDerivedUnits()
getDerivedUnits in interface SBaseWithDerivedUnit@Deprecated public java.lang.String getFormula()
getFormula in interface MathContainerpublic ASTNode getMath()
getMath in interface MathContainerpublic java.lang.String getMathMLString()
getMathMLString in interface MathContainerpublic boolean isSetMath()
isSetMath in interface MathContainer@Deprecated
public void setFormula(java.lang.String formula)
throws org.sbml.jsbml.text.parser.ParseException
setFormula in interface MathContainerorg.sbml.jsbml.text.parser.ParseExceptionpublic void setMath(ASTNode math)
setMath in interface MathContainer@Deprecated public void unsetFormula()
unsetFormula in interface MathContainerpublic void unsetMath()
unsetMath in interface MathContainerpublic boolean isSetListOfUncertParameters()
true if listOfUncertParameters contains at least
one element.true if listOfUncertParameters contains at least
one element, otherwise false.public ListOf<UncertParameter> getListOfUncertParameters()
listOfUncertParameters.
Creates it if it does not already exist.listOfUncertParameters.public void setListOfUncertParameters(ListOf<UncertParameter> listOfUncertParameters)
ListOf<UncertParameter>.
If listOfUncertParameters was defined before and contains some
elements, they are all unset.listOfUncertParameters - the list to setpublic boolean unsetListOfUncertParameters()
true if listOfUncertParameters contains at least
one element, otherwise false.public boolean addUncertParameter(UncertParameter uncertParameter)
UncertParameter to the listOfUncertParameters.
The listOfUncertParameters is initialized if necessary.
uncertParameter - the element to add to the listtrue (as specified by Collection.add(E))Collection.add(Object)public boolean removeUncertParameter(UncertParameter uncertParameter)
listOfUncertParameters.uncertParameter - the element to be removed from the list.true if the list contained the specified element and it was
removed.List.remove(Object)public UncertParameter removeUncertParameter(java.lang.String uncertParameterId)
listOfUncertParameters.uncertParameterId - the id of the element to be removed from the list.null.public UncertParameter removeUncertParameter(int i)
listOfUncertParameters at the given index.i - the index where to remove the UncertParameter.java.lang.IndexOutOfBoundsException - if the listOf is not set or if the index is
out of bound ((i < 0) || (i > listOfUncertParameters)).public UncertParameter createUncertParameter()
listOfUncertParameters list.listOfUncertParameterspublic UncertParameter createUncertParameter(java.lang.String id)
UncertParameter element and adds it to the
listOfUncertParameters list.id - the identifier that is to be applied to the new element.UncertParameter element, which is the last
element in the listOfUncertParameters.public UncertParameter getUncertParameter(int i)
listOfUncertParameters at the given index.i - the index of the UncertParameter element to get.java.lang.IndexOutOfBoundsException - if the listOf is not set or
if the index is out of bound (index < 0 || index > list.size).public UncertParameter getUncertParameter(java.lang.String uncertParameterId)
uncertParameterId - the id of the UncertParameter element to get.null.public int getUncertParameterCount()
UncertParameters in this
UncertParameter.UncertParameters in this
UncertParameter.public int getNumUncertParameters()
UncertParameters in this
UncertParameter.UncertParameters in this
UncertParameter.getUncertParameterCount()public boolean getAllowsChildren()
getAllowsChildren in interface javax.swing.tree.TreeNodegetAllowsChildren in class AbstractDistribSBasepublic javax.swing.tree.TreeNode getChildAt(int index)
getChildAt in interface javax.swing.tree.TreeNodegetChildAt in class AbstractDistribSBasepublic int getChildCount()
getChildCount in interface javax.swing.tree.TreeNodegetChildCount in class AbstractDistribSBasepublic java.util.Map<java.lang.String,java.lang.String> writeXMLAttributes()
writeXMLAttributes in interface SBasewriteXMLAttributes in class AbstractDistribSBasepublic boolean readAttribute(java.lang.String attributeName,
java.lang.String prefix,
java.lang.String value)
readAttribute in interface SBasereadAttribute in class AbstractSBaseCopyright © 2009–2022. All rights reserved.