org.sbml.jsbml.ext.spatial

Class CoordinateComponent

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.ext.spatial.AbstractSpatialNamedSBase

org.sbml.jsbml.ext.spatial.CoordinateComponent

All Implemented Interfaces:

Serializable, Cloneable, TreeNode, SpatialNamedSBase, SBase, SBaseWithDerivedUnit, SBaseWithUnit, TreeNodeWithChangeSupport

public class CoordinateComponent
extends AbstractSpatialNamedSBase
implements SBaseWithUnit

Since:

1.0

Author:

Alex Thomas, Andreas Dräger, Piero Dalle Pezze

See Also:

Serialized Form

Field Summary

Fields inherited from class org.sbml.jsbml.AbstractSBase

ignoredExtensions, ignoredXMLElements, JSBML_WRONG_SBO_TERM, packageName

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, resourceBundle

Constructor Summary

Constructors

Constructor and Description
CoordinateComponent() Creates a new CoordinateComponent instance.
CoordinateComponent(CoordinateComponent coordComp) Creates a new CoordinateComponent instance copied from the given CoordinateComponent.
CoordinateComponent(int level, int version) Creates a new CoordinateComponent instance.
CoordinateComponent(String id, int level, int version) Creates a new CoordinateComponent instance.

Method Summary

Modifier and Type	Method and Description
CoordinateComponent	clone()
boolean	containsUndeclaredUnits()
boolean	equals(Object object)
Boundary	getBoundaryMaximum() Returns the value of boundaryMaximum
Boundary	getBoundaryMinimum() Returns the value of boundaryMinimum
TreeNode	getChildAt(int childIndex)
int	getChildCount()
UnitDefinition	getDerivedUnitDefinition()
String	getDerivedUnits()
CoordinateKind	getType() Returns the value of type
String	getUnits() Returns the value of unit
UnitDefinition	getUnitsInstance()
int	hashCode()
boolean	isSetBoundaryMaximum() Returns whether boundaryMaximum is set
boolean	isSetBoundaryMinimum() Returns whether boundaryMinimum is set
boolean	isSetType() Returns whether type is set
boolean	isSetUnits() Returns whether unit is set
boolean	isSetUnitsInstance()
boolean	readAttribute(String attributeName, String prefix, String value)
void	setBoundaryMaximum(Boundary boundaryMaximum) Sets the value of boundaryMaximum
void	setBoundaryMinimum(Boundary boundaryMinimum) Sets the value of boundaryMinimum
void	setType(CoordinateKind type) Sets the value of type
void	setUnits(String unit) Sets the value of unit
void	setUnits(Unit.Kind unitKind)
void	setUnits(Unit unit)
void	setUnits(UnitDefinition units)
boolean	unsetBoundaryMaximum() Unsets the variable boundaryMaximum
boolean	unsetBoundaryMinimum() Unsets the variable boundaryMinimum
boolean	unsetType() Unsets the variable type
void	unsetUnits() Unsets the variable unit
Map<String,String>	writeXMLAttributes()

Methods inherited from class org.sbml.jsbml.ext.spatial.AbstractSpatialNamedSBase

getAllowsChildren, getSpatialId, initDefaults, isSetSpatialId, setSpatialId, unsetSpatialId

Methods inherited from class org.sbml.jsbml.AbstractSBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendAnnotation, appendAnnotation, appendNotes, appendNotes, checkAndSetPackageNamespaceAndVersion, checkAndSetPackageNamespaceAndVersion, checkAttribute, checkLevelAndVersionCompatibility, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getId, getIdManager, getLevel, getLevelAndVersion, getMetaId, getModel, getName, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isIdMandatory, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetId, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetName, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, notifyChildChange, registerChild, removeCVTerm, removeCVTerm, setAnnotation, setAnnotation, setAnnotation, setHistory, setId, setLevel, setMetaId, setName, setNamespace, setNotes, setNotes, setPackageVersion, setParentSBML, setParentSBMLObject, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, toString, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetId, unsetMetaId, unsetName, unsetNamespace, unsetNotes, unsetPlugin, unsetSBOTerm

Methods inherited from class org.sbml.jsbml.AbstractTreeNode

addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, children, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, getIndex, getListOfTreeNodeChangeListeners, getNumChildren, getRoot, getTreeNodeChangeListenerCount, getUserObject, indexOf, isLeaf, isReadingInProgress, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, userObjectKeySet

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.sbml.jsbml.SBase

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, getId, getLevel, getLevelAndVersion, getMetaId, getModel, getName, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isIdMandatory, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetId, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetName, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, registerChild, removeCVTerm, removeCVTerm, removeTreeNodeChangeListener, setAnnotation, setAnnotation, setAnnotation, setHistory, setId, setLevel, setMetaId, setName, setNotes, setNotes, setPackageVersion, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetId, unsetMetaId, unsetName, unsetNotes, unsetPlugin, unsetSBOTerm

Methods inherited from interface org.sbml.jsbml.util.TreeNodeWithChangeSupport

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

Methods inherited from interface javax.swing.tree.TreeNode

children, getAllowsChildren, getIndex, getParent, isLeaf

Constructor Detail

CoordinateComponent

public CoordinateComponent()

Creates a new CoordinateComponent instance.

CoordinateComponent

public CoordinateComponent(CoordinateComponent coordComp)

Creates a new CoordinateComponent instance copied from the given CoordinateComponent.

Parameters:

coordComp - the CoordinateComponent to clone or copy

CoordinateComponent

public CoordinateComponent(int level,
                           int version)

Creates a new CoordinateComponent instance.

Parameters:

level - the SBML level

version - the SBML version

CoordinateComponent

public CoordinateComponent(String id,
                           int level,
                           int version)

Creates a new CoordinateComponent instance.

Parameters:

id - the element id

level - the SBML level

version - the SBML version

Method Detail

clone

public CoordinateComponent clone()

Specified by:

clone in interface SBase

Specified by:

clone in class AbstractSpatialNamedSBase

getBoundaryMinimum

public Boundary getBoundaryMinimum()

Returns the value of boundaryMinimum

Returns:

the value of boundaryMinimum

isSetBoundaryMinimum

public boolean isSetBoundaryMinimum()

Returns whether boundaryMinimum is set

Returns:

whether boundaryMinimum is set

setBoundaryMinimum

public void setBoundaryMinimum(Boundary boundaryMinimum)

Sets the value of boundaryMinimum

Parameters:

boundaryMinimum - the minimum boundary

unsetBoundaryMinimum

public boolean unsetBoundaryMinimum()

Unsets the variable boundaryMinimum

Returns:

true, if boundaryMinimum was set before, otherwise false

getBoundaryMaximum

public Boundary getBoundaryMaximum()

Returns the value of boundaryMaximum

Returns:

the value of boundaryMaximum

isSetBoundaryMaximum

public boolean isSetBoundaryMaximum()

Returns whether boundaryMaximum is set

Returns:

whether boundaryMaximum is set

setBoundaryMaximum

public void setBoundaryMaximum(Boundary boundaryMaximum)

Sets the value of boundaryMaximum

Parameters:

boundaryMaximum - the maximum boundary

unsetBoundaryMaximum

public boolean unsetBoundaryMaximum()

Unsets the variable boundaryMaximum

Returns:

true, if boundaryMaximum was set before, otherwise false

getType

public CoordinateKind getType()

Returns the value of type

Returns:

the value of type

isSetType

public boolean isSetType()

Returns whether type is set

Returns:

whether type is set

setType

public void setType(CoordinateKind type)

Sets the value of type

Parameters:

type - the type

unsetType

public boolean unsetType()

Unsets the variable type

Returns:

true, if type was set before, otherwise false

containsUndeclaredUnits

public boolean containsUndeclaredUnits()

Specified by:

containsUndeclaredUnits in interface SBaseWithDerivedUnit

equals

public boolean equals(Object object)

Specified by:

equals in interface SBase

Overrides:

equals in class AbstractSpatialNamedSBase

getChildAt

public TreeNode getChildAt(int childIndex)

Specified by:

getChildAt in interface TreeNode

Overrides:

getChildAt in class AbstractSpatialNamedSBase

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface TreeNode

Overrides:

getChildCount in class AbstractSpatialNamedSBase

getUnits

public String getUnits()

Returns the value of unit

Specified by:

getUnits in interface SBaseWithUnit

Returns:

the value of unit

isSetUnits

public boolean isSetUnits()

Returns whether unit is set

Specified by:

isSetUnits in interface SBaseWithUnit

Returns:

whether unit is set

setUnits

public void setUnits(String unit)

Sets the value of unit

Specified by:

setUnits in interface SBaseWithUnit

unsetUnits

public void unsetUnits()

Unsets the variable unit

Specified by:

unsetUnits in interface SBaseWithUnit

getDerivedUnitDefinition

public UnitDefinition getDerivedUnitDefinition()

Specified by:

getDerivedUnitDefinition in interface SBaseWithDerivedUnit

getDerivedUnits

public String getDerivedUnits()

Specified by:

getDerivedUnits in interface SBaseWithDerivedUnit

getUnitsInstance

public UnitDefinition getUnitsInstance()

Specified by:

getUnitsInstance in interface SBaseWithUnit

hashCode

public int hashCode()

Specified by:

hashCode in interface SBase

Overrides:

hashCode in class AbstractSpatialNamedSBase

isSetUnitsInstance

public boolean isSetUnitsInstance()

Specified by:

isSetUnitsInstance in interface SBaseWithUnit

setUnits

public void setUnits(Unit.Kind unitKind)

Specified by:

setUnits in interface SBaseWithUnit

setUnits

public void setUnits(Unit unit)

Specified by:

setUnits in interface SBaseWithUnit

setUnits

public void setUnits(UnitDefinition units)

Specified by:

setUnits in interface SBaseWithUnit

writeXMLAttributes

public Map<String,String> writeXMLAttributes()

Specified by:

writeXMLAttributes in interface SBase

Overrides:

writeXMLAttributes in class AbstractSpatialNamedSBase

readAttribute

public boolean readAttribute(String attributeName,
                             String prefix,
                             String value)

Specified by:

readAttribute in interface SBase

Overrides:

readAttribute in class AbstractSpatialNamedSBase