org.jgrapht.traverse.AbstractGraphIterator Maven / Gradle / Ivy
Go to download
JGraphT is a free Java graph library
that provides mathematical graph-theory objects and algorithms
The newest version!
/* ==========================================
* JGraphT : a free Java graph-theory library
* ==========================================
*
* Project Info: http://jgrapht.sourceforge.net/
* Project Creator: Barak Naveh ([email protected])
*
* (C) Copyright 2003-2007, by Barak Naveh and Contributors.
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library; if not, write to the Free Software Foundation,
* Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
*/
/* --------------------------
* AbstractGraphIterator.java
* --------------------------
* (C) Copyright 2003-2007, by Barak Naveh and Contributors.
*
* Original Author: Barak Naveh
* Contributor(s): Christian Hammer
*
* $Id: AbstractGraphIterator.java 568 2007-09-30 00:12:18Z perfecthash $
*
* Changes
* -------
* 24-Jul-2003 : Initial revision (BN);
* 11-Aug-2003 : Adaptation to new event model (BN);
* 04-May-2004 : Made generic (CH)
*
*/
package org.jgrapht.traverse;
import java.util.*;
import org.jgrapht.event.*;
/**
* An empty implementation of a graph iterator to minimize the effort required
* to implement graph iterators.
*
* @author Barak Naveh
* @since Jul 19, 2003
*/
public abstract class AbstractGraphIterator
implements GraphIterator
{
//~ Instance fields --------------------------------------------------------
private List> traversalListeners =
new ArrayList>();
private boolean crossComponentTraversal = true;
private boolean reuseEvents = false;
//~ Methods ----------------------------------------------------------------
/**
* Sets the cross component traversal flag - indicates whether to traverse
* the graph across connected components.
*
* @param crossComponentTraversal if true traverses across
* connected components.
*/
public void setCrossComponentTraversal(boolean crossComponentTraversal)
{
this.crossComponentTraversal = crossComponentTraversal;
}
/**
* Test whether this iterator is set to traverse the graph across connected
* components.
*
* @return true if traverses across connected components,
* otherwise false.
*/
public boolean isCrossComponentTraversal()
{
return crossComponentTraversal;
}
/**
* @see GraphIterator#setReuseEvents(boolean)
*/
public void setReuseEvents(boolean reuseEvents)
{
this.reuseEvents = reuseEvents;
}
/**
* @see GraphIterator#isReuseEvents()
*/
public boolean isReuseEvents()
{
return reuseEvents;
}
/**
* Adds the specified traversal listener to this iterator.
*
* @param l the traversal listener to be added.
*/
public void addTraversalListener(TraversalListener l)
{
if (!traversalListeners.contains(l)) {
traversalListeners.add(l);
}
}
/**
* Unsupported.
*
* @throws UnsupportedOperationException
*/
public void remove()
{
throw new UnsupportedOperationException();
}
/**
* Removes the specified traversal listener from this iterator.
*
* @param l the traversal listener to be removed.
*/
public void removeTraversalListener(TraversalListener l)
{
traversalListeners.remove(l);
}
/**
* Informs all listeners that the traversal of the current connected
* component finished.
*
* @param e the connected component finished event.
*/
protected void fireConnectedComponentFinished(
ConnectedComponentTraversalEvent e)
{
int len = traversalListeners.size();
for (int i = 0; i < len; i++) {
TraversalListener l = traversalListeners.get(i);
l.connectedComponentFinished(e);
}
}
/**
* Informs all listeners that a traversal of a new connected component has
* started.
*
* @param e the connected component started event.
*/
protected void fireConnectedComponentStarted(
ConnectedComponentTraversalEvent e)
{
int len = traversalListeners.size();
for (int i = 0; i < len; i++) {
TraversalListener l = traversalListeners.get(i);
l.connectedComponentStarted(e);
}
}
/**
* Informs all listeners that a the specified edge was visited.
*
* @param e the edge traversal event.
*/
protected void fireEdgeTraversed(EdgeTraversalEvent e)
{
int len = traversalListeners.size();
for (int i = 0; i < len; i++) {
TraversalListener l = traversalListeners.get(i);
l.edgeTraversed(e);
}
}
/**
* Informs all listeners that a the specified vertex was visited.
*
* @param e the vertex traversal event.
*/
protected void fireVertexTraversed(VertexTraversalEvent e)
{
int len = traversalListeners.size();
for (int i = 0; i < len; i++) {
TraversalListener l = traversalListeners.get(i);
l.vertexTraversed(e);
}
}
/**
* Informs all listeners that a the specified vertex was finished.
*
* @param e the vertex traversal event.
*/
protected void fireVertexFinished(VertexTraversalEvent e)
{
int len = traversalListeners.size();
for (int i = 0; i < len; i++) {
TraversalListener l = traversalListeners.get(i);
l.vertexFinished(e);
}
}
}
// End AbstractGraphIterator.java