charger.obj

Class GNode

Object

charger.obj.GraphObject

charger.obj.GNode

Direct Known Subclasses:

Actor, Concept, Note, Relation, RelationLabel, TypeLabel

public abstract class GNode
extends GraphObject

A GNode is the abstract superclass to handle concepts, relations, actors and nested graphs.

Author:

Harry S. Delugach ( delugach@uah.edu ) Copyright (c) 1998-2020 by Harry S. Delugach.

Nested Class Summary

Nested classes/interfaces inherited from class charger.obj.GraphObject

GraphObject.Kind, GraphObject.ObjectIDComparator

Field Summary

Fields

Modifier and Type	Field and Description
static float	borderOutlineWidth If "outlines" are selected (i.e., turn on Hub.showBorders) this is how wide the border should be
protected static float[]	dashpattern
protected ArrayList	descriptors Some reference that helps describe this node.
(package private) GMark	mark
protected ArrayList	myedges List of GEdges by which this GNode is attached to other nodes.
(package private) static Font	showBoringDebugInfoFont
(package private) String	typeLabel

Fields inherited from class charger.obj.GraphObject

backColor, defaultDim, defaultSelectColor, defaultWrapColumns, defaultWrapLabels, displayRect3D, foreColor, highlightColor, history, isSelected, labelFont, myKind, objectID, objectMargin, ownerGraph, TerritorialLimit, textLabel, textLabelLowerLeftPt

Constructor Summary

Constructors

Constructor and Description
GNode()

Method Summary

Modifier and Type	Method and Description
void	abandonObject() Disconnects itself from any other GNodes, by telling each of its edges to erase itself.
void	adjustEdges() Adjust all this node's connecting edges so that they are positioned correctly.
void	attachGEdge(GEdge ge) Includes the already-allocated GEdge in the target node
protected String	CGIFStringGNodeEdges() Handles the translation necessary for providing links to a CGIF form.
void	clearDescriptors()
void	deleteGEdge(GEdge ge) Removes the GEdge from the node to which it is attached.
void	draw(Graphics2D g, boolean printing) Handles generic drawing for all nodes, and usually invokes the node's class method "draw"
void	drawActivated(Graphics2D g) Swap the fore and background, draw again, then restore fore and back
void	drawBorder(Graphics2D g, Color borderColor) Highlights the border of the object
void	drawDebuggingInfo(Graphics2D g)
protected void	finalize()
Rectangle2D.Double	getDisplayRect() Gets the display rectangle of this object on the canvas, without any scaling information.
ArrayList	getEdges() Returns the GEdges associated with this GNode.
ArrayList<GNode>	getLinkedNodes() A convenience method to get all linked nodes, regardless of whether they are "input" or "output".
ArrayList<GNode>	getLinkedNodes(GEdge.Direction direction) Returns a list of GNodes depending on whether they are "from" or "to" the calling node.
Dimension	getSize()
AbstractTypeDescriptor	getTypeDescriptor() Convenience method to return the first type descriptor.
AbstractTypeDescriptor[]	getTypeDescriptors()
String	getTypeLabel() Get just the type label portion of the concept's text label.
boolean	isActive() Does the marker indicate an active input concept to an actor?
boolean	isChanged() Does the marker indicate object has changed?
void	setActive(boolean b) Used when activating CG actors to mark this node as active in a sequence of firings.
void	setCenter() Sets the position of this node to be its center.
void	setCenter(Point2D.Double p) Sets the position of a node and makes the rest of its dimensions consistent.
void	setChanged(boolean b) Sets this node's mark to indicate that it's been changed.
void	setTypeDescriptor(AbstractTypeDescriptor o) Sets the first type descriptor of this node.
void	setTypeDescriptors(AbstractTypeDescriptor[] ds)
void	setTypeLabel(String s)
void	setTypeLabel(String label, boolean resize) Sets a type label for the target node.

Methods inherited from class charger.obj.GraphObject

addHistoryRecord, adjustCustomDisplayRect, commitToKnowledgeBase, findDominantContext, forceMove, forgetObject, getBestFontMetrics, getCenter, getColor, getDepth, getDim, getDisplayRect3D, getHistory, getLabelFont, getMinimumContentSize, getObjectLocator, getOutermostGraph, getOwnerFrame, getOwnerGraph, getShape, getShapeForDrawing, getTextLabel, getTextLabelSize, getUpperLeft, getWrapColumns, getWrapLabels, isNegated, isNegativelyNested, listToString, listToStringXML, putInCorrectContext, putInCorrectContext, resizeIfNecessary, resizeIfNecessary, selfCleanup, setBackground, setCenterOnly, setColor, setColor, setDepth, setDim, setDim, setDisplayRect, setDisplayRect, setDisplayRect3D, setForeground, setLabelFont, setNegated, setOwnerGraph, setTextLabel, setTextLabel, setTextLabel, setUpperLeft, setUpperLeft, toString, unCommitFromKnowledgeBase

Methods inherited from class Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

showBoringDebugInfoFont

static Font showBoringDebugInfoFont

myedges

protected ArrayList myedges

List of GEdges by which this GNode is attached to other nodes.

dashpattern

protected static float[] dashpattern

borderOutlineWidth

public static float borderOutlineWidth

If "outlines" are selected (i.e., turn on Hub.showBorders) this is how wide the border should be

mark

GMark mark

typeLabel

String typeLabel

descriptors

protected ArrayList descriptors

Some reference that helps describe this node. Currently used for a TypeDescriptor

See Also:

charger.obj.AbstractTypeDescriptor

Constructor Detail

GNode

public GNode()

Method Detail

isChanged

public boolean isChanged()

Does the marker indicate object has changed?

Returns:

true if ready

isActive

public boolean isActive()

Does the marker indicate an active input concept to an actor?

setChanged

public void setChanged(boolean b)

Sets this node's mark to indicate that it's been changed.

Parameters:

b - whether to tell the mark that the node is changed or not.

See Also:

GMark.setChanged(boolean)

setActive

public void setActive(boolean b)

Used when activating CG actors to mark this node as active in a sequence of firings.

Parameters:

b -

getEdges

public ArrayList getEdges()

Returns the GEdges associated with this GNode.

Returns:

vector of GEdges.

getLinkedNodes

public ArrayList<GNode> getLinkedNodes(GEdge.Direction direction)

Returns a list of GNodes depending on whether they are "from" or "to" the calling node.

Parameters:

direction - either GEdge.Direction.FROM (for nodes linked with arrows directed toward this node, or GEdge.Direction.TO (for nodes linked with arrows directed away from this node).

Returns:

the list of nodes that are connected in the appropriate direction

See Also:

GEdge.Direction

getLinkedNodes

public ArrayList<GNode> getLinkedNodes()

A convenience method to get all linked nodes, regardless of whether they are "input" or "output". Equivalent to the union of the lists returned by getLinkedNodes( from ) and getLinkedNodes( to )

Returns:

the list of nodes that are connected in either direction

CGIFStringGNodeEdges

protected String CGIFStringGNodeEdges()

Handles the translation necessary for providing links to a CGIF form. Assembled the input,output referents, and string-ifies them in order.

Returns:

Completed string, suitable for inserting after a CGIF relation/actor label.

setCenter

public void setCenter()

Sets the position of this node to be its center. Used to force re-evaluation of its dimensions and the dimensions of its links. Same as setCenter( getCenter() ).

See Also:

setCenter()

setCenter

public void setCenter(Point2D.Double p)

Sets the position of a node and makes the rest of its dimensions consistent. Assumes that the current dimensions are to be preserved. Should probably check here to see if the pos is within some reasonable rectangle.

Overrides:

setCenter in class GraphObject

Parameters:

p - the new center point, although internally the top left corner is saved as the position.

adjustEdges

public void adjustEdges()

Adjust all this node's connecting edges so that they are positioned correctly.

abandonObject

public void abandonObject()

Disconnects itself from any other GNodes, by telling each of its edges to erase itself.

Specified by:

abandonObject in class GraphObject

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class GraphObject

Throws:

Throwable

attachGEdge

public void attachGEdge(GEdge ge)

Includes the already-allocated GEdge in the target node

Parameters:

ge - the allocated and set-up GEdge

deleteGEdge

public void deleteGEdge(GEdge ge)

Removes the GEdge from the node to which it is attached.

draw

public void draw(Graphics2D g,
                 boolean printing)

Handles generic drawing for all nodes, and usually invokes the node's class method "draw"

Specified by:

draw in class GraphObject

Parameters:

g - Graphics context on which the object is to be rendered

printing - Whether to pretty-print the object

drawBorder

public void drawBorder(Graphics2D g,
                       Color borderColor)

Description copied from class: GraphObject

Highlights the border of the object

Specified by:

drawBorder in class GraphObject

Parameters:

g - Graphics context on which the object is to be rendered

borderColor - the color to draw

drawActivated

public void drawActivated(Graphics2D g)

Swap the fore and background, draw again, then restore fore and back

drawDebuggingInfo

public void drawDebuggingInfo(Graphics2D g)

getSize

public Dimension getSize()

getDisplayRect

public Rectangle2D.Double getDisplayRect()

Description copied from class: GraphObject

Gets the display rectangle of this object on the canvas, without any scaling information. The display rectangle includes the border but does not currently include the shadow (if present). Should it?

Overrides:

getDisplayRect in class GraphObject

getTypeLabel

public String getTypeLabel()

Get just the type label portion of the concept's text label.

Returns:

a type label (for GNodes, the default is the text label; subclasses must over-ride )

setTypeLabel

public void setTypeLabel(String label,
                         boolean resize)

Sets a type label for the target node.

Parameters:

label - The type label to set

resize - Shether to resize if necessary.

setTypeLabel

public void setTypeLabel(String s)

getTypeDescriptors

public AbstractTypeDescriptor[] getTypeDescriptors()

clearDescriptors

public void clearDescriptors()

setTypeDescriptors

public void setTypeDescriptors(AbstractTypeDescriptor[] ds)

getTypeDescriptor

public AbstractTypeDescriptor getTypeDescriptor()

Convenience method to return the first type descriptor.

setTypeDescriptor

public void setTypeDescriptor(AbstractTypeDescriptor o)

Sets the first type descriptor of this node.