org.sbml.jsbml.ext.spatial

Class AbstractSpatialNamedSBase

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.ext.spatial.AbstractSpatialNamedSBase

All Implemented Interfaces:

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

Direct Known Subclasses:

AdjacentDomains, Boundary, CompartmentMapping, CoordinateComponent, CSGNode, CSGObject, Domain, DomainType, Geometry, GeometryDefinition, ParametricObject, SampledField, SampledVolume, SpatialPoint

public abstract class AbstractSpatialNamedSBase
extends AbstractSBase
implements SpatialNamedSBase

Since:

1.0

Version:

$Rev: 1724 $

Author:

Alex Thomas, Andreas Dräger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.ResourceBundle	bundle
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
AbstractSpatialNamedSBase()
AbstractSpatialNamedSBase(int level, int version)
AbstractSpatialNamedSBase(SpatialNamedSBase nse)
AbstractSpatialNamedSBase(java.lang.String spatialId)
AbstractSpatialNamedSBase(java.lang.String spatialId, int level, int version)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object object) Returns true if and only if the given SBase has exactly the same properties like this SBase instance.
boolean	getAllowsChildren()
javax.swing.tree.TreeNode	getChildAt(int index)
int	getChildCount()
java.lang.String	getSpatialId() Returns the value of spatialId
int	hashCode() Returns a hash code value for this SBase instance.
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	setSpatialId(java.lang.String spatialId) Sets the value of spatialId
java.lang.String	toString()
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.AbstractSBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendNotes, appendNotes, checkLevelAndVersionCompatibility, clone, 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, clone, 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

Field Detail

serialVersionUID

private static final long serialVersionUID

Generated serial version identifier.

See Also:

Constant Field Values

spatialId

java.lang.String spatialId

bundle

private static final java.util.ResourceBundle bundle

Constructor Detail

AbstractSpatialNamedSBase

public AbstractSpatialNamedSBase()

AbstractSpatialNamedSBase

public AbstractSpatialNamedSBase(int level,
                         int version)

Parameters:

level -

version -

AbstractSpatialNamedSBase

public AbstractSpatialNamedSBase(SpatialNamedSBase nse)

Parameters:

nse -

AbstractSpatialNamedSBase

public AbstractSpatialNamedSBase(java.lang.String spatialId,
                         int level,
                         int version)

Parameters:

spatialId -

level -

version -

AbstractSpatialNamedSBase

public AbstractSpatialNamedSBase(java.lang.String spatialId)

Parameters:

spatialId -

Method Detail

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.

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()

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

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

setSpatialId

public void setSpatialId(java.lang.String spatialId)

Description copied from interface: SpatialNamedSBase

Sets the value of spatialId

Specified by:

setSpatialId in interface SpatialNamedSBase

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

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 AbstractSBase

Returns:

a Map containing the XML attributes of this object.

toString

public java.lang.String toString()

Specified by:

toString in class AbstractSBase

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 AbstractSBase

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.

getAllowsChildren

public boolean getAllowsChildren()

Specified by:

getAllowsChildren in interface javax.swing.tree.TreeNode

Overrides:

getAllowsChildren in class AbstractSBase

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface javax.swing.tree.TreeNode

Overrides:

getChildCount in class AbstractSBase

getChildAt

public javax.swing.tree.TreeNode getChildAt(int index)

Specified by:

getChildAt in interface javax.swing.tree.TreeNode

Overrides:

getChildAt in class AbstractSBase