/*

     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 20.08.2005

  *

  */

 package net.sourceforge.combean.test.graph.alg.traversal;

 import java.util.HashSet;

 import junit.framework.TestCase;

 import net.sourceforge.combean.graph.NumberNode;

 import net.sourceforge.combean.graph.alg.traversal.AbstractGraphTraversalAlg;

 import net.sourceforge.combean.graph.alg.traversal.NodeCountVisitor;

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

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

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

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

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

 import net.sourceforge.combean.interfaces.graph.prop.GlobalNumberedGraphProp;

 import net.sourceforge.combean.samples.simplegraphs.IsolatedNodes;

 import net.sourceforge.combean.samples.simplegraphs.Path;

 import net.sourceforge.combean.test.helpers.factories.GraphFixtureFactory;

 import net.sourceforge.combean.test.helpers.stubs.GraphWithoutProperties;

 /**

  * @author schickin

  *

  */

 public abstract class AbstractTestGraphTraversalAlg extends TestCase {

     private static final int NUMNODES = 5;

     private Path path = null;

     private IsolatedNodes isolated = null;

     private AbstractGraphTraversalAlg traversalAlg = null;

     private GlobalNumberedGraphProp directedPath = null;

     /**

      * Constructor for AbstractTestGraphTraversalAlg.

      * @param name

      */

     public AbstractTestGraphTraversalAlg(String name) {

         super(name);

     }

     protected void setUp() throws Exception {

             super.setUp();

             this.path = new Path(NUMNODES);

             this.isolated = new IsolatedNodes(NUMNODES);

             this.directedPath = GraphFixtureFactory.createDirectedPath(NUMNODES);

             this.traversalAlg = createTraversalAlg();

             NodeSet nodeSet = new SetAsNodeSet(new HashSet<Node>(NUMNODES));

             this.traversalAlg.setVisitedNodes(nodeSet);

     }

     protected void tearDown() throws Exception {

             super.tearDown();

     }

     protected abstract AbstractGraphTraversalAlg createTraversalAlg();

     public void testGetAndSetGraph() {

             Graph g = new GraphWithoutProperties();

             try {

                     this.traversalAlg.setGraph(g);

                     fail("graph set without the necessary properties");

             }

             catch (UnsupportedGraphProperty e) {

                     /* fine, expected exception has been throun */

             }

             this.traversalAlg.setGraph(this.path);

             assertEquals("graph not correctly retrieved", this.traversalAlg.getGraph(), 

                             this.path);

     }

     public final void testGlobalTraversalWithNodeCountVisitor() {

             this.traversalAlg.setGraph(this.path);

             NodeCountVisitor vis = new NodeCountVisitor();

             this.traversalAlg.setVisitor(vis);

             this.traversalAlg.run();

             assertEquals("wrong number of nodes counted", NUMNODES, vis.getNodeCount());

     }

     public final void testLocalTraversalWithNodeCountVisitor() {

             this.traversalAlg.setGraph(this.path);

             NumberNode v = new NumberNode(0);

             this.traversalAlg.setLocalStartNode(v);

             NodeCountVisitor vis = new NodeCountVisitor();

             this.traversalAlg.setVisitor(vis);

             this.traversalAlg.run();

             assertEquals("wrong number of nodes counted", NUMNODES, vis.getNodeCount());

     }

     public final void testLocalTraversalOfDirectedGraphWithNodeCountVisitor() {

             this.traversalAlg.setGraph(this.directedPath);

             this.traversalAlg.setUseOnlyOutgoingEdges(true);

             Node v = this.directedPath.getNode(1);

             this.traversalAlg.setLocalStartNode(v);

             NodeCountVisitor vis = new NodeCountVisitor();

             this.traversalAlg.setVisitor(vis);

             this.traversalAlg.run();

             assertEquals("wrong number of nodes counted", NUMNODES-1, vis.getNodeCount());

             this.traversalAlg.setUseOnlyOutgoingEdges(false);

             this.traversalAlg.run();

             assertEquals("wrong number of nodes counted", NUMNODES, vis.getNodeCount());

     }

     public final void testGlobalTraversalWithEmptyGraph() {

             this.traversalAlg.setGraph(this.isolated);

             NodeCountVisitor vis = new NodeCountVisitor();

             this.traversalAlg.setVisitor(vis);

             this.traversalAlg.run();

             assertEquals("wrong number of nodes counted", NUMNODES, vis.getNodeCount());

     }

 }