org.apereo.learninganalytics.snapp.ClusteringDemo.java Source code

Java tutorial

Introduction

Here is the source code for org.apereo.learninganalytics.snapp.ClusteringDemo.java

Source

package org.apereo.learninganalytics.snapp;

/*
* Copyright (c) 2003, the JUNG Project and the Regents of the University
* of California
* All rights reserved.
*
* This software is open-source under the BSD license; see either
* "license.txt" or
* http://jung.sourceforge.net/license.txt for a description.
*/

import java.awt.BasicStroke;
import java.awt.BorderLayout;
import java.awt.Color;
import java.awt.Container;
import java.awt.Dimension;
import java.awt.GridLayout;
import java.awt.Paint;
import java.awt.Stroke;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.ItemEvent;
import java.awt.event.ItemListener;
import java.awt.geom.Point2D;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;

import javax.swing.BorderFactory;
import javax.swing.Box;
import javax.swing.BoxLayout;
import javax.swing.JApplet;
import javax.swing.JButton;
import javax.swing.JFrame;
import javax.swing.JPanel;
import javax.swing.JSlider;
import javax.swing.JToggleButton;
import javax.swing.border.TitledBorder;
import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;

import org.apache.commons.collections15.Factory;
import org.apache.commons.collections15.Transformer;
import org.apache.commons.collections15.functors.ChainedTransformer;
import org.apache.commons.collections15.functors.ConstantTransformer;
import org.apache.commons.collections15.functors.MapTransformer;
import org.apache.commons.collections15.map.LazyMap;

import edu.uci.ics.jung.algorithms.cluster.EdgeBetweennessClusterer;
import edu.uci.ics.jung.algorithms.layout.AggregateLayout;
import edu.uci.ics.jung.algorithms.layout.CircleLayout;
import edu.uci.ics.jung.algorithms.layout.FRLayout;
import edu.uci.ics.jung.algorithms.layout.Layout;
import edu.uci.ics.jung.algorithms.layout.util.Relaxer;
import edu.uci.ics.jung.graph.Graph;
import edu.uci.ics.jung.graph.SparseMultigraph;
import edu.uci.ics.jung.io.PajekNetReader;
import edu.uci.ics.jung.visualization.*;
import edu.uci.ics.jung.visualization.control.DefaultModalGraphMouse;
import edu.uci.ics.jung.visualization.decorators.ToStringLabeller;
import edu.uci.ics.jung.visualization.renderers.Renderer;

/**
 * This simple app demonstrates how one can use our algorithms and visualization libraries in unison.
 * In this case, we generate use the Zachary karate club data set, widely known in the social networks literature, then
 * we cluster the vertices using an edge-betweenness clusterer, and finally we visualize the graph using
 * Fruchtermain-Rheingold layout and provide a slider so that the user can adjust the clustering granularity.
 * @author Scott White
 */
@SuppressWarnings("serial")
//public class ClusteringDemo extends JApplet {
public class ClusteringDemo {

    VisualizationViewer<Integer, Number> vv;
    static Graph<Integer, Number> g;
    Map<Integer, String> usernames = new HashMap<Integer, String>();

    //   Factory<Graph<Number,Number>> graphFactory;

    Map<Integer, Paint> vertexPaints = LazyMap.<Integer, Paint>decorate(new HashMap<Integer, Paint>(),
            new ConstantTransformer(Color.white));
    Map<Number, Paint> edgePaints = LazyMap.<Number, Paint>decorate(new HashMap<Number, Paint>(),
            new ConstantTransformer(Color.blue));

    public final Color[] similarColors = { new Color(216, 134, 134), new Color(135, 137, 211),
            new Color(134, 206, 189), new Color(206, 176, 134), new Color(194, 204, 134), new Color(145, 214, 134),
            new Color(133, 178, 209), new Color(103, 148, 255), new Color(60, 220, 220), new Color(30, 250, 100) };

    /*
       public static void main(String[] args) throws IOException {
              
          ClusteringDemo cd = new ClusteringDemo();
          cd.start();
          // Add a restart button so the graph can be redrawn to fit the size of the frame
          JFrame jf = new JFrame();
          jf.getContentPane().add(cd);
              
          jf.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
          jf.pack();
          jf.setVisible(true);
       }
    */
    public ClusteringDemo() {

    }

    public void start(Graph<Integer, Number> grp, Map<Integer, String> name) {
        setUpView(grp, name);
        /*
        InputStream is = ClusteringDemo.class.getResourceAsStream("images/zachary.net");
        BufferedReader br = new BufferedReader( new InputStreamReader( is ));
              
          try
          {
        setUpView(br);
          }
          catch (IOException e)
          {
        System.out.println("Error in loading graph");
        e.printStackTrace();
          }
          */

    }

    //private void setUpView(BufferedReader br) throws IOException {
    private void setUpView(Graph<Integer, Number> grp, Map<Integer, String> name) {
        /*
         Factory<Number> vertexFactory = new Factory<Number>() {
        int n = 0;
        public Number create() { return n++; }
          };
          Factory<Number> edgeFactory = new Factory<Number>()  {
        int n = 0;
        public Number create() { return n++; }
          };
            
          PajekNetReader<Graph<Number, Number>, Number,Number> pnr = 
        new PajekNetReader<Graph<Number, Number>, Number,Number>(vertexFactory, edgeFactory);
              
          final Graph<Number,Number> graph = new SparseMultigraph<Number, Number>();
              
          pnr.load(br, graph);
          */

        //Create a simple layout frame
        //specify the Fruchterman-Rheingold layout algorithm

        this.usernames = name;
        final AggregateLayout<Integer, Number> layout = new AggregateLayout<Integer, Number>(
                new FRLayout<Integer, Number>(grp));
        layout.setSize(new Dimension(500, 500));
        vv = new VisualizationViewer<Integer, Number>(layout);
        vv.setBackground(Color.white);
        //Tell the renderer to use our own customized color rendering
        vv.getRenderContext()
                .setVertexFillPaintTransformer(MapTransformer.<Integer, Paint>getInstance(vertexPaints));
        vv.getRenderContext().setVertexDrawPaintTransformer(new Transformer<Integer, Paint>() {
            public Paint transform(Integer v) {
                if (vv.getPickedVertexState().isPicked(v)) {
                    return Color.cyan;
                } else {
                    return Color.BLACK;
                }
            }
        });

        vv.getRenderContext().setEdgeDrawPaintTransformer(MapTransformer.<Number, Paint>getInstance(edgePaints));

        vv.getRenderContext().setEdgeStrokeTransformer(new Transformer<Number, Stroke>() {
            protected final Stroke THIN = new BasicStroke(1);
            protected final Stroke THICK = new BasicStroke(2);

            public Stroke transform(Number e) {
                Paint c = edgePaints.get(e);
                if (c == Color.LIGHT_GRAY)
                    return THIN;
                else
                    return THICK;
            }
        });

        vv.getRenderContext().setVertexLabelTransformer(
                // this chains together Transformers so that the html tags
                // are prepended to the toString method output
                new ChainedTransformer<Integer, String>(
                        new Transformer[] { new ToStringLabeller<String>(), new Transformer<String, String>() {
                            public String transform(String input) {
                                return usernames.get(Integer.parseInt(input));
                            }
                        } }));

        vv.getRenderer().getVertexLabelRenderer().setPosition(Renderer.VertexLabel.Position.S);
        /*
              //add restart button
              JButton scramble = new JButton("Restart");
              scramble.addActionListener(new ActionListener() {
                 public void actionPerformed(ActionEvent arg0) {
        Layout layout = vv.getGraphLayout();
        layout.initialize();
        Relaxer relaxer = vv.getModel().getRelaxer();
        if(relaxer != null) {
           relaxer.stop();
           relaxer.prerelax();
           relaxer.relax();
        }
                 }
            
              });
        */

        DefaultModalGraphMouse gm = new DefaultModalGraphMouse();
        vv.setGraphMouse(gm);

        final JToggleButton groupVertices = new JToggleButton("Group Clusters");

        //Create slider to adjust the number of edges to remove when clustering
        final JSlider edgeBetweennessSlider = new JSlider(JSlider.HORIZONTAL);
        edgeBetweennessSlider.setBackground(Color.WHITE);
        edgeBetweennessSlider.setPreferredSize(new Dimension(210, 50));
        edgeBetweennessSlider.setPaintTicks(true);
        edgeBetweennessSlider.setMaximum(grp.getEdgeCount());
        edgeBetweennessSlider.setMinimum(0);
        edgeBetweennessSlider.setValue(0);
        edgeBetweennessSlider.setMajorTickSpacing(10);
        edgeBetweennessSlider.setPaintLabels(true);
        edgeBetweennessSlider.setPaintTicks(true);

        //      edgeBetweennessSlider.setBorder(BorderFactory.createLineBorder(Color.black));
        //TO DO: edgeBetweennessSlider.add(new JLabel("Node Size (PageRank With Priors):"));
        //I also want the slider value to appear
        final JPanel eastControls = new JPanel();
        eastControls.setOpaque(true);
        eastControls.setLayout(new BoxLayout(eastControls, BoxLayout.Y_AXIS));
        eastControls.add(Box.createVerticalGlue());
        eastControls.add(edgeBetweennessSlider);

        final String COMMANDSTRING = "Edges removed for clusters: ";
        final String eastSize = COMMANDSTRING + edgeBetweennessSlider.getValue();

        final TitledBorder sliderBorder = BorderFactory.createTitledBorder(eastSize);
        eastControls.setBorder(sliderBorder);
        //eastControls.add(eastSize);
        eastControls.add(Box.createVerticalGlue());

        groupVertices.addItemListener(new ItemListener() {
            public void itemStateChanged(ItemEvent e) {
                clusterAndRecolor(layout, edgeBetweennessSlider.getValue(), similarColors,
                        e.getStateChange() == ItemEvent.SELECTED);
                vv.repaint();
            }
        });

        clusterAndRecolor(layout, 0, similarColors, groupVertices.isSelected());

        edgeBetweennessSlider.addChangeListener(new ChangeListener() {
            public void stateChanged(ChangeEvent e) {
                JSlider source = (JSlider) e.getSource();
                if (!source.getValueIsAdjusting()) {
                    int numEdgesToRemove = source.getValue();
                    clusterAndRecolor(layout, numEdgesToRemove, similarColors, groupVertices.isSelected());
                    sliderBorder.setTitle(COMMANDSTRING + edgeBetweennessSlider.getValue());
                    eastControls.repaint();
                    vv.validate();
                    vv.repaint();
                }
            }
        });

        // Add a restart button so the graph can be redrawn to fit the size of the frame
        JFrame jf = new JFrame("SNAPP: Find Clusters");
        //jf.getContentPane().add();

        //Container content = getContentPane();
        //content.add(new GraphZoomScrollPane(vv));
        jf.getContentPane().add(new GraphZoomScrollPane(vv));
        JPanel south = new JPanel();
        JPanel grid = new JPanel(new GridLayout(2, 1));
        //grid.add(scramble);
        grid.add(groupVertices);
        south.add(grid);
        south.add(eastControls);
        JPanel p = new JPanel();
        p.setBorder(BorderFactory.createTitledBorder("Mouse Mode"));
        p.add(gm.getModeComboBox());
        south.add(p);
        //content.add(south, BorderLayout.SOUTH);
        jf.getContentPane().add(south, BorderLayout.SOUTH);

        //jf.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
        jf.pack();
        jf.setVisible(true);
    }

    public void clusterAndRecolor(AggregateLayout<Integer, Number> layout, int numEdgesToRemove, Color[] colors,
            boolean groupClusters) {
        //Now cluster the vertices by removing the top 50 edges with highest betweenness
        //      if (numEdgesToRemove == 0) {
        //         colorCluster( g.getVertices(), colors[0] );
        //      } else {

        Graph<Integer, Number> g = layout.getGraph();
        layout.removeAll();

        EdgeBetweennessClusterer<Integer, Number> clusterer = new EdgeBetweennessClusterer<Integer, Number>(
                numEdgesToRemove);
        Set<Set<Integer>> clusterSet = clusterer.transform(g);
        List<Number> edges = clusterer.getEdgesRemoved();

        int i = 0;
        //Set the colors of each node so that each cluster's vertices have the same color
        for (Iterator<Set<Integer>> cIt = clusterSet.iterator(); cIt.hasNext();) {

            Set<Integer> vertices = cIt.next();
            Color c = colors[i % colors.length];

            colorCluster(vertices, c);
            if (groupClusters == true) {
                groupCluster(layout, vertices);
            }
            i++;
        }
        for (Number e : g.getEdges()) {

            if (edges.contains(e)) {
                edgePaints.put(e, Color.lightGray);
            } else {
                edgePaints.put(e, Color.black);
            }
        }

    }

    private void colorCluster(Set<Integer> vertices, Color c) {
        for (Integer v : vertices) {
            vertexPaints.put(v, c);
        }
    }

    private void groupCluster(AggregateLayout<Integer, Number> layout, Set<Integer> vertices) {
        if (vertices.size() < layout.getGraph().getVertexCount()) {
            Point2D center = layout.transform(vertices.iterator().next());
            Graph<Integer, Number> subGraph = SparseMultigraph.<Integer, Number>getFactory().create();
            for (Integer v : vertices) {
                subGraph.addVertex(v);
            }
            Layout<Integer, Number> subLayout = new CircleLayout<Integer, Number>(subGraph);
            subLayout.setInitializer(vv.getGraphLayout());
            subLayout.setSize(new Dimension(40, 40));

            layout.put(subLayout, center);
            vv.repaint();
        }
    }
}