public class GeneralGlyph extends AbstractReferenceGlyph
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.ignoredExtensions, ignoredXMLElements, JSBML_WRONG_SBO_TERM, packageNamelistOfListeners, parent, resourceBundle| Constructor and Description |
|---|
GeneralGlyph() |
GeneralGlyph(GeneralGlyph generalGlyph)
Creates a new instance of
GeneralGlyph cloned from the given element. |
GeneralGlyph(int level,
int version)
Creates a new instance of
GeneralGlyph. |
GeneralGlyph(String id)
Creates a new instance of
GeneralGlyph. |
GeneralGlyph(String id,
int level,
int version)
Creates a new instance of
GeneralGlyph. |
| 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() |
CompartmentGlyph |
createCompartmentGlyph()
Creates a new
CompartmentGlyph element and adds it to the ListOfSubGlyphs list. |
CompartmentGlyph |
createCompartmentGlyph(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(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(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(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(String id)
Creates and adds a new
ReferenceGlyph. |
ReferenceGlyph |
createReferenceGlyphForList()
Creates a new
ReferenceGlyph element and adds it to the ListOfSubGlyphs list. |
ReferenceGlyph |
createReferenceGlyphForList(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(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(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(String id)
Creates a new
TextGlyph element and adds it to the ListOfSubGlyphs list. |
boolean |
equals(Object object) |
TreeNode |
getChildAt(int index) |
int |
getChildCount() |
Curve |
getCurve()
Gets the
Curve. |
ListOf<ReferenceGlyph> |
getListOfReferenceGlyphs()
Returns the
listOfReferenceGlyphs. |
ListOf<GraphicalObject> |
getListOfSubGlyphs()
Returns the listOfSubGlyphs.
|
int |
hashCode() |
void |
initDefaults()
Initializes the default values using the namespace.
|
boolean |
isSetCurve()
Returns
true if the Curve element is not null. |
boolean |
isSetListOfReferenceGlyphs()
Returns
true if the listOfReferenceGlyphs element is not null. |
boolean |
isSetListOfSubGlyphs()
Returns
true, if listOfSubGlyphs contains at least one element. |
boolean |
readAttribute(String attributeName,
String prefix,
String value) |
boolean |
removeGeneralGlyph(GraphicalObject subGlyph)
Removes an element from the listOfSubGlyphs.
|
void |
removeGeneralGlyph(int i)
Removes an element from the
listOfSubGlyphs at the given index. |
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)
Sets the
Curve. |
void |
setListOfReferenceGlyph(ListOf<ReferenceGlyph> listOfReferenceGlyph)
Sets the
listOfReferenceGlyphs. |
void |
setListOfSubGlyphs(ListOf<GraphicalObject> listOfSubGlyphs)
The listOfSubGlyphs is an optional list that can contain sub-glyphs of the
GeneralGlyph. |
boolean |
unsetListOfSubGlyphs()
Returns
true, if listOfSubGlyphs contain at least one element,
otherwise false |
void |
unsetReaction() |
Map<String,String> |
writeXMLAttributes() |
getNamedSBaseInstance, getReference, getReferenceInstance, getSBaseInstance, isSetReference, setNamedSBase, setReference, setSBase, unsetReferencecreateBoundingBox, createBoundingBox, createBoundingBox, createBoundingBox, getAllowsChildren, getBoundingBox, getMetaidRef, isIdMandatory, isSetBoundingBox, isSetMetaidRef, setBoundingBox, setMetaidRef, unsetBoundingBox, unsetMetaidRefisValidIdaddCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendAnnotation, appendAnnotation, appendNotes, appendNotes, checkAndSetPackageNamespaceAndVersion, checkAndSetPackageNamespaceAndVersion, checkAttribute, checkLevelAndVersionCompatibility, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getId, getIdManager, getLevel, getLevelAndVersion, getMetaId, getModel, getName, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetId, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetName, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, notifyChildChange, registerChild, removeCVTerm, removeCVTerm, setAnnotation, setAnnotation, setAnnotation, setHistory, setId, setLevel, setMetaId, setName, setNamespace, setNotes, setNotes, setPackageVersion, setParentSBML, setParentSBMLObject, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, toString, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetId, unsetMetaId, unsetName, unsetNamespace, unsetNotes, unsetPlugin, unsetSBOTermaddAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, children, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, getIndex, getListOfTreeNodeChangeListeners, getNumChildren, getRoot, getTreeNodeChangeListenerCount, getUserObject, indexOf, isCloningInProgress, isInvalidSBMLAllowed, isLeaf, isReadingInProgress, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, userObjectKeySetfinalize, getClass, notify, notifyAll, wait, wait, waitgetId, getName, isSetId, isSetName, setId, setName, unsetId, unsetNameaddCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendAnnotation, appendAnnotation, appendNotes, appendNotes, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, registerChild, removeCVTerm, removeCVTerm, removeTreeNodeChangeListener, setAnnotation, setAnnotation, setAnnotation, setHistory, setLevel, setMetaId, setNotes, setNotes, setPackageVersion, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, unsetNotes, unsetPlugin, unsetSBOTermaddAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, fireNodeRemovedEvent, firePropertyChange, getListOfTreeNodeChangeListeners, getRoot, getTreeNodeChangeListenerCount, getUserObject, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeUserObject, userObjectKeySetpublic GeneralGlyph()
public GeneralGlyph(int level,
int version)
GeneralGlyph.level - the SBML levelversion - the SBML versionpublic GeneralGlyph(GeneralGlyph generalGlyph)
GeneralGlyph cloned from the given element.generalGlyph - the GeneralGlyph to clone.public GeneralGlyph(String id)
GeneralGlyph.id - the idpublic GeneralGlyph(String id, int level, int version)
GeneralGlyph.id - the idlevel - the SBML levelversion - the SBML versionpublic void initDefaults()
initDefaults in class GraphicalObjectpublic boolean isSetListOfSubGlyphs()
true, if listOfSubGlyphs contains at least one element.true, if listOfSubGlyphs contains at least one element,
otherwise falsepublic ListOf<GraphicalObject> getListOfSubGlyphs()
public void setListOfSubGlyphs(ListOf<GraphicalObject> listOfSubGlyphs)
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.listOfSubGlyphs - the list of SubGlyphs to set.public boolean unsetListOfSubGlyphs()
true, if listOfSubGlyphs contain at least one element,
otherwise falsetrue, if listOfSubGlyphs contain at least one element,
otherwise falsepublic boolean addSubGlyph(GraphicalObject subGlyph)
GraphicalObject to the listOfSubGlyphs.
The listOfSubGlyphs is initialized if necessary.
subGlyph - the element to add to the listtrue (as specified by Collection.add(E))public boolean removeSubGlyph(GraphicalObject subGlyph)
subGlyph - the element to be removed from the listtrue if the list contained the specified elementList.remove(Object)public void removeSubGlyph(int i)
listOfSubGlyphs at the given index.i - the index where to remove the glyph.IndexOutOfBoundsException - if the listOf is not set or
if the index is out of bound (index < 0 || index > list.size)public void removeGeneralGlyph(int i)
listOfSubGlyphs at the given index.i - the index where to remove the glyph.public boolean removeGeneralGlyph(GraphicalObject subGlyph)
subGlyph - the element to be removed from the listtrue if the list contained the specified elementList.remove(Object)public ReferenceGlyph createReferenceGlyph()
ReferenceGlyph element and adds it to the ListOfSubGlyphs list.ReferenceGlyph instance.public TextGlyph createTextGlyph()
TextGlyph element and adds it to the ListOfSubGlyphs list.TextGlyph instance.public TextGlyph createTextGlyph(String id)
TextGlyph element and adds it to the ListOfSubGlyphs list.public ReferenceGlyph createReferenceGlyphForList()
ReferenceGlyph element and adds it to the ListOfSubGlyphs list.ReferenceGlyph element.public ReferenceGlyph createReferenceGlyphForList(String id)
ReferenceGlyph element and adds it to the ListOfSubGlyphs list.id - the id of the new ReferenceGlyph instance.ReferenceGlyph element.public SpeciesGlyph createSpeciesGlyph()
SpeciesGlyph element and adds it to the ListOfSubGlyphs list.SpeciesGlyph element.public SpeciesGlyph createSpeciesGlyph(String id)
SpeciesGlyph element and adds it to the ListOfSubGlyphs list.id - the id of the new SpeciesGlyph instance.SpeciesGlyph element.public SpeciesReferenceGlyph createSpeciesReferenceGlyph()
SpeciesReferenceGlyph element and adds it to the ListOfSubGlyphs list.SpeciesReferenceGlyph element.public SpeciesReferenceGlyph createSpeciesReferenceGlyph(String id)
SpeciesReferenceGlyph element and adds it to the ListOfSubGlyphs list.id - the id of the new SpeciesReferenceGlyph instance.SpeciesReferenceGlyph element.public CompartmentGlyph createCompartmentGlyph()
CompartmentGlyph element and adds it to the ListOfSubGlyphs list.CompartmentGlyph element.public CompartmentGlyph createCompartmentGlyph(String id)
CompartmentGlyph element and adds it to the ListOfSubGlyphs list.id - the id of the new CompartmentGlyph instance.CompartmentGlyph element.public GeneralGlyph createGeneralGlyph()
GeneralGlyph element and adds it to the ListOfSubGlyphs list.GeneralGlyph.public GeneralGlyph createGeneralGlyph(String id)
GeneralGlyph element and adds it to the ListOfSubGlyphs list.id - the id of the new GeneralGlyph instance.GeneralGlyph element.public ReactionGlyph createReactionGlyph()
ReactionGlyph element and adds it to the ListOfSubGlyphs list.ReactionGlyph element.public ReactionGlyph createReactionGlyph(String id)
ReactionGlyph element and adds it to the ListOfSubGlyphs list.id - the id of the new ReactionGlyph instance.ReactionGlyph element.public GraphicalObject createGraphicalObject()
GraphicalObject element and adds it to the ListOfSubGlyphs list.GraphicalObject element.public GraphicalObject createGraphicalObject(String id)
GraphicalObject element and adds it to the ListOfSubGlyphs list.id - the id of the new GraphicalObject instance.GraphicalObject element.public boolean addReferenceGlyph(ReferenceGlyph glyph)
listOfReferenceGlyphs.glyph - the glyph to be added.true (as specified by Collection.add(E))NullPointerException - if the specified element is null and this list does not
permit null elementsIllegalArgumentException - if some property of this element prevents it from being added
to this listpublic GeneralGlyph clone()
clone in interface SBaseclone in class AbstractReferenceGlyphpublic ReferenceGlyph createReferenceGlyph(String id)
ReferenceGlyph.id - the identifier for the ReferenceGlyph to be created.ReferenceGlyph.public boolean equals(Object object)
equals in interface SBaseequals in class AbstractReferenceGlyphpublic TreeNode getChildAt(int index)
getChildAt in interface TreeNodegetChildAt in class GraphicalObjectpublic int getChildCount()
getChildCount in interface TreeNodegetChildCount in class GraphicalObjectpublic ListOf<ReferenceGlyph> getListOfReferenceGlyphs()
listOfReferenceGlyphs.
If the listOfReferenceGlyphs has not yet been initialized, this
will be done by this method.
listOfReferenceGlyphspublic int hashCode()
hashCode in interface SBasehashCode in class AbstractReferenceGlyphpublic boolean isSetCurve()
true if the Curve element is not null.true if the Curve element is set.public boolean isSetListOfReferenceGlyphs()
true if the listOfReferenceGlyphs element is not null.true if the listOfReferenceGlyphs element is set.public boolean readAttribute(String attributeName, String prefix, String value)
readAttribute in interface SBasereadAttribute in class GraphicalObjectpublic void setCurve(Curve curve)
Curve.
This is an optional attribute of type Curve. If this is defined, then the
BoundingBox is to be ignored.
curve - the Curve instance to set.public void setListOfReferenceGlyph(ListOf<ReferenceGlyph> listOfReferenceGlyph)
listOfReferenceGlyphs.
The listOfReferenceGlyphs is optional, since conceivable the GeneralGlyph could
just contain a number of subglyphs. When present, it must include at least one ReferenceGlyph.
listOfReferenceGlyph - the list of ReferenceGlyph to set.public void unsetReaction()
public Map<String,String> writeXMLAttributes()
writeXMLAttributes in interface SBasewriteXMLAttributes in class GraphicalObjectCopyright © 2009–2017. All rights reserved.