g2d.graph

Class IOPNode

java.lang.Object

g2d.jlambda.Identifiable

g2d.jlambda.Attributable

g2d.glyph.Glyphish

g2d.graph.GraphItem

g2d.graph.IOPNode

All Implemented Interfaces:

java.awt.event.KeyListener, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.lang.Comparable<IOPNode>, java.util.EventListener

public class IOPNode
extends GraphItem
implements java.lang.Comparable<IOPNode>

A node object for IOPGraph. Nodes are distinguished uniquely by their id. The id is set at construction time and is used for testing of equality. The id must be non-null otherwise runtime exceptions are thrown.

A node consists of a rectangular base glyph and a label (if not "") that is drawn as text above the base glyph. The label is always centered on top of the base. The base can have the shape of a rectangle/box or an ellipse. Following is a table showing which methods pertain to the base, label, and whole node.

A very old table; destined to be binned

rectangular base	setNodeShape(java.lang.String) and getNodeShape() setFillColor(java.awt.Color) and getFillColor() setBorderColor(java.awt.Color) and getBorderColor() setBaseDimension(double, double) setBaseCenter(java.awt.geom.Point2D) getBaseFrame()
textual label	setLabel(java.lang.String) and getLabel()
whole node	setCenter(java.awt.geom.Point2D) and getCenter() getWidth() getHeight() getPosition()

Since:

August 2004

Author:

Ben Funnell 2004, Linda (rewriting and more documentation) 2005, Ian genericized it in January 2007., Ian incorporated Dot's shapes and rendering in November 2011, Ian elevated Dot's rendering in February 2013, Ian exorcised Essences in October 2014

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IOPNode.NodeType

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Comparator<IOPNode>	COMPARATOR
DotNodeAttributes	dotNodeAttributes
g2d.graph.xdotparser.visitor.xDotNode	dotRendering
java.lang.String	id
java.lang.String	longName
static java.util.Comparator<IOPNode>	OCC_COMPARATOR
protected int	peripheries
static int	PERIPHERIES_DEFAULT
static java.util.Comparator<IOPNode>	RULE_COMPARATOR
protected Seed	seed
java.lang.String	shortName
IOPNode.NodeType	type

Fields inherited from class g2d.graph.GraphItem

antiAliased, gid, glyphList, HIGHLIGHT, HIGHLIGHT_OFFSET, highlighted

Fields inherited from class g2d.glyph.Glyphish

DEBUG

Constructor Summary

Constructors

Constructor and Description
IOPNode(IOPNode.NodeType type, java.lang.String id)
IOPNode(IOPNode.NodeType type, java.lang.String nodeId, java.lang.String shortName, java.lang.String longName) Make a node with the final bits.
IOPNode(IOPNode.NodeType type, java.lang.String nodeId, java.lang.String shortName, java.lang.String longName, DotNodeAttributes nattrs)
IOPNode(IOPNode.NodeType type, java.lang.String nodeId, java.lang.String shortName, java.lang.String longName, java.lang.String label, java.lang.String shape, java.awt.Color borderColor, java.awt.Color fillColor, int peripheries)
IOPNode(IOPNode clone) Construct a node cloning the given node.
IOPNode(java.lang.String id) Construct default node with given id and no label.
IOPNode(java.lang.String id, boolean interim)
IOPNode(java.lang.String longName, DotNodeAttributes nattrs)
IOPNode(java.lang.String id, int peripheries) Construct default node with given id and no label.
IOPNode(java.lang.String id, java.lang.String shape)
IOPNode(java.lang.String nodeId, java.lang.String longName, DotNodeAttributes nattrs)
IOPNode(java.lang.String id, java.lang.String label, java.lang.String shape, java.awt.Color borderColor, java.awt.Color fillColor) Construct node with given id and label and use given attributes to create node base.
IOPNode(java.lang.String id, java.lang.String label, java.lang.String shape, java.awt.Color borderColor, java.awt.Color fillColor, boolean interim) Construct node with given id and label and use given attributes to create node base.
IOPNode(java.lang.String id, java.lang.String label, java.lang.String shape, java.awt.Color borderColor, java.awt.Color fillColor, int peripheries) Construct node with given id and label and use given attributes to create node base.
IOPNode(java.lang.String id, java.lang.String label, java.lang.String shape, java.awt.Color borderColor, java.awt.Color fillColor, int peripheries, boolean interim)

Method Summary

Modifier and Type	Method and Description
java.lang.String	_toDotString()
static int	compareNodes(IOPNode n0, IOPNode n1)
int	compareTo(IOPNode in)
static int	compareToAsOcc(IOPNode n0, IOPNode n1)
static int	compareToAsRule(IOPNode n0, IOPNode n1)
void	dehighlight() Revert highlighting to previous state (if any).
java.lang.String	deprecated_toDotString()
double	distanceTo(java.awt.geom.Point2D p) Calculate distance from this node to given point.
boolean	equals(java.lang.Object o) Two nodes are equal if their id is the same.
java.awt.geom.Rectangle2D	getBaseFrame() Get rectangle of frame that defines shape of node base.
java.awt.Color	getBorderColor() Get the border color
java.awt.geom.Point2D	getCenter() Obtain center point of this node in double precision.
java.awt.Color	getFillColor() Get color used for filling the node base.
double	getHeight() Get height of node (including base and label) in double precision.
java.lang.String	getLabel() Get text of node label.
java.lang.String	getName() Get the id of this node.
java.lang.String	getNodeShape() Get a string describing the shape of the node base.
java.awt.geom.Point2D	getPosition() Get position of node as the top-left corner.
double	getWidth() Get width of node (including base and label) in double precision.
int	hashCode() Overriding method to comply with equals(Object).
void	highlight() Highlight this node or edge.
static IOPNode	makeOcc(java.lang.String nodeId, java.lang.String shortLabel, java.lang.String longLabel, DotNodeAttributes nattrs)
static IOPNode	makeOcc(java.lang.String nodeId, java.lang.String shortLabel, java.lang.String longLabel, java.lang.String shape, java.awt.Color color, java.awt.Color fillColor)
static IOPNode	makeOcc(java.lang.String nodeId, java.lang.String shortLabel, java.lang.String longLabel, java.lang.String shape, java.awt.Color color, java.awt.Color fillColor, int peripheries)
static IOPNode	makeRule(java.lang.String nodeId, java.lang.String shortLabel, java.lang.String longLabel, DotNodeAttributes nattrs)
static IOPNode	makeRule(java.lang.String nodeId, java.lang.String shortLabel, java.lang.String longLabel, java.lang.String shape, java.awt.Color color, java.awt.Color fillColor)
static IOPNode	makeRule(java.lang.String nodeId, java.lang.String shortLabel, java.lang.String longLabel, java.lang.String shape, java.awt.Color color, java.awt.Color fillColor, int peripheries)
protected void	mimic(IOPNode doppel)
void	paint(java.awt.Graphics2D g2d)
protected void	revert(java.awt.geom.Point2D center)
Glyph	scaleBase(int thickness) Produces a glyph that is simply the scale of the current base glyph.
void	setBaseCenter(java.awt.geom.Point2D center) Set position of node base to given center point.
void	setBaseDimension(double width, double height) Set size of node base.
void	setBorderColor(java.awt.Color color) Set the border color of the node base.
void	setCenter(java.awt.geom.Point2D center) Move this node to given center point.
void	setDotLayout(IOPGraph graph, java.awt.geom.Point2D center, double width, double height, java.lang.String _draw_, java.lang.String _ldraw_, double graphHeight)
void	setFillColor(java.awt.Color color) Set the fill color of the node base.
void	setLabel(java.lang.String label) Set the text of node label.
void	setNodeShape(java.lang.String shape) Set the shape of the node base.
void	setNodeShape(g2d.graph.xdotparser.visitor.xDotNode hints)
protected void	setRendering(g2d.graph.xdotparser.visitor.xDotNode info)
java.awt.Shape	string2Shape(java.lang.String shape, double x, double y, double width, double height)
java.lang.String	toDotString()
java.lang.String	toString()
void	updateFillColor()

Methods inherited from class g2d.graph.GraphItem

getBounds, gid, inside, intersects, isHighlighted, isSelected, setSelected, transform

Methods inherited from class g2d.glyph.Glyphish

keyPressed, keyReleased, keyTyped, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, rotate, rotate, scale, setKeyAction, setMouseAction, shear, translate, unsetMouseAction

Methods inherited from class g2d.jlambda.Attributable

_getAttribute, _setAttribute, getAttribute, getAttributeAsBoolean, getAttributeAsByte, getAttributeAsChar, getAttributeAsClosure, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsShort, getAttributeAsString, getKeys, getStaticAttribute, getStaticKeys, isAttribute, isStaticAttribute, removeAllAttributes, removeAllStaticAttributes, removeAttribute, removeStaticAttribute, setAttribute, setStaticAttribute, showAttributes, showAttributes

Methods inherited from class g2d.jlambda.Identifiable

getObject, getUID, setUID, setUID, unsetUID, unsetUID

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

type

public final IOPNode.NodeType type

id

public final java.lang.String id

longName

public final java.lang.String longName

shortName

public final java.lang.String shortName

PERIPHERIES_DEFAULT

public static int PERIPHERIES_DEFAULT

peripheries

protected int peripheries

dotRendering

public g2d.graph.xdotparser.visitor.xDotNode dotRendering

dotNodeAttributes

public DotNodeAttributes dotNodeAttributes

seed

protected Seed seed

COMPARATOR

public static java.util.Comparator<IOPNode> COMPARATOR

RULE_COMPARATOR

public static java.util.Comparator<IOPNode> RULE_COMPARATOR

OCC_COMPARATOR

public static java.util.Comparator<IOPNode> OCC_COMPARATOR

Constructor Detail

IOPNode

public IOPNode(IOPNode.NodeType type,
               java.lang.String nodeId,
               java.lang.String shortName,
               java.lang.String longName)

Make a node with the final bits.

Parameters:

type - one of the IOPNode.NodeType

nodeId - the nodes id, can be null, in which case we use its gid.

shortName - the short display name

longName - the long display name

IOPNode

public IOPNode(java.lang.String id)

Construct default node with given id and no label.

Parameters:

id - String identifying node

IOPNode

public IOPNode(IOPNode.NodeType type,
               java.lang.String id)

IOPNode

public IOPNode(java.lang.String nodeId,
               java.lang.String longName,
               DotNodeAttributes nattrs)

IOPNode

public IOPNode(java.lang.String longName,
               DotNodeAttributes nattrs)

IOPNode

public IOPNode(IOPNode.NodeType type,
               java.lang.String nodeId,
               java.lang.String shortName,
               java.lang.String longName,
               DotNodeAttributes nattrs)

IOPNode

public IOPNode(IOPNode.NodeType type,
               java.lang.String nodeId,
               java.lang.String shortName,
               java.lang.String longName,
               java.lang.String label,
               java.lang.String shape,
               java.awt.Color borderColor,
               java.awt.Color fillColor,
               int peripheries)

IOPNode

public IOPNode(java.lang.String id,
               int peripheries)

Construct default node with given id and no label.

Parameters:

id - String identifying node

peripheries - the number of peripheries

IOPNode

public IOPNode(java.lang.String id,
               java.lang.String shape)

IOPNode

public IOPNode(java.lang.String id,
               boolean interim)

IOPNode

public IOPNode(java.lang.String id,
               java.lang.String label,
               java.lang.String shape,
               java.awt.Color borderColor,
               java.awt.Color fillColor)

Construct node with given id and label and use given attributes to create node base.

Parameters:

id - String identifying node

label - String with label for node

shape - String defining shape of node base (such as "box", "rectangle", or "ellipse" [default value])

borderColor - Color of node base border

fillColor - Color used for filling node base

IOPNode

public IOPNode(java.lang.String id,
               java.lang.String label,
               java.lang.String shape,
               java.awt.Color borderColor,
               java.awt.Color fillColor,
               boolean interim)

Construct node with given id and label and use given attributes to create node base.

Parameters:

id - String identifying node

label - String with label for node

shape - String defining shape of node base (such as "box", "rectangle", or "ellipse" [default value])

borderColor - Color of node base border

fillColor - Color used for filling node base

interim - indicates that data will soon be augmented by dot layout info, so ...

IOPNode

public IOPNode(java.lang.String id,
               java.lang.String label,
               java.lang.String shape,
               java.awt.Color borderColor,
               java.awt.Color fillColor,
               int peripheries,
               boolean interim)

IOPNode

public IOPNode(java.lang.String id,
               java.lang.String label,
               java.lang.String shape,
               java.awt.Color borderColor,
               java.awt.Color fillColor,
               int peripheries)

Construct node with given id and label and use given attributes to create node base.

Parameters:

id - String identifying node

label - String with label for node

shape - String defining shape of node base (such as "box", "rectangle", or "ellipse" [default value])

borderColor - Color of node base border

fillColor - Color used for filling node base

peripheries - the number of borders the node exhibits.

IOPNode

public IOPNode(IOPNode clone)

Construct a node cloning the given node. The resulting new node will have the same id, same label, and same node base (w.r.t. shape, colors, size, position) of the given node to clone. It also inherits all attributes from the clone.

Parameters:

clone - IOPNode to be cloned

Method Detail

setRendering

protected void setRendering(g2d.graph.xdotparser.visitor.xDotNode info)

setDotLayout

public void setDotLayout(IOPGraph graph,
                         java.awt.geom.Point2D center,
                         double width,
                         double height,
                         java.lang.String _draw_,
                         java.lang.String _ldraw_,
                         double graphHeight)

mimic

protected void mimic(IOPNode doppel)

revert

protected void revert(java.awt.geom.Point2D center)

getName

public java.lang.String getName()

Get the id of this node. Will never return null.

Returns:

String with id of this node

getCenter

public java.awt.geom.Point2D getCenter()

Obtain center point of this node in double precision.

Returns:

Point that denotes center of this node

See Also:

setCenter(java.awt.geom.Point2D)

setCenter

public void setCenter(java.awt.geom.Point2D center)

Move this node to given center point.

Parameters:

center - Point that denotes new center of this node

See Also:

getCenter()

makeOcc

public static IOPNode makeOcc(java.lang.String nodeId,
                              java.lang.String shortLabel,
                              java.lang.String longLabel,
                              DotNodeAttributes nattrs)

makeOcc

public static IOPNode makeOcc(java.lang.String nodeId,
                              java.lang.String shortLabel,
                              java.lang.String longLabel,
                              java.lang.String shape,
                              java.awt.Color color,
                              java.awt.Color fillColor)

makeOcc

public static IOPNode makeOcc(java.lang.String nodeId,
                              java.lang.String shortLabel,
                              java.lang.String longLabel,
                              java.lang.String shape,
                              java.awt.Color color,
                              java.awt.Color fillColor,
                              int peripheries)

makeRule

public static IOPNode makeRule(java.lang.String nodeId,
                               java.lang.String shortLabel,
                               java.lang.String longLabel,
                               DotNodeAttributes nattrs)

makeRule

public static IOPNode makeRule(java.lang.String nodeId,
                               java.lang.String shortLabel,
                               java.lang.String longLabel,
                               java.lang.String shape,
                               java.awt.Color color,
                               java.awt.Color fillColor)

makeRule

public static IOPNode makeRule(java.lang.String nodeId,
                               java.lang.String shortLabel,
                               java.lang.String longLabel,
                               java.lang.String shape,
                               java.awt.Color color,
                               java.awt.Color fillColor,
                               int peripheries)

updateFillColor

public void updateFillColor()

setNodeShape

public void setNodeShape(java.lang.String shape)

Set the shape of the node base. If shape is either "box" or "rectangle" the node base will be rectangular. Otherwise, the node shape is an ellipse.

The change will become visible once the container of this node repaints.

Parameters:

shape - String describing the shape of node base

See Also:

getNodeShape()

setNodeShape

public void setNodeShape(g2d.graph.xdotparser.visitor.xDotNode hints)

string2Shape

public java.awt.Shape string2Shape(java.lang.String shape,
                                   double x,
                                   double y,
                                   double width,
                                   double height)

getNodeShape

public java.lang.String getNodeShape()

Get a string describing the shape of the node base.

Returns:

String describing the shape of node base

See Also:

setNodeShape(java.lang.String)

setFillColor

public void setFillColor(java.awt.Color color)

Set the fill color of the node base.

The change will become visible once the container of this node repaints.

Parameters:

color - Color used for filling node base

See Also:

getFillColor()

getFillColor

public java.awt.Color getFillColor()

Get color used for filling the node base.

Returns:

Color used for filling node base

See Also:

setFillColor(java.awt.Color)

setBorderColor

public void setBorderColor(java.awt.Color color)

Set the border color of the node base.

The change will become visible once the container of this node repaints.

Parameters:

color - Color used for border of node base

See Also:

getBorderColor()

getBorderColor

public java.awt.Color getBorderColor()

Get the border color

Returns:

Color used for border of node including the periperies

See Also:

setBorderColor(java.awt.Color)

setBaseDimension

public void setBaseDimension(double width,
                             double height)

Set size of node base.

The change will become visible once the container of this node repaints.

Parameters:

width - Width of node base in double precision

height - Height of node base in double precision

setBaseCenter

public void setBaseCenter(java.awt.geom.Point2D center)

Set position of node base to given center point.

The change will become visible once the container of this node repaints.

Parameters:

center - Point denoting center of node base

getBaseFrame

public java.awt.geom.Rectangle2D getBaseFrame()

Get rectangle of frame that defines shape of node base.

Returns:

Rectangle that is frame of node base

setLabel

public void setLabel(java.lang.String label)

Set the text of node label. Passing null or an empty string results in label not drawn.

The change will become visible once the container of this node repaints.

Parameters:

label - Text of node label

See Also:

getLabel()

getLabel

public java.lang.String getLabel()

Get text of node label.

Returns:

String with text of node label (will not be NULL)

See Also:

setLabel(java.lang.String)

getWidth

public double getWidth()

Get width of node (including base and label) in double precision.

Returns:

width of node

getHeight

public double getHeight()

Get height of node (including base and label) in double precision.

Returns:

height of node

getPosition

public java.awt.geom.Point2D getPosition()

Get position of node as the top-left corner.

Returns:

point denoting position of node

distanceTo

public double distanceTo(java.awt.geom.Point2D p)

Calculate distance from this node to given point. If point is inside this shape, returns 0.0. Otherwise, uses distance to center point of bounds.

Specified by:

distanceTo in class GraphItem

Parameters:

p - Point to compute distance to

Returns:

distance to point

scaleBase

public Glyph scaleBase(int thickness)

Produces a glyph that is simply the scale of the current base glyph. Doesn't work too well for assymetric shapes like triangles, polygons, etc. Best for elllipses and rectangles. Useful for highlighting and multiple borders, when Dot isn't being used.

Parameters:

thickness - of the border b/w base and scaled base; thickness is measured in pixels; positive means bigger; negative means smaller.

Returns:

distance to point

highlight

public void highlight()

Description copied from class: GraphItem

Highlight this node or edge.

Overrides:

highlight in class GraphItem

dehighlight

public void dehighlight()

Description copied from class: GraphItem

Revert highlighting to previous state (if any).

Overrides:

dehighlight in class GraphItem

paint

public void paint(java.awt.Graphics2D g2d)

Overrides:

paint in class GraphItem

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Two nodes are equal if their id is the same.

Overrides:

equals in class java.lang.Object

Parameters:

o - Object to test equality with this IOPNode

Returns:

true if this IOPNode is equal to given Object, false otherwise

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overriding method to comply with equals(Object).

Overrides:

hashCode in class java.lang.Object

Returns:

hash value of this IOPNode

compareTo

public int compareTo(IOPNode in)

Specified by:

compareTo in interface java.lang.Comparable<IOPNode>

_toDotString

public java.lang.String _toDotString()

toDotString

public java.lang.String toDotString()

deprecated_toDotString

public java.lang.String deprecated_toDotString()

compareNodes

public static int compareNodes(IOPNode n0,
                               IOPNode n1)

compareToAsOcc

public static int compareToAsOcc(IOPNode n0,
                                 IOPNode n1)

compareToAsRule

public static int compareToAsRule(IOPNode n0,
                                  IOPNode n1)