com.nwawsoft.util.datastructures

Class Graph.GraphNode

java.lang.Object

com.nwawsoft.util.datastructures.Graph.GraphNode

Enclosing class:

Graph

public static class Graph.GraphNode
extends java.lang.Object

Defines GraphNode objects as they are used in the Graph class. A GraphNode has a name, a list of edges to other GraphNode objects including their respective edge weights (often referred to as edgeWeights or edgeWeight) and are either marked or not marked (controlled by the boolean marked).

Constructor Summary

Constructors

Constructor and Description
GraphNode(java.lang.String nodeName) Creates a new GraphNode object with name nodeName.

Method Summary

Modifier and Type	Method and Description
void	addEdge(Graph.GraphNode graphNode, double weight) Adds a new edge from the calling to the specified GraphNode objects with the specified weight to the List of known edges of the GraphNode.
double	getEdgeWeight(Graph.GraphNode graphNode) Returns the edgeWeight of the calling and the specified GraphNode objects if there is any, otherwise Double.NaN.
java.lang.String	getName() Returns the name of the GraphNode object.
List	getNeighbors() Returns a List object of all neighbors.
boolean	isMarked() Returns whether the GraphNode object's "marked" flag is set.
void	mark() Sets "marked" to true.
void	removeEdge(Graph.GraphNode graphNode) Removes any edges between the calling and the specified GraphNode objects if graphNode !
void	removeMark() Sets "marked" to false.

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphNode

public GraphNode(java.lang.String nodeName)

Creates a new GraphNode object with name nodeName. It is unmarked.

Parameters:

nodeName - the name of the new GraphNode object.

Method Detail

mark

public void mark()

Sets "marked" to true.

removeMark

public void removeMark()

Sets "marked" to false.

isMarked

public boolean isMarked()

Returns whether the GraphNode object's "marked" flag is set.

Returns:

true if marked, else false.

getName

public java.lang.String getName()

Returns the name of the GraphNode object.

Returns:

the name of the GraphNode object.

addEdge

public void addEdge(Graph.GraphNode graphNode,
                    double weight)

Adds a new edge from the calling to the specified GraphNode objects with the specified weight to the List of known edges of the GraphNode.

Parameters:

graphNode - the GraphNode object to create a new edge to.

weight - the weight of the new edge from "this" to graphNode.

getEdgeWeight

public double getEdgeWeight(Graph.GraphNode graphNode)

Returns the edgeWeight of the calling and the specified GraphNode objects if there is any, otherwise Double.NaN.

Parameters:

graphNode - the GraphNode object to find the weight to.

Returns:

edgeWeight if any edge was found, otherwise Double.NaN.

removeEdge

public void removeEdge(Graph.GraphNode graphNode)

Removes any edges between the calling and the specified GraphNode objects if graphNode != null. If there were none, nothing happens.

Parameters:

graphNode - the GraphNode object to remove the edge to.

getNeighbors

public List getNeighbors()

Returns a List object of all neighbors.

Returns:

a list of all neighbors.