org.sbml.jsbml.ext.qual
public class Input extends AbstractNamedSBase implements UniqueNamedSBase, CallableSBase
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
qualitativeSpecies |
private static long |
serialVersionUID
Generated serial version identifier.
|
private Sign |
sign |
private java.lang.Integer |
thresholdLevel |
private InputTransitionEffect |
transitionEffect |
ignoredExtensions, ignoredXMLElements
listOfListeners, parent, UNKNOWN_ATTRIBUTES, UNKNOWN_ELEMENTS
Constructor and Description |
---|
Input() |
Input(Input in) |
Input(int level,
int version) |
Input(java.lang.String id) |
Input(java.lang.String id,
int level,
int version) |
Input(java.lang.String id,
QualitativeSpecies qualitativeSpecies,
InputTransitionEffect transitionEffect) |
Input(java.lang.String id,
java.lang.String name,
int level,
int version) |
Modifier and Type | Method and Description |
---|---|
AbstractSBase |
clone()
Creates a deep copy of this object, i.e., a new
SBase with the same properties
like this one. |
boolean |
containsUndeclaredUnits()
Returns
true or false depending on whether this
SBaseWithDerivedUnit refers to elements such as parameters or
numbers with undeclared units. |
boolean |
equals(java.lang.Object object)
|
UnitDefinition |
getDerivedUnitDefinition()
This method derives the unit of this quantity and tries to identify an
equivalent
UnitDefinition within the corresponding Model . |
java.lang.String |
getDerivedUnits()
This method derives the unit of this quantity.
|
java.lang.String |
getQualitativeSpecies() |
Sign |
getSign() |
int |
getThresholdLevel() |
InputTransitionEffect |
getTransitionEffect() |
int |
hashCode() |
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 |
isQualitativeSpeciesMandatory() |
boolean |
isSetQualitativeSpecies() |
boolean |
isSetSign() |
boolean |
isSetThresholdLevel() |
boolean |
isSetTransitionEffect() |
boolean |
isThresholdLevelMandatory() |
boolean |
isTransitionEffectMandatory() |
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 |
setQualitativeSpecies(java.lang.String qualitativeSpecies) |
void |
setSign(Sign sign) |
void |
setThresholdLevel(int thresholdLevel) |
void |
setTransitionEffect(InputTransitionEffect transitionEffect) |
boolean |
unsetQualitativeSpecies() |
boolean |
unsetSign() |
boolean |
unsetThresholdLevel() |
boolean |
unsetTransitionEffect() |
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 qualitativeSpecies
private InputTransitionEffect transitionEffect
private java.lang.Integer thresholdLevel
private Sign sign
public Input()
public Input(java.lang.String id)
id
- public Input(java.lang.String id, QualitativeSpecies qualitativeSpecies, InputTransitionEffect transitionEffect)
id
- qualitativeSpecies
- transitionEffect
- public Input(int level, int version)
level
- version
- public Input(java.lang.String id, int level, int version)
id
- level
- version
- public Input(java.lang.String id, java.lang.String name, int level, int version)
id
- name
- level
- version
- public Input(Input in)
public void initDefaults()
public AbstractSBase clone()
SBase
SBase
with the same properties
like this one.clone
in interface SBase
clone
in class AbstractSBase
public void setSign(Sign sign)
sign
- the sign to setpublic boolean isSetSign()
public Sign getSign()
public boolean unsetSign()
true
if unset the sign attribute was successfulpublic 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 isQualitativeSpeciesMandatory()
public boolean isSetQualitativeSpecies()
public java.lang.String getQualitativeSpecies()
public void setQualitativeSpecies(java.lang.String qualitativeSpecies)
qualitativeSpecies
- the qualitativeSpecies to setpublic boolean unsetQualitativeSpecies()
public boolean isTransitionEffectMandatory()
public boolean isSetTransitionEffect()
public InputTransitionEffect getTransitionEffect()
public void setTransitionEffect(InputTransitionEffect transitionEffect)
transitionEffect
- the transitionEffect to setpublic boolean unsetTransitionEffect()
public boolean isThresholdLevelMandatory()
public boolean isSetThresholdLevel()
public int getThresholdLevel()
public void setThresholdLevel(int thresholdLevel)
thresholdLevel
- the thresholdLevel to setpublic boolean unsetThresholdLevel()
true
if unset the threholdLevel 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.public boolean containsUndeclaredUnits()
SBaseWithDerivedUnit
true
or false
depending on whether this
SBaseWithDerivedUnit
refers to elements such as parameters or
numbers with undeclared units.
A return value of true indicates that the UnitDefinition
returned by SBaseWithDerivedUnit.getDerivedUnitDefinition()
may not accurately
represent the units of the expression.containsUndeclaredUnits
in interface SBaseWithDerivedUnit
true
if the math expression of this SBaseWithDerivedUnit
includes parameters/numbers with undeclared units,
false
otherwise.public UnitDefinition getDerivedUnitDefinition()
SBaseWithDerivedUnit
UnitDefinition
within the corresponding Model
.
If no equivalent unit definition can be found, a new unit definition will
be created that is not part of the model but represents the unit of this
quantity. If it is not possible to derive a unit for this quantity, null
will be returned.getDerivedUnitDefinition
in interface SBaseWithDerivedUnit
public java.lang.String getDerivedUnits()
SBaseWithDerivedUnit
Unit.Kind
this
method will return the String
representation of this
Unit.Kind
.getDerivedUnits
in interface SBaseWithDerivedUnit