java.io.Serializable
, java.lang.Cloneable
, javax.swing.tree.TreeNode
, IBoundingBox
, NamedSBase
, SBase
, UniqueNamedSBase
, UniqueSId
, TreeNodeWithChangeSupport
public class ReferenceGlyph extends AbstractReferenceGlyph
ReferenceGlyph
element describes the graphical connection between
an arbitrary GraphicalObject
(or derived element) and a
GeneralGlyph
(which would be an arrow or some curve in most cases).
A ReferenceGlyph
inherits from GraphicalObject
. Additionally,
it has a mandatory attribute 'glyph' and two optional attributes 'reference'
and 'role'. Optionally, the ReferenceGlyph also has an element 'curve'.
The ReferenceGlyph
should either contain a bounding box or a curve
specification. If both are given, the bounding box should be ignored.JSBML_WRONG_SBO_TERM
Constructor | Description |
---|---|
ReferenceGlyph() |
|
ReferenceGlyph(int level,
int version) |
|
ReferenceGlyph(java.lang.String id) |
|
ReferenceGlyph(java.lang.String id,
int level,
int version) |
|
ReferenceGlyph(ReferenceGlyph speciesReferenceGlyph) |
Modifier and Type | Method | Description |
---|---|---|
ReferenceGlyph |
clone() |
Creates a deep copy of this object, i.e., a new
SBase with the same
properties
like this one. |
Curve |
createCurve() |
|
boolean |
equals(java.lang.Object object) |
|
javax.swing.tree.TreeNode |
getChildAt(int index) |
|
int |
getChildCount() |
|
Curve |
getCurve() |
|
java.lang.String |
getGlyph() |
|
java.lang.String |
getRole() |
|
int |
hashCode() |
Returns a hash code value for this
SBase instance. |
void |
initDefaults() |
Initializes the default values using the namespace.
|
boolean |
isSetCurve() |
|
boolean |
isSetGlyph() |
|
boolean |
isSetReferenceInstance() |
|
boolean |
isSetRole() |
|
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 is an optional element of type
Curve . |
void |
setGlyph(java.lang.String glyph) |
It contains a reference to the id of a
GraphicalObject (or derived)
object that is to be connected to the GeneralGlyph . |
boolean |
setReference(java.lang.String reference) |
The reference is an optional attribute that is used to connect the
ReferenceGlyph with an element of the containing Model . |
void |
setRole(java.lang.String role) |
The role attribute is used to specify how the reference should be displayed.
|
boolean |
unsetCurve() |
|
void |
unsetGlyph() |
Unsets the
glyph attribute |
void |
unsetRole() |
Unsets the
role attribute |
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. |
isValidId
getNamedSBaseInstance, getReference, getReferenceInstance, getSBaseInstance, isSetReference, setNamedSBase, setSBase, unsetReference
addCVTerm, addDeclaredNamespace, addExtension, addPlugin, addResources, appendAnnotation, appendAnnotation, appendNotes, appendNotes, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAllDeclaredNamespaces, getAnnotation, getAnnotationString, 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, hasExtension, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, 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
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
createBoundingBox, createBoundingBox, createBoundingBox, createBoundingBox, getAllowsChildren, getBoundingBox, getMetaidRef, isIdMandatory, isSetBoundingBox, isSetMetaidRef, setBoundingBox, setMetaidRef, unsetBoundingBox, unsetMetaidRef
getId, getName, isSetId, isSetName, setId, setName, unsetId, unsetName
addCVTerm, 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, hasExtension, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, registerChild, removeCVTerm, removeCVTerm, removeDeclaredNamespaceByNamespace, removeDeclaredNamespaceByPrefix, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTreeNodeChangeListener, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setAnnotation, setHistory, setLevel, setMetaId, setNotes, setNotes, setPackageVersion, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, unsetNotes, unsetPlugin, unsetSBOTerm
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
public ReferenceGlyph()
public ReferenceGlyph(int level, int version)
level
- version
- public ReferenceGlyph(ReferenceGlyph speciesReferenceGlyph)
speciesReferenceGlyph
- public ReferenceGlyph(java.lang.String id)
id
- public ReferenceGlyph(java.lang.String id, int level, int version)
id
- level
- version
- public void initDefaults()
initDefaults
in class GraphicalObject
public ReferenceGlyph clone()
SBase
SBase
with the same
properties
like this one.clone
in interface SBase
clone
in class AbstractReferenceGlyph
public Curve createCurve()
public boolean equals(java.lang.Object object)
SBase
public javax.swing.tree.TreeNode getChildAt(int index)
getChildAt
in interface javax.swing.tree.TreeNode
getChildAt
in class GraphicalObject
public int getChildCount()
getChildCount
in interface javax.swing.tree.TreeNode
getChildCount
in class GraphicalObject
public Curve getCurve()
public java.lang.String getGlyph()
public java.lang.String getRole()
public int hashCode()
SBase
SBase
instance.hashCode
in interface SBase
hashCode
in class AbstractReferenceGlyph
SBase
instance.Object.hashCode()
public boolean isSetCurve()
public boolean isSetGlyph()
public boolean isSetRole()
public boolean isSetReferenceInstance()
public boolean readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value)
SBase
SBase
.
If the given attribute name is not recognized, nothing is done and
false
is returned.
readAttribute
in interface SBase
readAttribute
in class GraphicalObject
attributeName
- localName of the XML attributeprefix
- prefix of the XML attributevalue
- value of the XML attributetrue
if the attribute has been successfully read.public void setCurve(Curve curve)
Curve
. When present, the glyph’s BoundingBox
(as inherited from the GraphicalObject
) is to be disregarded. So as to make the drawing of
these curves as easy as possible the line segments should be ordered depending on the role of
the ReferenceGlyph
.
If the glyph represents a modification it should start at the glyph and end at the center of
the GeneralGlyph
.
Otherwise it should begin at the center section of the GeneralGlyph
and end at the reference
glyph.curve
- public void setRole(java.lang.String role)
role
- public void setGlyph(java.lang.String glyph)
GraphicalObject
(or derived)
object that is to be connected to the GeneralGlyph
. This attribute is
mandatory so as to ensure unambiguously which glyph has to be connected with
this GeneralGlyph
.glyph
- public boolean setReference(java.lang.String reference)
ReferenceGlyph
with an element of the containing Model
.setReference
in class AbstractReferenceGlyph
reference
- true
if this operation caused any change.public boolean unsetCurve()
public void unsetGlyph()
glyph
attributepublic void unsetRole()
role
attributepublic java.util.Map<java.lang.String,java.lang.String> writeXMLAttributes()
SBase
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.
writeXMLAttributes
in interface SBase
writeXMLAttributes
in class GraphicalObject
Map
containing the XML attributes of this object.