org.sbml.jsbml.ext.spatial

Class CSGScale

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

All Implemented Interfaces:

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

public class CSGScale
extends CSGTransformation

Since:

1.0

Version:

$Rev: 1639 $

Author:

Alex Thomas

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Double	scaleX
private java.lang.Double	scaleY
private java.lang.Double	scaleZ
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
CSGScale()
CSGScale(CSGScale csgt)
CSGScale(int level, int version)
CSGScale(java.lang.String id, int level, int version)

Method Summary

Methods

Modifier and Type	Method and Description
CSGScale	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.
double	getScaleX() Returns the value of scaleX
double	getScaleY() Returns the value of scaleY
double	getScaleZ() Returns the value of scaleZ
int	hashCode() Returns a hash code value for this SBase instance.
boolean	isSetScaleX() Returns whether scaleX is set
boolean	isSetScaleY() Returns whether scaleY is set
boolean	isSetScaleZ() Returns whether scaleZ is set
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value) Sets the given attribute in this SBase.
void	setScaleX(double scaleX) Sets the value of scaleX
void	setScaleY(double scaleY) Sets the value of scaleY
void	setScaleZ(double scaleZ) Sets the value of scaleZ
java.lang.String	toString()
boolean	unsetScaleX() Unsets the variable scaleX
boolean	unsetScaleY() Unsets the variable scaleY
boolean	unsetScaleZ() Unsets the variable scaleZ
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.CSGTransformation

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

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

scaleX

private java.lang.Double scaleX

scaleY

private java.lang.Double scaleY

scaleZ

private java.lang.Double scaleZ

Constructor Detail

CSGScale

public CSGScale()

CSGScale

public CSGScale(CSGScale csgt)

Parameters:

node -

CSGScale

public CSGScale(int level,
        int version)

Parameters:

level -

version -

CSGScale

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

Parameters:

id -

level -

version -

Method Detail

clone

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

getScaleX

public double getScaleX()

Returns the value of scaleX

Returns:

the value of scaleX

isSetScaleX

public boolean isSetScaleX()

Returns whether scaleX is set

Returns:

whether scaleX is set

setScaleX

public void setScaleX(double scaleX)

Sets the value of scaleX

unsetScaleX

public boolean unsetScaleX()

Unsets the variable scaleX

Returns:

true, if scaleX was set before, otherwise false

getScaleY

public double getScaleY()

Returns the value of scaleY

Returns:

the value of scaleY

isSetScaleY

public boolean isSetScaleY()

Returns whether scaleY is set

Returns:

whether scaleY is set

setScaleY

public void setScaleY(double scaleY)

Sets the value of scaleY

unsetScaleY

public boolean unsetScaleY()

Unsets the variable scaleY

Returns:

true, if scaleY was set before, otherwise false

getScaleZ

public double getScaleZ()

Returns the value of scaleZ

Returns:

the value of scaleZ

isSetScaleZ

public boolean isSetScaleZ()

Returns whether scaleZ is set

Returns:

whether scaleZ is set

setScaleZ

public void setScaleZ(double scaleZ)

Sets the value of scaleZ

unsetScaleZ

public boolean unsetScaleZ()

Unsets the variable scaleZ

Returns:

true, if scaleZ 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 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