rioko.searchers

Class SearchIterator<E>

java.lang.Object

rioko.searchers.SearchIterator<E>

Type Parameters:

E - Class of the elements that are being searched.

All Implemented Interfaces:

java.util.Iterator<E>

Direct Known Subclasses:

BreadthSearchIterator

public abstract class SearchIterator<E>
extends java.lang.Object
implements java.util.Iterator<E>

Search iterator throught different elements. This abstract class gives an interface to code search algorithms.

Author:

Antonio

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.HashMap<E,E>	parentOf

Constructor Summary

Constructors

Constructor and Description
SearchIterator()

Method Summary

Modifier and Type	Method and Description
E	getParent(E object) Public method to get the parent of an element that has been found in the search.
boolean	isFound(E object) Public method that allows to know if an element has been found in the search.
void	remove()

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, hasNext, next

Field Detail

parentOf

protected java.util.HashMap<E,E> parentOf

Constructor Detail

SearchIterator

public SearchIterator()

Method Detail

isFound

public boolean isFound(E object)

Public method that allows to know if an element has been found in the search. It is necessary to use before getParent() method.

Parameters:

object - Object to check

Returns:

True if the iterator has pass through this object and false otherwise

getParent

public E getParent(E object)

Public method to get the parent of an element that has been found in the search. Return null if it is the root. If the object has not been yet found, this method will return null too. ĦBe careful!

Parameters:

object - Object to check

Returns:

E with the parent of object. If it is the root of the search, returns null.

remove

public void remove()

Specified by:

remove in interface java.util.Iterator<E>