Package org.sbml.jsbml.ext.spatial

Class CSGTranslation

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

org.sbml.jsbml.ext.spatial.CSGTranslation

All Implemented Interfaces:

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

public class CSGTranslation
extends CSGTransformation

Since:

1.0

Author:

Alex-Thomas, Piero Dalle Pezze

See Also:

Serialized Form

Field Summary

Fields inherited from class org.sbml.jsbml.AbstractSBase

JSBML_WRONG_SBO_TERM

Constructor Summary

Constructors

Constructor	Description
CSGTranslation()
CSGTranslation(int level, int version)
CSGTranslation(java.lang.String id, int level, int version)
CSGTranslation(CSGTranslation csgt)

Method Summary

Modifier and Type	Method	Description
CSGTranslation	clone()	Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.
boolean	equals(java.lang.Object object)	Returns true if and only if the given SBase has exactly the same properties like this SBase instance.
java.lang.String	getElementName()	Returns the XML element name of this object.
double	getTranslateX()	Returns the value of translateX
double	getTranslateY()	Returns the value of translateY
double	getTranslateZ()	Returns the value of translateZ
int	hashCode()	Returns a hash code value for this SBase instance.
boolean	isSetTranslateX()	Returns whether translateX is set
boolean	isSetTranslateY()	Returns whether translateY is set
boolean	isSetTranslateZ()	Returns whether translateZ is set
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value)	Sets the given attribute in this SBase.
void	setTranslateX(double translateX)	Sets the value of translateX
void	setTranslateY(double translateY)	Sets the value of translateY
void	setTranslateZ(double translateZ)	Sets the value of translateZ
boolean	unsetTranslateX()	Unsets the variable translateX
boolean	unsetTranslateY()	Unsets the variable translateY
boolean	unsetTranslateZ()	Unsets the variable translateZ
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.AbstractSBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, addResources, appendAnnotation, appendAnnotation, appendNotes, appendNotes, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAllDeclaredNamespaces, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getExtension, getExtensionCount, getExtensionPackages, getFirstElementIndex, getHistory, getId, getLevel, getLevelAndVersion, getMetaId, getModel, getName, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasExtension, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isIdMandatory, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetId, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetName, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, registerChild, removeCVTerm, removeCVTerm, removeDeclaredNamespaceByNamespace, removeDeclaredNamespaceByPrefix, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setAnnotation, setHistory, setId, setLevel, setMetaId, setName, setNamespace, setNotes, setNotes, setPackageVersion, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, toString, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetId, unsetMetaId, unsetName, unsetNamespace, unsetNotes, unsetPlugin, unsetSBOTerm

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

getSpatialId, initDefaults, isSetSpatialId, setSpatialId, unsetSpatialId

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 org.sbml.jsbml.ext.spatial.CSGTransformation

getAllowsChildren, getChildAt, getChildCount, getCSGNode, isSetCSGNode, setCSGNode, unsetCSGNode

Methods inherited from interface org.sbml.jsbml.NamedSBase

getId, getName, isIdMandatory, isSetId, isSetName, setId, setName, unsetId, unsetName

Methods inherited from class java.lang.Object

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, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasExtension, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, registerChild, removeCVTerm, removeCVTerm, removeDeclaredNamespaceByNamespace, removeDeclaredNamespaceByPrefix, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTreeNodeChangeListener, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setAnnotation, setHistory, setLevel, setMetaId, setNotes, setNotes, setPackageVersion, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, unsetNotes, unsetPlugin, unsetSBOTerm

Methods inherited from interface javax.swing.tree.TreeNode

children, getIndex, getParent, isLeaf

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

Constructor Detail

CSGTranslation

public CSGTranslation()

CSGTranslation

public CSGTranslation(CSGTranslation csgt)

Parameters:

csgt -

CSGTranslation

public CSGTranslation(int level,
                      int version)

Parameters:

level -

version -

CSGTranslation

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

Parameters:

id -

level -

version -

Method Detail

clone

public CSGTranslation 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 AbstractSpatialNamedSBase

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 CSGTransformation

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.

getTranslateX

public double getTranslateX()

Returns the value of translateX

Returns:

the value of translateX

isSetTranslateX

public boolean isSetTranslateX()

Returns whether translateX is set

Returns:

whether translateX is set

setTranslateX

public void setTranslateX(double translateX)

Sets the value of translateX

Parameters:

translateX -

unsetTranslateX

public boolean unsetTranslateX()

Unsets the variable translateX

Returns:

true, if translateX was set before, otherwise false

getTranslateY

public double getTranslateY()

Returns the value of translateY

Returns:

the value of translateY

isSetTranslateY

public boolean isSetTranslateY()

Returns whether translateY is set

Returns:

whether translateY is set

setTranslateY

public void setTranslateY(double translateY)

Sets the value of translateY

Parameters:

translateY -

unsetTranslateY

public boolean unsetTranslateY()

Unsets the variable translateY

Returns:

true, if translateY was set before, otherwise false

getTranslateZ

public double getTranslateZ()

Returns the value of translateZ

Returns:

the value of translateZ

isSetTranslateZ

public boolean isSetTranslateZ()

Returns whether translateZ is set

Returns:

whether translateZ is set

setTranslateZ

public void setTranslateZ(double translateZ)

Sets the value of translateZ

Parameters:

translateZ -

unsetTranslateZ

public boolean unsetTranslateZ()

Unsets the variable translateZ

Returns:

true, if translateZ was set before, otherwise false

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 AbstractSBase

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.

getElementName

public java.lang.String getElementName()

Description copied from interface: SBase

Returns the XML element name of this object.

Specified by:

getElementName in interface SBase

Overrides:

getElementName in class AbstractSBase

Returns:

the XML element name of this object.