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:

java.io.Serializable, java.lang.Cloneable, javax.swing.tree.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

Version:

$Rev: 1822 $

Author:

Nicolas Rodriguez, Andreas Dräger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
(package private) ListOf<CurveSegment>	listOfCurveSegments
private static long	serialVersionUID Generated serial version identifier.

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addCurveSegment(CurveSegment curveSegment)
void	addCurveSegment(int index, CurveSegment element)
Curve	clone() Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.
CubicBezier	createCubicBezier() Creates a new CubicBezier instance, adds it to this Curve and returns it.
LineSegment	createLineSegment() Creates a new LineSegment instance, adds it to this Curve and returns it.
boolean	equals(java.lang.Object object) Returns true if and only if the given SBase has exactly the same properties like this SBase instance.
javax.swing.tree.TreeNode	getChildAt(int index)
int	getChildCount()
CurveSegment	getCurveSegment(int n)
int	getCurveSegmentCount()
ListOf<CurveSegment>	getListOfCurveSegments()
int	hashCode() Returns a hash code value for this SBase instance.
private void	initDefaults()
boolean	isIdMandatory() This method can be used to query if the identifier of this NamedSBase is required to be defined (i.e., not null) in the definition of SBML.
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 #listOfLineSegments from this Model and notifies all registered instances of TreeNodeChangeListener.

Methods inherited from class org.sbml.jsbml.AbstractNamedSBase

getId, getName, isSetId, isSetName, isValidId, readAttribute, setId, setName, toString, unsetId, unsetName, writeXMLAttributes

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

Field Detail

serialVersionUID

private static final long serialVersionUID

Generated serial version identifier.

See Also:

Constant Field Values

listOfCurveSegments

ListOf<CurveSegment> listOfCurveSegments

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 -

addCurveSegment

public void addCurveSegment(int index,
                   CurveSegment element)

Parameters:

index -

element -

clone

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

createLineSegment

public LineSegment createLineSegment()

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

Returns:

the new LineSegment instance

createCubicBezier

public CubicBezier createCubicBezier()

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

Returns:

the new CubicBezier instance

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 AbstractNamedSBase

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.

getChildAt

public javax.swing.tree.TreeNode getChildAt(int index)

Specified by:

getChildAt in interface javax.swing.tree.TreeNode

Overrides:

getChildAt in class AbstractSBase

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface javax.swing.tree.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()

Description copied from interface: SBase

Returns a hash code value for this SBase instance.

Specified by:

hashCode in interface SBase

Overrides:

hashCode in class AbstractNamedSBase

Returns:

a hash code value for this SBase instance.

See Also:

Object.hashCode()

initDefaults

private void initDefaults()

isIdMandatory

public boolean isIdMandatory()

Description copied from interface: NamedSBase

This method can be used to query if the identifier of this NamedSBase is required to be defined (i.e., not null) in the definition of SBML.

Returns:

true if the identifier of this element must be set in order to create a valid SBML representation. false otherwise, i.e., if the identifier can be understood as an optional attribute.

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 #listOfLineSegments from this Model and notifies all registered instances of TreeNodeChangeListener.

Returns:

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