import java.util.*;
/**
 * RoadPoints.java
 *
 *
 * Created: Mon Nov 29 21:50:36 2004
 *
 * @author <a href="mailto:albaab01@gettysburg.edu">Disha Al Baqui</a> 
 * @author <a href="mailto:bassdo02@gettysburg.edu">Donald W. Bassett</a> 
 * @author <a href="mailto:ranamo01@gettysburg.edu">Monica A. Ranadive</a>
 * @author <a href="mailto:schmky0101@gettysburg.edu">Kyle R. Schmidt</a>
 * @version 1.0
 */
public class RoadPoints extends SearchNode {

    /**
     * <code>index</code> - the index holds the ID for the roadPts,
     * this is an arbitrary number given to the roadPoint by the
     * programmer (this number will change with each map rcreated)
     *
     */
    private int index;

    /**
     * <code>children</code> - the vector of children hold all the
     * other roadPts this roadPoint can get to directly
     *
     */
    private Vector children;

    /**
     * <code>isGoal</code> - holds a boolean value (set by the Map
     * class) of whether or not this node is actually the goal for the
     * map traversal problem. The value of this boolean is initially
     * set to false, it can be changed later with the setGoal()
     * method.
     *
     */
    private boolean isGoal = false;
    
    /**
     * Creates a new <code>RoadPoints</code> instance.
     *
     * When the roadPoint is initialized, it initializes the index to
     * a given integer and initializes the vector of children
     * (children will be entered later)
     *
     * @param index an <code>int</code> value - the index of the
     * roadPoint
     */
    public RoadPoints(int index){	
	this.index = index;
	children = new Vector();
    }
 
    /**
     * <code>addChild</code> - this method adds a child to the
     * children vector
     *
     * @param child a <code>RoadPoints</code> value - a RoadPoint this
     * is connected to
     */
    public void addChild(RoadPoints child)
    {
	children.addElement(child);
	child.parent = this;
    }

    /**
     * <code>setGoal</code> - will change the isGoal boolean from
     * false to true, making it the goal for the robot
     *
     */
    public void setGoal()
    {
	isGoal = true;
    }
    
    /**
     * <code>isConnected</code> - this method will return whether the
     * current node is a parent of another node that is specified in
     * the parameters of the method
     *
     * @param point a <code>RoadPoints</code> value - the child in question
     * @return a <code>boolean</code> value - returns true if the two
     * road points are connected, otherwise returns false
     */
    public boolean isConnected(RoadPoints point)
    {
	for(int i = 0; i < children.size(); i++){
	    if((children.elementAt(i)).equals(point))
		return true;
	}
	return false;
    }

    /**
     * <code>expand</code> - method is used in the
     * BreadthFirstSearcher to find the optimal path for the robot, it
     * returns the children of the current road point
     *
     * @return a <code>Vector</code> value - the children of the road
     * point
     */
    public Vector expand()
    {
	return children;
    }

    /**
     * <code>isGoal</code> - returns a boolean value of whether this
     * point is the goal or not
     *
     * @return a <code>boolean</code> value - returns true if this
     * point is the goal, false otherwise
     */
    public boolean 	    //System.out.println(map);
	}
isGoal()
    {
	return isGoal;
    }    

    /**
     * <code>getIndex</code> - returns the index of the road point
     * (this index is specified by the programmer in the Map class)
     *
     * @return an <code>int</code> value - returns the index of the
     * road point
     */
    public int getIndex()
    {
	return index;
    }

    /**
     * <code>toString</code> - returns a string representation of the
     * road point. Since the point does not have too many variables,
     * it simply returns the point's index as a string.
     *
     * @return a <code>String</code> value
     */
    public String toString()
    {
	return new Integer(index).toString();
    }

} // RoadPoints