TreeNode

java.lang.Object
- keel.Algorithms.Decision_Trees.PUBLIC.TreeNode

```
public class TreeNode
extends java.lang.Object
```
File: TreeNode.java Data structure that is used in the construction of the decision tree. It stores the information about the relationship between nodes in a tree, and the type of node that it is. This class has a identifier that relates the instances of this class with the instances of the Node class.

Since:

JDK1.5

Version:

1.0

Author:

Written by Victoria Lopez Morales (University of Granada) 29/04/2009

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.ArrayList<java.lang.Integer>`	`deleteDescendants(int original_identifier)` Removes the descendants from a identifier given of a node.
`boolean`	`equals(java.lang.Object obj)` Checks if a node is the same node as another object
`int`	`evaluate(double[] ind, java.util.ArrayList<myAttribute> atts)` Classifies a given item with the information stored in the node and its descendants
`Split`	`getCondition()` Gets the relationship between this node and its descendats, that's the way to split this node in two
`int`	`getIdentifier()` Gets the identifier of the node
`int`	`getLeafs()` Gets the number of leaf nodes from this node and its descendants
`TreeNode`	`getLeft()` Gets the left descendant of the node, if it is not a leaf node
`TreeNode`	`getNode(int id)` Searches a descendant node from this node with a specific id
`int`	`getNumNodes()` Gets the number of internal nodes from this node and its descendants.
`int`	`getOutputClass()` Gets the output class stored for the node.
`TreeNode`	`getRight()` Gets the right descendant of the node, if it is not a leaf node
`int`	`hashCode()` Hash-code function for the class that is used when object is inserted in a structure like a hashtable
`boolean`	`isLeaf()` Answers if the node is a leaf node or not
`java.lang.String`	`printTree(java.util.ArrayList<myAttribute> atts, myAttribute outputAttribute)` Prints the tree in a String with all the information that makes it human readable
`void`	`setCondition(Split condition)` Replaces the relationship between this node and its descendants, this means, changing the condition how the two descendants are created.
`void`	`setIdentifier(int identifier)` Replaces the identifier of the node with another new node
`void`	`setLeaf(boolean isLeaf)` Changes the logical attribute stating if a node is leaf or not
`void`	`setLeft(TreeNode left)` Replaces the left descendant of the node with another new left descendant
`void`	`setOutputClass(int outputClass)` Replaces the output class of the node with another new output class
`void`	`setRight(TreeNode right)` Replaces the right descendant of the node with another new right descendant
`java.lang.String`	`toString()` Overriden function that converts the class to a string

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Checks if a node is the same node as another object
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    obj - Object that is checked to see if it is the same node
    
    Returns:
    
    true if the nodes are the same, false otherwise
    
    See Also:
    
    Object.equals(java.lang.Object)
  - hashCode
```
public int hashCode()
```
    Hash-code function for the class that is used when object is inserted in a structure like a hashtable
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    the hash code obtained
    
    See Also:
    
    Object.hashCode()
  - toString
```
public java.lang.String toString()
```
    Overriden function that converts the class to a string
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the string representation of the class
    
    See Also:
    
    Object.toString()
  - printTree
```
public java.lang.String printTree(java.util.ArrayList<myAttribute> atts,
                                  myAttribute outputAttribute)
```
    Prints the tree in a String with all the information that makes it human readable
    
    Parameters:
    
    atts - Attributes used in the dataset for building the tree that are needed to change the numberical information stored in the tree to words information
    
    outputAttribute - Attribute used for the class in the dataset for building the tree that is needed in a similar way to the attributes
    
    Returns:
    
    a String with the tree in it
  - getIdentifier
```
public int getIdentifier()
```
    Gets the identifier of the node
    
    Returns:
    
    the identifier of the node
  - setIdentifier
```
public void setIdentifier(int identifier)
```
    Replaces the identifier of the node with another new node
    
    Parameters:
    
    identifier - New identifier for the node
  - getLeft
```
public TreeNode getLeft()
```
    Gets the left descendant of the node, if it is not a leaf node
    
    Returns:
    
    the left descendant of the node
  - setLeft
```
public void setLeft(TreeNode left)
```
    Replaces the left descendant of the node with another new left descendant
    
    Parameters:
    
    left - New node that is going to be kept as left descendant of this node
  - getRight
```
public TreeNode getRight()
```
    Gets the right descendant of the node, if it is not a leaf node
    
    Returns:
    
    the left descendant of the node
  - setRight
```
public void setRight(TreeNode right)
```
    Replaces the right descendant of the node with another new right descendant
    
    Parameters:
    
    right - New node that is going to be kept as right descendant of this node
  - isLeaf
```
public boolean isLeaf()
```
    Answers if the node is a leaf node or not
    
    Returns:
    
    true if the node is a leaf node, false otherwise
  - setLeaf
```
public void setLeaf(boolean isLeaf)
```
    Changes the logical attribute stating if a node is leaf or not
    
    Parameters:
    
    isLeaf - Logical value stating if a node is leaf or not
  - getOutputClass
```
public int getOutputClass()
```
    Gets the output class stored for the node. It should be considered only when the node is a leaf node
    
    Returns:
    
    the output class of the node
  - setOutputClass
```
public void setOutputClass(int outputClass)
```
    Replaces the output class of the node with another new output class
    
    Parameters:
    
    outputClass - New output class for the node
  - getCondition
```
public Split getCondition()
```
    Gets the relationship between this node and its descendats, that's the way to split this node in two
    
    Returns:
    
    the split for this node
  - setCondition
```
public void setCondition(Split condition)
```
    Replaces the relationship between this node and its descendants, this means, changing the condition how the two descendants are created. When using this function is highly recommended using the setLeft() and setRight() functions too
    
    Parameters:
    
    condition - New relationship between this node and its descendants
  - getNode
```
public TreeNode getNode(int id)
```
    Searches a descendant node from this node with a specific id
    
    Parameters:
    
    id - Identifier of the node we are searching for
    
    Returns:
    
    the TreeNode with the specified id
  - getNumNodes
```
public int getNumNodes()
```
    Gets the number of internal nodes from this node and its descendants. If this is a leaf node the number of internal nodes is 0.
    
    Returns:
    
    the number of internal nodes from this node and its descendants
  - getLeafs
```
public int getLeafs()
```
    Gets the number of leaf nodes from this node and its descendants
    
    Returns:
    
    the number of leaf nodes from this node and its descendants
  - evaluate
```
public int evaluate(double[] ind,
                    java.util.ArrayList<myAttribute> atts)
```
    Classifies a given item with the information stored in the node and its descendants
    
    Parameters:
    
    ind - Data attribute values for the item we are classifying
    
    atts - Attributes in the data set that are used for building the tree and describing the instance given
    
    Returns:
    
    the class asigned to the item given
  - deleteDescendants
```
public java.util.ArrayList<java.lang.Integer> deleteDescendants(int original_identifier)
```
    Removes the descendants from a identifier given of a node. The nodes whose descendants are being removed become leaf nodes
    
    Parameters:
    
    original_identifier - Identifier of the node that is becoming a leaf node and whose descendants are being removed
    
    Returns:
    
    ArrayList with all the identifiers of the nodes that are being removed

Class TreeNode

Method Summary

Methods inherited from class java.lang.Object

Method Detail

equals

hashCode

toString

printTree

getIdentifier

setIdentifier

getLeft

setLeft

getRight

setRight

isLeaf

setLeaf

getOutputClass

setOutputClass

getCondition

setCondition

getNode

getNumNodes

getLeafs

evaluate

deleteDescendants