Class GraphComponent

Hierarchy: Object , GraphComponent
Direct Known Subclasses: DirectedEdge, Edge, Node
public abstract class GraphComponent
The base class for all graph component classes. Maintains flags of use in generic graph algorithms. Provides two flags:
  • marked - typically this is used to indicate a state that persists for the course of the graph's lifetime. For instance, it can be used to indicate that a component has been logically deleted from the graph.
  • visited - this is used to indicate that a component has been processed or visited by an single graph algorithm. For instance, a breadth-first traversal of the graph might use this to indicate that a node has already been traversed. The visited flag may be set and cleared many times during the lifetime of a graph.

Graph components support storing user context data. This will typically be used by client algorithms which use planar graphs.

Other

  • version: 1.7
public GraphComponent()
public static void setVisited(Iterator i, boolean visited)
Sets the Visited state for all GraphComponents in an Iterator
Parameters:
i - i the Iterator to scan
visited - visited the state to set the visited flag to
public static void setMarked(Iterator i, boolean marked)
Sets the Marked state for all GraphComponents in an Iterator
Parameters:
i - i the Iterator to scan
marked - marked the state to set the Marked flag to
public static GraphComponent getComponentWithVisitedState(Iterator i, boolean visitedState)
Finds the first GraphComponent in a Iterator set which has the specified visited state.
Parameters:
i - i an Iterator of GraphComponents
visitedState - visitedState the visited state to test
Returns:
the first component found, or null if none found
public boolean isVisited()
Tests if a component has been visited during the course of a graph algorithm
Returns:
true if the component has been visited
public void setVisited(boolean isVisited)
Sets the visited flag for this component.
Parameters:
isVisited - isVisited the desired value of the visited flag
public boolean isMarked()
Tests if a component has been marked at some point during the processing involving this graph.
Returns:
true if the component has been marked
public void setMarked(boolean isMarked)
Sets the marked flag for this component.
Parameters:
isMarked - isMarked the desired value of the marked flag
public void setContext(Object data)
Sets the user-defined data for this component.
Parameters:
data - data an Object containing user-defined data
public Object getContext()
Gets the user-defined data for this component.
Returns:
the user-defined data
public void setData(Object data)
Sets the user-defined data for this component.
Parameters:
data - data an Object containing user-defined data
public Object getData()
Gets the user-defined data for this component.
Returns:
the user-defined data
public abstract abstract boolean isRemoved()
Tests whether this component has been removed from its containing graph
Returns:
true if this component is removed