charger.obj

Class Graph

Object

charger.obj.GraphObject

charger.obj.GNode

charger.obj.Concept

charger.obj.Graph

All Implemented Interfaces:

Printable, KnowledgeSource

public class Graph
extends Concept
implements Printable, KnowledgeSource

A Graph stores zero or more graph objects. Since it is a graph object itself, graphs can be arbitrarily nested. It is each graph's responsibility to store its own components in its objectHashStore. Extends GNode because it has a name, referent and can be linked as a GNode.

The drawing of graphs as contexts is outlined as follows:

Display Rectangle

The display rectangle (displayRect) is the largest rectangle occupied by the graph. All other elements must be no larger than this rectangle.

Border

The border is inscribed inside the display rectangle. In order to draw the border, consider it drawn as lines positioned in the center of the border's line, whose line thickness is defined by Global.contextBorderWidth

Inner padding

Inside the border, there is a (narrow) band of space so that the graph's contents aren't touching the border. This means that the graph's inner contents must fit inside a rectangle whose width is diplayrect.width - 2* contextBorderWidth - 2 * innerpadding

Graph name

The graph's text label is inscribed at the top left of the graph's contents. Its lower left corner is therefore positioned at: displayrect. This means that the graph's inner contents must fit inside a rectangle whose height is diplayrect.height - 2* contextBorderWidth - 2 * innerpadding - textLabelHeight

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 int	contextBorderWidth The actual width of the context's displayed border; included in its displayRect
static int	contextInnerPadding The "breathing room" spacing inside a context's border
String	createdTimeStamp
String	modifiedTimeStamp
HashMap<String,GraphObject>	objectHashStore Holds the list of objects owned by this graph.
protected EditFrame	ownerFrame The user interface frame that contains this graph.
Point2D	textCenterPt
int	wrapColumns
boolean	wrapLabels

Fields inherited from class charger.obj.Concept

refDone, referent, TEXT_HEIGHT, TEXT_WIDTH

Fields inherited from class charger.obj.GNode

borderOutlineWidth, dashpattern, descriptors, mark, myedges, showBoringDebugInfoFont, 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

Fields inherited from interface Printable

NO_SUCH_PAGE, PAGE_EXISTS

Constructor Summary

Constructors

Constructor and Description
Graph() Constructs a new Graph object, with a given parent graph within which it is enclosed.
Graph(Graph g) Constructs a new Graph object, with a given parent graph within which it is enclosed.

Method Summary

Modifier and Type	Method and Description
void	abandonObject() Makes the object expendable from the CharGer graph.
void	addHistory(chargerlib.history.ObjectHistoryRecord he) Add the history event to all objects in the graph
boolean	commitToKnowledgeBase(KnowledgeBase kb) Perform whatever activities are required for this concept to be committed to a knowledge base.
boolean	containsGraphObjects(ArrayList<GraphObject> graphobjects) Determines whether every node in the list is contained in the graph.
void	dispose() Invokes forgetObject on all the objects (including nested ones) in this graph.
void	draw(Graphics2D g2D, boolean printing) Renders the graph, recursively rendering all of it contents.
void	drawBorder(Graphics2D g, Color borderColor) Draws the border of a context.
protected void	finalize()
GraphObject	findByID(GraphObjectID ID) Find an object by its ID at any level in the target graph.
AbstractTypeDescriptor[]	findTypeDescriptors(String term) Look for descriptors for the given term in the knowledge source, however it may be remembered.
boolean	forceDeepMove(Point2D.Double delta) Forces an unverified move for the graph and all its contained objects.
static boolean	forceMoveGraphObjects(ArrayList<GraphObject> objectsToMove, Point2D.Double delta) Forces an un-verified move of all objects, with identical moves for all objects.
void	forgetObject(GraphObject go) Removes object from this graph, removes it from the knowledge base and logically garbages the object.
Graph[]	getAllGraphs() Get all the graphs known to this knowledge source.
AbstractTypeDescriptor[]	getAllTypeDescriptors() Get all the type descriptors known to this knowledge source.
String	getBriefSummary() Create a short summary of the number of objects and their types.
Rectangle2D.Double	getContentBounds() Determines the region that a graph's contents require.
Rectangle2D.Double	getDisplayBounds() Determines how much space it takes to render the graph on a canvas.
int	getGraphObjectCount() Return the number of objects (including edges) in this graph
ArrayList<GraphObject>	getGraphObjects()
EditFrame	getOwnerFrame() Find the user window (if any) associated with this graph.
Rectangle2D.Double	getRegionAvailableForContent() Starting with the graph's already-defined display rectangle, takes into account the context's border, the margin, and the current label's height.
Shape	getShape() Find the outer boundary of the graph, taking into account the border width, but does NOT consider shadows (we let arrows and other things cover up shadows).
Shape	getShapeForDrawing() Finds the center line of the border, so that drawing the border will take place entirely within the display rectangle.
private void	graphConstructor(Graph g)
Iterator<GraphObject>	graphObjects() Get an iterator for all the given graph's objects (including edges).
void	handleContextLinks() Recursively descend in target graph, cutting/changing links as needed.
void	insertInCharGerGraph(GraphObject go) Attaches the given graph object to a CharGer graph, but doesn't do any consistency check.
void	insertObject(GraphObject go) Inserts an object into the graph, proposing the target graph as its owner.
boolean	isEmpty() Determines whether there are any objects in this graph.
void	layoutGraph() Apply the spring graph layout algorithm to this graph, using the preferred edge length.
void	layoutGraph(double edgeLength) Apply the spring graph layout algorithm to this graph.
EditingChangeState	moveGraph(Point2D.Double translation) Adjust all objects to be offset by the translation vector.
EditingChangeState	moveGraphObjects(ArrayList<GraphObject> objectsToMove, Point2D.Double delta) Moves a set of objects on the canvas through a common x,y displacement.
boolean	nestedWithin(Graph gouter) Determines whether this graph is nested (at any level) within a given graph.
int	print(Graphics g, PageFormat pf, int pageIndex) Used by the PrintJob class to print the graph.
void	removeFromGraph(GraphObject go) Detaches the given graph object from a CharGer graph.
void	resizeForContents(Point2D.Double center) Looks at every object in target graph and adjusts the graph's displayRect to enclose them.
String	safeString() String-ifies graph with objects in an order that has no internal forward references, using version 3's format.
String	safeString2() String-ifies graph with objects in an order that has no internal forward references.
void	setCenter() Sets the position of this graph to be its center.
void	setCenter(Point2D.Double p) Calls the super's setCenter, changes the textLabelLowerLeftPt point to put the label in the upper left hand corner of the context.
void	setOwnerFrame(EditFrame ef) Sets the editing window frame that contains this graph.
void	setRegionAvailableForContent(Rectangle2D.Double rect) Sets the display rect of the graph to contain the content as well as the border, margin and label.
void	setSize(Dimension size)
void	setTextLabel(String s, FontMetrics fmetrics, Point2D.Double p) Sets the text label of the graph object.
void	setTextLabelPos() Sets the position of the text label, based on the center point.
String	toString() Gives a CharGer-formatted version of the target graph, with objects in arbitrary order.
String	toStringDeep(boolean deep) Returns graph objects in a CharGer-formatted string
boolean	unCommitFromKnowledgeBase(KnowledgeBase kb) Perform whatever activities are required for this concept to be deleted from a knowledge base.

Methods inherited from class charger.obj.Concept

getReferent, getTypeLabel, parseTextLabel, setReferent, setReferent, setTextLabel, setTypeLabel, setTypeLabel, UnCommitFromKnowledgeBase

Methods inherited from class charger.obj.GNode

adjustEdges, attachGEdge, CGIFStringGNodeEdges, clearDescriptors, deleteGEdge, drawActivated, drawDebuggingInfo, getDisplayRect, getEdges, getLinkedNodes, getLinkedNodes, getSize, getTypeDescriptor, getTypeDescriptors, isActive, isChanged, setActive, setChanged, setTypeDescriptor, setTypeDescriptors

Methods inherited from class charger.obj.GraphObject

addHistoryRecord, adjustCustomDisplayRect, findDominantContext, forceMove, forgetObject, getBestFontMetrics, getCenter, getColor, getDepth, getDim, getDisplayRect3D, getHistory, getLabelFont, getMinimumContentSize, getObjectLocator, getOutermostGraph, getOwnerGraph, 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, setUpperLeft, setUpperLeft

Methods inherited from class Object

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

Field Detail

objectHashStore

public HashMap<String,GraphObject> objectHashStore

Holds the list of objects owned by this graph. Should be private.

See Also:

findByID(charger.obj.GraphObjectID)

contextBorderWidth

public static int contextBorderWidth

The actual width of the context's displayed border; included in its displayRect

contextInnerPadding

public static int contextInnerPadding

The "breathing room" spacing inside a context's border

textCenterPt

public Point2D textCenterPt

ownerFrame

protected EditFrame ownerFrame

The user interface frame that contains this graph. If not outermost, or if we're internal without a frame, expect null.

createdTimeStamp

public String createdTimeStamp

modifiedTimeStamp

public String modifiedTimeStamp

wrapLabels

public boolean wrapLabels

wrapColumns

public int wrapColumns

Constructor Detail

Graph

public Graph(Graph g)

Constructs a new Graph object, with a given parent graph within which it is enclosed. Same as Graph()

Parameters:

g - existing graph to which this one is to be subordinate; null if there isn't one.

Graph

public Graph()

Constructs a new Graph object, with a given parent graph within which it is enclosed. Same as Graph( null )

Method Detail

graphConstructor

private void graphConstructor(Graph g)

getOwnerFrame

public EditFrame getOwnerFrame()

Find the user window (if any) associated with this graph.

Overrides:

getOwnerFrame in class GraphObject

Returns:

The user interface frame that contains this graph. If not outermost, or if the graph is internal without a frame, return null.

setOwnerFrame

public void setOwnerFrame(EditFrame ef)

Sets the editing window frame that contains this graph. If not outermost, or if the graph is internal without a frame, pass null.

setCenter

public void setCenter()

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

Overrides:

setCenter in class GNode

See Also:

setCenter()

setCenter

public void setCenter(Point2D.Double p)

Calls the super's setCenter, changes the textLabelLowerLeftPt point to put the label in the upper left hand corner of the context. Moves all of the context's contents so they maintain the same relative position inside the context.

Overrides:

setCenter in class GNode

Parameters:

p - the new center point, although internally the top left corner is saved in the displayRect.

See Also:

GNode.setCenter()

setTextLabelPos

public void setTextLabelPos()

Sets the position of the text label, based on the center point.

See Also:

CGUtil.getStringLowerLeftFromCenter(java.awt.FontMetrics, java.lang.String, java.awt.geom.Point2D.Double)

print

public int print(Graphics g,
                 PageFormat pf,
                 int pageIndex)
          throws PrinterException

Used by the PrintJob class to print the graph.

Specified by:

print in interface Printable

Throws:

PrinterException

See Also:

EditManager.performActionPrintGraph()

getShape

public Shape getShape()

Find the outer boundary of the graph, taking into account the border width, but does NOT consider shadows (we let arrows and other things cover up shadows).

Overrides:

getShape in class Concept

Returns:

the Shape for this object, with appropriate dimensions, etc.

See Also:

GraphObject.getShape()

getShapeForDrawing

public Shape getShapeForDrawing()

Finds the center line of the border, so that drawing the border will take place entirely within the display rectangle.

Overrides:

getShapeForDrawing in class GraphObject

Returns:

The graph's rectangle, shrunk in all dimensions by contextBorderWidth.

getRegionAvailableForContent

public Rectangle2D.Double getRegionAvailableForContent()

Starting with the graph's already-defined display rectangle, takes into account the context's border, the margin, and the current label's height.

Returns:

the region of this graph/context that is available for content.

setRegionAvailableForContent

public void setRegionAvailableForContent(Rectangle2D.Double rect)

Sets the display rect of the graph to contain the content as well as the border, margin and label.

Parameters:

rect -

drawBorder

public void drawBorder(Graphics2D g,
                       Color borderColor)

Draws the border of a context. Graphs are handled specially because to draw a graph means not only drawing its border but also drawing its contents. To ease recursive routines, the draw routine call this one. (Currently, not used; the draw method does this too.)

Overrides:

drawBorder in class GNode

Parameters:

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

borderColor - the color to draw

See Also:

draw(java.awt.Graphics2D, boolean)

draw

public void draw(Graphics2D g2D,
                 boolean printing)

Renders the graph, recursively rendering all of it contents. If there's an owner graph, draw a context rectangle INSIDE its actual border. If this graph is currently selected, then draw the narrow selection rectangle. Invoke draw on each of the graph's elements.

Overrides:

draw in class Concept

Parameters:

g2D - The 2D graphics on which to draw

printing - if true, then translate to top left and be sure to set font, etc.

insertInCharGerGraph

public void insertInCharGerGraph(GraphObject go)

Attaches the given graph object to a CharGer graph, but doesn't do any consistency check. Doesn't attach any arcs or anything else.

removeFromGraph

public void removeFromGraph(GraphObject go)

Detaches the given graph object from a CharGer graph. Any remaining links or pointers in the graph object are the responsibility of the implementer.

forceDeepMove

public boolean forceDeepMove(Point2D.Double delta)

Forces an unverified move for the graph and all its contained objects. Does not recursively call itself on its nested contents; simply grabs all content however nested and moves them. Adjusts the node edges to correspond to the new positions.

Parameters:

delta -

Returns:

whether anything actually changed

forceMoveGraphObjects

public static boolean forceMoveGraphObjects(ArrayList<GraphObject> objectsToMove,
                                            Point2D.Double delta)

Forces an un-verified move of all objects, with identical moves for all objects. Does no checking for overlap or context curruption or edge corruption. To be used only when it is certain everything is to be moved.

Parameters:

objectsToMove -

delta -

Returns:

whether anything actually changed

moveGraphObjects

public EditingChangeState moveGraphObjects(ArrayList<GraphObject> objectsToMove,
                                           Point2D.Double delta)

Moves a set of objects on the canvas through a common x,y displacement. Assumes that if a context is moved, then all of the context's contents are to be moved with it. Intended for use when the objects to move are all contained (directly or nested) in this graph.

Parameters:

delta - the translation displacement

objectsToMove - the collection of objects to be displaced

Returns:

a change state indicating whether semantics, appearance or nothing has changed

insertObject

public void insertObject(GraphObject go)

Inserts an object into the graph, proposing the target graph as its owner. In general, this is just a wrapper for insertIncharGerGraph, except in one set of cases: where a GEdge crosses a context boundary. In that case, this method finds the two end nodes of the edge, and inserts the edge into the innermost enclosing context that also encloses both of the end nodes.

Parameters:

go - Object to be added to the target graph.

See Also:

insertInCharGerGraph(charger.obj.GraphObject), forgetObject(charger.obj.GraphObject)

forgetObject

public void forgetObject(GraphObject go)

Removes object from this graph, removes it from the knowledge base and logically garbages the object. This operation should result in a correctly formed graph.

Parameters:

go - object to be erased from target graph

setTextLabel

public void setTextLabel(String s,
                         FontMetrics fmetrics,
                         Point2D.Double p)

Sets the text label of the graph object. May re-size the node if the label is too long.

Overrides:

setTextLabel in class GraphObject

Parameters:

s - new text label (erases the old text label)

fmetrics - font metrics needed in case the label is too big or requires resizing the graph

p - the point around which the label is centered

resizeForContents

public void resizeForContents(Point2D.Double center)

Looks at every object in target graph and adjusts the graph's displayRect to enclose them. If there's no graphics context on which to display the graph, then don't bother.

Parameters:

center - Center point around which to adjust the display rect; null means to move the center point if necessary. Leaves dimensions alone unless they don't enclose the contents.

nestedWithin

public boolean nestedWithin(Graph gouter)

Determines whether this graph is nested (at any level) within a given graph. Forbids overlapping contexts; i.e., every graph has at most one enclosing graph.

Parameters:

gouter - is the potential outermost graph

Returns:

true if target graph is nested logically (at any level) within gouter; false otherwise or if gouter is the same as this object.

containsGraphObjects

public boolean containsGraphObjects(ArrayList<GraphObject> graphobjects)

Determines whether every node in the list is contained in the graph. Uses shallow semantics (i.e., do not check if nested graphs are entirely contained)

Parameters:

graphobjects - Collection of objects

Returns:

true if every element in target is contained in collection; else false

handleContextLinks

public void handleContextLinks()

Recursively descend in target graph, cutting/changing links as needed. If two connected nodes are in different contexts, only allow it if: (a) the connection is a coref or gen-spec link, or (b) the connection is to an actor and we're allowed to link across contexts. If the connection is allowed, make sure that the connection's "owner" (in the CharGer sense) is in a dominant context for the two.

See Also:

Global.allowActorLinksAcrossContexts

findByID

public GraphObject findByID(GraphObjectID ID)

Find an object by its ID at any level in the target graph. Also checks the target graph itself.

Parameters:

ID - a graph ID

Returns:

The object if it is found within the graph; null otherwise.

See Also:

Global.applyForID()

abandonObject

public void abandonObject()

Makes the object expendable from the CharGer graph. Fails when deleting a context connected to actors

Overrides:

abandonObject in class GNode

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Concept

Throws:

Throwable

See Also:

forgetObject(charger.obj.GraphObject)

getBriefSummary

public String getBriefSummary()

Create a short summary of the number of objects and their types.

Returns:

One-line string summary

getContentBounds

public Rectangle2D.Double getContentBounds()

Determines the region that a graph's contents require. Doesn't pay attention to adornments such as shadows.

Returns:

the region needed to enclose all the graph's contents.

See Also:

getDisplayBounds()

getDisplayBounds

public Rectangle2D.Double getDisplayBounds()

Determines how much space it takes to render the graph on a canvas. Takes into account shadows, border widths and other adornments. Question for Harry: How is this different from getDisplayRect? Answer: it is generally used for printing where every pixel counts.

Returns:

the region needed to render the graph completely (plus one pixel for margin)

See Also:

getContentBounds()

moveGraph

public EditingChangeState moveGraph(Point2D.Double translation)

Adjust all objects to be offset by the translation vector. Needs to allow for nested contexts and needs to make sure all enclosing contexts are moved (not re-sized) before redrawing.

Parameters:

translation -

isEmpty

public boolean isEmpty()

Determines whether there are any objects in this graph.

Returns:

true if there's at least one object in the graph; false otherwise.

safeString

public String safeString()

String-ifies graph with objects in an order that has no internal forward references, using version 3's format.

Returns:

string representing the graph in a safe order; i.e., every object occurs before it is referenced (e.g., by a link)

safeString2

public String safeString2()

String-ifies graph with objects in an order that has no internal forward references.

Returns:

string representing the graph in a safe order; i.e., every object occurs before it is referenced (e.g., by a link)

toString

public String toString()

Gives a CharGer-formatted version of the target graph, with objects in arbitrary order.

Overrides:

toString in class GraphObject

Returns:

A CharGer-format string

See Also:

IOManager

toStringDeep

public String toStringDeep(boolean deep)

Returns graph objects in a CharGer-formatted string

Parameters:

deep - Whether to recursively fetch graph objects or not.

See Also:

GraphObject.toString(), safeString(), toStringDeep(boolean)

graphObjects

public Iterator<GraphObject> graphObjects()

Get an iterator for all the given graph's objects (including edges). A convenience method to access the objectHashStore for this graph. Does not use ObjectIterator or its subclasses.

Returns:

the immediately-contained graph objects for this graph (including edges). A nested context is considered as a single graph object.

getGraphObjectCount

public int getGraphObjectCount()

Return the number of objects (including edges) in this graph

Returns:

number of objects (including edges) in this graph. A nested graph is considered a single graph object.

dispose

public void dispose()

Invokes forgetObject on all the objects (including nested ones) in this graph.

See Also:

forgetObject(charger.obj.GraphObject)

getGraphObjects

public ArrayList<GraphObject> getGraphObjects()

setSize

public void setSize(Dimension size)

layoutGraph

public void layoutGraph(double edgeLength)

Apply the spring graph layout algorithm to this graph.

Parameters:

edgeLength - the equilibrium edge length desired.

See Also:

SpringGraphLayout

layoutGraph

public void layoutGraph()

Apply the spring graph layout algorithm to this graph, using the preferred edge length.

See Also:

SpringGraphLayout

addHistory

public void addHistory(chargerlib.history.ObjectHistoryRecord he)

Add the history event to all objects in the graph

Parameters:

he -

findTypeDescriptors

public AbstractTypeDescriptor[] findTypeDescriptors(String term)

Look for descriptors for the given term in the knowledge source, however it may be remembered. Calls to findTypeDescriptors may return more than one descriptor, since some compound terms may require two or more descriptors.

Specified by:

findTypeDescriptors in interface KnowledgeSource

Parameters:

term - a phrase that may have type descriptors.

Returns:

zero or more type descriptors, but never null.

getAllTypeDescriptors

public AbstractTypeDescriptor[] getAllTypeDescriptors()

Get all the type descriptors known to this knowledge source.

Specified by:

getAllTypeDescriptors in interface KnowledgeSource

Returns:

a possibly empty list, but never null;

getAllGraphs

public Graph[] getAllGraphs()

Get all the graphs known to this knowledge source.

Specified by:

getAllGraphs in interface KnowledgeSource

Returns:

a one-element array consisting of this graph and no others;

commitToKnowledgeBase

public boolean commitToKnowledgeBase(KnowledgeBase kb)

Perform whatever activities are required for this concept to be committed to a knowledge base. Adds the type label to the type hierarchy.

Overrides:

commitToKnowledgeBase in class Concept

Parameters:

kb -

unCommitFromKnowledgeBase

public boolean unCommitFromKnowledgeBase(KnowledgeBase kb)

Perform whatever activities are required for this concept to be deleted from a knowledge base. Removes the type label to the type hierarchy.

Overrides:

unCommitFromKnowledgeBase in class GraphObject

Parameters:

kb -