org.sbml.jsbml.ext.spatial
public class CoordinateComponent extends AbstractSpatialNamedSBase implements SBaseWithUnit
Modifier and Type | Field and Description |
---|---|
private static java.util.ResourceBundle |
bundle |
private java.lang.String |
componentType |
private java.lang.Integer |
coordinateIndex |
private Boundary |
maximum |
private Boundary |
minimum |
private static long |
serialVersionUID
Generated serial version identifier.
|
private java.lang.String |
unit |
spatialId
ignoredExtensions, ignoredXMLElements
listOfListeners, parent, UNKNOWN_ATTRIBUTES, UNKNOWN_ELEMENTS
Constructor and Description |
---|
CoordinateComponent() |
CoordinateComponent(CoordinateComponent coordComp) |
CoordinateComponent(int level,
int version) |
CoordinateComponent(java.lang.String id,
int level,
int version) |
Modifier and Type | Method and Description |
---|---|
CoordinateComponent |
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)
|
javax.swing.tree.TreeNode |
getChildAt(int childIndex) |
int |
getChildCount() |
java.lang.String |
getComponentType()
Returns the value of componentType
|
int |
getCoordinateIndex()
Returns the value of coordinateIndex
|
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.
|
Boundary |
getMaximum()
Returns the value of maximum
|
Boundary |
getMinimum()
Returns the value of minimum
|
java.lang.String |
getUnits()
Returns the value of unit
|
UnitDefinition |
getUnitsInstance() |
int |
hashCode() |
boolean |
isSetComponentType()
Returns whether componentType is set
|
boolean |
isSetCoordinateIndex()
Returns whether coordinateIndex is set
|
boolean |
isSetMaximum()
Returns whether maximum is set
|
boolean |
isSetMinimum()
Returns whether minimum is set
|
boolean |
isSetUnits()
Returns whether unit is set
|
boolean |
isSetUnitsInstance()
Checks whether the element referenced by the
unitsID
attribute of this SBaseWithUnit is either an existing base
Unit , i.e., a simple Unit that can directly be addressed
via its Unit.Kind element, or the identifier of an existing
UnitDefinition in the Model to which this
SBaseWithUnit belongs. |
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 |
setComponentType(java.lang.String componentType)
Sets the value of componentType
|
void |
setCoordinateIndex(int coordinateIndex)
Sets the value of coordinateIndex
|
void |
setMaximum(Boundary maximum)
Sets the value of maximum
|
void |
setMinimum(Boundary minimum)
Sets the value of minimum
|
void |
setUnits(java.lang.String unit)
Sets the value of unit
|
void |
setUnits(Unit.Kind unitKind)
Sets the unit of this
SBaseWithUnit . |
void |
setUnits(Unit unit)
Sets the
Unit of this SBaseWithUnit . |
void |
setUnits(UnitDefinition units)
Set the unit attribute of this
SBaseWithUnit to the given
unit definition. |
java.lang.String |
toString() |
boolean |
unsetComponentType()
Unsets the variable componentType
|
boolean |
unsetCoordinateIndex()
Unsets the variable coordinateIndex
|
boolean |
unsetMaximum()
Unsets the variable maximum
|
boolean |
unsetMinimum()
Unsets the variable minimum
|
void |
unsetUnits()
Unsets the variable unit
|
java.util.Map<java.lang.String,java.lang.String> |
writeXMLAttributes() |
getAllowsChildren, getSpatialId, isSetSpatialId, setSpatialId, unsetSpatialId
addCVTerm, addDeclaredNamespace, addExtension, appendNotes, appendNotes, checkLevelAndVersionCompatibility, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, getAnnotation, getAnnotationString, 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
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 componentType
private java.lang.Integer coordinateIndex
private Boundary maximum
private Boundary minimum
private java.lang.String unit
private static final java.util.ResourceBundle bundle
public CoordinateComponent()
public CoordinateComponent(CoordinateComponent coordComp)
coordComp
- public CoordinateComponent(int level, int version)
level
- version
- public CoordinateComponent(java.lang.String id, int level, int version)
id
- level
- version
- public CoordinateComponent clone()
SBase
SBase
with the same properties
like this one.clone
in interface SBase
clone
in class AbstractSBase
public Boundary getMinimum()
public boolean isSetMinimum()
public void setMinimum(Boundary minimum)
public boolean unsetMinimum()
true
, if minimum was set before,
otherwise false
public Boundary getMaximum()
public boolean isSetMaximum()
public void setMaximum(Boundary maximum)
public boolean unsetMaximum()
true
, if maximum was set before,
otherwise false
public int getCoordinateIndex()
public boolean isSetCoordinateIndex()
public void setCoordinateIndex(int coordinateIndex)
public boolean unsetCoordinateIndex()
true
, if coordinateIndex was set before,
otherwise false
public java.lang.String getComponentType()
public boolean isSetComponentType()
public void setComponentType(java.lang.String componentType)
public boolean unsetComponentType()
true
, if componentType was set before,
otherwise false
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 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 AbstractSpatialNamedSBase
true
if and only if the given Object
is an instance of
SBase
that has exactly the same properties like this
SBase instance.public javax.swing.tree.TreeNode getChildAt(int childIndex)
getChildAt
in interface javax.swing.tree.TreeNode
getChildAt
in class AbstractSpatialNamedSBase
public int getChildCount()
getChildCount
in interface javax.swing.tree.TreeNode
getChildCount
in class AbstractSpatialNamedSBase
public java.lang.String getUnits()
getUnits
in interface SBaseWithUnit
public boolean isSetUnits()
isSetUnits
in interface SBaseWithUnit
public void setUnits(java.lang.String unit)
setUnits
in interface SBaseWithUnit
unit
- the identifier of an already existing UnitDefinition
or an Unit.Kind
identifier for the current
level/version combination of this unit. Passing a null value
to this method is equivalent to calling SBaseWithUnit.unsetUnits()
.public void unsetUnits()
unsetUnits
in interface SBaseWithUnit
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
public UnitDefinition getUnitsInstance()
getUnitsInstance
in interface SBaseWithUnit
#unitsID
of
this SBaseWithUnit
as id. Null if it doesn't
exist. In case that the unit of this SBaseWithUnit
represents a base Unit
, a new UnitDefinition
will
be created and returned by this method. This new
UnitDefinition
will only contain the one unit represented
by the unit identifier in this SBaseWithUnit
. Note
that the corresponding model will not contain this
UnitDefinition
. The identifier of this new
UnitDefinition
will be set to the same value as the name
of the base Unit
.public int hashCode()
hashCode
in interface SBase
hashCode
in class AbstractSpatialNamedSBase
Object.hashCode()
public boolean isSetUnitsInstance()
SBaseWithUnit
unitsID
attribute of this SBaseWithUnit
is either an existing base
Unit
, i.e., a simple Unit
that can directly be addressed
via its Unit.Kind
element, or the identifier of an existing
UnitDefinition
in the Model
to which this
SBaseWithUnit
belongs.isSetUnitsInstance
in interface SBaseWithUnit
true
if either a UnitDefinition
, which has the
unitsID
of this SBaseWithUnit
, can be
found in the Model
to which this
SBaseWithUnit
belongs, or if this element's
unitsID
as a corresponding base Unit
for the
given Level/Version combination.public void setUnits(Unit.Kind unitKind)
SBaseWithUnit
SBaseWithUnit
.
A new unit will be created base on this kind.setUnits
in interface SBaseWithUnit
public void setUnits(Unit unit)
SBaseWithUnit
Unit
of this SBaseWithUnit
.setUnits
in interface SBaseWithUnit
public void setUnits(UnitDefinition units)
SBaseWithUnit
SBaseWithUnit
to the given
unit definition.setUnits
in interface SBaseWithUnit
public java.util.Map<java.lang.String,java.lang.String> writeXMLAttributes()
writeXMLAttributes
in interface SBase
writeXMLAttributes
in class AbstractSpatialNamedSBase
Map
containing the XML attributes of this object.public boolean readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value)
SBase
readAttribute
in interface SBase
readAttribute
in class AbstractSpatialNamedSBase
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.lang.String toString()
toString
in class AbstractSpatialNamedSBase