org.sbml.jsbml.ext.spatial

Class AnalyticVolume

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.AbstractMathContainer

org.sbml.jsbml.ext.spatial.AnalyticVolume

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, javax.swing.tree.TreeNode, SpatialNamedSBase, MathContainer, SBase, SBaseWithDerivedUnit, TreeNodeWithChangeSupport

public class AnalyticVolume
extends AbstractMathContainer
implements SpatialNamedSBase

Since:

1.0

Version:

$Rev: 1980 $

Author:

Alex Thomas, Andreas Dräger

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnalyticVolume.FunctionKind

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.ResourceBundle	bundle
private java.lang.String	domainType
private AnalyticVolume.FunctionKind	functionType
private java.lang.Integer	ordinal
private static long	serialVersionUID Generated serial version identifier.
(package private) java.lang.String	spatialId

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
AnalyticVolume()
AnalyticVolume(AnalyticVolume node)
AnalyticVolume(java.lang.String id, int level, int version)

Method Summary

Methods

Modifier and Type	Method and Description
AnalyticVolume	clone() Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.
boolean	equals(java.lang.Object object) Returns true if and only if the given SBase has exactly the same properties like this SBase instance.
java.lang.String	getDomainType() Returns the value of domainType
AnalyticVolume.FunctionKind	getFunctionType() Returns the value of functionType
java.lang.Integer	getOrdinal() Returns the value of ordinal
java.lang.String	getSpatialId() Returns the value of spatialId
int	hashCode() Returns a hash code value for this SBase instance.
boolean	isSetDomainType() Returns whether domainType is set
boolean	isSetFunctionType() Returns whether functionType is set
boolean	isSetOrdinal() Returns whether ordinal is set
boolean	isSetSpatialId() Returns whether spatialId is set
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value) Sets the given attribute in this SBase.
void	setDomainType(java.lang.String domainType) Sets the value of domainType
void	setFunctionType(AnalyticVolume.FunctionKind functionType) Sets the value of functionType
void	setOrdinal(int ordinal) Sets the value of ordinal
void	setSpatialId(java.lang.String spatialId) Sets the value of spatialId
java.lang.String	toString()
boolean	unsetDomainType() Unsets the variable domainType
boolean	unsetFunctionType() Unsets the variable functionType
boolean	unsetOrdinal() Unsets the variable ordinal
boolean	unsetSpatialId() Unsets the variable spatialId
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.

Methods inherited from class org.sbml.jsbml.AbstractMathContainer

containsUndeclaredUnits, getAllowsChildren, getChildAt, getChildCount, getDerivedUnitDefinition, getDerivedUnits, getFormula, getMath, getMathMLString, isSetMath, setFormula, setMath, unsetFormula, unsetMath

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, getAllowsChildren, getChildAt, getChildCount, getIndex, getParent, isLeaf

Field Detail

spatialId

java.lang.String spatialId

domainType

private java.lang.String domainType

functionType

private AnalyticVolume.FunctionKind functionType

ordinal

private java.lang.Integer ordinal

serialVersionUID

private static final long serialVersionUID

Generated serial version identifier.

See Also:

Constant Field Values

bundle

private static final java.util.ResourceBundle bundle

Constructor Detail

AnalyticVolume

public AnalyticVolume()

AnalyticVolume

public AnalyticVolume(AnalyticVolume node)

Parameters:

node -

AnalyticVolume

public AnalyticVolume(java.lang.String id,
              int level,
              int version)

Method Detail

clone

public AnalyticVolume clone()

Description copied from interface: SBase

Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.

Specified by:

clone in interface SBase

Specified by:

clone in class AbstractMathContainer

Returns:

a copy of this object

equals

public boolean equals(java.lang.Object object)

Description copied from interface: SBase

Returns true if and only if the given SBase has exactly the same properties like this SBase instance.

Specified by:

equals in interface SBase

Overrides:

equals in class AbstractSBase

Parameters:

object - the SBase to be compared to.

Returns:

true if and only if the given Object is an instance of SBase that has exactly the same properties like this SBase instance.

getFunctionType

public AnalyticVolume.FunctionKind getFunctionType()

Returns the value of functionType

Returns:

the value of functionType

isSetFunctionType

public boolean isSetFunctionType()

Returns whether functionType is set

Returns:

whether functionType is set

setFunctionType

public void setFunctionType(AnalyticVolume.FunctionKind functionType)

Sets the value of functionType

unsetFunctionType

public boolean unsetFunctionType()

Unsets the variable functionType

Returns:

true, if functionType was set before, otherwise false

getDomainType

public java.lang.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(java.lang.String domainType)

Sets the value of domainType

unsetDomainType

public boolean unsetDomainType()

Unsets the variable domainType

Returns:

true, if domainType was set before, otherwise false

getOrdinal

public java.lang.Integer getOrdinal()

Returns the value of ordinal

Returns:

the value of ordinal

isSetOrdinal

public boolean isSetOrdinal()

Returns whether ordinal is set

Returns:

whether ordinal is set

setOrdinal

public void setOrdinal(int ordinal)

Sets the value of ordinal

unsetOrdinal

public boolean unsetOrdinal()

Unsets the variable ordinal

Returns:

true, if ordinal was set before, otherwise false

unsetSpatialId

public boolean unsetSpatialId()

Description copied from interface: SpatialNamedSBase

Unsets the variable spatialId

Specified by:

unsetSpatialId in interface SpatialNamedSBase

Returns:

true, if spatialId was set before, otherwise false

setSpatialId

public void setSpatialId(java.lang.String spatialId)

Description copied from interface: SpatialNamedSBase

Sets the value of spatialId

Specified by:

setSpatialId in interface SpatialNamedSBase

isSetSpatialId

public boolean isSetSpatialId()

Description copied from interface: SpatialNamedSBase

Returns whether spatialId is set

Specified by:

isSetSpatialId in interface SpatialNamedSBase

Returns:

whether spatialId is set

getSpatialId

public java.lang.String getSpatialId()

Description copied from interface: SpatialNamedSBase

Returns the value of spatialId

Specified by:

getSpatialId in interface SpatialNamedSBase

Returns:

the value of spatialId

hashCode

public int hashCode()

Description copied from interface: SBase

Returns a hash code value for this SBase instance.

Specified by:

hashCode in interface SBase

Overrides:

hashCode in class AbstractSBase

Returns:

a hash code value for this SBase instance.

See Also:

Object.hashCode()

writeXMLAttributes

public java.util.Map<java.lang.String,java.lang.String> writeXMLAttributes()

Description copied from interface: SBase

Returns a map with all the attributes of this 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.

Specified by:

writeXMLAttributes in interface SBase

Overrides:

writeXMLAttributes in class AbstractMathContainer

Returns:

a Map containing the XML attributes of this object.

readAttribute

public boolean readAttribute(java.lang.String attributeName,
                    java.lang.String prefix,
                    java.lang.String value)

Description copied from interface: SBase

Sets the given attribute in this SBase.

If the given attribute name is not recognized, nothing is done and false is returned.

Specified by:

readAttribute in interface SBase

Overrides:

readAttribute in class AbstractMathContainer

Parameters:

attributeName - localName of the XML attribute

prefix - prefix of the XML attribute

value - value of the XML attribute

Returns:

true if the attribute has been successfully read.

toString

public java.lang.String toString()

Overrides:

toString in class AbstractMathContainer