Package org.sbml.jsbml.ext.layout

Class CurveSegment

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.ext.layout.CurveSegment

All Implemented Interfaces:

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

Direct Known Subclasses:

LineSegment

public abstract class CurveSegment
extends AbstractSBase

Parent class to LineSegment and CubicBezier.

Since:

1.0

Author:

Sebastian Fröhlich, Nicolas Rodriguez, David Vetter

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CurveSegment.Type

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	Description
CurveSegment()
CurveSegment(int level, int version)
CurveSegment(CurveSegment curveSegment)

Method Summary

Modifier and Type	Method	Description
abstract Point	createEnd()	Creates, sets and returns an empty Point.
abstract Point	createEnd(double x, double y, double z)	Creates, sets and returns a Point based on the given values.
abstract Point	createStart()	Creates, sets and returns an empty Point.
abstract Point	createStart(double x, double y, double z)	Creates, sets and returns a Point based on the given values.
boolean	equals(java.lang.Object object)
abstract Point	getEnd()	Returns the End Point of this CurveSegment.
abstract Point	getStart()	Returns the Start Point of this CurveSegment.
CurveSegment.Type	getType()
int	hashCode()
boolean	isCubicBezier()
boolean	isLineSegment()
abstract boolean	isSetEnd()	Returns true if the End Point is set.
abstract boolean	isSetStart()	Returns true if the Start Point is set.
boolean	isSetType()
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value)
Point	removeEnd()
Point	removeStart()
abstract void	setEnd(Point end)	Sets the End Point of this CurveSegment.
abstract void	setStart(Point start)	Sets the Start Point of this CurveSegment.
void	unsetEnd()	Unsets the end-point of this CurveSegment
void	unsetStart()	Unsets the start-point of this CurveSegment
java.util.Map<java.lang.String,java.lang.String>	writeXMLAttributes()

Methods inherited from class org.sbml.jsbml.AbstractSBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, addResources, appendAnnotation, appendAnnotation, appendNotes, appendNotes, checkAndSetPackageNamespaceAndVersion, checkAndSetPackageNamespaceAndVersion, checkAttribute, checkIdentifier, checkLevelAndVersionCompatibility, clone, 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, getIdManager, 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, notifyChildChange, registerChild, removeCVTerm, removeCVTerm, removeDeclaredNamespaceByNamespace, removeDeclaredNamespaceByPrefix, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setAnnotation, setHistory, setId, setLevel, setMetaId, setName, setNamespace, setNotes, setNotes, setPackageVersion, setParentSBML, setParentSBMLObject, 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, isCloningInProgress, isInvalidSBMLAllowed, isLeaf, isReadingInProgress, 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 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

CurveSegment

public CurveSegment()

CurveSegment

public CurveSegment(CurveSegment curveSegment)

Parameters:

curveSegment -

CurveSegment

public CurveSegment(int level,
                    int version)

Parameters:

level -

version -

Method Detail

createEnd

public abstract Point createEnd()

Creates, sets and returns an empty Point.

Returns:

a new Point object.

createEnd

public abstract Point createEnd(double x,
                                double y,
                                double z)

Creates, sets and returns a Point based on the given values.

Parameters:

x -

y -

z -

Returns:

a new Point object.

createStart

public abstract Point createStart()

Creates, sets and returns an empty Point.

Returns:

a new Point object.

createStart

public abstract Point createStart(double x,
                                  double y,
                                  double z)

Creates, sets and returns a Point based on the given values.

Parameters:

x -

y -

z -

Returns:

a new Point object.

equals

public boolean equals(java.lang.Object object)

Specified by:

equals in interface SBase

Overrides:

equals in class AbstractSBase

getEnd

public abstract Point getEnd()

Returns the End Point of this CurveSegment.

Returns:

the End Point of this CurveSegment.

getStart

public abstract Point getStart()

Returns the Start Point of this CurveSegment.

Returns:

the Start Point of this CurveSegment.

getType

public CurveSegment.Type getType()

Returns:

hashCode

public int hashCode()

Specified by:

hashCode in interface SBase

Overrides:

hashCode in class AbstractSBase

isCubicBezier

public boolean isCubicBezier()

Returns:

isLineSegment

public boolean isLineSegment()

Returns:

isSetEnd

public abstract boolean isSetEnd()

Returns true if the End Point is set.

Returns:

true if the End Point is set.

isSetStart

public abstract boolean isSetStart()

Returns true if the Start Point is set.

Returns:

true if the Start Point is set.

isSetType

public boolean isSetType()

Returns:

readAttribute

public boolean readAttribute(java.lang.String attributeName,
                             java.lang.String prefix,
                             java.lang.String value)

Specified by:

readAttribute in interface SBase

Overrides:

readAttribute in class AbstractSBase

removeEnd

public Point removeEnd()

Returns:

removeStart

public Point removeStart()

Returns:

setEnd

public abstract void setEnd(Point end)

Sets the End Point of this CurveSegment.

Parameters:

end - the End Point to set

setStart

public abstract void setStart(Point start)

Sets the Start Point of this CurveSegment.

Parameters:

start - the Start Point to set

unsetEnd

public void unsetEnd()

Unsets the end-point of this CurveSegment

unsetStart

public void unsetStart()

Unsets the start-point of this CurveSegment

writeXMLAttributes

public java.util.Map<java.lang.String,java.lang.String> writeXMLAttributes()

Specified by:

writeXMLAttributes in interface SBase

Overrides:

writeXMLAttributes in class AbstractSBase