/*

     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.02.2005

  *

  */

 package net.sourceforge.combean.adapters.jgraph;

 import org.jgraph.graph.GraphModel;

 import net.sourceforge.combean.graph.iterators.IncidentEdgeAsIncomingEdgeIterator;

 import net.sourceforge.combean.graph.iterators.IncidentEdgeAsOutgoingEdgeIterator;

 import net.sourceforge.combean.graph.iterators.IndexedEdgeIterator;

 import net.sourceforge.combean.graph.iterators.IndexedNodeIterator;

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

 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.prop.DirectedEdgeNeighborhoodGraphProp;

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

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

 /**

  * Use a JGraph GraphModel as a Combean Graph

  * 

  * @author schickin

  *

  */

 public class JGraphModelAsGraph implements

         Graph,

         DirectedEdgeNeighborhoodGraphProp,

         GlobalIndexedNodesGraphProp,

         GlobalIndexedEdgesGraphProp {

     private GraphModel graphModel = null;

     private Node[] allNodes = null;

     private Edge[] allEdges = null;

     /**

      * Constructor

      * 

      * @param jgraph the GraphModel to be wrapped

      */

     public JGraphModelAsGraph(GraphModel jgraph) {

         super();

         this.graphModel = jgraph;

         int edgeCount = countEdgesInGraphModel();

         this.allEdges = new Edge[edgeCount];

         this.allNodes = new Node[this.graphModel.getRootCount()-edgeCount];

         copyNodesAndEdgesFromGraphModel();

     }

     /**

      * Helper method to count all edges in the GraphModel

      * 

      * @return number of edges

      */

     private final int countEdgesInGraphModel() {

         int edgeCount = 0;

         for (int i = 0; i < this.graphModel.getRootCount(); i++) {

             Object o = this.graphModel.getRootAt(i);

             if (this.graphModel.isEdge(o)) {

                 edgeCount++;

             }

         }

         return edgeCount;

     }

     /**

      * Copy nodes and edges from GraphModel into internal data structures

      * for easier and more efficient access.

      */

     private final void copyNodesAndEdgesFromGraphModel() {

         int edgeCount = 0;

         int nodeCount = 0;

         for (int i = 0; i < this.graphModel.getRootCount(); i++) {

             Object o = this.graphModel.getRootAt(i);

             if (this.graphModel.isEdge(o)) {

                 this.allEdges[edgeCount++] =

                     new JGraphEdgeAsEdge((org.jgraph.graph.Edge) o);

             }

             else {

                 this.allNodes[nodeCount++] = new JGraphCellAsNode(o);

             }

         }

     }

     /* (non-Javadoc)

      * @see net.sourceforge.combean.interfaces.graph.Graph#getNodeClass()

      */

     public Class getNodeClass() {

          return JGraphCellAsNode.class;

     }

     /* (non-Javadoc)

      * @see net.sourceforge.combean.interfaces.graph.Graph#getEdgeClass()

      */

     public Class getEdgeClass() {

         return JGraphEdgeAsEdge.class;

     }

     /* (non-Javadoc)

      * @see net.sourceforge.combean.interfaces.graph.NeighborhoodGraphProp#getIncidentEdges(net.sourceforge.combean.interfaces.graph.Node)

      */

     public EdgeIterator getIncidentEdges(Node v) {

          return new JGraphEdgeIterator(this.graphModel,

                  ((JGraphCellAsNode)v).getInnerObject());

     }

     /* (non-Javadoc)

      * @see net.sourceforge.combean.interfaces.graph.OutgoingEdgeNeighborhoodGraphProp#getOutgoingEdges(net.sourceforge.combean.interfaces.graph.Node)

      */

     public EdgeIterator getOutgoingEdges(Node v) {

          return new IncidentEdgeAsOutgoingEdgeIterator(

                  this, v, getIncidentEdges(v));

     }

     /* (non-Javadoc)

      * @see net.sourceforge.combean.interfaces.graph.IncomingEdgeNeighborhoodGraphProp#getIncomingEdges(net.sourceforge.combean.interfaces.graph.Node)

      */

     public EdgeIterator getIncomingEdges(Node v) {

          return new IncidentEdgeAsIncomingEdgeIterator(

                  this, v, getIncidentEdges(v));

     }

     /* (non-Javadoc)

      * @see net.sourceforge.combean.interfaces.graph.NeighborhoodGraphProp#getOtherNode(net.sourceforge.combean.interfaces.graph.Edge, net.sourceforge.combean.interfaces.graph.Node)

      */

     public Node getOtherNode(Edge e, Node v) {

         Node w = getFirstNode(e);

         if (w.equals(v)) {

             return getSecondNode(e);

         }

         return w;

     }

     /**

      * Move up the tree in the GraphModel to the root.

      * 

      * @param o the starting object for which the root shall be found

      * @return the root of the tree containing o

      */

     private final Object findRootOf(Object o) {

         Object result = o;

         while (this.graphModel.getParent(result) != null) {

             result = this.graphModel.getParent(result);

         }

         return result;

     }

     /* (non-Javadoc)

      * @see net.sourceforge.combean.interfaces.graph.NeighborhoodGraphProp#getFirstNode(net.sourceforge.combean.interfaces.graph.Edge)

      */

     public Node getFirstNode(Edge e) {

         org.jgraph.graph.Edge jgraphEdge =

             ((JGraphEdgeAsEdge)e).getJGraphEdge();

         Object source = this.graphModel.getSource(jgraphEdge);

         return new JGraphCellAsNode(findRootOf(source));

     }

     /* (non-Javadoc)

      * @see net.sourceforge.combean.interfaces.graph.NeighborhoodGraphProp#getSecondNode(net.sourceforge.combean.interfaces.graph.Edge)

      */

     public Node getSecondNode(Edge e) {

         org.jgraph.graph.Edge jgraphEdge =

             ((JGraphEdgeAsEdge)e).getJGraphEdge();

         Object target = this.graphModel.getTarget(jgraphEdge);

         return new JGraphCellAsNode(findRootOf(target));

     }

     /* (non-Javadoc)

      * @see net.sourceforge.combean.interfaces.graph.GlobalNodesGraphProp#getAllNodesIterator()

      */

     public NodeIterator getAllNodesIterator() {

          return new IndexedNodeIterator(this);

     }

     /* (non-Javadoc)

      * @see net.sourceforge.combean.interfaces.graph.GlobalNodesGraphProp#getNumNodes()

      */

     public int getNumNodes() {

         return this.allNodes.length;

     }

     /* (non-Javadoc)

      * @see net.sourceforge.combean.interfaces.graph.GlobalIndexedNodesGraphProp#getNode(int)

      */

     public Node getNode(int index) {

          return this.allNodes[index];

     }

     /* (non-Javadoc)

      * @see net.sourceforge.combean.interfaces.graph.GlobalEdgeGraphProp#getAllEdgesIterator()

      */

     public EdgeIterator getAllEdgesIterator() {

          return new IndexedEdgeIterator(this);

     }

     /* (non-Javadoc)

      * @see net.sourceforge.combean.interfaces.graph.GlobalEdgeGraphProp#getNumEdges()

      */

     public int getNumEdges() {

          return this.allEdges.length;

     }

     /* (non-Javadoc)

      * @see net.sourceforge.combean.interfaces.graph.GlobalIndexedEdgesGraphProp#getEdge(int)

      */

     public Edge getEdge(int index) {

          return this.allEdges[index];

     }

 }