com.vividsolutions.jts.planargraph
Class GraphComponent
java.lang.Object
com.vividsolutions.jts.planargraph.GraphComponent
public abstract class GraphComponent
extends java.lang.Object
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.
static GraphComponent | getComponentWithVisitedState(Iterator i, boolean visitedState) - Finds the first
GraphComponent in a Iterator set
which has the specified visited state.
|
Object | getContext() - Gets the user-defined data for this component.
|
Object | getData() - Gets the user-defined data for this component.
|
boolean | isMarked() - Tests if a component has been marked at some point during the processing
involving this graph.
|
abstract boolean | isRemoved() - Tests whether this component has been removed from its containing graph
|
boolean | isVisited() - Tests if a component has been visited during the course of a graph algorithm
|
void | setContext(Object data) - Sets the user-defined data for this component.
|
void | setData(Object data) - Sets the user-defined data for this component.
|
static void | setMarked(Iterator i, boolean marked) - Sets the Marked state for all
GraphComponent s in an Iterator
|
void | setMarked(boolean isMarked) - Sets the marked flag for this component.
|
static void | setVisited(Iterator i, boolean visited) - Sets the Visited state for all
GraphComponent s in an Iterator
|
void | setVisited(boolean isVisited) - Sets the visited flag for this component.
|
isMarked
protected boolean isMarked
isVisited
protected boolean isVisited
GraphComponent
public GraphComponent()
getComponentWithVisitedState
public static GraphComponent getComponentWithVisitedState(Iterator i,
boolean visitedState)
Finds the first
GraphComponent
in a
Iterator
set
which has the specified visited state.
i
- an Iterator of GraphComponentsvisitedState
- the visited state to test
- the first component found, or
null
if none found
getContext
public Object getContext()
Gets the user-defined data for this component.
getData
public Object getData()
Gets the user-defined data for this component.
isMarked
public boolean isMarked()
Tests if a component has been marked at some point during the processing
involving this graph.
true
if the component has been marked
isRemoved
public abstract boolean isRemoved()
Tests whether this component has been removed from its containing graph
true
if this component is removed
isVisited
public boolean isVisited()
Tests if a component has been visited during the course of a graph algorithm
true
if the component has been visited
setContext
public void setContext(Object data)
Sets the user-defined data for this component.
data
- an Object containing user-defined data
setData
public void setData(Object data)
Sets the user-defined data for this component.
data
- an Object containing user-defined data
setMarked
public static void setMarked(Iterator i,
boolean marked)
i
- the Iterator to scanmarked
- the state to set the Marked flag to
setMarked
public void setMarked(boolean isMarked)
Sets the marked flag for this component.
isMarked
- the desired value of the marked flag
setVisited
public static void setVisited(Iterator i,
boolean visited)
i
- the Iterator to scanvisited
- the state to set the visited flag to
setVisited
public void setVisited(boolean isVisited)
Sets the visited flag for this component.
isVisited
- the desired value of the visited flag