org.sbml.jsbml.ext.layout

Class LineSegment

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.ext.layout.CurveSegment

org.sbml.jsbml.ext.layout.LineSegment

All Implemented Interfaces:

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

Direct Known Subclasses:

CubicBezier

public class LineSegment
extends CurveSegment

The LineSegment class consists of the mandatory attribute xsi:type and two child elements of type Point. One is called 'start' and represents the starting point of the line, the other is called 'end' and represents the endpoint of the line. The LineSegment class is also the base class for CubicBezier, which represent curved lines instead of straight ones.

Since:

1.0

Version:

$Rev: 1885 $

Author:

Nicolas Rodriguez, Andreas Dräger

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.sbml.jsbml.ext.layout.CurveSegment

CurveSegment.Type

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Point	end
private static long	serialVersionUID Generated serial version identifier.
(package private) Point	start

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
LineSegment()
LineSegment(CurveSegment lineSegment)
LineSegment(int level, int version)
LineSegment(LineSegment lineSegment)

Method Summary

Methods

Modifier and Type	Method and Description
LineSegment	clone() Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.
Point	createEnd() Creates, sets and returns a Point
Point	createEnd(double x, double y, double z) Creates, sets and returns a Point based on the given values.
Point	createStart() Creates, sets and returns a Point
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) 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()
Point	getEnd() Returns the End Point of this CurveSegment.
Point	getStart() Returns the Start Point of this CurveSegment.
int	hashCode() Returns a hash code value for this SBase instance.
boolean	isSetEnd() Returns true if the End Point is set.
boolean	isSetStart() Returns true if the Start Point is set.
void	setEnd(Point end) Sets the End Point of this CurveSegment.
void	setStart(Point start) Sets the Start Point of this CurveSegment.
java.lang.String	toString()

Methods inherited from class org.sbml.jsbml.ext.layout.CurveSegment

getType, isCubicBezier, isLineSegment, isSetType, readAttribute, removeEnd, removeStart, setType, 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

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

Generated serial version identifier.

See Also:

Constant Field Values

end

Point end

start

Point start

Constructor Detail

LineSegment

public LineSegment()

LineSegment

public LineSegment(int level,
           int version)

Parameters:

level -

version -

LineSegment

public LineSegment(LineSegment lineSegment)

Parameters:

lineSegment -

LineSegment

public LineSegment(CurveSegment lineSegment)

Parameters:

lineSegment -

Method Detail

clone

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

createEnd

public Point createEnd()

Creates, sets and returns a Point

Specified by:

createEnd in class CurveSegment

Returns:

new Point object.

createEnd

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

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

Specified by:

createEnd in class CurveSegment

Parameters:

x -

y -

z -

Returns:

new Point object.

createStart

public Point createStart()

Creates, sets and returns a Point

Specified by:

createStart in class CurveSegment

Returns:

new Point object.

createStart

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

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

Specified by:

createStart in class CurveSegment

Parameters:

x -

y -

z -

Returns:

new Point object.

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 CurveSegment

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

getEnd

public Point getEnd()

Description copied from class: CurveSegment

Returns the End Point of this CurveSegment.

Specified by:

getEnd in class CurveSegment

Returns:

the End Point of this CurveSegment.

getStart

public Point getStart()

Description copied from class: CurveSegment

Returns the Start Point of this CurveSegment.

Specified by:

getStart in class CurveSegment

Returns:

the Start Point of this CurveSegment.

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 CurveSegment

Returns:

a hash code value for this SBase instance.

See Also:

Object.hashCode()

isSetEnd

public boolean isSetEnd()

Description copied from class: CurveSegment

Returns true if the End Point is set.

Specified by:

isSetEnd in class CurveSegment

Returns:

true if the End Point is set.

isSetStart

public boolean isSetStart()

Description copied from class: CurveSegment

Returns true if the Start Point is set.

Specified by:

isSetStart in class CurveSegment

Returns:

true if the Start Point is set.

setEnd

public void setEnd(Point end)

Description copied from class: CurveSegment

Sets the End Point of this CurveSegment.

Specified by:

setEnd in class CurveSegment

setStart

public void setStart(Point start)

Description copied from class: CurveSegment

Sets the Start Point of this CurveSegment.

Specified by:

setStart in class CurveSegment

Parameters:

start - the Start Point to set

toString

public java.lang.String toString()

Specified by:

toString in class AbstractSBase