org.sbml.jsbml.ext.layout

Class BoundingBox

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.AbstractNamedSBase

org.sbml.jsbml.ext.layout.BoundingBox

All Implemented Interfaces:

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

public class BoundingBox
extends AbstractNamedSBase
implements UniqueNamedSBase

The BoundingBox class specifies the required elements position and dimension. The class describes the rectangular area by which other classes of the Layout package will be situated.

Since:

1.0

Version:

$Rev: 1885 $

Author:

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private Dimensions	dimensions
private static org.apache.log4j.Logger	logger A Logger for this class.
private Point	position
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
BoundingBox()
BoundingBox(BoundingBox boundingBox)
BoundingBox(int level, int version)
BoundingBox(java.lang.String id)
BoundingBox(java.lang.String id, int level, int version)

Method Summary

Methods

Modifier and Type	Method and Description
BoundingBox	clone() Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.
Dimensions	createDimensions() Creates, sets and returns a Dimensions
Dimensions	createDimensions(double width, double height, double depth) Creates, sets and returns Dimensions based on the given values.
Point	createPosition() Creates, sets and returns a Point
Point	createPosition(double x, double y, double z) Creates, sets and returns a Point based on the given values.
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()
Dimensions	getDimensions()
Point	getPosition()
int	hashCode() Returns a hash code value for this SBase instance.
private void	init()
boolean	isIdMandatory() This method can be used to query if the identifier of this NamedSBase is required to be defined (i.e., not null) in the definition of SBML.
boolean	isSetDimensions()
boolean	isSetPosition()
void	setDimensions(Dimensions dimensions) The dimensions element is required and of type Dimensions.
void	setPosition(Point point) Position always specifies the upper left corner of the BoundingBox.
java.lang.String	toString() Returns the name of the component, if it is available.
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.AbstractNamedSBase

getId, getName, isSetId, isSetName, isValidId, readAttribute, 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, getAllowsChildren, 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, readAttribute, 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, getAllowsChildren, getIndex, getParent, isLeaf

Field Detail

serialVersionUID

private static final long serialVersionUID

Generated serial version identifier.

See Also:

Constant Field Values

logger

private static final org.apache.log4j.Logger logger

A Logger for this class.

dimensions

private Dimensions dimensions

position

private Point position

Constructor Detail

BoundingBox

public BoundingBox()

BoundingBox

public BoundingBox(BoundingBox boundingBox)

Parameters:

boundingBox -

BoundingBox

public BoundingBox(int level,
           int version)

Parameters:

level -

version -

BoundingBox

public BoundingBox(java.lang.String id)

Parameters:

id -

BoundingBox

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

Parameters:

id -

level -

version -

Method Detail

clone

public BoundingBox 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 AbstractSBase

Returns:

a copy of this object

createDimensions

public Dimensions createDimensions()

Creates, sets and returns a Dimensions

Returns:

new Dimensions object.

createDimensions

public Dimensions createDimensions(double width,
                          double height,
                          double depth)

Creates, sets and returns Dimensions based on the given values.

Parameters:

width -

height -

depth -

Returns:

new Dimensions object.

createPosition

public Point createPosition()

Creates, sets and returns a Point

Returns:

new Point object.

createPosition

public Point createPosition(double x,
                   double y,
                   double z)

Creates, sets and returns a Point based on the given values.

Parameters:

x -

y -

z -

Returns:

new Point object.

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 AbstractNamedSBase

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 AbstractSBase

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface javax.swing.tree.TreeNode

Overrides:

getChildCount in class AbstractSBase

getDimensions

public Dimensions getDimensions()

Returns:

getPosition

public Point getPosition()

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 AbstractNamedSBase

Returns:

a hash code value for this SBase instance.

See Also:

Object.hashCode()

init

private void init()

isIdMandatory

public boolean isIdMandatory()

Description copied from interface: NamedSBase

This method can be used to query if the identifier of this NamedSBase is required to be defined (i.e., not null) in the definition of SBML.

Specified by:

isIdMandatory in interface NamedSBase

Returns:

true if the identifier of this element must be set in order to create a valid SBML representation. false otherwise, i.e., if the identifier can be understood as an optional attribute.

isSetDimensions

public boolean isSetDimensions()

Returns:

isSetPosition

public boolean isSetPosition()

Returns:

setDimensions

public void setDimensions(Dimensions dimensions)

The dimensions element is required and of type Dimensions. It represents the size of the BoundingBox.

Parameters:

dimensions -

setPosition

public void setPosition(Point point)

Position always specifies the upper left corner of the BoundingBox. The position is of type Point.

Parameters:

point -

toString

public java.lang.String toString()

Description copied from class: AbstractNamedSBase

Returns the name of the component, if it is available. Otherwise, the identifier is returned. If both is not possible, the class name of this element is returned.

Overrides:

toString in class AbstractNamedSBase

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 AbstractNamedSBase

Returns:

a Map containing the XML attributes of this object.