Package org.sbml.jsbml.ext.render

Class Ellipse

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.ext.render.Transformation

org.sbml.jsbml.ext.render.Transformation2D

org.sbml.jsbml.ext.render.GraphicalPrimitive1D

org.sbml.jsbml.ext.render.GraphicalPrimitive2D

org.sbml.jsbml.ext.render.Ellipse

All Implemented Interfaces:

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

public class Ellipse
extends GraphicalPrimitive2D

Encodes an ellipse.

Since:

1.0

Author:

Eugen Netz, Alexander Diamantikos, Jakob Matthes, Jan Rudolph, David Vetter

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.sbml.jsbml.ext.render.GraphicalPrimitive2D

GraphicalPrimitive2D.FillRule

Field Summary

Fields inherited from class org.sbml.jsbml.AbstractSBase

JSBML_WRONG_SBO_TERM

Constructor Summary

Constructors

Constructor	Description
Ellipse()	Creates a new Ellipse instance.
Ellipse(int level, int version)	Creates a new Ellipse instance.
Ellipse(Ellipse obj)	Creates a new Ellipse instance, copied from the given ellipse.

Method Summary

Modifier and Type	Method	Description
Ellipse	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 obj)	Returns true if and only if the given SBase has exactly the same properties like this SBase instance.
RelAbsVector	getCx()
RelAbsVector	getCy()
RelAbsVector	getCz()
double	getRatio()
RelAbsVector	getRx()
RelAbsVector	getRy()
int	hashCode()	Returns a hash code value for this SBase instance.
boolean	isSetCx()
boolean	isSetCy()
boolean	isSetCz()
boolean	isSetRatio()
boolean	isSetRx()
boolean	isSetRy()
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value)	Sets the given attribute in this SBase.
void	setCx(RelAbsVector cx)	Set the value of cx
void	setCy(RelAbsVector cy)	Set the value of cy
void	setCz(RelAbsVector cz)	Set the value of cz
void	setRatio(java.lang.Double newRatio)	Sets the ratio-attribute to given value and fires appropriate change-events
void	setRx(RelAbsVector rx)	Set the value of rx
void	setRy(RelAbsVector ry)	Set the value of ry
boolean	unsetCx()	Unsets the variable cx
boolean	unsetCy()	Unsets the variable cy
boolean	unsetCz()	Unsets the variable cz
boolean	unsetRatio()	Unsets the ratio-attribute (if set)
boolean	unsetRx()	Unsets the variable rx
boolean	unsetRy()	Unsets the variable ry
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, getAllowsChildren, getAnnotation, getAnnotationString, getChildAt, getChildCount, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getElementName, 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.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.render.GraphicalPrimitive1D

addStrokeDash, getStroke, getStrokeDash, getStrokeDashArray, getStrokeWidth, isSetStroke, isSetStrokeDashArray, isSetStrokeWidth, setStroke, setStrokeDashArray, setStrokeDashArray, setStrokeWidth, unsetStroke, unsetStrokeDashArray, unsetStrokeWidth

Methods inherited from class org.sbml.jsbml.ext.render.GraphicalPrimitive2D

getFill, getFillRule, initDefaults, isSetFill, isSetFillRule, setFill, setFillRule, unsetFill, unsetFillRule

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.sbml.jsbml.SBase

removeTreeNodeChangeListener

Methods inherited from class org.sbml.jsbml.ext.render.Transformation

isSetTransform, setTransform

Methods inherited from class org.sbml.jsbml.ext.render.Transformation2D

getTransform, unsetTransform

Methods inherited from interface javax.swing.tree.TreeNode

children, getIndex, isLeaf

Methods inherited from interface org.sbml.jsbml.util.TreeNodeWithChangeSupport

addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, getListOfTreeNodeChangeListeners, getRoot, getTreeNodeChangeListenerCount, getUserObject, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeUserObject, userObjectKeySet

Constructor Detail

Ellipse

public Ellipse()

Creates a new Ellipse instance.

Ellipse

public Ellipse(Ellipse obj)

Creates a new Ellipse instance, copied from the given ellipse.

Parameters:

obj - the Ellipse to be cloned

Ellipse

public Ellipse(int level,
               int version)

Creates a new Ellipse instance.

Parameters:

level - the SBML level

version - the SBML version

Method Detail

clone

public Ellipse 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

Overrides:

clone in class GraphicalPrimitive2D

Returns:

a copy of this object

getCx

public RelAbsVector getCx()

Returns:

the value of cx

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 GraphicalPrimitive2D

Returns:

a hash code value for this SBase instance.

See Also:

Object.hashCode()

equals

public boolean equals(java.lang.Object obj)

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 GraphicalPrimitive2D

Parameters:

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

isSetCx

public boolean isSetCx()

Returns:

whether cx is set

setCx

public void setCx(RelAbsVector cx)

Set the value of cx

Parameters:

cx -

unsetCx

public boolean unsetCx()

Unsets the variable cx

Returns:

true, if cx was set before, otherwise false

getCy

public RelAbsVector getCy()

Returns:

the value of cy

isSetCy

public boolean isSetCy()

Returns:

whether cy is set

setCy

public void setCy(RelAbsVector cy)

Set the value of cy

Parameters:

cy -

unsetCy

public boolean unsetCy()

Unsets the variable cy

Returns:

true, if cy was set before, otherwise false

getCz

public RelAbsVector getCz()

Returns:

the value of cz

isSetCz

public boolean isSetCz()

Returns:

whether cz is set

setCz

public void setCz(RelAbsVector cz)

Set the value of cz

Parameters:

cz -

unsetCz

public boolean unsetCz()

Unsets the variable cz

Returns:

true, if cz was set before, otherwise false

getRatio

public double getRatio()

Returns:

the ratio-attribute (specifies rx/ry, cf. render specification: Ellipse class)

isSetRatio

public boolean isSetRatio()

Returns:

whether the ratio-attribute is set to a number

setRatio

public void setRatio(java.lang.Double newRatio)

Sets the ratio-attribute to given value and fires appropriate change-events

Parameters:

newRatio - the new value to be taken

unsetRatio

public boolean unsetRatio()

Unsets the ratio-attribute (if set)

Returns:

Whether the ratio could actually be unset

getRx

public RelAbsVector getRx()

Returns:

the value of rx

isSetRx

public boolean isSetRx()

Returns:

whether rx is set

setRx

public void setRx(RelAbsVector rx)

Set the value of rx

Parameters:

rx -

unsetRx

public boolean unsetRx()

Unsets the variable rx

Returns:

true, if rx was set before, otherwise false

getRy

public RelAbsVector getRy()

Returns:

the value of ry

isSetRy

public boolean isSetRy()

Returns:

whether ry is set

setRy

public void setRy(RelAbsVector ry)

Set the value of ry

Parameters:

ry -

unsetRy

public boolean unsetRy()

Unsets the variable ry

Returns:

true, if ry was set before, otherwise false

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 GraphicalPrimitive2D

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 GraphicalPrimitive2D

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.