/*

     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 14.01.2005

  *

  */

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

 import net.sourceforge.combean.graph.except.UnsupportedGraphProperty;

 import net.sourceforge.combean.interfaces.graph.Graph;

 /**

  * The base interface for all graph algorithms.

  * 

  * @author schickin

  *

  */

 public interface GraphAlgorithm {

         /**

          * Set the graph on which the algorithm shall work.

          * 

          * @param g the graph

          * @throws UnsupportedGraphProperty thrown if g does not have all properties

          * required by the algorithm.

          */

         public void setGraph(Graph g)

         throws UnsupportedGraphProperty;

         /**

          * @return the graph on which the algorithm works.

          */

         public Graph getGraph();

         /**

          * Execute the algorithm.

          */

         public void run();

 }