org.sbml.jsbml.ext.spatial

Class CSGSetOperator

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.ext.spatial.AbstractSpatialNamedSBase

org.sbml.jsbml.ext.spatial.CSGNode

org.sbml.jsbml.ext.spatial.CSGSetOperator

All Implemented Interfaces:

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

public class CSGSetOperator
extends CSGNode

Since:

1.0

Version:

$Rev: 1980 $

Author:

Alex Thomas

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CSGSetOperator.SetOperation

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	complementA
private java.lang.String	complementB
private ListOf<CSGNode>	listOfCSGNodes
private CSGSetOperator.SetOperation	operationType
private static long	serialVersionUID

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addCSGNode(CSGNode csgNode) Adds a new CSGNode to the listOfCSGNodes.
CSGSetOperator	clone() Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.
CSGHomogeneousTransformation	createCSGHomogeneousTransformation()
CSGHomogeneousTransformation	createCSGHomogeneousTransformation(java.lang.String id) Creates a new CSGHomogeneousTransformation element and adds it to the ListOfCSGNodes list
CSGPrimitive	createCSGPrimitive() Creates a new CSGNode element and adds it to the ListOfCSGNodes list
CSGPrimitive	createCSGPrimitive(java.lang.String id) Creates a new CSGPrimitive element and adds it to the ListOfCSGNodes list
CSGPseudoPrimitive	createCSGPseudoPrimitive()
CSGPseudoPrimitive	createCSGPseudoPrimitive(java.lang.String id) Creates a new CSGPseudoPrimitive element and adds it to the ListOfCSGNodes list
CSGRotation	createCSGRotation()
CSGRotation	createCSGRotation(java.lang.String id) Creates a new CSGRotation element and adds it to the ListOfCSGNodes list
CSGScale	createCSGScale()
CSGScale	createCSGScale(java.lang.String id) Creates a new CSGScale element and adds it to the ListOfCSGNodes list
CSGSetOperator	createCSGSetOperator()
CSGSetOperator	createCSGSetOperator(java.lang.String id) Creates a new CSGSetOperator element and adds it to the ListOfCSGNodes list
CSGTranslation	createCSGTranslation()
CSGTranslation	createCSGTranslation(java.lang.String id) Creates a new CSGTranslation element and adds it to the ListOfCSGNodes 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	getComplementA() Returns the value of complementA
java.lang.String	getComplementB() Returns the value of complementB
ListOf<CSGNode>	getListOfCSGNodes() Returns the listOfCSGNodes.
CSGSetOperator.SetOperation	getOperationType() Returns the value of operationType
int	hashCode() Returns a hash code value for this SBase instance.
boolean	isSetComplementA() Returns whether complementA is set
boolean	isSetComplementB() Returns whether complementB is set
boolean	isSetListOfCSGNodes() Returns true, if listOfCSGNodes contains at least one element.
boolean	isSetOperationType() Returns whether operationType is set
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value) Sets the given attribute in this SBase.
boolean	removeCSGNode(CSGNode csgNode) Removes an element from the listOfCSGNodes.
void	removeCSGNode(int i) Removes an element from the listOfCSGNodes at the given index.
void	removeCSGNode(java.lang.String id)
void	setComplementA(java.lang.String complementA) Sets the value of complementA
void	setComplementB(java.lang.String complementB) Sets the value of complementB
void	setListOfCSGNodes(ListOf<CSGNode> listOfCSGNodes) Sets the given ListOf<CSGNode>.
void	setOperationType(CSGSetOperator.SetOperation operationType) Sets the value of operationType
java.lang.String	toString()
boolean	unsetComplementA() Unsets the variable complementA
boolean	unsetComplementB() Unsets the variable complementB
boolean	unsetListOfCSGNodes() Returns true, if listOfCSGNodes contain at least one element, otherwise false
boolean	unsetOperationType() Unsets the variable operationType
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

See Also:

Constant Field Values

operationType

private CSGSetOperator.SetOperation operationType

complementA

private java.lang.String complementA

complementB

private java.lang.String complementB

listOfCSGNodes

private ListOf<CSGNode> listOfCSGNodes

Constructor Detail

CSGSetOperator

public CSGSetOperator()

CSGSetOperator

public CSGSetOperator(CSGSetOperator csgso)

Parameters:

node -

CSGSetOperator

public CSGSetOperator(int level,
              int version)

Parameters:

level -

version -

CSGSetOperator

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

Parameters:

id -

level -

version -

Method Detail

clone

public CSGSetOperator 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 CSGNode

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.

getComplementA

public java.lang.String getComplementA()

Returns the value of complementA

Returns:

the value of complementA

isSetComplementA

public boolean isSetComplementA()

Returns whether complementA is set

Returns:

whether complementA is set

setComplementA

public void setComplementA(java.lang.String complementA)

Sets the value of complementA

unsetComplementA

public boolean unsetComplementA()

Unsets the variable complementA

Returns:

true, if complementA was set before, otherwise false

getComplementB

public java.lang.String getComplementB()

Returns the value of complementB

Returns:

the value of complementB

isSetComplementB

public boolean isSetComplementB()

Returns whether complementB is set

Returns:

whether complementB is set

setComplementB

public void setComplementB(java.lang.String complementB)

Sets the value of complementB

unsetComplementB

public boolean unsetComplementB()

Unsets the variable complementB

Returns:

true, if complementB was set before, otherwise false

getOperationType

public CSGSetOperator.SetOperation getOperationType()

Returns the value of operationType

Returns:

the value of operationType

isSetOperationType

public boolean isSetOperationType()

Returns whether operationType is set

Returns:

whether operationType is set

setOperationType

public void setOperationType(CSGSetOperator.SetOperation operationType)

Sets the value of operationType

unsetOperationType

public boolean unsetOperationType()

Unsets the variable operationType

Returns:

true, if operationType was set before, otherwise false

isSetListOfCSGNodes

public boolean isSetListOfCSGNodes()

Returns true, if listOfCSGNodes contains at least one element.

Returns:

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

getListOfCSGNodes

public ListOf<CSGNode> getListOfCSGNodes()

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

Returns:

the listOfCSGNodes

setListOfCSGNodes

public void setListOfCSGNodes(ListOf<CSGNode> listOfCSGNodes)

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

Parameters:

listOfCSGNodes -

unsetListOfCSGNodes

public boolean unsetListOfCSGNodes()

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

Returns:

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

addCSGNode

public boolean addCSGNode(CSGNode csgNode)

Adds a new CSGNode to the listOfCSGNodes.

The listOfCSGNodes is initialized if necessary.

Parameters:

csgNode - the element to add to the list

Returns:

true (as specified by Collection.add)

removeCSGNode

public boolean removeCSGNode(CSGNode csgNode)

Removes an element from the listOfCSGNodes.

Parameters:

csgNode - the element to be removed from the list

Returns:

true if the list contained the specified element

See Also:

List#remove(Object)

removeCSGNode

public void removeCSGNode(int i)

Removes an element from the listOfCSGNodes at the given index.

Parameters:

i - the index where to remove the CSGNode

Throws:

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

removeCSGNode

public void removeCSGNode(java.lang.String id)

createCSGPrimitive

public CSGPrimitive createCSGPrimitive()

Creates a new CSGNode element and adds it to the ListOfCSGNodes list

createCSGPseudoPrimitive

public CSGPseudoPrimitive createCSGPseudoPrimitive()

createCSGSetOperator

public CSGSetOperator createCSGSetOperator()

createCSGTranslation

public CSGTranslation createCSGTranslation()

createCSGRotation

public CSGRotation createCSGRotation()

createCSGScale

public CSGScale createCSGScale()

createCSGHomogeneousTransformation

public CSGHomogeneousTransformation createCSGHomogeneousTransformation()

createCSGHomogeneousTransformation

public CSGHomogeneousTransformation createCSGHomogeneousTransformation(java.lang.String id)

Creates a new CSGHomogeneousTransformation element and adds it to the ListOfCSGNodes list

Returns:

a new CSGHomogeneousTransformation element

createCSGScale

public CSGScale createCSGScale(java.lang.String id)

Creates a new CSGScale element and adds it to the ListOfCSGNodes list

Returns:

a new CSGScale element

createCSGRotation

public CSGRotation createCSGRotation(java.lang.String id)

Creates a new CSGRotation element and adds it to the ListOfCSGNodes list

Returns:

a new CSGRotation element

createCSGTranslation

public CSGTranslation createCSGTranslation(java.lang.String id)

Creates a new CSGTranslation element and adds it to the ListOfCSGNodes list

Returns:

a new CSGTranslation element

createCSGSetOperator

public CSGSetOperator createCSGSetOperator(java.lang.String id)

Creates a new CSGSetOperator element and adds it to the ListOfCSGNodes list

Returns:

a new CSGSetOperator element

createCSGPseudoPrimitive

public CSGPseudoPrimitive createCSGPseudoPrimitive(java.lang.String id)

Creates a new CSGPseudoPrimitive element and adds it to the ListOfCSGNodes list

Returns:

a new CSGPseudoPrimitive element

createCSGPrimitive

public CSGPrimitive createCSGPrimitive(java.lang.String id)

Creates a new CSGPrimitive element and adds it to the ListOfCSGNodes list

Returns:

a new CSGPrimitive 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