org.sbml.jsbml.ext.spatial

Class ParametricGeometry

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.ParametricGeometry

All Implemented Interfaces:

Serializable, Cloneable, TreeNode, SpatialNamedSBase, SBase, TreeNodeWithChangeSupport

public class ParametricGeometry
extends GeometryDefinition

Since:

1.0

Version:

$Rev$

Author:

Alex Thomas, Andreas Dräger

See Also:

Serialized Form

Field Summary

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
ParametricGeometry()
ParametricGeometry(int level, int version)
ParametricGeometry(ParametricGeometry pg)
ParametricGeometry(String id, int level, int version)

Method Summary

Modifier and Type	Method and Description
boolean	addParametricObject(ParametricObject parametricObject) Adds a new ParametricObject to the listOfParametricObjects.
boolean	addSpatialPoint(SpatialPoint spatialPoint) Adds a new SpatialPoint to the listOfSpatialPoints.
ParametricGeometry	clone()
ParametricObject	createParametricObject() Creates a new ParametricObject element and adds it to the ListOfParametricObjects list
ParametricObject	createParametricObject(String id) Creates a new ParametricObject element and adds it to the ListOfParametricObjects list
SpatialPoint	createSpatialPoint() Creates a new SpatialPoint element and adds it to the ListOfSpatialPoints list
SpatialPoint	createSpatialPoint(String id) Creates a new SpatialPoint element and adds it to the ListOfSpatialPoints list
boolean	equals(Object object)
boolean	getAllowsChildren()
TreeNode	getChildAt(int index)
int	getChildCount()
ListOf<ParametricObject>	getListOfParametricObjects() Returns the listOfParametricObjects.
ListOf<SpatialPoint>	getListOfSpatialPoints() Returns the listOfSpatialPoints.
boolean	isSetListOfParametricObjects() Returns true, if listOfParametricObjects contains at least one element.
boolean	isSetListOfSpatialPoints() Returns true, if listOfSpatialPoints contains at least one element.
void	removeParametricObject(int i) Removes an element from the listOfParametricObjects at the given index.
boolean	removeParametricObject(ParametricObject parametricObject) Removes an element from the listOfParametricObjects.
void	removeSpatialPoint(int i) Removes an element from the listOfSpatialPoints at the given index.
boolean	removeSpatialPoint(SpatialPoint spatialPoint) Removes an element from the listOfSpatialPoints.
void	setListOfParametricObjects(ListOf<ParametricObject> listOfParametricObjects) Sets the given ListOf<ParametricObject>.
void	setListOfSpatialPoints(ListOf<SpatialPoint> listOfSpatialPoints) Sets the given ListOf<SpatialPoint>.
boolean	unsetListOfParametricObjects() Returns true, if listOfParametricObjects contain at least one element, otherwise false
boolean	unsetListOfSpatialPoints() Returns true, if listOfSpatialPoints 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

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

Constructor Detail

ParametricGeometry

public ParametricGeometry()

ParametricGeometry

public ParametricGeometry(ParametricGeometry pg)

Parameters:

pg -

ParametricGeometry

public ParametricGeometry(int level,
                          int version)

Parameters:

level -

version -

ParametricGeometry

public ParametricGeometry(String id,
                          int level,
                          int version)

Parameters:

id -

level -

version -

Method Detail

clone

public ParametricGeometry clone()

Specified by:

clone in interface SBase

Overrides:

clone in class AbstractSBase

equals

public boolean equals(Object object)

Specified by:

equals in interface SBase

Overrides:

equals in class GeometryDefinition

isSetListOfParametricObjects

public boolean isSetListOfParametricObjects()

Returns true, if listOfParametricObjects contains at least one element.

Returns:

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

getListOfParametricObjects

public ListOf<ParametricObject> getListOfParametricObjects()

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

Returns:

the listOfParametricObjects

setListOfParametricObjects

public void setListOfParametricObjects(ListOf<ParametricObject> listOfParametricObjects)

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

Parameters:

listOfParametricObjects -

unsetListOfParametricObjects

public boolean unsetListOfParametricObjects()

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

Returns:

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

addParametricObject

public boolean addParametricObject(ParametricObject parametricObject)

Adds a new ParametricObject to the listOfParametricObjects.

The listOfParametricObjects is initialized if necessary.

Parameters:

parametricObject - the element to add to the list

Returns:

true (as specified by Collection#add)

removeParametricObject

public boolean removeParametricObject(ParametricObject parametricObject)

Removes an element from the listOfParametricObjects.

Parameters:

parametricObject - the element to be removed from the list

Returns:

true if the list contained the specified element

See Also:

List#remove(Object)

removeParametricObject

public void removeParametricObject(int i)

Removes an element from the listOfParametricObjects at the given index.

Parameters:

i - the index where to remove the ParametricObject

Throws:

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

createParametricObject

public ParametricObject createParametricObject()

Creates a new ParametricObject element and adds it to the ListOfParametricObjects list

createParametricObject

public ParametricObject createParametricObject(String id)

Creates a new ParametricObject element and adds it to the ListOfParametricObjects list

Returns:

a new ParametricObject element

isSetListOfSpatialPoints

public boolean isSetListOfSpatialPoints()

Returns true, if listOfSpatialPoints contains at least one element.

Returns:

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

getListOfSpatialPoints

public ListOf<SpatialPoint> getListOfSpatialPoints()

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

Returns:

the listOfSpatialPoints

setListOfSpatialPoints

public void setListOfSpatialPoints(ListOf<SpatialPoint> listOfSpatialPoints)

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

Parameters:

listOfSpatialPoints -

unsetListOfSpatialPoints

public boolean unsetListOfSpatialPoints()

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

Returns:

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

addSpatialPoint

public boolean addSpatialPoint(SpatialPoint spatialPoint)

Adds a new SpatialPoint to the listOfSpatialPoints.

The listOfSpatialPoints is initialized if necessary.

Parameters:

spatialPoint - the element to add to the list

Returns:

true (as specified by Collection#add)

removeSpatialPoint

public boolean removeSpatialPoint(SpatialPoint spatialPoint)

Removes an element from the listOfSpatialPoints.

Parameters:

spatialPoint - the element to be removed from the list

Returns:

true if the list contained the specified element

See Also:

List#remove(Object)

removeSpatialPoint

public void removeSpatialPoint(int i)

Removes an element from the listOfSpatialPoints at the given index.

Parameters:

i - the index where to remove the SpatialPoint

Throws:

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

createSpatialPoint

public SpatialPoint createSpatialPoint()

Creates a new SpatialPoint element and adds it to the ListOfSpatialPoints list

createSpatialPoint

public SpatialPoint createSpatialPoint(String id)

Creates a new SpatialPoint element and adds it to the ListOfSpatialPoints list

Returns:

a new SpatialPoint element

getAllowsChildren

public boolean getAllowsChildren()

Specified by:

getAllowsChildren in interface TreeNode

Overrides:

getAllowsChildren in class AbstractSpatialNamedSBase

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface TreeNode

Overrides:

getChildCount in class AbstractSpatialNamedSBase

getChildAt

public TreeNode getChildAt(int index)

Specified by:

getChildAt in interface TreeNode

Overrides:

getChildAt in class AbstractSpatialNamedSBase