/*

     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 17.04.2005

  *

  */

 package net.sourceforge.combean.graph.prop.statics;

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

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

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

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

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

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

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

 /**

  * Utilitiy class which converts graphs and substructures of graphs into

  * human-readable string representations (for debugging purposes)

  * 

  * @author schickin

  *

  */

 public class GraphStringifier {

     /**

      * Convert a path to a string

      * 

      * @param path the path to be converted

      * @return a string representation of path

      */

     public static String convertToString(FixedPath path) {

         StringBuffer result = new StringBuffer();

         result.append("path {");

         NodeIterator itPathNodes = path.getNodeIterator();

         EdgeIterator itPathEdges = path.getEdgeIterator();

         while (itPathEdges.hasNext()) {

             result.append("node {");

             result.append(itPathNodes.next());

             result.append("} edge {");

             result.append(itPathEdges.next());

             result.append("} ");

         }

         result.append("node {");

         result.append(itPathNodes.next());

         result.append("}");

         result.append("}");

         return result.toString();

     }

     /**

      * Convert the edges in an edge iteration to a String

      * 

      * @param itEdges the iterator for which all edges of the iteration shall

      * be converted to a string.

      * @return the string representing the edges in the iteration.

      */

     public static String convertEdgeIterationToString(EdgeIterator itEdges) {

         StringBuffer result = new StringBuffer();

         result.append("edge iterator contents {");

         while (itEdges.hasNext()) {

             result.append(" edge {");

             result.append(itEdges.next());

             result.append("}");

         }

         return result.toString();

     }

     /**

      * Convert a graph to a string consisting of all adjacency lists

      * of outgoing edges

      * 

      * @param g the graph to be converted

      * @return the adjacency lists of outgoing edges of g

      */

     public static String convertOutgoingAdjacencyListsToString(Graph g) {

         OutgoingEdgeNeighborhoodGraphProp outG = (OutgoingEdgeNeighborhoodGraphProp)

             GraphPropertyInitializer.requireGraphProperty(g,

                     OutgoingEdgeNeighborhoodGraphProp.class);

         GlobalNodesGraphProp globNodes = (GlobalNodesGraphProp)

             GraphPropertyInitializer.requireGraphProperty(g,

                     GlobalNodesGraphProp.class);

         StringBuffer result = new StringBuffer();

         result.append("graph outgoing edges {");

         NodeIterator itAllNodes = globNodes.getAllNodesIterator();

         while (itAllNodes.hasNext()) {

             Node v = itAllNodes.next();

             result.append("node {");

             result.append(v);

             result.append("} outgoing edges {");

             EdgeIterator outEdges = outG.getOutgoingEdges(v);

             result.append(convertEdgeIterationToString(outEdges));

             result.append("} ");

         }

         result.append("}");

         return result.toString();

     }

 }