java.io.Serializable
, java.lang.Cloneable
, javax.swing.tree.TreeNode
, SpatialNamedSBase
, NamedSBase
, SBase
, TreeNodeWithChangeSupport
public class SampledFieldGeometry extends GeometryDefinition
JSBML_WRONG_SBO_TERM
Constructor | Description |
---|---|
SampledFieldGeometry() |
Creates a new
SampledFieldGeometry instance. |
SampledFieldGeometry(java.lang.String id,
int level,
int version) |
Creates a new
SampledFieldGeometry instance. |
SampledFieldGeometry(SampledFieldGeometry sampledFieldGeometry) |
Creates a new
SampledFieldGeometry instance cloned from the given sampledFieldGeometry. |
Modifier and Type | Method | Description |
---|---|---|
boolean |
addSampledVolume(SampledVolume sampledVolume) |
Adds a new
SampledVolume to the listOfSampledVolumes. |
SampledFieldGeometry |
clone() |
Creates a deep copy of this object, i.e., a new
SBase with the same
properties
like this one. |
SampledVolume |
createSampledVolume() |
Creates a new
SampledVolume instance and adds it to the ListOfSampledVolumes list |
SampledVolume |
createSampledVolume(java.lang.String id) |
Creates a new
SampledVolume instance and adds it to the ListOfSampledVolumes list |
boolean |
equals(java.lang.Object object) |
|
boolean |
getAllowsChildren() |
|
javax.swing.tree.TreeNode |
getChildAt(int index) |
|
int |
getChildCount() |
|
ListOf<SampledVolume> |
getListOfSampledVolumes() |
Returns the listOfSampledVolumes.
|
java.lang.String |
getSampledField() |
Returns the value of sampledField
|
int |
hashCode() |
Returns a hash code value for this
SBase instance. |
boolean |
isSetListOfSampledVolumes() |
Returns
true , if listOfSampledVolumes contains at least one element. |
boolean |
isSetSampledField() |
Returns whether sampledField is set
|
boolean |
readAttribute(java.lang.String attributeName,
java.lang.String prefix,
java.lang.String value) |
Sets the given attribute in this
SBase . |
void |
removeSampledVolume(int i) |
Removes an element from the listOfSampledVolumes at the given index.
|
void |
removeSampledVolume(java.lang.String id) |
Removes an element from the listOfSampledVolumes with the given id.
|
boolean |
removeSampledVolume(SampledVolume sampledVolume) |
Removes an element from the listOfSampledVolumes.
|
void |
setListOfSampledVolumes(ListOf<SampledVolume> listOfSampledVolumes) |
Sets the given
ListOf<SampledVolume> . |
void |
setSampledField(java.lang.String sampledField) |
Sets the value of sampledField
|
boolean |
unsetListOfSampledVolumes() |
Returns
true , if listOfSampledVolumes contain at least one element,
otherwise false |
boolean |
unsetSampledField() |
Unsets the variable sampledField
|
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. |
addCVTerm, addDeclaredNamespace, addExtension, addPlugin, addResources, appendAnnotation, appendAnnotation, appendNotes, appendNotes, 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, getLevel, getLevelAndVersion, getMetaId, getModel, getName, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, 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, registerChild, removeCVTerm, removeCVTerm, removeDeclaredNamespaceByNamespace, removeDeclaredNamespaceByPrefix, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setAnnotation, setHistory, setId, setLevel, setMetaId, setName, setNamespace, setNotes, setNotes, setPackageVersion, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, toString, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetId, unsetMetaId, unsetName, unsetNamespace, unsetNotes, unsetPlugin, unsetSBOTerm
getSpatialId, initDefaults, isSetSpatialId, setSpatialId, unsetSpatialId
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
getIsActive, isActive, isSetIsActive, setIsActive, unsetIsActive
getId, getName, isIdMandatory, isSetId, isSetName, setId, setName, unsetId, unsetName
addCVTerm, 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, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasExtension, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, 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
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
public SampledFieldGeometry()
SampledFieldGeometry
instance.public SampledFieldGeometry(SampledFieldGeometry sampledFieldGeometry)
SampledFieldGeometry
instance cloned from the given sampledFieldGeometry.sampledFieldGeometry
- the SampledFieldGeometry
to clone.public SampledFieldGeometry(java.lang.String id, int level, int version)
SampledFieldGeometry
instance.id
- the element idlevel
- the SBML levelversion
- the SBML versionpublic SampledFieldGeometry clone()
SBase
SBase
with the same
properties
like this one.clone
in interface SBase
clone
in class AbstractSpatialNamedSBase
public boolean equals(java.lang.Object object)
SBase
public java.lang.String getSampledField()
public boolean isSetSampledField()
public void setSampledField(java.lang.String sampledField)
sampledField
- the sampledField value to setpublic boolean unsetSampledField()
true
, if sampledField was set before,
otherwise false
public boolean isSetListOfSampledVolumes()
true
, if listOfSampledVolumes contains at least one element.true
, if listOfSampledVolumes contains at least one element,
otherwise false
public ListOf<SampledVolume> getListOfSampledVolumes()
public void setListOfSampledVolumes(ListOf<SampledVolume> listOfSampledVolumes)
ListOf<SampledVolume>
. If listOfSampledVolumes
was defined before and contains some elements, they are all unset.listOfSampledVolumes
- the list of SampledVolume
to set.public boolean unsetListOfSampledVolumes()
true
, if listOfSampledVolumes contain at least one element,
otherwise false
true
, if listOfSampledVolumes contain at least one element,
otherwise false
public boolean addSampledVolume(SampledVolume sampledVolume)
SampledVolume
to the listOfSampledVolumes.
The listOfSampledVolumes is initialized if necessary.
sampledVolume
- the element to add to the listCollection.add(E)
)public boolean removeSampledVolume(SampledVolume sampledVolume)
sampledVolume
- the element to be removed from the listList.remove(Object)
public void removeSampledVolume(int i)
i
- the index where to remove the SampledVolume
java.lang.IndexOutOfBoundsException
- if the listOf is not set or
if the index is out of bound (index < 0 || index > list.size).public void removeSampledVolume(java.lang.String id)
id
- the id of the element to remove.public SampledVolume createSampledVolume()
SampledVolume
instance and adds it to the ListOfSampledVolumes listSampledVolume
instancepublic SampledVolume createSampledVolume(java.lang.String id)
SampledVolume
instance and adds it to the ListOfSampledVolumes listid
- the id to set in the new SampledVolume instanceSampledVolume
instancepublic boolean getAllowsChildren()
getAllowsChildren
in interface javax.swing.tree.TreeNode
getAllowsChildren
in class AbstractSpatialNamedSBase
public int getChildCount()
getChildCount
in interface javax.swing.tree.TreeNode
getChildCount
in class AbstractSpatialNamedSBase
public javax.swing.tree.TreeNode getChildAt(int index)
getChildAt
in interface javax.swing.tree.TreeNode
getChildAt
in class AbstractSpatialNamedSBase
public int hashCode()
SBase
SBase
instance.hashCode
in interface SBase
hashCode
in class GeometryDefinition
SBase
instance.Object.hashCode()
public java.util.Map<java.lang.String,java.lang.String> writeXMLAttributes()
SBase
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.
writeXMLAttributes
in interface SBase
writeXMLAttributes
in class GeometryDefinition
Map
containing the XML attributes of this object.public boolean readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value)
SBase
SBase
.
If the given attribute name is not recognized, nothing is done and
false
is returned.
readAttribute
in interface SBase
readAttribute
in class GeometryDefinition
attributeName
- localName of the XML attributeprefix
- prefix of the XML attributevalue
- value of the XML attributetrue
if the attribute has been successfully read.