Vertex

java.lang.Object
- java.util.Observable
- - cusack.hcg.graph.Vertex

All Implemented Interfaces:

java.lang.Comparable<Vertex>
```
public class Vertex
extends java.util.Observable
implements java.lang.Comparable<Vertex>
```
This class is an object that acts as a representation of a vertex on a graph. It holds coordinates, a list of adjacent vertices, and the graph that it is a part of.

Author:

Jeff Largent, Ryan Alfuth, Updated by Chuck Cusack, January 2010.

Constructor Summary

Constructors
Constructor and Description

Vertex(Graph g)
Default constructor

Vertex(Vertex orig)
Copy constructor.

Constructors
Constructor and Description
`Vertex(Graph g)` Default constructor
`Vertex(Vertex orig)` Copy constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDirectedEdge(Vertex vertex)` This method adds a directed edge from this vertex to the vertex that was passed in.
`void`	`addEdge(Vertex vertex)` This method creates an undirected edge between this vertex and the vertex that was passed in.
`void`	`clearSelectionData()` Clear all selection data.
`int`	`compareTo(Vertex other)` From the Comparable interface.
`boolean`	`coordinatesChanged()` Tells whether or not the coordinates of this vertex are different than its initial coordinates
`void`	`decrementSelectedNeighbors()` Reduces the number of selected neighbors by 1
`void`	`deleteAllNeighbors()` This method causes all edges from the vertices adjacent this one to be deleted.
`java.util.List<Vertex>`	`getAdjacencyList()` This method returns the list of all vertices that are adjacent to this one.
`java.awt.Point`	`getCoordinates()` This method returns the coordinates of this vertex.
`int`	`getDegree()` Returns the number of edges connected to this vertex
`int`	`getIndex()` Returns the index of this vertex
`int`	`getIndexWhenFirstAddedOrBeforeRemoved()` Gets the original index of this vertex
`java.awt.Point`	`getInitCoordinates()` This method returns the intial coordinates of this vertex on the graph.
`Graph`	`getMyGraph()` This method returns the graph that this vertex contains.
`int`	`getTimeStamp()` Returns the time stamp which has to do with the order that the vertices are added to a graph
`void`	`incrementSelectedNeighbors()` Increases the number of selected neighbors by 1
`boolean`	`isAdjacent(Vertex vertex)` This method checks to see if this vertex is connected to the vertex that is passed in.
`boolean`	`isSelected()`
`boolean`	`isTarget()`
`void`	`removeDirectedEdge(Vertex vertex)` This method will remove a directed edge that is between this vertex and the vertex that is passed in.
`void`	`removeEdge(Vertex vertex)` This method removes the edge between this vertex and the vertex that is passed in.
`void`	`resetCoordinates()` This method resets the coordinates of this vertex (moves it back to its intial location).
`void`	`setAdjacencyList(java.util.List<Vertex> adjList)` This method sets the list of adjacent vertices to be the list of vertices that is passed in to this method.
`void`	`setCoordinates(java.awt.Point coordinates)` This method sets the coordinates of this vertex to the input value.
`void`	`setIndexWhenFirstAddedOrBeforeRemoved(int indexWhenFirstAddedOrBeforeRemoved)` Sets the original index of this vertex
`void`	`setIndexWhenFirstAddedOrBeforeRemovedToCurrentIndex()` Sets the original index of this vertex to its current index
`void`	`setInitCoordinates(java.awt.Point initCoordinates)` This method sets the initial coordinates of a vertex on the graph.
`void`	`setInitCoordinatesToCurrentCoordinates()` This method sets the initial coordinates of this vertex to its current coordinates
`void`	`setMyGraph(Graph g)` Sets the graph that this vertex belongs to to the passed in graph
`void`	`setSelected(boolean selected)` This method should not be called by anyone except PuzzleInstance! Doing so will cause the data structures to get out of sync.
`void`	`setTimeStamp(int timeStamp)` Sets the times stamp which has to do with the order that the vertices are added to a graph
`void`	`translate(java.awt.Point change)` Adds the x and y values of the passed in Point to this vertex's coordinates.

Methods inherited from class java.util.Observable
addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Vertex
```
public Vertex(Vertex orig)
```
    Copy constructor. Use carefully. It's use has not been tested extensively and it was only created to help solve a bug with caching images of vertices for the various games. It is my assumption that the problem was caused by a change in the vertex from when the id was obtained from vertex and when the drawing actually happened. It's complicated. Anyway, use this carefully. CSC, 7/26/11
    
    Parameters:
    
    orig -
  - Vertex
```
public Vertex(Graph g)
```
    Default constructor
    
    Parameters:
    
    g - The graph object that this vertex needs to hold
- Method Detail
  - getTimeStamp
```
public int getTimeStamp()
```
    Returns the time stamp which has to do with the order that the vertices are added to a graph
    
    Returns:
    
    The time stamp
  - setTimeStamp
```
public void setTimeStamp(int timeStamp)
```
    Sets the times stamp which has to do with the order that the vertices are added to a graph
    
    Parameters:
    
    timeStamp - the time stamp
  - isTarget
```
public boolean isTarget()
```
    Returns:
    
    True of the vertex has at least one neighbor that is selected, false otherwise.
  - isSelected
```
public boolean isSelected()
```
    Returns:
    
    True if the vertex is selected and false otherwise
  - setSelected
```
public void setSelected(boolean selected)
```
    This method should not be called by anyone except PuzzleInstance! Doing so will cause the data structures to get out of sync.
    
    Parameters:
    
    selected - the selected to set
  - decrementSelectedNeighbors
```
public void decrementSelectedNeighbors()
```
    Reduces the number of selected neighbors by 1
  - incrementSelectedNeighbors
```
public void incrementSelectedNeighbors()
```
    Increases the number of selected neighbors by 1
  - clearSelectionData
```
public void clearSelectionData()
```
    Clear all selection data. This method does NOT inform neighbors of this fact, since it is assumed that this is called when all data should be cleared.
  - getDegree
```
public int getDegree()
```
    Returns the number of edges connected to this vertex
    
    Returns:
    
    The number of edges connected to this vertex
  - getInitCoordinates
```
public java.awt.Point getInitCoordinates()
```
    This method returns the intial coordinates of this vertex on the graph.
    
    Returns:
    
    The point that represents the coordinates
  - setInitCoordinates
```
public void setInitCoordinates(java.awt.Point initCoordinates)
```
    This method sets the initial coordinates of a vertex on the graph.
    
    Parameters:
    
    initCoordinates - The point that represents this vertex's coordinates
  - setInitCoordinatesToCurrentCoordinates
```
public void setInitCoordinatesToCurrentCoordinates()
```
    This method sets the initial coordinates of this vertex to its current coordinates
  - getCoordinates
```
public java.awt.Point getCoordinates()
```
    This method returns the coordinates of this vertex.
    
    Returns:
    
    The point that represent the coordinates of this vertex
  - setCoordinates
```
public void setCoordinates(java.awt.Point coordinates)
```
    This method sets the coordinates of this vertex to the input value.
    
    Parameters:
    
    coordinates - The coordinates that this vertex will be moved to
  - coordinatesChanged
```
public boolean coordinatesChanged()
```
    Tells whether or not the coordinates of this vertex are different than its initial coordinates
    
    Returns:
    
    True if this vertex's current coordinates are the different from its initial coordinates and false otherwise
  - translate
```
public void translate(java.awt.Point change)
```
    Adds the x and y values of the passed in Point to this vertex's coordinates.
    
    Parameters:
    
    change - The point that represents the shift.
  - isAdjacent
```
public boolean isAdjacent(Vertex vertex)
```
    This method checks to see if this vertex is connected to the vertex that is passed in.
    
    Parameters:
    
    vertex - The vertex that needs to compared with this vertex
    
    Returns:
    
    true if this are adjacent, and false otherwise
  - addDirectedEdge
```
public void addDirectedEdge(Vertex vertex)
```
    This method adds a directed edge from this vertex to the vertex that was passed in.
    
    Parameters:
    
    vertex - The vertex that this vertex will have a directed edge point to
  - addEdge
```
public void addEdge(Vertex vertex)
```
    This method creates an undirected edge between this vertex and the vertex that was passed in.
    
    Parameters:
    
    vertex - The vertex that will share and undirected edge with this one
  - removeDirectedEdge
```
public void removeDirectedEdge(Vertex vertex)
```
    This method will remove a directed edge that is between this vertex and the vertex that is passed in.
    
    Parameters:
    
    vertex - The vertex that the edge will be pointed towards (The direction is from this vertex to the passed in vertex)
  - removeEdge
```
public void removeEdge(Vertex vertex)
```
    This method removes the edge between this vertex and the vertex that is passed in.
    
    Parameters:
    
    vertex - The second vertex that the edge will exist between
  - deleteAllNeighbors
```
public void deleteAllNeighbors()
```
    This method causes all edges from the vertices adjacent this one to be deleted.
  - getAdjacencyList
```
public java.util.List<Vertex> getAdjacencyList()
```
    This method returns the list of all vertices that are adjacent to this one.
    
    Returns:
    
    The list of vertices that are adjacent to this one
  - setAdjacencyList
```
public void setAdjacencyList(java.util.List<Vertex> adjList)
```
    This method sets the list of adjacent vertices to be the list of vertices that is passed in to this method. WARNING! This method could make selected neighbors data out of date. It is assumed it is only called on an empty data structure so it should not cause a problem, but if this method is used elsewhere problems may crop up. CAC, Feb 2010.
    
    Parameters:
    
    adjList - The list of vertices that are going to be set as adjacent to this vertex
  - resetCoordinates
```
public void resetCoordinates()
```
    This method resets the coordinates of this vertex (moves it back to its intial location).
  - getMyGraph
```
public Graph getMyGraph()
```
    This method returns the graph that this vertex contains. This method will primarily be used to get the index of this vertex.
    
    Returns:
    
    Graph The graph that this vertex is on
  - setMyGraph
```
public void setMyGraph(Graph g)
```
    Sets the graph that this vertex belongs to to the passed in graph
    
    Parameters:
    
    g - The graph that this vertex is to belong to
  - getIndex
```
public int getIndex()
```
    Returns the index of this vertex
    
    Returns:
    
    The index of this vertex
  - getIndexWhenFirstAddedOrBeforeRemoved
```
public int getIndexWhenFirstAddedOrBeforeRemoved()
```
    Gets the original index of this vertex
    
    Returns:
    
    The original index of this vertex
  - setIndexWhenFirstAddedOrBeforeRemoved
```
public void setIndexWhenFirstAddedOrBeforeRemoved(int indexWhenFirstAddedOrBeforeRemoved)
```
    Sets the original index of this vertex
  - setIndexWhenFirstAddedOrBeforeRemovedToCurrentIndex
```
public void setIndexWhenFirstAddedOrBeforeRemovedToCurrentIndex()
```
    Sets the original index of this vertex to its current index
  - compareTo
```
public int compareTo(Vertex other)
```
    From the Comparable interface.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<Vertex>
    
    Returns:
    
    A positive value if this vertex's original index is greater than the index of the passed in vertex, zero if the indices are the same, and a negative value otherwise.

Class Vertex

Constructor Summary

Method Summary

Methods inherited from class java.util.Observable

Methods inherited from class java.lang.Object

Constructor Detail

Vertex

Vertex

Method Detail

getTimeStamp

setTimeStamp

isTarget

isSelected

setSelected

decrementSelectedNeighbors

incrementSelectedNeighbors

clearSelectionData

getDegree

getInitCoordinates

setInitCoordinates

setInitCoordinatesToCurrentCoordinates

getCoordinates

setCoordinates

coordinatesChanged

translate

isAdjacent

addDirectedEdge

addEdge

removeDirectedEdge

removeEdge

deleteAllNeighbors

getAdjacencyList

setAdjacencyList

resetCoordinates

getMyGraph

setMyGraph

getIndex

getIndexWhenFirstAddedOrBeforeRemoved

setIndexWhenFirstAddedOrBeforeRemoved

setIndexWhenFirstAddedOrBeforeRemovedToCurrentIndex

compareTo