org.sbml.jsbml.ext.layout

Class ReactionGlyph

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.AbstractNamedSBase

org.sbml.jsbml.ext.layout.GraphicalObject

org.sbml.jsbml.ext.layout.AbstractReferenceGlyph

org.sbml.jsbml.ext.layout.ReactionGlyph

All Implemented Interfaces:

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

public class ReactionGlyph
extends AbstractReferenceGlyph

Analogous to how a Reaction object has to at least have one reactant or product, the ReactionGlyph has to at least have one SpeciesReferenceGlyph stored in the ListOfSpeciesReferenceGlyphs. The ReactionGlyph inherits from GraphicalObject. In addition to the attributes inherited from GraphicalObject, the ReactionGlyph is described by an attribute reaction, a Curve element and a listOfSpeciesReferenceGlyphs element.

Since:

1.0

Version:

$Rev: 1921 $

Author:

Nicolas Rodriguez, Sebastian Frölich, Andreas Dräger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private Curve	curve
private ListOf<SpeciesReferenceGlyph>	listOfSpeciesReferencesGlyphs
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
ReactionGlyph()
ReactionGlyph(int level, int version)
ReactionGlyph(ReactionGlyph reactionGlyph)
ReactionGlyph(java.lang.String id)
ReactionGlyph(java.lang.String id, int level, int version)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addSpeciesReferenceGlyph(SpeciesReferenceGlyph glyph) Appends the specified element to the end of the listOfSpeciesReferencesGlyphs.
ReactionGlyph	clone() Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.
SpeciesReferenceGlyph	createSpeciesReferenceGlyph(java.lang.String id) Creates and adds a new SpeciesReferenceGlyph
SpeciesReferenceGlyph	createSpeciesReferenceGlyph(java.lang.String id, java.lang.String speciesGlyph) Creates and adds a new SpeciesReferenceGlyph
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()
Curve	getCurve()
ListOf<SpeciesReferenceGlyph>	getListOfSpeciesReferenceGlyphs() If the listOfSpeciesReferencesGlyphs has not yet been initialized, this will be done by this method.
java.lang.String	getReaction()
NamedSBase	getReactionInstance() Note that the return type of this method is NamedSBase because it could be possible to link some element from other packages to this glyph.
SpeciesReferenceGlyph	getSpeciesReferenceGlyph(int i)
SpeciesReferenceGlyph	getSpeciesReferenceGlyph(java.lang.String srGlyphId)
int	hashCode() Returns a hash code value for this SBase instance.
boolean	isSetCurve()
boolean	isSetListOfSpeciesReferencesGlyphs()
boolean	isSetReaction()
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value) Sets the given attribute in this SBase.
void	setCurve(Curve curve) The curve describes the center section of a ReactionGlyph.
void	setListOfSpeciesReferencesGlyph(ListOf<SpeciesReferenceGlyph> listOfSpeciesReferencesGlyph) Since the Species element can have several graphical representations in the layout there must be a way to specify which SpeciesGlyph should be connected to the ReactionGlyph.
void	setReaction(Reaction reaction) See setReaction(String)
void	setReaction(java.lang.String reaction) The reaction attribute is used to specify the id of the corresponding Reaction in the Model.
void	unsetListOfSpeciesReferencesGlyph()
void	unsetReaction()
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.ext.layout.AbstractReferenceGlyph

getNamedSBaseInstance, getReference, getReferenceInstance, isSetReference, setNamedSBase, setReference, setReference, toString, unsetReference

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

createBoundingBox, createBoundingBox, createBoundingBox, createBoundingBox, getAllowsChildren, getBoundingBox, getMetaidRef, isIdMandatory, isSetBoundingBox, isSetMetaidRef, setBoundingBox, setMetaidRef, unsetBoundingBox, unsetMetaidRef

Methods inherited from class org.sbml.jsbml.AbstractNamedSBase

getId, getName, isSetId, isSetName, isValidId, setId, setName, unsetId, unsetName

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, 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.NamedSBase

getId, getName, isSetId, isSetName, setId, setName, unsetId, unsetName

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

Field Detail

serialVersionUID

private static final long serialVersionUID

Generated serial version identifier.

See Also:

Constant Field Values

curve

private Curve curve

listOfSpeciesReferencesGlyphs

private ListOf<SpeciesReferenceGlyph> listOfSpeciesReferencesGlyphs

Constructor Detail

ReactionGlyph

public ReactionGlyph()

ReactionGlyph

public ReactionGlyph(int level,
             int version)

Parameters:

level -

version -

ReactionGlyph

public ReactionGlyph(ReactionGlyph reactionGlyph)

Parameters:

reactionGlyph -

ReactionGlyph

public ReactionGlyph(java.lang.String id)

Parameters:

id -

ReactionGlyph

public ReactionGlyph(java.lang.String id,
             int level,
             int version)

Parameters:

id -

level -

version -

Method Detail

addSpeciesReferenceGlyph

public boolean addSpeciesReferenceGlyph(SpeciesReferenceGlyph glyph)

Appends the specified element to the end of the listOfSpeciesReferencesGlyphs.

Parameters:

glyph -

Returns:

true (as specified by Collection#add(E))

Throws:

java.lang.NullPointerException - if the specified element is null and this list does not permit null elements

java.lang.IllegalArgumentException - if some property of this element prevents it from being added to this list

clone

public ReactionGlyph 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 AbstractReferenceGlyph

Returns:

a copy of this object

createSpeciesReferenceGlyph

public SpeciesReferenceGlyph createSpeciesReferenceGlyph(java.lang.String id)

Creates and adds a new SpeciesReferenceGlyph

Parameters:

id - the identifier for the SpeciesReferenceGlyph to be created.

Returns:

a new SpeciesReferenceGlyph.

createSpeciesReferenceGlyph

public SpeciesReferenceGlyph createSpeciesReferenceGlyph(java.lang.String id,
                                                java.lang.String speciesGlyph)

Creates and adds a new SpeciesReferenceGlyph

Parameters:

id - the identifier for the SpeciesReferenceGlyph to be created.

speciesGlyph - corresponding SpeciesGlyph ID.

Returns:

a new SpeciesReferenceGlyph that points to the given speciesGlyph.

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 AbstractReferenceGlyph

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 GraphicalObject

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface javax.swing.tree.TreeNode

Overrides:

getChildCount in class GraphicalObject

getCurve

public Curve getCurve()

Returns:

getListOfSpeciesReferenceGlyphs

public ListOf<SpeciesReferenceGlyph> getListOfSpeciesReferenceGlyphs()

If the listOfSpeciesReferencesGlyphs has not yet been initialized, this will be done by this method.

Returns:

the listOfSpeciesReferencesGlyphs

getReaction

public java.lang.String getReaction()

Returns:

getReactionInstance

public NamedSBase getReactionInstance()

Note that the return type of this method is NamedSBase because it could be possible to link some element from other packages to this glyph.

Returns:

getSpeciesReferenceGlyph

public SpeciesReferenceGlyph getSpeciesReferenceGlyph(int i)

Parameters:

i -

Returns:

getSpeciesReferenceGlyph

public SpeciesReferenceGlyph getSpeciesReferenceGlyph(java.lang.String srGlyphId)

Parameters:

srGlyphId -

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 AbstractReferenceGlyph

Returns:

a hash code value for this SBase instance.

See Also:

Object.hashCode()

isSetCurve

public boolean isSetCurve()

Returns:

isSetListOfSpeciesReferencesGlyphs

public boolean isSetListOfSpeciesReferencesGlyphs()

Returns:

isSetReaction

public boolean isSetReaction()

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 GraphicalObject

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.

setCurve

public void setCurve(Curve curve)

The curve describes the center section of a ReactionGlyph. The center section is frequently used by tools to separate the point where substrates arcs come together from the point where product arcs split off. The Curve is optional, and when not present the dimensions of the inherited BoundingBox describes the center section, by storing its position and dimension.

Parameters:

curve -

setListOfSpeciesReferencesGlyph

public void setListOfSpeciesReferencesGlyph(ListOf<SpeciesReferenceGlyph> listOfSpeciesReferencesGlyph)

Since the Species element can have several graphical representations in the layout there must be a way to specify which SpeciesGlyph should be connected to the ReactionGlyph. This is done using the listOfSpeciesReferenceGlyphs.

Parameters:

listOfSpeciesReferencesGlyph -

setReaction

public void setReaction(Reaction reaction)

See setReaction(String)

Parameters:

reaction -

setReaction

public void setReaction(java.lang.String reaction)

The reaction attribute is used to specify the id of the corresponding Reaction in the Model. This reference is optional.

Parameters:

reaction -

unsetListOfSpeciesReferencesGlyph

public void unsetListOfSpeciesReferencesGlyph()

unsetReaction

public void unsetReaction()

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 GraphicalObject

Returns:

a Map containing the XML attributes of this object.