java.lang.Cloneable
, NamedSBase
, SBase
, java.io.Serializable
, javax.swing.tree.TreeNode
, TreeNodeWithChangeSupport
BindingSiteSpeciesType
, CompartmentGlyph
, CompartmentReference
, IntraSpeciesReaction
, MultiSpeciesType
, QualitativeSpecies
, Reaction
, Species
public interface CompartmentalizedSBase extends NamedSBase
Modifier and Type | Method | Description |
---|---|---|
java.lang.String |
getCompartment() |
Returns the value of the referenced compartment.
|
NamedSBase |
getCompartmentInstance() |
Returns the
Compartment that is referenced by this SBase . |
boolean |
isCompartmentMandatory() |
|
boolean |
isSetCompartment() |
|
boolean |
isSetCompartmentInstance() |
|
boolean |
setCompartment(java.lang.String compartmentId) |
Sets the compartment attribute.
|
boolean |
setCompartment(Compartment compartment) |
Sets the compartment identifiers of this
CompartmentalizedSBase to
the id of the Compartment 'compartment'. |
boolean |
unsetCompartment() |
Remove the reference to a compartment, i.e., unset the value of the
variable 'compartment'.
|
getId, getName, isIdMandatory, isSetId, isSetName, setId, setName, unsetId, unsetName
addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendAnnotation, appendAnnotation, appendNotes, appendNotes, clone, createPlugin, disablePackage, enablePackage, enablePackage, equals, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasExtension, hashCode, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, readAttribute, registerChild, removeCVTerm, removeCVTerm, removeDeclaredNamespaceByNamespace, removeDeclaredNamespaceByPrefix, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTreeNodeChangeListener, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setAnnotation, setHistory, setLevel, setMetaId, setNotes, setNotes, setPackageVersion, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, unsetNotes, unsetPlugin, unsetSBOTerm, writeXMLAttributes
children, getAllowsChildren, getChildAt, getChildCount, getIndex, getParent, isLeaf
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
java.lang.String getCompartment()
String
if it is not set.NamedSBase getCompartmentInstance()
Compartment
that is referenced by this SBase
.
Note that the return type of this method is NamedSBase
because it
could be possible that some subclasses link other elements than
Compartment
.Model
that represents the linked
Compartment
or null
if it does not exist or cannot
be retrieved (e.g., if this component has not yet been linked to a
Model
).boolean isCompartmentMandatory()
true
if for this object the compartment attribute is
mandatory, false
otherwise.boolean isSetCompartment()
true
if compartment attribute is set, i.e., not
null
, false
otherwise.boolean isSetCompartmentInstance()
true
if the Compartment
which has the compartment
identifier stored in this CompartmentalizedSBase
as id is
not null
and this Compartment
can be retrieved from
the Model
that contains this CompartmentalizedSBase
.
In other words, this method also returns false
if the
this object is not linked to any model.boolean setCompartment(Compartment compartment)
CompartmentalizedSBase
to
the id of the Compartment
'compartment'.
The compartment attribute is used to add a reference to the id of
the corresponding Compartment
in the Model
.
In some situations, the compartment might be optional, so that the user can
even specify Compartment
s that are not part of the Model
.
compartment
- the Compartment
whose identifier should be referenced.true
if this operation caused any change.setCompartment(String)
,
isCompartmentMandatory()
boolean setCompartment(java.lang.String compartmentId)
The required attribute compartment is used to identify the
Compartment
in which the CompartmentalizedSBase
is located.
The attribute's value should be the identifier of an existing
Compartment
object in the model.
compartmentId
- the identifier of the compartment to be set.true
if this operation caused any change.setCompartment(Compartment)
,
isCompartmentMandatory()
boolean unsetCompartment()
true
if compartment was set before, otherwise false
.