org.sbml.jsbml.ext.qual
public class QualitativeSpecies extends AbstractNamedSBase implements UniqueNamedSBase
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
compartment |
private java.lang.Boolean |
constant |
private java.lang.Integer |
initialLevel |
private java.lang.Integer |
maxLevel |
private static long |
serialVersionUID
Generated serial version identifier.
|
ignoredExtensions, ignoredXMLElements
listOfListeners, parent, UNKNOWN_ATTRIBUTES, UNKNOWN_ELEMENTS
Constructor and Description |
---|
QualitativeSpecies() |
QualitativeSpecies(int level,
int version) |
QualitativeSpecies(QualitativeSpecies qualSpecies)
Copy constructor that clones all variables of
qualSpecies . |
QualitativeSpecies(Species species)
Copy constructor that clones all values from the input
species that are also available in
QualitativeSpecies . |
QualitativeSpecies(java.lang.String id) |
QualitativeSpecies(java.lang.String id,
int level,
int version) |
QualitativeSpecies(java.lang.String id,
java.lang.String name,
int level,
int version) |
Modifier and Type | Method and Description |
---|---|
QualitativeSpecies |
clone()
Creates a deep copy of this object, i.e., a new
SBase with the same properties
like this one. |
boolean |
equals(java.lang.Object object)
|
java.lang.String |
getCompartment() |
boolean |
getConstant() |
int |
getInitialLevel() |
int |
getMaxLevel() |
int |
hashCode() |
void |
initDefaults() |
boolean |
isBoundaryConditionMandatory() |
boolean |
isCompartmentMandatory() |
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 |
isInitialLevelMandatory() |
boolean |
isMaxLevelMandatory() |
boolean |
isSetCompartment() |
boolean |
isSetConstant() |
boolean |
isSetConstantMandatory() |
boolean |
isSetInitialLevel() |
boolean |
isSetMaxLevel() |
boolean |
readAttribute(java.lang.String attributeName,
java.lang.String prefix,
java.lang.String value)
If the attribute is an id or name attribute, it will set the id or name
of this object with the value of the XML attribute ('value').
|
void |
setCompartment(Compartment compartment)
Sets the compartmentID of this
Species to the id of
'compartment'. |
void |
setCompartment(java.lang.String compartment) |
void |
setConstant(boolean constant) |
void |
setInitialLevel(int initialLevel) |
void |
setMaxLevel(int maxLevel) |
boolean |
unsetCompartment() |
boolean |
unsetConstant() |
boolean |
unsetInitialLevel() |
boolean |
unsetMaxLevel() |
java.util.Map<java.lang.String,java.lang.String> |
writeXMLAttributes() |
getId, getName, isSetId, isSetName, isValidId, setId, setName, toString, unsetId, unsetName
addCVTerm, addDeclaredNamespace, addExtension, appendNotes, appendNotes, checkLevelAndVersionCompatibility, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, getAllowsChildren, getAnnotation, getAnnotationString, getChildAt, getChildCount, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementName, getExtension, getExtensionPackages, getHistory, 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, setAnnotation, setHistory, setLevel, setMetaId, setNamespace, setNotes, setNotes, setParentSBML, setParentSBMLObject, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregister, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, unsetNamespace, unsetNotes, unsetPlugin, unsetSBOTerm
addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, children, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, firePropertyChange, getIndex, getListOfTreeNodeChangeListeners, getNumChildren, getRoot, getTreeNodeChangeListenerCount, getUserObject, indexOf, isLeaf, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, userObjectKeySet
finalize, getClass, notify, notifyAll, wait, wait, wait
getId, getName, isSetId, isSetName, setId, setName, unsetId, unsetName
addCVTerm, addDeclaredNamespace, addExtension, appendNotes, appendNotes, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementName, getExtension, 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, removeTreeNodeChangeListener, setAnnotation, setHistory, setLevel, setMetaId, setNotes, setNotes, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregister, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, unsetNotes, unsetPlugin, unsetSBOTerm
addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, fireNodeRemovedEvent, firePropertyChange, getListOfTreeNodeChangeListeners, getRoot, getTreeNodeChangeListenerCount, getUserObject, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeUserObject, userObjectKeySet
private static final long serialVersionUID
private java.lang.String compartment
private java.lang.Boolean constant
private java.lang.Integer initialLevel
private java.lang.Integer maxLevel
public QualitativeSpecies()
public QualitativeSpecies(java.lang.String id)
id
- public QualitativeSpecies(int level, int version)
level
- version
- public QualitativeSpecies(java.lang.String id, int level, int version)
id
- level
- version
- public QualitativeSpecies(java.lang.String id, java.lang.String name, int level, int version)
id
- level
- version
- public QualitativeSpecies(Species species)
species
that are also available in
QualitativeSpecies
.
You should consider setting a new id and meta_id afterwards to avoid duplicate identifiers.
species
- public QualitativeSpecies(QualitativeSpecies qualSpecies)
qualSpecies
.qualSpecies
- public void initDefaults()
public QualitativeSpecies clone()
SBase
SBase
with the same properties
like this one.clone
in interface SBase
clone
in class AbstractSBase
public boolean isIdMandatory()
NamedSBase
NamedSBase
is required to be defined (i.e., not null
)
in the definition of SBML.isIdMandatory
in interface NamedSBase
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.public boolean isCompartmentMandatory()
public boolean isSetCompartment()
public java.lang.String getCompartment()
public void setCompartment(java.lang.String compartment)
compartment
- the compartment to setpublic void setCompartment(Compartment compartment)
Species
to the id of
'compartment'.compartment
- public boolean unsetCompartment()
true
if the unset of the compartment attribute was successfulpublic boolean isBoundaryConditionMandatory()
public boolean isSetConstantMandatory()
public boolean isSetConstant()
public boolean getConstant()
public void setConstant(boolean constant)
constant
- the constant to setpublic boolean unsetConstant()
true
if the unset of the constant attribute was successfulpublic boolean isInitialLevelMandatory()
public boolean isSetInitialLevel()
public int getInitialLevel()
public void setInitialLevel(int initialLevel)
initialLevel
- the initialLevel to setpublic boolean unsetInitialLevel()
true
if unset initialLevel attribute was successfulpublic boolean isMaxLevelMandatory()
public boolean isSetMaxLevel()
public int getMaxLevel()
public void setMaxLevel(int maxLevel)
maxLevel
- the maxLevel to setpublic boolean unsetMaxLevel()
true
if unset maxLevel attribute was successfulpublic boolean equals(java.lang.Object object)
SBase
true
if and only if the given SBase
has exactly the same
properties like this SBase
instance.equals
in interface SBase
equals
in class AbstractNamedSBase
true
if and only if the given Object
is an instance of
SBase
that has exactly the same properties like this
SBase instance.public int hashCode()
hashCode
in interface SBase
hashCode
in class AbstractNamedSBase
Object.hashCode()
public boolean readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value)
SBase
readAttribute
in interface SBase
readAttribute
in class AbstractNamedSBase
attributeName
- localName of the XML attributeprefix
- prefix of the XML attributevalue
- value of the XML attributetrue
if the attribute has been successfully read.public java.util.Map<java.lang.String,java.lang.String> writeXMLAttributes()
writeXMLAttributes
in interface SBase
writeXMLAttributes
in class AbstractNamedSBase
Map
containing the XML attributes of this object.