org.sbml.jsbml.ext.render

Class RenderCurveSegment

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.ext.render.RenderCurveSegment

All Implemented Interfaces:

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

Direct Known Subclasses:

RenderPoint

public abstract class RenderCurveSegment
extends AbstractSBase
implements Point3D

Parent class to RenderPoint and RenderCubicBezier.

Since:

1.2

Author:

Nicolas Rodriguez

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RenderCurveSegment.Type

Field Summary

Fields inherited from class org.sbml.jsbml.AbstractSBase

JSBML_WRONG_SBO_TERM

Constructor Summary

Constructors

Constructor and Description
RenderCurveSegment() Creates a new RenderCurveSegment instance.
RenderCurveSegment(int level, int version) Creates a new RenderCurveSegment instance.
RenderCurveSegment(RenderCurveSegment curveSegment) Creates a new RenderCurveSegment instance cloned from the given RenderCurveSegment.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object object) Returns true if and only if the given SBase has exactly the same properties like this SBase instance.
RenderCurveSegment.Type	getType() Returns the type.
int	hashCode() Returns a hash code value for this SBase instance.
boolean	isRenderCubicBezier() Returns true if the type is equals to RenderCurveSegment.Type.RENDER_CUBIC_BEZIER.
boolean	isRenderPoint() Returns true if the type is equals to RenderCurveSegment.Type.RENDER_POINT.
boolean	isSetType() Returns true if the type is set.
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value) Sets the given attribute in this SBase.
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, appendAnnotation, appendAnnotation, appendNotes, appendNotes, 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, getLevel, getLevelAndVersion, getMetaId, getModel, getName, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isIdMandatory, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetId, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetName, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, registerChild, removeCVTerm, removeCVTerm, removeDeclaredNamespaceByNamespace, removeDeclaredNamespaceByPrefix, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setAnnotation, setHistory, setId, setLevel, setMetaId, setName, setNamespace, setNotes, setNotes, setPackageVersion, 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, isLeaf, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, userObjectKeySet

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.sbml.jsbml.ext.render.Point3D

getX, getY, getZ, isSetX, isSetY, isSetZ, setX, setY, setZ, unsetX, unsetY, unsetZ

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

Constructor Detail

RenderCurveSegment

public RenderCurveSegment()

Creates a new RenderCurveSegment instance.

RenderCurveSegment

public RenderCurveSegment(RenderCurveSegment curveSegment)

Creates a new RenderCurveSegment instance cloned from the given RenderCurveSegment.

Parameters:

curveSegment - the RenderCurveSegment to clone

RenderCurveSegment

public RenderCurveSegment(int level,
                          int version)

Creates a new RenderCurveSegment instance.

Parameters:

level - the SBML level

version - the SBML version

Method Detail

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.

getType

public RenderCurveSegment.Type getType()

Returns the type.

Returns:

the type.

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

isRenderCubicBezier

public boolean isRenderCubicBezier()

Returns true if the type is equals to RenderCurveSegment.Type.RENDER_CUBIC_BEZIER.

Returns:

true if the type is equals to RenderCurveSegment.Type.RENDER_CUBIC_BEZIER.

isRenderPoint

public boolean isRenderPoint()

Returns true if the type is equals to RenderCurveSegment.Type.RENDER_POINT.

Returns:

true if the type is equals to RenderCurveSegment.Type.RENDER_POINT.

isSetType

public boolean isSetType()

Returns true if the type is set.

Returns:

true if the type is set.

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.

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.