/*

     This file is part of Combean.

     Combean is free software; you can redistribute it and/or modify

     it under the terms of the GNU General Public License as published by

     the Free Software Foundation; either version 2 of the License, or

     (at your option) any later version.

     Combean 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 General Public License for more details.

     You should have received a copy of the GNU General Public License

     along with Combean; if not, write to the Free Software

     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

 */

 /*

  * Created on 24.03.2005

  *

  */

 package net.sourceforge.combean.graph.alg.partition;

 import net.sourceforge.combean.graph.alg.AbstractGraphAlg;

 import net.sourceforge.combean.graph.containers.NodeNumberingAdvisor;

 import net.sourceforge.combean.interfaces.graph.alg.partition.NodePartitionVisitor;

 import net.sourceforge.combean.interfaces.graph.alg.partition.StronglyConnectedComponentsAlg;

 import net.sourceforge.combean.interfaces.graph.containers.NodeNumbering;

 /**

  * A convenience class for implementing SCC algorithms.

  * 

  * @author schickin

  *

  */

 public abstract class AbstractSCCImpl extends AbstractGraphAlg

 implements StronglyConnectedComponentsAlg {

     private NodePartitionVisitor partitionVisitor = null;

     /**

      * constructor

      */

     public AbstractSCCImpl() {

         super();

    }

     /* (non-Javadoc)

      * @see net.sourceforge.combean.interfaces.graph.alg.partition.PartitioningAlg#setVisitor(net.sourceforge.combean.interfaces.graph.alg.partition.NodePartitionVisitor)

      */

     public void setVisitor(NodePartitionVisitor partitionVisitor) {

         this.partitionVisitor = partitionVisitor;

     }

     /* (non-Javadoc)

      * @see net.sourceforge.combean.interfaces.graph.alg.partition.PartitioningAlg#getVisitor()

      */

     public NodePartitionVisitor getVisitor() {

         return this.partitionVisitor;

     }

     /**

      * Set a NodeNumbering as Visitor for the strongly connected components.

      * The NodeNumbering will be filled with the number of the SCCs,

      * starting with 0.

      * 

      * @return the NodeNumbering to be used as Visitor

      */

     public final NodeNumbering setNodeNumberingAsVisitor() {

         NodeNumbering numbering =

             NodeNumberingAdvisor.getFastestNodeNumbering(getGraph());

         setVisitor(new NodeNumberingAsPartitionVisitor(numbering));

         return numbering;

     }

 }