org.sbml.jsbml.ext.spatial

Class CSGeometry

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.ext.spatial.AbstractSpatialNamedSBase

org.sbml.jsbml.ext.spatial.GeometryDefinition

org.sbml.jsbml.ext.spatial.CSGeometry

All Implemented Interfaces:

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

public class CSGeometry
extends GeometryDefinition

Since:

1.0

Version:

$Rev: 1822 $

Author:

Alex Thomas, Andreas Dräger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private ListOf<CSGObject>	listOfCSGObjects
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
CSGeometry()
CSGeometry(CSGeometry csg)
CSGeometry(int level, int version)
CSGeometry(java.lang.String id, int level, int version)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addCSGObject(CSGObject csgo) Adds a new CSGObject to the listOfCSGObjects.
CSGeometry	clone() Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.
CSGObject	createCSGObject() Creates a new CSGObject element and adds it to the ListOfCSGObjects list
CSGObject	createCSGObject(java.lang.String id) Creates a new CSGObject element and adds it to the ListOfCSGObjects 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.
ListOf<CSGObject>	getListOfCSGObjects() Returns the listOfCSGObjects.
boolean	isSetListOfCSGObjects() Returns true, if listOfCSGObjects contains at least one element.
boolean	removeCSGObject(CSGObject csgo) Removes an element from the listOfCSGObjects.
void	removeCSGObject(int i) Removes an element from the listOfCSGObjects at the given index.
void	setListOfCSGObjects(ListOf<CSGObject> listOfCSGObjects) Sets the given ListOf<CSGObject>.
boolean	unsetListOfCSGObjects() Returns true, if listOfCSGObjects contain at least one element, otherwise false

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

getIsActive, hashCode, isActive, isSetIsActive, readAttribute, setIsActive, toString, unsetIsActive, writeXMLAttributes

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

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

listOfCSGObjects

private ListOf<CSGObject> listOfCSGObjects

Constructor Detail

CSGeometry

public CSGeometry()

CSGeometry

public CSGeometry(CSGeometry csg)

Parameters:

node -

CSGeometry

public CSGeometry(int level,
          int version)

Parameters:

level -

version -

CSGeometry

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

Parameters:

id -

level -

version -

Method Detail

clone

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

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 GeometryDefinition

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.

isSetListOfCSGObjects

public boolean isSetListOfCSGObjects()

Returns true, if listOfCSGObjects contains at least one element.

Returns:

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

getListOfCSGObjects

public ListOf<CSGObject> getListOfCSGObjects()

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

Returns:

the listOfCSGObjects

setListOfCSGObjects

public void setListOfCSGObjects(ListOf<CSGObject> listOfCSGObjects)

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

Parameters:

listOfCSGObjects -

unsetListOfCSGObjects

public boolean unsetListOfCSGObjects()

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

Returns:

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

addCSGObject

public boolean addCSGObject(CSGObject csgo)

Adds a new CSGObject to the listOfCSGObjects.

The listOfCSGObjects is initialized if necessary.

Parameters:

csgo - the element to add to the list

Returns:

true (as specified by Collection.add)

removeCSGObject

public boolean removeCSGObject(CSGObject csgo)

Removes an element from the listOfCSGObjects.

Parameters:

csgo - the element to be removed from the list

Returns:

true if the list contained the specified element

See Also:

List#remove(Object)

removeCSGObject

public void removeCSGObject(int i)

Removes an element from the listOfCSGObjects at the given index.

Parameters:

i - the index where to remove the CSGObject

Throws:

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

createCSGObject

public CSGObject createCSGObject()

Creates a new CSGObject element and adds it to the ListOfCSGObjects list

createCSGObject

public CSGObject createCSGObject(java.lang.String id)

Creates a new CSGObject element and adds it to the ListOfCSGObjects list

Returns:

a new CSGObject element