org.sbml.jsbml.ext.layout

Class GeneralGlyph

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.GeneralGlyph

All Implemented Interfaces:

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

public class GeneralGlyph
extends AbstractReferenceGlyph

The GeneralGlyph is used to facilitate the representation of elements other than Compartment, Species and Reaction and thus can be used for the display of relationships of Rule or elements defined by other SBML packages. It closely follows the structure of the ReactionGlyph. GeneralGlyph is defined to have an optional attribute reference as well as the elements curve, listOfReferenceGlyphs and listOfSubGlyphs.

Since:

1.0

Version:

$Rev: 1464 $

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<ReferenceGlyph>	listOfReferenceGlyphs
private ListOf<GraphicalObject>	listOfSubGlyphs
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
GeneralGlyph()
GeneralGlyph(GeneralGlyph generalGlyph)
GeneralGlyph(int level, int version)
GeneralGlyph(java.lang.String id)
GeneralGlyph(java.lang.String id, int level, int version)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addReferenceGlyph(ReferenceGlyph glyph) Appends the specified element to the end of the listOfReferenceGlyphs.
boolean	addSubGlyph(GraphicalObject subGlyph) Adds a new GraphicalObject to the listOfSubGlyphs.
GeneralGlyph	clone() Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.
CompartmentGlyph	createCompartmentGlyph() Creates a new CompartmentGlyph element and adds it to the ListOfSubGlyphs list
CompartmentGlyph	createCompartmentGlyph(java.lang.String id) Creates a new CompartmentGlyph element and adds it to the ListOfSubGlyphs list
GeneralGlyph	createGeneralGlyph() Creates a new GeneralGlyph element and adds it to the ListOfSubGlyphs list
GeneralGlyph	createGeneralGlyph(java.lang.String id) Creates a new GeneralGlyph element and adds it to the ListOfSubGlyphs list
GraphicalObject	createGraphicalObject() Creates a new GraphicalObject element and adds it to the ListOfSubGlyphs list
GraphicalObject	createGraphicalObject(java.lang.String id) Creates a new GraphicalObject element and adds it to the ListOfSubGlyphs list
ReactionGlyph	createReactionGlyph() Creates a new ReactionGlyph element and adds it to the ListOfSubGlyphs list
ReactionGlyph	createReactionGlyph(java.lang.String id) Creates a new ReactionGlyph element and adds it to the ListOfSubGlyphs list
ReferenceGlyph	createReferenceGlyph() Creates a new ReferenceGlyph element and adds it to the ListOfSubGlyphs list
ReferenceGlyph	createReferenceGlyph(java.lang.String id) Creates and adds a new ReferenceGlyph
ReferenceGlyph	createReferenceGlyphForList() Creates a new ReferenceGlyph element and adds it to the ListOfSubGlyphs list
ReferenceGlyph	createReferenceGlyphForList(java.lang.String id) Creates a new ReferenceGlyph element and adds it to the ListOfSubGlyphs list
SpeciesGlyph	createSpeciesGlyph() Creates a new SpeciesGlyph element and adds it to the ListOfSubGlyphs list
SpeciesGlyph	createSpeciesGlyph(java.lang.String id) Creates a new SpeciesGlyph element and adds it to the ListOfSubGlyphs list
SpeciesReferenceGlyph	createSpeciesReferenceGlyph() Creates a new SpeciesReferenceGlyph element and adds it to the ListOfSubGlyphs list
SpeciesReferenceGlyph	createSpeciesReferenceGlyph(java.lang.String id) Creates a new SpeciesReferenceGlyph element and adds it to the ListOfSubGlyphs list
TextGlyph	createTextGlyph() Creates a new TextGlyph element and adds it to the ListOfSubGlyphs list
TextGlyph	createTextGlyph(java.lang.String id) Creates a new TextGlyph element and adds it to the ListOfSubGlyphs list
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<ReferenceGlyph>	getListOfReferenceGlyphs() If the listOfReferenceGlyphs has not yet been initialized, this will be done by this method.
ListOf<GraphicalObject>	getListOfSubGlyphs() Returns the listOfSubGlyphs.
int	hashCode() Returns a hash code value for this SBase instance.
boolean	isSetCurve()
boolean	isSetListOfReferenceGlyphs()
boolean	isSetListOfSubGlyphs() Returns true, if listOfSubGlyphs contains at least one element.
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value) Sets the given attribute in this SBase.
void	removeGeneralGlyph(GraphicalObject subGlyph)
void	removeGeneralGlyph(int i)
boolean	removeSubGlyph(GraphicalObject subGlyph) Removes an element from the listOfSubGlyphs.
void	removeSubGlyph(int i) Removes an element from the listOfSubGlyphs at the given index.
void	setCurve(Curve curve) This is an optional attribute of type Curve.
void	setListOfReferenceGlyph(ListOf<ReferenceGlyph> listOfReferenceGlyph) The listOfReferenceGlyphs is optional, since conceivable the GeneralGlyph could just contain a number of subglyphs.
void	setListOfSubGlyphs(ListOf<GraphicalObject> listOfSubGlyphs) The listOfSubGlyphs is an optional list that can contain sub-glyphs of the GeneralGlyph.
private void	unsetListOfReferenceGlyph()
boolean	unsetListOfSubGlyphs() Returns true, if listOfSubGlyphs contain at least one element, otherwise false
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

listOfReferenceGlyphs

private ListOf<ReferenceGlyph> listOfReferenceGlyphs

listOfSubGlyphs

private ListOf<GraphicalObject> listOfSubGlyphs

Constructor Detail

GeneralGlyph

public GeneralGlyph()

GeneralGlyph

public GeneralGlyph(int level,
            int version)

Parameters:

level -

version -

GeneralGlyph

public GeneralGlyph(GeneralGlyph generalGlyph)

Parameters:

generalGlyph -

GeneralGlyph

public GeneralGlyph(java.lang.String id)

Parameters:

id -

GeneralGlyph

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

Parameters:

id -

level -

version -

Method Detail

isSetListOfSubGlyphs

public boolean isSetListOfSubGlyphs()

Returns true, if listOfSubGlyphs contains at least one element.

Returns:

true, if listOfSubGlyphs contains at least one element, otherwise false

getListOfSubGlyphs

public ListOf<GraphicalObject> getListOfSubGlyphs()

Returns the listOfSubGlyphs. Creates it if it is not already existing.

Returns:

the listOfSubGlyphs

setListOfSubGlyphs

public void setListOfSubGlyphs(ListOf<GraphicalObject> listOfSubGlyphs)

The listOfSubGlyphs is an optional list that can contain sub-glyphs of the GeneralGlyph. One example of its use could be a sub-module containing SpeciesGlyphs and ReactionGlyphs that are not necessarily part of the enclosing Model. Another example is an Event, visualized with its Trigger and additional GeneralGlyphs for its EventAssignment. The listOfSubGlyphs consists of GraphicalObjects or derived classes. Thus, unlike the listOfAdditionalGraphicalObjects (which may only contain GraphicalObject or GeneralGlyphs), the listOfSubGlyphs may contain any derived class, such as for example TextGlyph elements. Sets the given ListOf<GraphicalObject>. If listOfSubGlyphs was defined before and contains some elements, they are all unset.

Parameters:

listOfSubGlyphs -

unsetListOfSubGlyphs

public boolean unsetListOfSubGlyphs()

Returns true, if listOfSubGlyphs contain at least one element, otherwise false

Returns:

true, if listOfSubGlyphs contain at least one element, otherwise false

addSubGlyph

public boolean addSubGlyph(GraphicalObject subGlyph)

Adds a new GraphicalObject to the listOfSubGlyphs.

The listOfSubGlyphs is initialized if necessary.

Parameters:

subGlyph - the element to add to the list

Returns:

true (as specified by Collection.add)

removeSubGlyph

public boolean removeSubGlyph(GraphicalObject subGlyph)

Removes an element from the listOfSubGlyphs.

Parameters:

subGlyph - the element to be removed from the list

Returns:

true if the list contained the specified element

See Also:

List#remove(Object)

removeSubGlyph

public void removeSubGlyph(int i)

Removes an element from the listOfSubGlyphs at the given index.

Parameters:

i - the index where to remove the SubGlyph

Throws:

java.lang.IndexOutOfBoundsException - if the listOf is not set or if the index is out of bound (index < 0 || index > list.size)

removeGeneralGlyph

public void removeGeneralGlyph(int i)

removeGeneralGlyph

public void removeGeneralGlyph(GraphicalObject subGlyph)

createReferenceGlyph

public ReferenceGlyph createReferenceGlyph()

Creates a new ReferenceGlyph element and adds it to the ListOfSubGlyphs list

createTextGlyph

public TextGlyph createTextGlyph()

Creates a new TextGlyph element and adds it to the ListOfSubGlyphs list

createTextGlyph

public TextGlyph createTextGlyph(java.lang.String id)

Creates a new TextGlyph element and adds it to the ListOfSubGlyphs list

Returns:

a new TextGlyph element

createReferenceGlyphForList

public ReferenceGlyph createReferenceGlyphForList()

Creates a new ReferenceGlyph element and adds it to the ListOfSubGlyphs list

createReferenceGlyphForList

public ReferenceGlyph createReferenceGlyphForList(java.lang.String id)

Creates a new ReferenceGlyph element and adds it to the ListOfSubGlyphs list

Returns:

a new ReferenceGlyph element

createSpeciesGlyph

public SpeciesGlyph createSpeciesGlyph()

Creates a new SpeciesGlyph element and adds it to the ListOfSubGlyphs list

createSpeciesGlyph

public SpeciesGlyph createSpeciesGlyph(java.lang.String id)

Creates a new SpeciesGlyph element and adds it to the ListOfSubGlyphs list

Returns:

a new SpeciesGlyph element

createSpeciesReferenceGlyph

public SpeciesReferenceGlyph createSpeciesReferenceGlyph()

Creates a new SpeciesReferenceGlyph element and adds it to the ListOfSubGlyphs list

createSpeciesReferenceGlyph

public SpeciesReferenceGlyph createSpeciesReferenceGlyph(java.lang.String id)

Creates a new SpeciesReferenceGlyph element and adds it to the ListOfSubGlyphs list

Returns:

a new SpeciesReferenceGlyph element

createCompartmentGlyph

public CompartmentGlyph createCompartmentGlyph()

Creates a new CompartmentGlyph element and adds it to the ListOfSubGlyphs list

createCompartmentGlyph

public CompartmentGlyph createCompartmentGlyph(java.lang.String id)

Creates a new CompartmentGlyph element and adds it to the ListOfSubGlyphs list

Returns:

a new CompartmentGlyph element

createGeneralGlyph

public GeneralGlyph createGeneralGlyph()

Creates a new GeneralGlyph element and adds it to the ListOfSubGlyphs list

createGeneralGlyph

public GeneralGlyph createGeneralGlyph(java.lang.String id)

Creates a new GeneralGlyph element and adds it to the ListOfSubGlyphs list

Returns:

a new GeneralGlyph element

createReactionGlyph

public ReactionGlyph createReactionGlyph()

Creates a new ReactionGlyph element and adds it to the ListOfSubGlyphs list

createReactionGlyph

public ReactionGlyph createReactionGlyph(java.lang.String id)

Creates a new ReactionGlyph element and adds it to the ListOfSubGlyphs list

Returns:

a new ReactionGlyph element

createGraphicalObject

public GraphicalObject createGraphicalObject()

Creates a new GraphicalObject element and adds it to the ListOfSubGlyphs list

createGraphicalObject

public GraphicalObject createGraphicalObject(java.lang.String id)

Creates a new GraphicalObject element and adds it to the ListOfSubGlyphs list

Returns:

a new GraphicalObject element

addReferenceGlyph

public boolean addReferenceGlyph(ReferenceGlyph glyph)

Appends the specified element to the end of the listOfReferenceGlyphs.

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

createReferenceGlyph

public ReferenceGlyph createReferenceGlyph(java.lang.String id)

Creates and adds a new ReferenceGlyph

Parameters:

id - the identifier for the ReferenceGlyph to be created.

Returns:

a new ReferenceGlyph.

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:

getListOfReferenceGlyphs

public ListOf<ReferenceGlyph> getListOfReferenceGlyphs()

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

Returns:

the listOfReferenceGlyphs

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:

isSetListOfReferenceGlyphs

public boolean isSetListOfReferenceGlyphs()

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)

This is an optional attribute of type Curve. If this is defined, then the BoundingBox is to be ignored.

Parameters:

curve -

setListOfReferenceGlyph

public void setListOfReferenceGlyph(ListOf<ReferenceGlyph> listOfReferenceGlyph)

The listOfReferenceGlyphs is optional, since conceivable the GeneralGlyph could just contain a number of subglyphs. When present, it must include at least one ReferenceGlyph.

Parameters:

listOfReferenceGlyph -

unsetListOfReferenceGlyph

private void unsetListOfReferenceGlyph()

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.