TreeElementIterator

java.lang.Object
- TreeElementIterator<E,K>

Type Parameters:

E - The type of element that the BinarySearchTree will hold. Please note that E must implement the KeyElementInterface or some super class of E must implement the KeyElementInterface.

K - The type of key that all elements must contain. Please note that K must implement the Comparable interface or some super class of K must implement the Comparable interface.

All Implemented Interfaces:

java.util.Iterator<E>
```
public class TreeElementIterator<E extends KeyedElementInterface<K>,K extends java.lang.Comparable<? super K>>
extends java.lang.Object
implements java.util.Iterator<E>
```
The TreeIterator allows a user of a BinarySearchTree to iterate through the TreeItems currently in the tree in one of the following Key orders:
1. preOrder
2. inOrder
3. postOrder
Users will set the desired order and access the TreeItems using the Iterator interface.
Author:

Sameh Fakhouri

Field Summary

Fields
Modifier and Type	Field and Description
`private BinarySearchTree<E,K>`	`bst` Instance variable representing the `BinarySearchTree` that this iterator will operate on.
`private java.util.Vector<TreeNode<E,K>>`	`treeNodes` A Vector that will be used to contain the elements in configure order (preOrder, inOrder, or postOrder).

Constructor Summary

Constructors
Constructor and Description

TreeElementIterator(BinarySearchTree<E,K> binarySearchTree)
This is the constructor for the TreeElementIterator.

Constructors
Constructor and Description
`TreeElementIterator(BinarySearchTree<E,K> binarySearchTree)` This is the constructor for the `TreeElementIterator`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`hasNext()` This method is used to verify that the `TreeElementIterator` has more elements to return.
`private void`	`inOrder(TreeNode<E,K> treeNode)` A recursive method that traverses the binary search tree rooted at the specified `treeNode` in in-order, adding the visited nodes to the `treeNodes` Vector.
`boolean`	`isEmpty()` This method is used to check if the iterator is empty.
`E`	`next()` This method is used to retrieve the next element from the `TreeElementIterator`.
`private void`	`postOrder(TreeNode<E,K> treeNode)` A recursive method that traverses the binary search tree rooted at the specified `treeNode` in post-order, adding the visited nodes to the `treeNodes` Vector.
`private void`	`preOrder(TreeNode<E,K> treeNode)` A recursive method that traverses the binary search tree rooted at the specified `treeNode` in pre-order, adding the visited nodes to the `treeNodes` Vector.
`void`	`setInOrder()` This method sets the order of retrieval from the `TreeElementIterator` to be inOrder.
`void`	`setPostOrder()` This method sets the order of retrieval from the `TreeElementIterator` to be postOrder.
`void`	`setPreOrder()` This method sets the order of retrieval from the `TreeElementIterator` to be preOrder.
`int`	`size()` This method is used to obtain the number of elements available in the iterator.

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

Methods inherited from interface java.util.Iterator
forEachRemaining, remove

- Field Detail
  - bst
```
private BinarySearchTree<E extends KeyedElementInterface<K>,K extends java.lang.Comparable<? super K>> bst
```
    Instance variable representing the BinarySearchTree that this iterator will operate on.
  - treeNodes
```
private java.util.Vector<TreeNode<E extends KeyedElementInterface<K>,K extends java.lang.Comparable<? super K>>> treeNodes
```
    A Vector that will be used to contain the elements in configure order (preOrder, inOrder, or postOrder).
- Constructor Detail
  - TreeElementIterator
```
public TreeElementIterator(BinarySearchTree<E,K> binarySearchTree)
```
    This is the constructor for the TreeElementIterator. The constructor will initialize the Iterator to initially provide the elements using inOrder traversal.
    
    Parameters:
    
    binarySearchTree - The BinarySearchTree that this iterator will operate on.
- Method Detail
  - size
```
public int size()
```
    This method is used to obtain the number of elements available in the iterator.
    
    Returns:
    
    Returns the number of TreeNode's available in the iterator.
  - isEmpty
```
public boolean isEmpty()
```
    This method is used to check if the iterator is empty.
    
    Returns:
    
    Returns true if the iterator is emtpy, false otherwise.
  - hasNext
```
public boolean hasNext()
```
    This method is used to verify that the TreeElementIterator has more elements to return.
    
    Specified by:
    
    hasNext in interface java.util.Iterator<E extends KeyedElementInterface<K>>
    
    Returns:
    
    Returns true if there are more elements to return, false otherwise.
  - next
```
public E next()
       throws java.util.NoSuchElementException
```
    This method is used to retrieve the next element from the TreeElementIterator.
    
    Specified by:
    
    next in interface java.util.Iterator<E extends KeyedElementInterface<K>>
    
    Returns:
    
    Returns the next element from the TreeElementIterator.
    
    Throws:
    
    java.util.NoSuchElementException
  - setPreOrder
```
public void setPreOrder()
```
    This method sets the order of retrieval from the TreeElementIterator to be preOrder. This method will call the private method preOrder() in order to populate the treeNodes Vector of elements.
  - setInOrder
```
public void setInOrder()
```
    This method sets the order of retrieval from the TreeElementIterator to be inOrder. This method will call the private method inOrder() in order to populate the treeNodes Vector of elements.
  - setPostOrder
```
public void setPostOrder()
```
    This method sets the order of retrieval from the TreeElementIterator to be postOrder. This method will call the private method postOrder() in order to populate the treeNodes Vector of elements.
  - preOrder
```
private void preOrder(TreeNode<E,K> treeNode)
```
    A recursive method that traverses the binary search tree rooted at the specified treeNode in pre-order, adding the visited nodes to the treeNodes Vector.
    
    Parameters:
    
    treeNode - The node specifying the root of the binary search tree being traversed.
  - inOrder
```
private void inOrder(TreeNode<E,K> treeNode)
```
    A recursive method that traverses the binary search tree rooted at the specified treeNode in in-order, adding the visited nodes to the treeNodes Vector.
    
    Parameters:
    
    treeNode - The node specifying the root of the binary search tree being traversed.
  - postOrder
```
private void postOrder(TreeNode<E,K> treeNode)
```
    A recursive method that traverses the binary search tree rooted at the specified treeNode in post-order, adding the visited nodes to the treeNodes Vector.
    
    Parameters:
    
    treeNode - The node specifying the root of the binary search tree being traversed.

Class TreeElementIterator<E extends KeyedElementInterface<K>,K extends java.lang.Comparable<? super K>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Iterator

Field Detail

bst

treeNodes

Constructor Detail

TreeElementIterator

Method Detail

size

isEmpty

hasNext

next

setPreOrder

setInOrder

setPostOrder

preOrder

inOrder

postOrder