org.sbml.jsbml.ext.spatial

Class CompartmentMapping

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.ext.spatial.AbstractSpatialNamedSBase

org.sbml.jsbml.ext.spatial.CompartmentMapping

All Implemented Interfaces:

Serializable, Cloneable, TreeNode, SpatialNamedSBase, SBase, TreeNodeWithChangeSupport

public class CompartmentMapping
extends AbstractSpatialNamedSBase

Since:

1.0

Version:

$Rev$

Author:

Alex Thomas, Andreas Dräger

See Also:

Serialized Form

Field Summary

Fields inherited from class org.sbml.jsbml.AbstractSBase

ignoredExtensions, ignoredXMLElements

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, UNKNOWN_ATTRIBUTES, UNKNOWN_ELEMENTS

Constructor Summary

Constructors

Constructor and Description
CompartmentMapping()
CompartmentMapping(CompartmentMapping cm)
CompartmentMapping(int level, int version)
CompartmentMapping(String id, int level, int version)

Method Summary

Modifier and Type	Method and Description
CompartmentMapping	clone()
boolean	equals(Object object)
String	getCompartment() Returns the value of compartment
Compartment	getCompartmentInstance()
String	getDomainType() Returns the value of domainType
DomainType	getDomainTypeInstance()
double	getUnitSize() Returns the value of unitSize
int	hashCode()
boolean	isSetCompartment() Returns whether compartment is set
boolean	isSetDomainType() Returns whether domainType is set
boolean	isSetUnitSize() Returns whether unitSize is set
boolean	readAttribute(String attributeName, String prefix, String value)
void	setCompartment(String compartment) Sets the value of compartment
void	setDomainType(String domainType) Sets the value of domainType
void	setUnitSize(double unitSize) Sets the value of unitSize
String	toString()
boolean	unsetCompartment() Unsets the variable compartment
boolean	unsetDomainType() Unsets the variable domainType
boolean	unsetUnitSize() Unsets the variable unitSize
Map<String,String>	writeXMLAttributes()

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

getAllowsChildren, getChildAt, getChildCount, getSpatialId, isSetSpatialId, setSpatialId, unsetSpatialId

Methods inherited from class org.sbml.jsbml.AbstractSBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendNotes, appendNotes, checkLevelAndVersionCompatibility, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getIdManager, 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, removeCVTerm, removeCVTerm, setAnnotation, setHistory, setLevel, setMetaId, setNamespace, setNotes, setNotes, setParentSBML, setParentSBMLObject, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, 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, 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, appendNotes, appendNotes, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementName, getExtension, getExtensionCount, 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, removeCVTerm, removeCVTerm, removeTreeNodeChangeListener, setAnnotation, setHistory, setLevel, setMetaId, setNotes, setNotes, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, 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, getIndex, getParent, isLeaf

Constructor Detail

CompartmentMapping

public CompartmentMapping()

CompartmentMapping

public CompartmentMapping(CompartmentMapping cm)

Parameters:

cm -

CompartmentMapping

public CompartmentMapping(int level,
                          int version)

Parameters:

level -

version -

CompartmentMapping

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

Parameters:

id -

level -

version -

Method Detail

clone

public CompartmentMapping clone()

Specified by:

clone in interface SBase

Overrides:

clone in class AbstractSBase

equals

public boolean equals(Object object)

Specified by:

equals in interface SBase

Overrides:

equals in class AbstractSpatialNamedSBase

getCompartment

public String getCompartment()

Returns the value of compartment

Returns:

the value of compartment

isSetCompartment

public boolean isSetCompartment()

Returns whether compartment is set

Returns:

whether compartment is set

setCompartment

public void setCompartment(String compartment)

Sets the value of compartment

unsetCompartment

public boolean unsetCompartment()

Unsets the variable compartment

Returns:

true, if compartment was set before, otherwise false

getDomainType

public String getDomainType()

Returns the value of domainType

Returns:

the value of domainType

isSetDomainType

public boolean isSetDomainType()

Returns whether domainType is set

Returns:

whether domainType is set

setDomainType

public void setDomainType(String domainType)

Sets the value of domainType

unsetDomainType

public boolean unsetDomainType()

Unsets the variable domainType

Returns:

true, if domainType was set before, otherwise false

getUnitSize

public double getUnitSize()

Returns the value of unitSize

Returns:

the value of unitSize

isSetUnitSize

public boolean isSetUnitSize()

Returns whether unitSize is set

Returns:

whether unitSize is set

setUnitSize

public void setUnitSize(double unitSize)

Sets the value of unitSize

unsetUnitSize

public boolean unsetUnitSize()

Unsets the variable unitSize

Returns:

true, if unitSize was set before, otherwise false

getCompartmentInstance

public Compartment getCompartmentInstance()

Returns:

get compartment instance of Compartment class

getDomainTypeInstance

public DomainType getDomainTypeInstance()

Returns:

the domainType instance of the DomainType class

hashCode

public int hashCode()

Specified by:

hashCode in interface SBase

Overrides:

hashCode in class AbstractSpatialNamedSBase

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

toString

public String toString()

Overrides:

toString in class AbstractSpatialNamedSBase