org.sbml.jsbml.ext.render

Class RenderCurve

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

All Implemented Interfaces:

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

public class RenderCurve
extends GraphicalPrimitive1D

Implements the Curve concept from the SBML render extension.

The curve concept in the SBML render extension is similar to the curves in the SBML layout. Each curve consists of a number of either straight line segments or cubic bezier elements. The two element types can also by mixed in a single curve object.

In contrast to layout curves, render curves can not have gaps and the individual coordinates of the curve elements can be specified as a combination of absolute and relative values.

Another difference to layout curves is the fact that render curves can specify decorations to be applied to the start and/or the end of the curve (@see LineEnding).

Since RenderCurve is derived from GraphicalPrimitive1D, it inherits all its attributes and methods.

Since:

1.0

Version:

$Rev: 1954 $

Author:

Eugen Netz, Alexander Diamantikos, Jakob Matthes, Jan Rudolph

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	endHead
protected ListOf<RenderPoint>	listOfElements
private static long	serialVersionUID
protected java.lang.String	startHead

Fields inherited from class org.sbml.jsbml.ext.render.GraphicalPrimitive1D

stroke, strokeDashArray, strokeWidth

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

transform

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
RenderCurve() Creates an Curve instance
RenderCurve(RenderCurve obj) Clone constructor

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addElement(RenderPoint element)
RenderCurve	clone() Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.
RenderPoint	createElement() create a new Element element and adds it to the ListOfElements list
RenderPoint	createElement(java.lang.String id) create a new Element element and adds it to the ListOfElements list
boolean	equals(java.lang.Object obj) Returns true if and only if the given SBase has exactly the same properties like this SBase instance.
java.lang.String	getEndHead()
ListOf<RenderPoint>	getListOfElements()
java.lang.String	getStartHead()
int	hashCode() Returns a hash code value for this SBase instance.
void	initDefaults() Initializes the default values using the namespace.
boolean	isSetEndHead()
boolean	isSetListOfElements()
boolean	isSetStartHead()
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value) Sets the given attribute in this SBase.
void	removeElement(int i)
boolean	removeElement(RenderPoint element)
void	setEndHead(java.lang.String endHead) Set the value of endHead
void	setListOfElements(ListOf<RenderPoint> listOfElements)
void	setStartHead(java.lang.String startHead) Set the value of startHead
boolean	unsetEndHead() Unsets the variable endHead
boolean	unsetListOfElements()
boolean	unsetStartHead() Unsets the variable startHead
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.render.GraphicalPrimitive1D

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

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

getTransform, isSetTransform, setTransform, unsetTransform

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

toString

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, getAllowsChildren, getAnnotation, getAnnotationString, getChildAt, getChildCount, 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

removeTreeNodeChangeListener

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

Methods inherited from interface javax.swing.tree.TreeNode

children, getIndex, isLeaf

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

startHead

protected java.lang.String startHead

endHead

protected java.lang.String endHead

listOfElements

protected ListOf<RenderPoint> listOfElements

Constructor Detail

RenderCurve

public RenderCurve()

Creates an Curve instance

RenderCurve

public RenderCurve(RenderCurve obj)

Clone constructor

Method Detail

clone

public RenderCurve 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 GraphicalPrimitive1D

Returns:

a copy of this object

initDefaults

public void initDefaults()

Description copied from class: Transformation

Initializes the default values using the namespace.

Overrides:

initDefaults in class GraphicalPrimitive1D

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 GraphicalPrimitive1D

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 GraphicalPrimitive1D

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.

getStartHead

public java.lang.String getStartHead()

Returns:

the value of startHead

isSetStartHead

public boolean isSetStartHead()

Returns:

whether startHead is set

setStartHead

public void setStartHead(java.lang.String startHead)

Set the value of startHead

unsetStartHead

public boolean unsetStartHead()

Unsets the variable startHead

Returns:

true, if startHead was set before, otherwise false

getEndHead

public java.lang.String getEndHead()

Returns:

the value of endHead

isSetEndHead

public boolean isSetEndHead()

Returns:

whether endHead is set

setEndHead

public void setEndHead(java.lang.String endHead)

Set the value of endHead

unsetEndHead

public boolean unsetEndHead()

Unsets the variable endHead

Returns:

true, if endHead was set before, otherwise false

isSetListOfElements

public boolean isSetListOfElements()

Returns:

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

getListOfElements

public ListOf<RenderPoint> getListOfElements()

Returns:

the listOfElements

setListOfElements

public void setListOfElements(ListOf<RenderPoint> listOfElements)

Parameters:

listOfElements -

unsetListOfElements

public boolean unsetListOfElements()

Returns:

true, if listOfElements contained at least one element, otherwise false

addElement

public boolean addElement(RenderPoint element)

Parameters:

element -

removeElement

public boolean removeElement(RenderPoint element)

Parameters:

element -

removeElement

public void removeElement(int i)

Parameters:

i -

createElement

public RenderPoint createElement()

create a new Element element and adds it to the ListOfElements list

NOTE: only use this method, if ID is not mandatory in Element otherwise use @see createElement(String id)!

createElement

public RenderPoint createElement(java.lang.String id)

create a new Element element and adds it to the ListOfElements list

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 GraphicalPrimitive1D

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 GraphicalPrimitive1D

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.