org.sbml.jsbml.ext.spatial

Class AdvectionCoefficient

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.ext.spatial.ParameterType

org.sbml.jsbml.ext.spatial.AdvectionCoefficient

All Implemented Interfaces:

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

public class AdvectionCoefficient
extends ParameterType

Since:

1.0

Version:

$Rev: 1980 $

Author:

Alex Thomas, Andreas Dräger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private CoordinateKind	coordinate
private static long	serialVersionUID Generated serial version identifier.

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

Method Summary

Methods

Modifier and Type	Method and Description
AdvectionCoefficient	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	getCoordinate() Returns the value of coordinate
int	hashCode() Returns a hash code value for this SBase instance.
boolean	isSetCoordinate() Returns whether coordinate is set
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value) Sets the given attribute in this SBase.
void	setCoordinate(CoordinateKind coordinate) Sets the value of coordinate
boolean	unsetCoordinate() Unsets the variable coordinate
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.ext.spatial.ParameterType

getAllowsChildren, getChildAt, getChildCount, getGeometryInstance, getSpeciesInstance, getSpeciesReference, getSpId, getVariable, getVariableInstance, isSetSpatialRef, isSetSpeciesReference, isSetSpId, isSetVariable, setSpeciesReference, setSpId, setVariable, toString

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

removeTreeNodeChangeListener

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

Methods inherited from interface javax.swing.tree.TreeNode

children, getIndex, isLeaf

Field Detail

serialVersionUID

private static final long serialVersionUID

Generated serial version identifier.

See Also:

Constant Field Values

coordinate

private CoordinateKind coordinate

Constructor Detail

AdvectionCoefficient

public AdvectionCoefficient()

AdvectionCoefficient

public AdvectionCoefficient(AdvectionCoefficient advCoeff)

Parameters:

node -

AdvectionCoefficient

public AdvectionCoefficient(int level,
                    int version)

Parameters:

level -

version -

AdvectionCoefficient

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

Parameters:

id -

level -

version -

Method Detail

clone

public AdvectionCoefficient 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.

getCoordinate

public CoordinateKind getCoordinate()

Returns the value of coordinate

Returns:

the value of coordinate

isSetCoordinate

public boolean isSetCoordinate()

Returns whether coordinate is set

Returns:

whether coordinate is set

setCoordinate

public void setCoordinate(CoordinateKind coordinate)

Sets the value of coordinate

unsetCoordinate

public boolean unsetCoordinate()

Unsets the variable coordinate

Returns:

true, if coordinate 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.