Package org.sbml.jsbml.ext.spatial

Class DiffusionCoefficient

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.ext.spatial.ParameterType

org.sbml.jsbml.ext.spatial.DiffusionCoefficient

All Implemented Interfaces:

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

public class DiffusionCoefficient
extends ParameterType

Since:

1.0

Author:

Alex Thomas, Andreas Dräger

See Also:

Serialized Form

Field Summary

Fields inherited from class org.sbml.jsbml.AbstractSBase

JSBML_WRONG_SBO_TERM

Constructor Summary

Constructors

Constructor	Description
DiffusionCoefficient()
DiffusionCoefficient(int level, int version)
DiffusionCoefficient(java.lang.String id, int level, int version)
DiffusionCoefficient(DiffusionCoefficient diffCoeff)

Method Summary

Modifier and Type	Method	Description
DiffusionCoefficient	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.
CoordinateKind	getCoordinateReference1()	Returns the value of coordinateReference1
CoordinateKind	getCoordinateReference2()	Returns the value of coordinateReference2
DiffusionKind	getType()	Returns the value of diffusionKind
int	hashCode()	Returns a hash code value for this SBase instance.
boolean	isSetCoordinateReference1()	Returns whether coordinateReference1 is set
boolean	isSetCoordinateReference2()	Returns whether coordinateReference2 is set
boolean	isSetType()	Returns whether diffusionKind is set
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value)	Sets the given attribute in this SBase.
void	setCoordinateReference1(CoordinateKind coordinateReference1)	Sets the value of coordinateReference1
void	setCoordinateReference2(CoordinateKind coordinateReference2)	Sets the value of coordinateReference2
void	setType(DiffusionKind diffusionKind)	Sets the value of diffusionKind
boolean	unsetCoordinateReference1()	Unsets the variable coordinateReference1
boolean	unsetCoordinateReference2()	Unsets the variable coordinateReference2
boolean	unsetType()	Unsets the variable diffusionKind
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.AbstractSBase

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

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

getClass, notify, notifyAll, wait, wait, wait

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

getAllowsChildren, getChildAt, getChildCount, getGeometryInstance, getParameterInstance, getSpatialRef, getSpeciesInstance, getSpeciesReference, getSpId, getVariable, getVariableInstance, initDefaults, isSetSpatialRef, isSetSpeciesReference, isSetSpId, isSetVariable, setSpatialRef, setSpeciesRef, setSpeciesReference, setSpId, setVariable, unsetSpatialRef, unsetVariable

Methods inherited from interface org.sbml.jsbml.SBase

removeTreeNodeChangeListener

Methods inherited from interface javax.swing.tree.TreeNode

children, getIndex, isLeaf

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

addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, getListOfTreeNodeChangeListeners, getRoot, getTreeNodeChangeListenerCount, getUserObject, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeUserObject, userObjectKeySet

Constructor Detail

DiffusionCoefficient

public DiffusionCoefficient()

DiffusionCoefficient

public DiffusionCoefficient(DiffusionCoefficient diffCoeff)

Parameters:

diffCoeff -

DiffusionCoefficient

public DiffusionCoefficient(int level,
                            int version)

Parameters:

level -

version -

DiffusionCoefficient

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

Parameters:

id -

level -

version -

Method Detail

clone

public DiffusionCoefficient 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

Overrides:

clone in class ParameterType

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 ParameterType

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.

getCoordinateReference1

public CoordinateKind getCoordinateReference1()

Returns the value of coordinateReference1

Returns:

the value of coordinateReference1

isSetCoordinateReference1

public boolean isSetCoordinateReference1()

Returns whether coordinateReference1 is set

Returns:

whether coordinateReference1 is set

setCoordinateReference1

public void setCoordinateReference1(CoordinateKind coordinateReference1)

Sets the value of coordinateReference1

Parameters:

coordinateReference1 -

unsetCoordinateReference1

public boolean unsetCoordinateReference1()

Unsets the variable coordinateReference1

Returns:

true, if coordinateReference1 was set before, otherwise false

getCoordinateReference2

public CoordinateKind getCoordinateReference2()

Returns the value of coordinateReference2

Returns:

the value of coordinateReference2

isSetCoordinateReference2

public boolean isSetCoordinateReference2()

Returns whether coordinateReference2 is set

Returns:

whether coordinateReference2 is set

setCoordinateReference2

public void setCoordinateReference2(CoordinateKind coordinateReference2)

Sets the value of coordinateReference2

Parameters:

coordinateReference2 -

unsetCoordinateReference2

public boolean unsetCoordinateReference2()

Unsets the variable coordinateReference2

Returns:

true, if coordinateReference2 was set before, otherwise false

getType

public DiffusionKind getType()

Returns the value of diffusionKind

Returns:

the value of diffusionKind

isSetType

public boolean isSetType()

Returns whether diffusionKind is set

Returns:

whether diffusionKind is set

setType

public void setType(DiffusionKind diffusionKind)

Sets the value of diffusionKind

Parameters:

diffusionKind -

unsetType

public boolean unsetType()

Unsets the variable diffusionKind

Returns:

true, if diffusionKind was set before, otherwise false

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 ParameterType

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 ParameterType

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 ParameterType

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.