org.sbml.jsbml.ext.layout

Class Curve

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.AbstractNamedSBase

org.sbml.jsbml.ext.layout.Curve

All Implemented Interfaces:

Serializable, Cloneable, TreeNode, NamedSBase, SBase, TreeNodeWithChangeSupport

public class Curve
extends AbstractNamedSBase

The Curve class describes how to connect elements in a diagram defined with the use of the Layout package. A curve is fully specified by a mandatory listOfCurveSegments element and is used in four places in the Layout package: SpeciesReferenceGlyph, ReactionGlyph, ReferenceGlyph, and GeneralGlyph.

Since:

1.0

Author:

Nicolas Rodriguez, Andreas Dräger

See Also:

Serialized Form

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
Curve()
Curve(Curve curve)
Curve(int level, int version)

Method Summary

Modifier and Type	Method and Description
boolean	addCurveSegment(CurveSegment curveSegment)
void	addCurveSegment(int index, CurveSegment element)
Curve	clone()
CubicBezier	createCubicBezier() Creates a new CubicBezier instance, adds it to this Curve.
CubicBezier	createCubicBezier(Point start, Point basePoint1, Point basePoint2, Point end)
LineSegment	createLineSegment() Creates a new LineSegment instance, adds it to this Curve and returns it.
LineSegment	createLineSegment(Point start, Point end)
boolean	equals(Object object)
TreeNode	getChildAt(int index)
int	getChildCount()
CurveSegment	getCurveSegment(int n)
int	getCurveSegmentCount()
ListOf<CurveSegment>	getListOfCurveSegments()
int	hashCode()
boolean	isIdMandatory()
boolean	isSetListOfCurveSegments()
boolean	removeCurveSegment(CurveSegment cs)
void	setListOfCurveSegments(ListOf<CurveSegment> listOfCurveSegments) The listOfCurveSegments element contains arbitrary number of cuve segments that can be either of type LineSegment or of type CubicBezier.
boolean	unsetListOfCurveSegments() Removes the listOfCurveSegments from this Model and notifies all registered instances of TreeNodeChangeListener.

Methods inherited from class org.sbml.jsbml.AbstractNamedSBase

isValidId

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, getAllowsChildren, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getElementName, 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, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetId, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetName, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, notifyChildChange, readAttribute, 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, writeXMLAttributes

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

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

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

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, getAllowsChildren, getIndex, getParent, isLeaf

Constructor Detail

Curve

public Curve()

Curve

public Curve(Curve curve)

Parameters:

curve -

Curve

public Curve(int level,
             int version)

Parameters:

level -

version -

Method Detail

addCurveSegment

public boolean addCurveSegment(CurveSegment curveSegment)

Parameters:

curveSegment -

Returns:

See Also:

List#add(Object)

addCurveSegment

public void addCurveSegment(int index,
                            CurveSegment element)

Parameters:

index -

element -

clone

public Curve clone()

Specified by:

clone in interface SBase

Overrides:

clone in class AbstractSBase

createLineSegment

public LineSegment createLineSegment()

Creates a new LineSegment instance, adds it to this Curve and returns it.

Returns:

the new LineSegment instance

createLineSegment

public LineSegment createLineSegment(Point start,
                                     Point end)

Parameters:

start -

end -

Returns:

createCubicBezier

public CubicBezier createCubicBezier()

Creates a new CubicBezier instance, adds it to this Curve. and returns it.

Returns:

the new CubicBezier instance

createCubicBezier

public CubicBezier createCubicBezier(Point start,
                                     Point basePoint1,
                                     Point basePoint2,
                                     Point end)

Parameters:

start -

basePoint1 -

basePoint2 -

end -

Returns:

equals

public boolean equals(Object object)

Specified by:

equals in interface SBase

Overrides:

equals in class AbstractSBase

getChildAt

public TreeNode getChildAt(int index)

Specified by:

getChildAt in interface TreeNode

Overrides:

getChildAt in class AbstractSBase

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface TreeNode

Overrides:

getChildCount in class AbstractSBase

getCurveSegment

public CurveSegment getCurveSegment(int n)

Parameters:

n -

Returns:

getCurveSegmentCount

public int getCurveSegmentCount()

Returns:

getListOfCurveSegments

public ListOf<CurveSegment> getListOfCurveSegments()

Returns:

hashCode

public int hashCode()

Specified by:

hashCode in interface SBase

Overrides:

hashCode in class AbstractSBase

isIdMandatory

public boolean isIdMandatory()

Specified by:

isIdMandatory in interface NamedSBase

Specified by:

isIdMandatory in interface SBase

Overrides:

isIdMandatory in class AbstractSBase

isSetListOfCurveSegments

public boolean isSetListOfCurveSegments()

Returns:

removeCurveSegment

public boolean removeCurveSegment(CurveSegment cs)

Parameters:

cs -

Returns:

setListOfCurveSegments

public void setListOfCurveSegments(ListOf<CurveSegment> listOfCurveSegments)

The listOfCurveSegments element contains arbitrary number of cuve segments that can be either of type LineSegment or of type CubicBezier. Here, both classes are child classes of the abstract type CurveSegment.

Parameters:

listOfCurveSegments -

unsetListOfCurveSegments

public boolean unsetListOfCurveSegments()

Removes the listOfCurveSegments from this Model and notifies all registered instances of TreeNodeChangeListener.

Returns:

true if calling this method lead to a change in this data structure.