Class GraphNode

java.lang.Object

GraphNode

All Implemented Interfaces:

java.lang.Comparable<GraphNode>

public class GraphNode
extends java.lang.Object
implements java.lang.Comparable<GraphNode>

Field Summary

Fields

Modifier and Type	Field and Description
static int	NOT_NEIGHBOR A value that can be used if a cost is needed even if the GraphNode is not a neighbor of a node.

Constructor Summary

Constructors

Constructor and Description
GraphNode(java.lang.String name) Represents a valid location in the game graph.

Method Summary

Modifier and Type	Method and Description
void	addNeighbor(GraphNode neighbor, int cost) Maintains sorted order of neighbors by neighbor name.
int	compareTo(GraphNode otherNode) Return the results of comparing this node's name to the other node's name.
void	displayCostToEachNeighbor() Prints a list of neighbors of this GraphNode and the cost of the edge to them
int	getCostTo(java.lang.String neighborName)
GraphNode	getNeighbor(java.lang.String name)
java.util.Iterator<java.lang.String>	getNeighborNames() Returns and iterator that can be used to find neighbors of this GraphNode.
java.util.List<Neighbor>	getNeighbors() Returns a list of the neighbors of this GraphNode instance.
java.lang.String	getNodeName() Return the name of this GraphNode.
boolean	getSpycam()
boolean	isNeighbor(java.lang.String neighborName) Returns true if this node name is a neighbor of current node.
void	printNeighborNames() Display's the node name followed by a list of neighbors to this node.
void	setSpycam(boolean cam)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NOT_NEIGHBOR

public static final int NOT_NEIGHBOR

A value that can be used if a cost is needed even if the GraphNode is not a neighbor of a node.

In Dijkstra's algorithm, initializing a node to a high cost (Integer.MAX_VALUE) can be used to indicate a node is not a neighbor, or not connected by a path to the starting node.

There is no requirement to use this constant.

See Also:

Constant Field Values

Constructor Detail

GraphNode

public GraphNode(java.lang.String name)

Represents a valid location in the game graph. There can be a player, a spycam, or a spy at any graph node.

Parameters:

name - The label that uniquely identifies this graph node.

Method Detail

getNodeName

public java.lang.String getNodeName()

Return the name of this GraphNode.

Returns:

name of node

getNeighbors

public java.util.List<Neighbor> getNeighbors()

Returns a list of the neighbors of this GraphNode instance. This instance of GraphNode is not included as it is not a neighbor of itself.

Returns:

a list of neighbors of this GraphNode.

isNeighbor

public boolean isNeighbor(java.lang.String neighborName)

Returns true if this node name is a neighbor of current node.

Parameters:

neighborName - to look for

Returns:

true if the node is an adjacent neighbor.

addNeighbor

public void addNeighbor(GraphNode neighbor,
                        int cost)

Maintains sorted order of neighbors by neighbor name.

Parameters:

neighbor - An adjacent node (a neighbor)

cost - The cost to move to that node (from this node)

getNeighborNames

public java.util.Iterator<java.lang.String> getNeighborNames()

Returns and iterator that can be used to find neighbors of this GraphNode.

Returns:

An iterator of String node labels

getSpycam

public boolean getSpycam()

Returns:

true if the GraphNode has a spycam

setSpycam

public void setSpycam(boolean cam)

Parameters:

cam - indicates whether the node now has a spycam

getCostTo

public int getCostTo(java.lang.String neighborName)
              throws NotNeighborException

Parameters:

neighborName - name of potential neighbor

Returns:

cost to neighborName

Throws:

NotNeighborException - if neighborName is not a neighbor

getNeighbor

public GraphNode getNeighbor(java.lang.String name)
                      throws NotNeighborException

Parameters:

name - name of potential neighbor

Returns:

the GraphNode associated with name that is a neighbor of the current node

Throws:

NotNeighborException - if name is not a neighbor of the GraphNode

displayCostToEachNeighbor

public void displayCostToEachNeighbor()

Prints a list of neighbors of this GraphNode and the cost of the edge to them

 1 b
 4 c
 20 d
 1 f

compareTo

public int compareTo(GraphNode otherNode)

Return the results of comparing this node's name to the other node's name. Allows collections of nodes to be sorted using the built-in sort methods.

Specified by:

compareTo in interface java.lang.Comparable<GraphNode>

Parameters:

otherNode - Another node to compare names with this node.

Returns:

the result of compareTo on the node names only.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

name of node

printNeighborNames

public void printNeighborNames()

Display's the node name followed by a list of neighbors to this node. Example:

 1 b
 4 c
 20 d
 1 f