rioko.searchers

Class BreadthSearchIterator<V extends Vertex>

java.lang.Object

rioko.searchers.SearchIterator<V>

rioko.searchers.BreadthSearchIterator<V>

Type Parameters:

V - Class of the vertex of the graph.

All Implemented Interfaces:

java.util.Iterator<V>

Direct Known Subclasses:

DirectedSearchIterator, UndirectedSearchIterator

public abstract class BreadthSearchIterator<V extends Vertex>
extends SearchIterator<V>

Breadth search algorithm used in graphs of the class AbstractGraph<V,E>.

Author:

Antonio

Field Summary

Fields inherited from class rioko.searchers.SearchIterator

parentOf

Constructor Summary

Constructors

Constructor and Description
BreadthSearchIterator(AdjacencyListGraph<V,? extends Edge<V>> graph, V root)

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
protected abstract boolean	isValidEdge(Edge<V> edge, V currentVertex) Abstract method to know if an edge is valid to explore in the breadth algorithm.
protected boolean	isValidVertex(V vertex) Method to know if a vertex is valid for the breadth algorithm
V	next()
protected void	setSearchAll(boolean searchAll) Setter method for parameter searchAll

Methods inherited from class rioko.searchers.SearchIterator

getParent, isFound, 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

Constructor Detail

BreadthSearchIterator

public BreadthSearchIterator(AdjacencyListGraph<V,? extends Edge<V>> graph,
                             V root)

Method Detail

setSearchAll

protected void setSearchAll(boolean searchAll)

Setter method for parameter searchAll

Parameters:

searchAll - boolean which will be establish as value for the parameter.

isValidVertex

protected boolean isValidVertex(V vertex)

Method to know if a vertex is valid for the breadth algorithm

Parameters:

vertex - Vertex we want to check.

Returns:

True if the vertex should be add to the queue when the algorithm reach it and false otherwise.

isValidEdge

protected abstract boolean isValidEdge(Edge<V> edge,
                                       V currentVertex)

Abstract method to know if an edge is valid to explore in the breadth algorithm.

Parameters:

edge - Edge we want to check.

currentVertex - Vertex where the algorithm is exploring currently.

Returns:

True if the edge should be explore in this step of the algorithm.

hasNext

public boolean hasNext()

next

public V next()