org.sbml.jsbml.ext.spatial

Class Domain

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.ext.spatial.AbstractSpatialNamedSBase

org.sbml.jsbml.ext.spatial.Domain

All Implemented Interfaces:

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

public class Domain
extends AbstractSpatialNamedSBase

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 static java.util.ResourceBundle	bundle
private java.lang.String	domainType
private ListOf<InteriorPoint>	listOfInteriorPoints
private static long	serialVersionUID Generated serial version identifier.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addInteriorPoint(InteriorPoint interiorPoint) Adds a new InteriorPoint to the listOfInteriorPoints.
Domain	clone() Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.
InteriorPoint	createInteriorPoint() Creates a new InteriorPoint element and adds it to the ListOfInteriorPoints list
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	getDomainType() Returns the value of domainType
ListOf<InteriorPoint>	getListOfInteriorPoints() Returns the listOfInteriorPoints.
int	hashCode() Returns a hash code value for this SBase instance.
boolean	isSetDomainType() Returns whether domainType is set
boolean	isSetListOfInteriorPoints() Returns true, if listOfInteriorPoints contains at least one element.
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value) Sets the given attribute in this SBase.
void	removeInteriorPoint(int i) Removes an element from the listOfInteriorPoints at the given index.
boolean	removeInteriorPoint(InteriorPoint interiorPoint) Removes an element from the listOfInteriorPoints.
void	setDomainType(java.lang.String domainType) Sets the value of domainType
void	setListOfInteriorPoints(ListOf<InteriorPoint> listOfInteriorPoints) Sets the given ListOf<InteriorPoint>.
java.lang.String	toString()
boolean	unsetDomainType() Unsets the variable domainType
boolean	unsetListOfInteriorPoints() Returns true, if listOfInteriorPoints contain at least one element, otherwise false
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.AbstractSpatialNamedSBase

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

Field Detail

serialVersionUID

private static final long serialVersionUID

Generated serial version identifier.

See Also:

Constant Field Values

domainType

private java.lang.String domainType

listOfInteriorPoints

private ListOf<InteriorPoint> listOfInteriorPoints

bundle

private static final java.util.ResourceBundle bundle

Constructor Detail

Domain

public Domain()

Domain

public Domain(int level,
      int version)

Parameters:

level -

version -

Domain

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

Domain

public Domain(Domain dm)

Parameters:

sb -

Method Detail

clone

public Domain 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 AbstractSBase

Returns:

a copy of this object

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

isSetListOfInteriorPoints

public boolean isSetListOfInteriorPoints()

Returns true, if listOfInteriorPoints contains at least one element.

Returns:

true, if listOfInteriorPoints contains at least one element, otherwise false

getListOfInteriorPoints

public ListOf<InteriorPoint> getListOfInteriorPoints()

Returns the listOfInteriorPoints. Creates it if it is not already existing.

Returns:

the listOfInteriorPoints

setListOfInteriorPoints

public void setListOfInteriorPoints(ListOf<InteriorPoint> listOfInteriorPoints)

Sets the given ListOf<InteriorPoint>. If listOfInteriorPoints was defined before and contains some elements, they are all unset.

Parameters:

listOfInteriorPoints -

unsetListOfInteriorPoints

public boolean unsetListOfInteriorPoints()

Returns true, if listOfInteriorPoints contain at least one element, otherwise false

Returns:

true, if listOfInteriorPoints contain at least one element, otherwise false

addInteriorPoint

public boolean addInteriorPoint(InteriorPoint interiorPoint)

Adds a new InteriorPoint to the listOfInteriorPoints.

The listOfInteriorPoints is initialized if necessary.

Parameters:

interiorPoint - the element to add to the list

Returns:

true (as specified by Collection.add)

removeInteriorPoint

public boolean removeInteriorPoint(InteriorPoint interiorPoint)

Removes an element from the listOfInteriorPoints.

Parameters:

interiorPoint - the element to be removed from the list

Returns:

true if the list contained the specified element

See Also:

List#remove(Object)

removeInteriorPoint

public void removeInteriorPoint(int i)

Removes an element from the listOfInteriorPoints at the given index.

Parameters:

i - the index where to remove the InteriorPoint

Throws:

java.lang.IndexOutOfBoundsException - if the listOf is not set or if the index is out of bound (index < 0 || index > list.size)

createInteriorPoint

public InteriorPoint createInteriorPoint()

Creates a new InteriorPoint element and adds it to the ListOfInteriorPoints list

Returns:

a new InteriorPoint element

getAllowsChildren

public boolean getAllowsChildren()

Specified by:

getAllowsChildren in interface javax.swing.tree.TreeNode

Overrides:

getAllowsChildren in class AbstractSpatialNamedSBase

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface javax.swing.tree.TreeNode

Overrides:

getChildCount in class AbstractSpatialNamedSBase

getChildAt

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

Specified by:

getChildAt in interface javax.swing.tree.TreeNode

Overrides:

getChildAt in class AbstractSpatialNamedSBase

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 AbstractSpatialNamedSBase

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 AbstractSpatialNamedSBase

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 AbstractSpatialNamedSBase

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 AbstractSpatialNamedSBase

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 AbstractSpatialNamedSBase

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.