org.sbml.jsbml.ext.spatial

Class Geometry

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.ext.spatial.AbstractSpatialNamedSBase

org.sbml.jsbml.ext.spatial.Geometry

All Implemented Interfaces:

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

public class Geometry
extends AbstractSpatialNamedSBase

Since:

1.0

Version:

$Rev: 1980 $

Author:

Alex Thomas, Andreas Dräger

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Geometry.GeometryKind

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.ResourceBundle	bundle
private Geometry.GeometryKind	coordinateSystem
private ListOf<AdjacentDomains>	listOfAdjacentDomains
private ListOf<CoordinateComponent>	listOfCoordinateComponents
private ListOf<Domain>	listOfDomains
private ListOf<DomainType>	listOfDomainTypes
private ListOf<GeometryDefinition>	listOfGeometryDefinitions
private ListOf<SampledField>	listOfSampledFields
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
Geometry()
Geometry(Geometry sb)
Geometry(int level, int version)
Geometry(java.lang.String id, int level, int version)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addAdjacentDomain(AdjacentDomains adjacentDomains) Adds a new AdjacentDomain to the listOfAdjacentDomains.
boolean	addCoordinateComponent(CoordinateComponent coordinateComponents) Adds a new CoordinateComponent to the listOfCoordinateComponents.
boolean	addDomain(Domain domain) Adds a new Domain to the listOfDomains.
boolean	addDomainType(DomainType domainType) Adds a new DomainType to the listOfDomainTypes.
boolean	addGeometryDefinition(GeometryDefinition geometryDefinition) Adds a new GeometryDefinition to the listOfGeometryDefinitions.
boolean	addSampledField(SampledField sampledField) Adds a new SampledField to the listOfSampledFields.
Geometry	clone() Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.
AdjacentDomains	createAdjacentDomain() Creates a new AdjacentDomain element and adds it to the ListOfAdjacentDomains list
AdjacentDomains	createAdjacentDomain(java.lang.String id) Creates a new AdjacentDomain element and adds it to the ListOfAdjacentDomains list
AnalyticGeometry	createAnalyticGeometry()
AnalyticGeometry	createAnalyticGeometry(java.lang.String id)
CoordinateComponent	createCoordinateComponent() Creates a new CoordinateComponent element and adds it to the ListOfCoordinateComponents list
CoordinateComponent	createCoordinateComponent(java.lang.String id) Creates a new CoordinateComponent element and adds it to the ListOfCoordinateComponents list
CSGeometry	createCSGeometry()
CSGeometry	createCSGeometry(java.lang.String id)
Domain	createDomain() Creates a new Domain element and adds it to the ListOfDomains list
Domain	createDomain(java.lang.String id) Creates a new Domain element and adds it to the ListOfDomains list
DomainType	createDomainType() Creates a new DomainType element and adds it to the ListOfDomainTypes list
DomainType	createDomainType(java.lang.String id) Creates a new DomainType element and adds it to the ListOfDomainTypes list
MixedGeometry	createMixedGeometry()
MixedGeometry	createMixedGeometry(java.lang.String id) Creates a new GeometryDefinition element and adds it to the ListOfGeometryDefinitions list
ParametricGeometry	createParametricGeometry()
ParametricGeometry	createParametricGeometry(java.lang.String id)
SampledField	createSampledField() Creates a new SampledField element and adds it to the ListOfSampledFields list
SampledField	createSampledField(java.lang.String id) Creates a new SampledField element and adds it to the ListOfSampledFields list
SampledFieldGeometry	createSampledFieldGeometry(java.lang.String id) Creates a new GeometryDefinition element and adds it to the ListOfGeometryDefinitions list
SampledFieldGeometry	createSampledFieldGeometryn() Creates a new GeometryDefinition element and adds it to the ListOfGeometryDefinitions 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()
Geometry.GeometryKind	getCoordinateSystem() Returns the value of coordinateSystem
ListOf<AdjacentDomains>	getListOfAdjacentDomains() Returns the listOfAdjacentDomains.
ListOf<CoordinateComponent>	getListOfCoordinateComponents() Returns the listOfCoordinateComponents.
ListOf<Domain>	getListOfDomains() Returns the listOfDomains.
ListOf<DomainType>	getListOfDomainTypes() Returns the listOfDomainTypes.
ListOf<GeometryDefinition>	getListOfGeometryDefinitions() Returns the listOfGeometryDefinitions.
ListOf<SampledField>	getListOfSampledFields() Returns the listOfSampledFields.
int	hashCode() Returns a hash code value for this SBase instance.
boolean	isSetCoordinateSystem() Returns whether coordinateSystem is set
boolean	isSetListOfAdjacentDomains() Returns true, if listOfAdjacentDomains contains at least one element.
boolean	isSetListOfCoordinateComponents() Returns true, if listOfCoordinateComponents contains at least one element.
boolean	isSetListOfDomains() Returns true, if listOfDomains contains at least one element.
boolean	isSetListOfDomainTypes() Returns true, if listOfDomainTypes contains at least one element.
boolean	isSetListOfGeometryDefinitions() Returns true, if listOfGeometryDefinitions contains at least one element.
boolean	isSetListOfSampledFields() Returns true, if listOfSampledFields 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.
boolean	removeAdjacentDomain(AdjacentDomains adjacentDomains) Removes an element from the listOfAdjacentDomains.
void	removeAdjacentDomain(int i) Removes an element from the listOfAdjacentDomains at the given index.
void	removeAdjacentDomain(java.lang.String id)
boolean	removeCoordinateComponent(CoordinateComponent coordinateComponents) Removes an element from the listOfCoordinateComponents.
void	removeCoordinateComponent(int i) Removes an element from the listOfCoordinateComponents at the given index.
void	removeCoordinateComponent(java.lang.String id)
boolean	removeDomain(Domain domain) Removes an element from the listOfDomains.
void	removeDomain(int i) Removes an element from the listOfDomains at the given index.
void	removeDomain(java.lang.String id)
boolean	removeDomainType(DomainType domainType) Removes an element from the listOfDomainTypes.
void	removeDomainType(int i) Removes an element from the listOfDomainTypes at the given index.
void	removeDomainType(java.lang.String id)
boolean	removeGeometryDefinition(GeometryDefinition geometryDefinition) Removes an element from the listOfGeometryDefinitions.
void	removeGeometryDefinition(int i) Removes an element from the listOfGeometryDefinitions at the given index.
void	removeGeometryDefinition(java.lang.String id)
void	removeSampledField(int i) Removes an element from the listOfSampledFields at the given index.
boolean	removeSampledField(SampledField sampledField) Removes an element from the listOfSampledFields.
void	removeSampledField(java.lang.String id)
void	setCoordinateSystem(Geometry.GeometryKind coordinateSystem) Sets the value of coordinateSystem
void	setListOfAdjacentDomains(ListOf<AdjacentDomains> listOfAdjacentDomains) Sets the given ListOf<AdjacentDomain>.
void	setListOfCoordinateComponents(ListOf<CoordinateComponent> listOfCoordinateComponents) Sets the given ListOf<CoordinateComponent>.
void	setListOfDomains(ListOf<Domain> listOfDomains) Sets the given ListOf<Domain>.
void	setListOfDomainTypes(ListOf<DomainType> listOfDomainTypes) Sets the given ListOf<DomainType>.
void	setListOfGeometryDefinitions(ListOf<GeometryDefinition> listOfGeometryDefinitions) Sets the given ListOf<GeometryDefinition>.
void	setListOfSampledFields(ListOf<SampledField> listOfSampledFields) Sets the given ListOf<SampledField>.
java.lang.String	toString()
boolean	unsetCoordinateSystem() Unsets the variable coordinateSystem
boolean	unsetListOfAdjacentDomains() Returns true, if listOfAdjacentDomains contain at least one element, otherwise false
boolean	unsetListOfCoordinateComponents() Returns true, if listOfCoordinateComponents contain at least one element, otherwise false
boolean	unsetListOfDomains() Returns true, if listOfDomains contain at least one element, otherwise false
boolean	unsetListOfDomainTypes() Returns true, if listOfDomainTypes contain at least one element, otherwise false
boolean	unsetListOfGeometryDefinitions() Returns true, if listOfGeometryDefinitions contain at least one element, otherwise false
boolean	unsetListOfSampledFields() Returns true, if listOfSampledFields 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

listOfCoordinateComponents

private ListOf<CoordinateComponent> listOfCoordinateComponents

listOfDomainTypes

private ListOf<DomainType> listOfDomainTypes

listOfDomains

private ListOf<Domain> listOfDomains

listOfAdjacentDomains

private ListOf<AdjacentDomains> listOfAdjacentDomains

listOfGeometryDefinitions

private ListOf<GeometryDefinition> listOfGeometryDefinitions

listOfSampledFields

private ListOf<SampledField> listOfSampledFields

coordinateSystem

private Geometry.GeometryKind coordinateSystem

bundle

private static final java.util.ResourceBundle bundle

Constructor Detail

Geometry

public Geometry()

Geometry

public Geometry(Geometry sb)

Parameters:

sb -

Geometry

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

Geometry

public Geometry(int level,
        int version)

Parameters:

level -

version -

Method Detail

clone

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

getCoordinateSystem

public Geometry.GeometryKind getCoordinateSystem()

Returns the value of coordinateSystem

Returns:

the value of coordinateSystem

isSetCoordinateSystem

public boolean isSetCoordinateSystem()

Returns whether coordinateSystem is set

Returns:

whether coordinateSystem is set

setCoordinateSystem

public void setCoordinateSystem(Geometry.GeometryKind coordinateSystem)

Sets the value of coordinateSystem

unsetCoordinateSystem

public boolean unsetCoordinateSystem()

Unsets the variable coordinateSystem

Returns:

true, if coordinateSystem was set before, otherwise false

isSetListOfSampledFields

public boolean isSetListOfSampledFields()

Returns true, if listOfSampledFields contains at least one element.

Returns:

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

getListOfSampledFields

public ListOf<SampledField> getListOfSampledFields()

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

Returns:

the listOfSampledFields

setListOfSampledFields

public void setListOfSampledFields(ListOf<SampledField> listOfSampledFields)

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

Parameters:

listOfSampledFields -

unsetListOfSampledFields

public boolean unsetListOfSampledFields()

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

Returns:

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

addSampledField

public boolean addSampledField(SampledField sampledField)

Adds a new SampledField to the listOfSampledFields.

The listOfSampledFields is initialized if necessary.

Parameters:

sampledField - the element to add to the list

Returns:

true (as specified by Collection.add)

removeSampledField

public boolean removeSampledField(SampledField sampledField)

Removes an element from the listOfSampledFields.

Parameters:

sampledField - the element to be removed from the list

Returns:

true if the list contained the specified element

See Also:

List#remove(Object)

removeSampledField

public void removeSampledField(int i)

Removes an element from the listOfSampledFields at the given index.

Parameters:

i - the index where to remove the SampledField

Throws:

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

removeSampledField

public void removeSampledField(java.lang.String id)

createSampledField

public SampledField createSampledField()

Creates a new SampledField element and adds it to the ListOfSampledFields list

createSampledField

public SampledField createSampledField(java.lang.String id)

Creates a new SampledField element and adds it to the ListOfSampledFields list

Returns:

a new SampledField element

isSetListOfGeometryDefinitions

public boolean isSetListOfGeometryDefinitions()

Returns true, if listOfGeometryDefinitions contains at least one element.

Returns:

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

getListOfGeometryDefinitions

public ListOf<GeometryDefinition> getListOfGeometryDefinitions()

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

Returns:

the listOfGeometryDefinitions

setListOfGeometryDefinitions

public void setListOfGeometryDefinitions(ListOf<GeometryDefinition> listOfGeometryDefinitions)

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

Parameters:

listOfGeometryDefinitions -

unsetListOfGeometryDefinitions

public boolean unsetListOfGeometryDefinitions()

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

Returns:

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

addGeometryDefinition

public boolean addGeometryDefinition(GeometryDefinition geometryDefinition)

Adds a new GeometryDefinition to the listOfGeometryDefinitions.

The listOfGeometryDefinitions is initialized if necessary.

Parameters:

geometryDefinition - the element to add to the list

Returns:

true (as specified by Collection.add)

removeGeometryDefinition

public boolean removeGeometryDefinition(GeometryDefinition geometryDefinition)

Removes an element from the listOfGeometryDefinitions.

Parameters:

geometryDefinition - the element to be removed from the list

Returns:

true if the list contained the specified element

See Also:

List#remove(Object)

removeGeometryDefinition

public void removeGeometryDefinition(int i)

Removes an element from the listOfGeometryDefinitions at the given index.

Parameters:

i - the index where to remove the GeometryDefinition

Throws:

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

removeGeometryDefinition

public void removeGeometryDefinition(java.lang.String id)

createSampledFieldGeometryn

public SampledFieldGeometry createSampledFieldGeometryn()

Creates a new GeometryDefinition element and adds it to the ListOfGeometryDefinitions list

createAnalyticGeometry

public AnalyticGeometry createAnalyticGeometry()

createCSGeometry

public CSGeometry createCSGeometry()

createParametricGeometry

public ParametricGeometry createParametricGeometry()

createMixedGeometry

public MixedGeometry createMixedGeometry()

createMixedGeometry

public MixedGeometry createMixedGeometry(java.lang.String id)

Creates a new GeometryDefinition element and adds it to the ListOfGeometryDefinitions list

Returns:

a new GeometryDefinition element

createSampledFieldGeometry

public SampledFieldGeometry createSampledFieldGeometry(java.lang.String id)

Creates a new GeometryDefinition element and adds it to the ListOfGeometryDefinitions list

Returns:

a new GeometryDefinition element

createAnalyticGeometry

public AnalyticGeometry createAnalyticGeometry(java.lang.String id)

createCSGeometry

public CSGeometry createCSGeometry(java.lang.String id)

createParametricGeometry

public ParametricGeometry createParametricGeometry(java.lang.String id)

isSetListOfAdjacentDomains

public boolean isSetListOfAdjacentDomains()

Returns true, if listOfAdjacentDomains contains at least one element.

Returns:

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

getListOfAdjacentDomains

public ListOf<AdjacentDomains> getListOfAdjacentDomains()

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

Returns:

the listOfAdjacentDomains

setListOfAdjacentDomains

public void setListOfAdjacentDomains(ListOf<AdjacentDomains> listOfAdjacentDomains)

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

Parameters:

listOfAdjacentDomains -

unsetListOfAdjacentDomains

public boolean unsetListOfAdjacentDomains()

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

Returns:

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

addAdjacentDomain

public boolean addAdjacentDomain(AdjacentDomains adjacentDomains)

Adds a new AdjacentDomain to the listOfAdjacentDomains.

The listOfAdjacentDomains is initialized if necessary.

Parameters:

adjacentDomains - the element to add to the list

Returns:

true (as specified by Collection.add)

removeAdjacentDomain

public boolean removeAdjacentDomain(AdjacentDomains adjacentDomains)

Removes an element from the listOfAdjacentDomains.

Parameters:

adjacentDomains - the element to be removed from the list

Returns:

true if the list contained the specified element

See Also:

List#remove(Object)

removeAdjacentDomain

public void removeAdjacentDomain(int i)

Removes an element from the listOfAdjacentDomains at the given index.

Parameters:

i - the index where to remove the AdjacentDomain

Throws:

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

removeAdjacentDomain

public void removeAdjacentDomain(java.lang.String id)

createAdjacentDomain

public AdjacentDomains createAdjacentDomain()

Creates a new AdjacentDomain element and adds it to the ListOfAdjacentDomains list

createAdjacentDomain

public AdjacentDomains createAdjacentDomain(java.lang.String id)

Creates a new AdjacentDomain element and adds it to the ListOfAdjacentDomains list

Returns:

a new AdjacentDomain element

isSetListOfDomainTypes

public boolean isSetListOfDomainTypes()

Returns true, if listOfDomainTypes contains at least one element.

Returns:

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

getListOfDomainTypes

public ListOf<DomainType> getListOfDomainTypes()

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

Returns:

the listOfDomainTypes

setListOfDomainTypes

public void setListOfDomainTypes(ListOf<DomainType> listOfDomainTypes)

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

Parameters:

listOfDomainTypes -

unsetListOfDomainTypes

public boolean unsetListOfDomainTypes()

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

Returns:

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

addDomainType

public boolean addDomainType(DomainType domainType)

Adds a new DomainType to the listOfDomainTypes.

The listOfDomainTypes is initialized if necessary.

Parameters:

domainType - the element to add to the list

Returns:

true (as specified by Collection.add)

removeDomainType

public boolean removeDomainType(DomainType domainType)

Removes an element from the listOfDomainTypes.

Parameters:

domainType - the element to be removed from the list

Returns:

true if the list contained the specified element

See Also:

List#remove(Object)

removeDomainType

public void removeDomainType(int i)

Removes an element from the listOfDomainTypes at the given index.

Parameters:

i - the index where to remove the DomainType

Throws:

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

removeDomainType

public void removeDomainType(java.lang.String id)

createDomainType

public DomainType createDomainType()

Creates a new DomainType element and adds it to the ListOfDomainTypes list

createDomainType

public DomainType createDomainType(java.lang.String id)

Creates a new DomainType element and adds it to the ListOfDomainTypes list

Returns:

a new DomainType element

isSetListOfDomains

public boolean isSetListOfDomains()

Returns true, if listOfDomains contains at least one element.

Returns:

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

getListOfDomains

public ListOf<Domain> getListOfDomains()

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

Returns:

the listOfDomains

setListOfDomains

public void setListOfDomains(ListOf<Domain> listOfDomains)

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

Parameters:

listOfDomains -

unsetListOfDomains

public boolean unsetListOfDomains()

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

Returns:

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

addDomain

public boolean addDomain(Domain domain)

Adds a new Domain to the listOfDomains.

The listOfDomains is initialized if necessary.

Parameters:

domain - the element to add to the list

Returns:

true (as specified by Collection.add)

removeDomain

public boolean removeDomain(Domain domain)

Removes an element from the listOfDomains.

Parameters:

domain - the element to be removed from the list

Returns:

true if the list contained the specified element

See Also:

List#remove(Object)

removeDomain

public void removeDomain(int i)

Removes an element from the listOfDomains at the given index.

Parameters:

i - the index where to remove the Domain

Throws:

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

removeDomain

public void removeDomain(java.lang.String id)

createDomain

public Domain createDomain()

Creates a new Domain element and adds it to the ListOfDomains list

createDomain

public Domain createDomain(java.lang.String id)

Creates a new Domain element and adds it to the ListOfDomains list

Returns:

a new Domain element

isSetListOfCoordinateComponents

public boolean isSetListOfCoordinateComponents()

Returns true, if listOfCoordinateComponents contains at least one element.

Returns:

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

getListOfCoordinateComponents

public ListOf<CoordinateComponent> getListOfCoordinateComponents()

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

Returns:

the listOfCoordinateComponents

setListOfCoordinateComponents

public void setListOfCoordinateComponents(ListOf<CoordinateComponent> listOfCoordinateComponents)

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

Parameters:

listOfCoordinateComponents -

unsetListOfCoordinateComponents

public boolean unsetListOfCoordinateComponents()

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

Returns:

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

addCoordinateComponent

public boolean addCoordinateComponent(CoordinateComponent coordinateComponents)

Adds a new CoordinateComponent to the listOfCoordinateComponents.

The listOfCoordinateComponents is initialized if necessary.

Parameters:

coordinateComponents - the element to add to the list

Returns:

true (as specified by Collection.add)

removeCoordinateComponent

public boolean removeCoordinateComponent(CoordinateComponent coordinateComponents)

Removes an element from the listOfCoordinateComponents.

Parameters:

coordinateComponents - the element to be removed from the list

Returns:

true if the list contained the specified element

See Also:

List#remove(Object)

removeCoordinateComponent

public void removeCoordinateComponent(int i)

Removes an element from the listOfCoordinateComponents at the given index.

Parameters:

i - the index where to remove the CoordinateComponent

Throws:

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

removeCoordinateComponent

public void removeCoordinateComponent(java.lang.String id)

createCoordinateComponent

public CoordinateComponent createCoordinateComponent()

Creates a new CoordinateComponent element and adds it to the ListOfCoordinateComponents list

createCoordinateComponent

public CoordinateComponent createCoordinateComponent(java.lang.String id)

Creates a new CoordinateComponent element and adds it to the ListOfCoordinateComponents list

Returns:

a new CoordinateComponent element

toString

public java.lang.String toString()

Overrides:

toString in class AbstractSpatialNamedSBase

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.

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.

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

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