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:

Serializable, Cloneable, TreeNode, SpatialNamedSBase, SBase, TreeNodeWithChangeSupport

public class CSGSetOperator
extends CSGNode

Since:

1.0

Version:

$Rev$

Author:

Alex Thomas, Piero Dalle Pezze

See Also:

Serialized Form

Last modified:

Jan 20, 2014

Field Summary

Fields inherited from class org.sbml.jsbml.AbstractSBase

ignoredExtensions, ignoredXMLElements, JSBML_WRONG_SBO_TERM, packageName

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, resourceBundle

Constructor Summary

Constructors

Constructor and Description
CSGSetOperator()
CSGSetOperator(CSGSetOperator csgso)
CSGSetOperator(int level, int version)
CSGSetOperator(String id, int level, int version)

Method Summary

Modifier and Type	Method and Description
boolean	addCSGNode(CSGNode csgNode) Adds a new CSGNode to the listOfCSGNodes.
CSGSetOperator	clone()
CSGHomogeneousTransformation	createCSGHomogeneousTransformation()
CSGHomogeneousTransformation	createCSGHomogeneousTransformation(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(String id) Creates a new CSGPrimitive element and adds it to the ListOfCSGNodes list
CSGPseudoPrimitive	createCSGPseudoPrimitive()
CSGPseudoPrimitive	createCSGPseudoPrimitive(String id) Creates a new CSGPseudoPrimitive element and adds it to the ListOfCSGNodes list
CSGRotation	createCSGRotation()
CSGRotation	createCSGRotation(String id) Creates a new CSGRotation element and adds it to the ListOfCSGNodes list
CSGScale	createCSGScale()
CSGScale	createCSGScale(String id) Creates a new CSGScale element and adds it to the ListOfCSGNodes list
CSGSetOperator	createCSGSetOperator()
CSGSetOperator	createCSGSetOperator(String id) Creates a new CSGSetOperator element and adds it to the ListOfCSGNodes list
CSGTranslation	createCSGTranslation()
CSGTranslation	createCSGTranslation(String id) Creates a new CSGTranslation element and adds it to the ListOfCSGNodes list
boolean	equals(Object object)
boolean	getAllowsChildren()
TreeNode	getChildAt(int index)
int	getChildCount()
String	getComplementA() Returns the value of complementA
String	getComplementB() Returns the value of complementB
String	getElementName()
ListOf<CSGNode>	getListOfCSGNodes() Returns the listOfCSGNodes.
SetOperation	getOperationType() Returns the value of operationType
int	hashCode()
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(String attributeName, String prefix, String value)
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(String id)
void	setComplementA(String complementA) Sets the value of complementA
void	setComplementB(String complementB) Sets the value of complementB
void	setListOfCSGNodes(ListOf<CSGNode> listOfCSGNodes) Sets the given ListOf<CSGNode>.
void	setOperationType(SetOperation operationType) Sets the value of operationType
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
Map<String,String>	writeXMLAttributes()

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

getSpatialId, initDefaults, isSetSpatialId, setSpatialId, unsetSpatialId

Methods inherited from class org.sbml.jsbml.AbstractSBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendAnnotation, appendAnnotation, appendNotes, appendNotes, checkAndSetPackageNamespaceAndVersion, checkAndSetPackageNamespaceAndVersion, checkAttribute, checkLevelAndVersionCompatibility, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getExtension, getExtensionCount, getExtensionPackages, getHistory, getId, getIdManager, getLevel, getLevelAndVersion, getMetaId, getModel, getName, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isIdMandatory, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetId, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetName, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, notifyChildChange, registerChild, removeCVTerm, removeCVTerm, setAnnotation, setAnnotation, setAnnotation, setHistory, setId, setLevel, setMetaId, setName, setNamespace, setNotes, setNotes, setPackageVersion, setParentSBML, setParentSBMLObject, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetId, unsetMetaId, unsetName, 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, isReadingInProgress, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, toString, 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, appendAnnotation, appendAnnotation, appendNotes, appendNotes, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getExtension, getExtensionCount, getExtensionPackages, getHistory, getId, getLevel, getLevelAndVersion, getMetaId, getModel, getName, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isIdMandatory, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetId, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetName, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, registerChild, removeCVTerm, removeCVTerm, removeTreeNodeChangeListener, setAnnotation, setAnnotation, setAnnotation, setHistory, setId, setLevel, setMetaId, setName, setNotes, setNotes, setPackageVersion, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetId, unsetMetaId, unsetName, 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

CSGSetOperator

public CSGSetOperator()

CSGSetOperator

public CSGSetOperator(CSGSetOperator csgso)

Parameters:

csgso -

CSGSetOperator

public CSGSetOperator(int level,
                      int version)

Parameters:

level -

version -

CSGSetOperator

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

Parameters:

id -

level -

version -

Method Detail

clone

public CSGSetOperator clone()

Specified by:

clone in interface SBase

Specified by:

clone in class AbstractSpatialNamedSBase

equals

public boolean equals(Object object)

Specified by:

equals in interface SBase

Overrides:

equals in class CSGNode

getComplementA

public 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(String complementA)

Sets the value of complementA

Parameters:

complementA -

unsetComplementA

public boolean unsetComplementA()

Unsets the variable complementA

Returns:

true, if complementA was set before, otherwise false

getComplementB

public 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(String complementB)

Sets the value of complementB

Parameters:

complementB -

unsetComplementB

public boolean unsetComplementB()

Unsets the variable complementB

Returns:

true, if complementB was set before, otherwise false

getOperationType

public 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(SetOperation operationType)

Sets the value of operationType

Parameters:

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:

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

removeCSGNode

public void removeCSGNode(String id)

Parameters:

id -

createCSGPrimitive

public CSGPrimitive createCSGPrimitive()

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

Returns:

createCSGPseudoPrimitive

public CSGPseudoPrimitive createCSGPseudoPrimitive()

Returns:

createCSGSetOperator

public CSGSetOperator createCSGSetOperator()

Returns:

createCSGTranslation

public CSGTranslation createCSGTranslation()

Returns:

createCSGRotation

public CSGRotation createCSGRotation()

Returns:

createCSGScale

public CSGScale createCSGScale()

Returns:

createCSGHomogeneousTransformation

public CSGHomogeneousTransformation createCSGHomogeneousTransformation()

Returns:

createCSGHomogeneousTransformation

public CSGHomogeneousTransformation createCSGHomogeneousTransformation(String id)

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

Parameters:

id -

Returns:

a new CSGHomogeneousTransformation element

createCSGScale

public CSGScale createCSGScale(String id)

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

Parameters:

id -

Returns:

a new CSGScale element

createCSGRotation

public CSGRotation createCSGRotation(String id)

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

Parameters:

id -

Returns:

a new CSGRotation element

createCSGTranslation

public CSGTranslation createCSGTranslation(String id)

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

Parameters:

id -

Returns:

a new CSGTranslation element

createCSGSetOperator

public CSGSetOperator createCSGSetOperator(String id)

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

Parameters:

id -

Returns:

a new CSGSetOperator element

createCSGPseudoPrimitive

public CSGPseudoPrimitive createCSGPseudoPrimitive(String id)

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

Parameters:

id -

Returns:

a new CSGPseudoPrimitive element

createCSGPrimitive

public CSGPrimitive createCSGPrimitive(String id)

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

Parameters:

id -

Returns:

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

hashCode

public int hashCode()

Specified by:

hashCode in interface SBase

Overrides:

hashCode in class AbstractSpatialNamedSBase

writeXMLAttributes

public Map<String,String> writeXMLAttributes()

Specified by:

writeXMLAttributes in interface SBase

Overrides:

writeXMLAttributes in class AbstractSpatialNamedSBase

readAttribute

public boolean readAttribute(String attributeName,
                             String prefix,
                             String value)

Specified by:

readAttribute in interface SBase

Overrides:

readAttribute in class AbstractSpatialNamedSBase

getElementName

public String getElementName()

Specified by:

getElementName in interface SBase

Overrides:

getElementName in class AbstractSBase