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

Version:

$Rev: 1904 $

Author:

Sebastian Fr&oum;hlich, Nicolas Rodriguez

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CurveSegment.Type

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.log4j.Logger	logger
private static long	serialVersionUID Generated serial version identifier.
private CurveSegment.Type	type

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

Method Summary

Methods

Modifier and Type	Method and 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) Returns true if and only if the given SBase has exactly the same properties like this SBase instance.
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() Returns a hash code value for this SBase instance.
private void	initDefaults()
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) Sets the given attribute in this SBase.
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.
(package private) void	setType(CurveSegment.Type type) Sets the CurveSegment.Type of this CurveSegment to LineSegment or CubicBezier.
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.AbstractSBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendNotes, appendNotes, checkLevelAndVersionCompatibility, clone, 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, toString, 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

logger

private org.apache.log4j.Logger logger

type

private CurveSegment.Type type

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)

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 AbstractSBase

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.

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()

Description copied from interface: SBase

Returns a hash code value for this SBase instance.

Specified by:

hashCode in interface SBase

Overrides:

hashCode in class AbstractSBase

Returns:

a hash code value for this SBase instance.

See Also:

Object.hashCode()

initDefaults

private void initDefaults()

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)

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 AbstractSBase

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.

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:

start - 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

setType

void setType(CurveSegment.Type type)

Sets the CurveSegment.Type of this CurveSegment to LineSegment or CubicBezier.

Parameters:

type -

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 AbstractSBase

Returns:

a Map containing the XML attributes of this object.