org.sbml.jsbml.ext.layout

Class GraphicalObject

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.AbstractNamedSBase

org.sbml.jsbml.ext.layout.GraphicalObject

All Implemented Interfaces:

Serializable, Cloneable, TreeNode, NamedSBase, SBase, UniqueNamedSBase, TreeNodeWithChangeSupport

Direct Known Subclasses:

AbstractReferenceGlyph

public class GraphicalObject
extends AbstractNamedSBase
implements UniqueNamedSBase

All the more specific layout elements (CompartmentGlyph, GeneralGlyph, SpeciesGlyph, ReactionGlyph, ReferenceGlyph, TextGlyph, and SpeciesReferenceGlyph) are derived from the class GraphicalObject. Each object of class GraphicalObject has a mandatory BoundingBox, which specifies the position and the size of the object. While GraphicalObject is the base class for most elements in the Layout package, it is not an abstract class. It can be instantiated when used in the listOfAdditionalGraphicalObjects to describe additional elements and relationships. Since it only describes a BoundingBox, programs are encouraged to add Annotation objects that describe program-specific graphical information.

Since:

1.0

Version:

$Rev$

Author:

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

See Also:

Serialized Form

Field Summary

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
GraphicalObject()
GraphicalObject(GraphicalObject graphicalObject)
GraphicalObject(int level, int version)
GraphicalObject(String id)
GraphicalObject(String id, int level, int version)

Method Summary

Modifier and Type	Method and Description
GraphicalObject	clone()
BoundingBox	createBoundingBox() Creates and sets a BoundingBox for this object.
BoundingBox	createBoundingBox(Dimensions dimensions)
BoundingBox	createBoundingBox(double width, double height, double depth) Creates and sets a BoundingBox for this object, with the given parameters for Dimensions.
BoundingBox	createBoundingBox(double width, double height, double depth, double x, double y, double z) Creates and sets a BoundingBox for this object, with the given parameters for Dimensions and Point.
boolean	equals(Object object)
boolean	getAllowsChildren()
BoundingBox	getBoundingBox()
TreeNode	getChildAt(int index)
int	getChildCount()
String	getMetaidRef() Returns the value of metaidRef
int	hashCode()
boolean	isIdMandatory()
boolean	isSetBoundingBox()
boolean	isSetMetaidRef() Returns whether metaidRef is set
boolean	readAttribute(String attributeName, String prefix, String value)
void	setBoundingBox(BoundingBox boundingBox) This is the only required element (besides the SId) of the GraphicalObject.
void	setMetaidRef(String metaidRef) Sets the value of metaidRef which uniquely references elements in the model.
void	unsetBoundingBox()
boolean	unsetMetaidRef() Unsets the variable metaidRef
Map<String,String>	writeXMLAttributes()

Methods inherited from class org.sbml.jsbml.AbstractNamedSBase

getId, getName, isSetId, isSetName, isValidId, setId, setName, toString, 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

Constructor Detail

GraphicalObject

public GraphicalObject()

GraphicalObject

public GraphicalObject(GraphicalObject graphicalObject)

Parameters:

graphicalObject -

GraphicalObject

public GraphicalObject(int level,
                       int version)

Parameters:

level -

version -

GraphicalObject

public GraphicalObject(String id)

Parameters:

id -

GraphicalObject

public GraphicalObject(String id,
                       int level,
                       int version)

Parameters:

id -

level -

version -

Method Detail

clone

public GraphicalObject clone()

Specified by:

clone in interface SBase

Overrides:

clone in class AbstractSBase

createBoundingBox

public BoundingBox createBoundingBox()

Creates and sets a BoundingBox for this object.

Returns:

BoundingBox.

createBoundingBox

public BoundingBox createBoundingBox(Dimensions dimensions)

Parameters:

dimensions -

Returns:

createBoundingBox

public BoundingBox createBoundingBox(double width,
                                     double height,
                                     double depth)

Creates and sets a BoundingBox for this object, with the given parameters for Dimensions.

Parameters:

width -

height -

depth -

Returns:

BoundingBox.

createBoundingBox

public BoundingBox createBoundingBox(double width,
                                     double height,
                                     double depth,
                                     double x,
                                     double y,
                                     double z)

Creates and sets a BoundingBox for this object, with the given parameters for Dimensions and Point.

Parameters:

width -

height -

depth -

x -

y -

z -

Returns:

BoundingBox.

equals

public boolean equals(Object object)

Specified by:

equals in interface SBase

Overrides:

equals in class AbstractNamedSBase

getAllowsChildren

public boolean getAllowsChildren()

Specified by:

getAllowsChildren in interface TreeNode

Overrides:

getAllowsChildren in class AbstractSBase

getBoundingBox

public BoundingBox getBoundingBox()

Returns:

getChildAt

public TreeNode getChildAt(int index)

Specified by:

getChildAt in interface TreeNode

Overrides:

getChildAt in class AbstractSBase

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface TreeNode

Overrides:

getChildCount in class AbstractSBase

hashCode

public int hashCode()

Specified by:

hashCode in interface SBase

Overrides:

hashCode in class AbstractNamedSBase

isIdMandatory

public boolean isIdMandatory()

Specified by:

isIdMandatory in interface NamedSBase

isSetBoundingBox

public boolean isSetBoundingBox()

Returns:

setBoundingBox

public void setBoundingBox(BoundingBox boundingBox)

This is the only required element (besides the SId) of the GraphicalObject. Because this class is not an abstract class and can be instantiated, Annotation objects are encouraged to be added.

Parameters:

boundingBox -

unsetBoundingBox

public void unsetBoundingBox()

writeXMLAttributes

public Map<String,String> writeXMLAttributes()

Specified by:

writeXMLAttributes in interface SBase

Overrides:

writeXMLAttributes in class AbstractNamedSBase

getMetaidRef

public String getMetaidRef()

Returns the value of metaidRef

Returns:

the value of metaidRef

isSetMetaidRef

public boolean isSetMetaidRef()

Returns whether metaidRef is set

Returns:

whether metaidRef is set

setMetaidRef

public void setMetaidRef(String metaidRef)

Sets the value of metaidRef which uniquely references elements in the model.

Parameters:

metaidRef -

unsetMetaidRef

public boolean unsetMetaidRef()

Unsets the variable metaidRef

Returns:

true, if metaidRef was set before, otherwise false

readAttribute

public boolean readAttribute(String attributeName,
                             String prefix,
                             String value)

Specified by:

readAttribute in interface SBase

Overrides:

readAttribute in class AbstractNamedSBase