com.example.sulemaia.Model

Class PathManualTree

java.lang.Object

com.example.sulemaia.Model.PathManualTree

public class PathManualTree
extends Object

Whole class for the creation of the tree that belongs to the manual gameplay (i.e.: when the game is not running with automatic algorithms like A*, Uniform Cost or BestCost.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PathManualTree.Node Public class that contains all the attributes of the node that corresponds to a Manual Tree (Different from a Heuristic Tree Node).

Field Summary

Fields

Modifier and Type	Field and Description
private PathManualTree.Node	anchor
private ArrayList<PathManualTree.Node>	expansionOrder
private GraphViz	graphVizHelper
private HashSet<PathManualTree.Node>	visitedInExpanded
private HashSet<PathManualTree.Node>	visitedNodes

Constructor Summary

Constructors

Constructor and Description
PathManualTree(PathManualTree.Node anchor) Initialize a graphViz tree with an initial node received by parameter, which is the anchor.

Method Summary

Modifier and Type	Method and Description
void	addMovement(PathManualTree.Node child) Create a step movement between father and child
void	addNode(PathManualTree.Node father, PathManualTree.Node child) This method adds a child to the specified node.
void	addNodeToInvalidNodes(PathManualTree.Node node) this method adds a node to a list of inaccessible nodes
private void	drawTree(PathManualTree.Node node) We draw the tree node by node checking which nodes are the actual node's children.
void	endTree() We have to manually end the tree, again, so the nodes wont be displayed in an incorrect order on the graphic implementation.
boolean	exists(PathManualTree.Node child) Method to check if the node already exist as a child, so we wont repeat nodes, or even that we have the chance to change it to another father to correct the flow of the tree.
String	getDotTree() Get the source for the tree creation from the GraphViz class.
void	setFinal(PathManualTree.Node node) Set a certain node as the final node for the graphical implementation.
void	setInitial(PathManualTree.Node node) Set a certain node as the initial node for the graphical implementation.

Methods inherited from class java.lang.Object

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

Field Detail

anchor

private PathManualTree.Node anchor

graphVizHelper

private GraphViz graphVizHelper

visitedNodes

private HashSet<PathManualTree.Node> visitedNodes

visitedInExpanded

private HashSet<PathManualTree.Node> visitedInExpanded

expansionOrder

private ArrayList<PathManualTree.Node> expansionOrder

Constructor Detail

PathManualTree

public PathManualTree(PathManualTree.Node anchor)

Initialize a graphViz tree with an initial node received by parameter, which is the anchor.

Parameters:

anchor - initial node for the tree.

Method Detail

addNodeToInvalidNodes

public void addNodeToInvalidNodes(PathManualTree.Node node)

this method adds a node to a list of inaccessible nodes

Parameters:

node - node to set inaccessible

addNode

public void addNode(PathManualTree.Node father,
                    PathManualTree.Node child)

This method adds a child to the specified node. If the father already has that node, child is not added

Parameters:

father - parent node

child - child node

addMovement

public void addMovement(PathManualTree.Node child)

Create a step movement between father and child

Parameters:

child - final node

exists

public boolean exists(PathManualTree.Node child)

Method to check if the node already exist as a child, so we wont repeat nodes, or even that we have the chance to change it to another father to correct the flow of the tree.

Parameters:

child - Child node to look for.

Returns:

true or false depending on if we find the node or not.

endTree

public void endTree()

We have to manually end the tree, again, so the nodes wont be displayed in an incorrect order on the graphic implementation. This is rather complicated because a lot of things have to be taken in account for the manual gameplay. All these problems are out of the panorama when the game is played automatically by any algorithm.

drawTree

private void drawTree(PathManualTree.Node node)

We draw the tree node by node checking which nodes are the actual node's children.

Parameters:

node - Father node to look for children.

getDotTree

public String getDotTree()

Get the source for the tree creation from the GraphViz class. This is part of the configuration of the URL to create the tree in the git.

Returns:

a dot-language source for the tree.

setInitial

public void setInitial(PathManualTree.Node node)

Set a certain node as the initial node for the graphical implementation.

Parameters:

node - The original node to initiate the graphic tree.

setFinal

public void setFinal(PathManualTree.Node node)

Set a certain node as the final node for the graphical implementation.

Parameters:

node - The final node to get the graphic tree to an end.