Made it easier to add/remove columns to the node info table

examples/sky-shell/src/se/sics/contiki/collect/gui/NodeInfoPanel.java

@@ -26,7 +26,7 @@
  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  * SUCH DAMAGE.
  *
- * $Id: NodeInfoPanel.java,v 1.5 2010/09/15 16:15:10 nifi Exp $
+ * $Id: NodeInfoPanel.java,v 1.6 2010/09/24 06:00:16 nifi Exp $
  *
  * -----------------------------------------------------------------
  *
@@ -34,27 +34,37 @@
  *
  * Authors : Joakim Eriksson, Niclas Finne
  * Created : 6 sep 2010
- * Updated : $Date: 2010/09/15 16:15:10 $
+ * Updated : $Date: 2010/09/24 06:00:16 $
- *           $Revision: 1.5 $
+ *           $Revision: 1.6 $
  */
 
 package se.sics.contiki.collect.gui;
 import java.awt.BorderLayout;
 import java.awt.Component;
-import java.awt.Dimension;
+import java.awt.Cursor;
+import java.awt.event.ActionEvent;
+import java.awt.event.MouseAdapter;
 import java.awt.event.MouseEvent;
 
+import javax.swing.AbstractAction;
+import javax.swing.JCheckBoxMenuItem;
 import javax.swing.JLabel;
 import javax.swing.JPanel;
+import javax.swing.JPopupMenu;
 import javax.swing.JScrollPane;
 import javax.swing.JTable;
+import javax.swing.SwingUtilities;
 import javax.swing.table.AbstractTableModel;
 import javax.swing.table.DefaultTableCellRenderer;
 import javax.swing.table.JTableHeader;
+import javax.swing.table.TableCellRenderer;
+import javax.swing.table.TableColumn;
+import javax.swing.table.TableRowSorter;
 
 import se.sics.contiki.collect.CollectServer;
 import se.sics.contiki.collect.Node;
 import se.sics.contiki.collect.SensorData;
+import se.sics.contiki.collect.SensorInfo;
 import se.sics.contiki.collect.Visualizer;
 
 /**
@@ -66,42 +76,155 @@ public class NodeInfoPanel extends JPanel implements Visualizer {
 
   private final CollectServer server;
   private final String category;
-  private final JTable nodeTable;
+  private final JTable table;
   private final NodeModel nodeModel;
-  private Node[] nodes;
 
+  @SuppressWarnings("serial")
   public NodeInfoPanel(CollectServer server, String category) {
     super(new BorderLayout());
     this.server = server;
     this.category = category;
-    
-    nodeModel = new NodeModel();
-    nodeTable = new JTable(nodeModel) {
-      private static final long serialVersionUID = 1L;
 
-      public Dimension getPreferredScrollableViewportSize() {
+    TableData[] columns = new TableData[] {
-        return getPreferredSize();
+        new TableData("Node", Node.class) {
-      } 
+          public Object getValue(Node node) {
+            return node;
+          }
+        },
+        new TableData("Packets", "Packets Received", Integer.class) {
+          public Object getValue(Node node) {
+            return node.getSensorDataAggregator().getPacketCount();
+          }
+        },
+        new TableData("Duplicates", "Duplicate Packets Received", Integer.class) {
+          public Object getValue(Node node) {
+            return node.getSensorDataAggregator().getDuplicateCount();
+          }
+        },
+        new TableData("Estimated Lost", "Estimated Lost Packets", Integer.class) {
+          public Object getValue(Node node) {
+            return node.getSensorDataAggregator().getEstimatedLostCount();
+          }
+        },
+        new TableData("Average Hops", "Average Hops to Sink", Double.class) {
+          public Object getValue(Node node) {
+            return node.getSensorDataAggregator().getAverageValue(SensorData.HOPS);
+          }
+        },
+        new TableData("Next Hop Changes", "Next Hop Change Count", Integer.class) {
+          public Object getValue(Node node) {
+            return node.getSensorDataAggregator().getNextHopChangeCount();
+          }
+        },
+
+        new TableData("Restarts", "Estimated Node Restart Count", Integer.class) {
+          public Object getValue(Node node) {
+            return node.getSensorDataAggregator().getEstimatedRestarts();
+          }
+        }.setVisible(false),
+
+        // Power
+        new TableData("CPU Power", "Average CPU Power Consumption", Double.class) {
+          public Object getValue(Node node) {
+            return node.getSensorDataAggregator().getCPUPower();
+          }
+        }.setVisible(false),
+        new TableData("LPM Power", "Average LPM Power Consumption", Double.class) {
+          public Object getValue(Node node) {
+            return node.getSensorDataAggregator().getLPMPower();
+          }
+        }.setVisible(false),
+        new TableData("Listen Power", "Average Radio Listen Power Consumption", Double.class) {
+          public Object getValue(Node node) {
+            return node.getSensorDataAggregator().getListenPower();
+          }
+        }.setVisible(false),
+        new TableData("Transmit Power", "Average Radio Transmit Power Consumption", Double.class) {
+          public Object getValue(Node node) {
+            return node.getSensorDataAggregator().getTransmitPower();
+          }
+        }.setVisible(false),
+        new TableData("Power", "Average Power Consumption", Double.class) {
+          public Object getValue(Node node) {
+            return node.getSensorDataAggregator().getAveragePower();
+          }
+        }.setVisible(false),
+        new TableData("Power Time", "Power Measure Time", Long.class) {
+          public Object getValue(Node node) {
+            return node.getSensorDataAggregator().getPowerMeasureTime();
+          }
+        }.setVisible(false),
+
+        new TableData("Listen Duty Cycle", "Average Radio Listen Duty Cycle (%)", Double.class) {
+          public Object getValue(Node node) {
+            return 100 * node.getSensorDataAggregator().getAverageDutyCycle(SensorInfo.TIME_LISTEN);
+          }
+        }.setVisible(false),
+        new TableData("Transmit Duty Cycle", "Average Radio Transmit Duty Cycle (%)", Double.class) {
+          public Object getValue(Node node) {
+            return 100 * node.getSensorDataAggregator().getAverageDutyCycle(SensorInfo.TIME_TRANSMIT);
+          }
+        }.setVisible(false),
+
+        // Inter-packet times
+        new TableData("Average Inter-packet Time", Long.class) {
+          public Object getValue(Node node) {
+            return node.getSensorDataAggregator().getAveragePeriod();
+          }
+        },
+        new TableData("Shortest Inter-packet Time", Long.class) {
+          public Object getValue(Node node) {
+            return node.getSensorDataAggregator().getShortestPeriod();
+          }
+        },
+        new TableData("Longest Inter-packet Time", Long.class) {
+          public Object getValue(Node node) {
+            return node.getSensorDataAggregator().getLongestPeriod();
+          }
+        }
+    };
+    nodeModel = new NodeModel(columns);
+    table = new JTable(nodeModel) {
+      private static final long serialVersionUID = 1L;
 
       protected JTableHeader createDefaultTableHeader() {
           return new JTableHeader(columnModel) {
             private static final long serialVersionUID = 1L;
 
             public String getToolTipText(MouseEvent e) {
-              int index = columnModel.getColumnIndexAtX(e.getPoint().x);
+              int index = columnModel.getColumnIndexAtX(e.getX());
-              int realIndex = index < 0 ? index : columnModel.getColumn(index).getModelIndex();
+              int modelIndex = index < 0 ? index : columnModel.getColumn(index).getModelIndex();
-              return realIndex < 0 ? null : nodeModel.getColumnToolTip(realIndex);
+              return modelIndex < 0 ? null : nodeModel.getColumnToolTip(modelIndex);
             }
           };
       }
     };
-    nodeTable.setFillsViewportHeight(true);
+
-    nodeTable.setAutoCreateRowSorter(true);
+    // Do not sort column when clicking between the columns (resizing)
+    table.setRowSorter(new TableRowSorter<NodeModel>(nodeModel) {
+      public void toggleSortOrder(int column) {
+        if(table.getTableHeader().getCursor().getType() != Cursor.E_RESIZE_CURSOR) {
+          super.toggleSortOrder(column);
+        }
+      }
+    });
+    // Pack the column when double clicking between columns (resizing)
+    table.getTableHeader().addMouseListener(new MouseAdapter() {
+      public void mouseClicked(MouseEvent e) {
+        if(e.getClickCount() == 2 && SwingUtilities.isLeftMouseButton(e) &&
+            table.getTableHeader().getCursor().getType() == Cursor.E_RESIZE_CURSOR) {
+          int index = table.getColumnModel().getColumnIndexAtX(e.getX() - 3);
+          if (index >= 0) {
+            packColumn(table, index);
+          }
+        }
+      }
+    });
 
     // Add right aligned renderer for node name
     DefaultTableCellRenderer renderer = new DefaultTableCellRenderer();
     renderer.setHorizontalAlignment(JLabel.RIGHT);
-    nodeTable.setDefaultRenderer(Node.class, renderer);
+    table.setDefaultRenderer(Node.class, renderer);
 
     // Add renderer for time
     renderer = new DefaultTableCellRenderer() {
@@ -112,7 +235,7 @@ public class NodeInfoPanel extends JPanel implements Visualizer {
         setText(time > 0 ? getTimeAsString(time) : null);
       }
     };
-    nodeTable.setDefaultRenderer(Long.class, renderer);
+    table.setDefaultRenderer(Long.class, renderer);
 
     // Add renderer for double
     renderer = new DefaultTableCellRenderer() {
@@ -128,9 +251,21 @@ public class NodeInfoPanel extends JPanel implements Visualizer {
       }
     };
     renderer.setHorizontalAlignment(JLabel.RIGHT);
-    nodeTable.setDefaultRenderer(Double.class, renderer);
+    table.setDefaultRenderer(Double.class, renderer);
 
-    add(new JScrollPane(nodeTable), BorderLayout.CENTER);
+    table.setFillsViewportHeight(true);
+    table.setAutoResizeMode(JTable.AUTO_RESIZE_OFF);
+    for (int i = 0, n = table.getColumnCount(); i < n; i++) {
+      packColumn(table, i);
+    }
+
+    JPopupMenu popupMenu = new JPopupMenu();
+    // The first column (the node name) should always be visible.
+    for(int i = 1; i < columns.length; i++) {
+      popupMenu.add(new JCheckBoxMenuItem(columns[i].init(table, i)));
+    }
+    table.setComponentPopupMenu(popupMenu);
+    add(new JScrollPane(table), BorderLayout.CENTER);
   }
 
   @Override
@@ -150,17 +285,17 @@ public class NodeInfoPanel extends JPanel implements Visualizer {
 
   @Override
   public void nodeAdded(Node node) {
-    updateNodes();
+    nodeModel.setNodes(server.getNodes());
   }
 
   @Override
   public void nodeDataReceived(SensorData sensorData) {
-    updateNode(sensorData.getNode());
+    nodeModel.updateNode(sensorData.getNode());
   }
 
   @Override
   public void clearNodeData() {
-    updateNodes();
+    nodeModel.setNodes(null);
   }
 
   @Override
@@ -170,40 +305,10 @@ public class NodeInfoPanel extends JPanel implements Visualizer {
 
   @Override
   public void setVisible(boolean visible) {
-    if (visible) {
+    nodeModel.setNodes(visible ? server.getNodes() : null);
-      updateNodes();
-    } else {
-      clearNodes();
-    }
     super.setVisible(visible);
   }
 
-  private void clearNodes() {
-    if (this.nodes != null && this.nodes.length > 0) {
-      nodeModel.fireTableRowsDeleted(0, this.nodes.length - 1);
-    }
-    this.nodes = null;
-  }
-
-  private void updateNodes() {
-    clearNodes();
-    this.nodes = server.getNodes();
-    if (this.nodes != null && this.nodes.length > 0) {
-      nodeModel.fireTableRowsInserted(0, this.nodes.length - 1);
-    }
-  }
-
-  private void updateNode(Node node) {
-    if (this.nodes != null) {
-      for(int row = 0; row < this.nodes.length; row++) {
-        if (this.nodes[row] == node) {
-          nodeModel.fireTableRowsUpdated(row, row);
-          break;
-        }
-      }
-    }
-  }
-
   private String getTimeAsString(long time) {
     StringBuilder sb = new StringBuilder();
     time /= 1000;
@@ -221,80 +326,165 @@ public class NodeInfoPanel extends JPanel implements Visualizer {
     return sb.toString();
   }
 
-  private class NodeModel extends AbstractTableModel {
+  private static void packColumn(JTable table, int columnIndex) {
+    TableColumn tableColumn = table.getColumnModel().getColumn(columnIndex);
+    Object value = tableColumn.getHeaderValue();
+    TableCellRenderer columnRenderer = tableColumn.getHeaderRenderer();
+    if (columnRenderer == null) {
+      columnRenderer = table.getTableHeader().getDefaultRenderer();
+    }
+    Component c = columnRenderer.getTableCellRendererComponent(table, value, false, false, -1, columnIndex);
+    int width = c.getPreferredSize().width + 6;
+
+    for(int i = 0, n = table.getRowCount(); i < n; i++) {
+      TableCellRenderer cellRenderer = table.getCellRenderer(i, columnIndex);
+      value = table.getValueAt(i, columnIndex);
+      c = cellRenderer.getTableCellRendererComponent(table, value, false, false, i, columnIndex);
+      int w = c.getPreferredSize().width + table.getIntercellSpacing().width;
+      if (w > width) {
+        width = w;
+      }
+    }
+    table.getTableHeader().setResizingColumn(tableColumn);
+    tableColumn.setWidth(width);
+    tableColumn.setPreferredWidth(width);
+  }
+
+  private static class NodeModel extends AbstractTableModel {
 
     private static final long serialVersionUID = 1692207305977527004L;
 
-    private final String[] COLUMN_NAMES = {
+    private final TableData[] columns;
-        "Node", "Node",
+    private Node[] nodes;
-        "Packets", "Packets Received",
-        "Duplicates", "Duplicate Packets Received",
-        "Estimated Lost", "Estimated Lost Packets",
-        "Average Hops", "Average Hops to Sink",
-        "Next Hop Changes", "Next Hop Change Count",
-        "Average Inter-packet time", "Average Inter-packet Time",
-        "Shortest Inter-packet Time", "Shortest Inter-packet Time",
-        "Longest Inter-packet Time", "Longest Inter-packet Time"
-    };
-    private final Class<?>[] COLUMN_TYPES = {
-        Node.class,
-        Integer.class,
-        Integer.class,
-        Integer.class,
-        Double.class,
-        Integer.class,
-        Long.class,
-        Long.class,
-        Long.class
-    };
 
-    public Object getValueAt(int row, int col) {
+    public NodeModel(TableData[] columns) {
-      Node node = nodes[row];
+      this.columns = columns;
-      switch (col) {
-      case 0:
-        return node;
-      case 1:
-        return node.getSensorDataAggregator().getPacketCount();
-      case 2:
-        return node.getSensorDataAggregator().getDuplicateCount();
-      case 3:
-        return node.getSensorDataAggregator().getEstimatedLostCount();
-      case 4:
-        return node.getSensorDataAggregator().getAverageValue(SensorData.HOPS);
-      case 5:
-        return node.getSensorDataAggregator().getNextHopChangeCount();
-      case 6:
-        return node.getSensorDataAggregator().getAveragePeriod();
-      case 7: {
-        long time = node.getSensorDataAggregator().getShortestPeriod();
-        return time < Long.MAX_VALUE ? time : 0;
-      }
-      case 8:
-        return node.getSensorDataAggregator().getLongestPeriod();
-      default:
-        return null;
-      }
     }
 
-    public Class<?> getColumnClass(int c) {
+    public Object getValueAt(int row, int col) {
-      return COLUMN_TYPES[c];
+      return columns[col].getValue(nodes[row]);
+    }
+
+    public Class<?> getColumnClass(int col) {
+      return columns[col].dataClass;
     }
 
     public String getColumnName(int col) {
-      return COLUMN_NAMES[col * 2];
+      return columns[col].name;
     }
 
     public String getColumnToolTip(int col) {
-      return COLUMN_NAMES[col * 2 + 1];
+      Object v = columns[col].getValue(TableData.SHORT_DESCRIPTION);
+      return v == null ? null : v.toString();
     }
 
     public int getColumnCount() {
-      return COLUMN_NAMES.length / 2;
+      return columns.length;
     }
 
     public int getRowCount() {
       return nodes == null ? 0 : nodes.length;
     }
 
+    public void setNodes(Node[] nodes) {
+      if (this.nodes != null && this.nodes.length > 0) {
+        fireTableRowsDeleted(0, this.nodes.length - 1);
+      }
+      this.nodes = nodes;
+      if (this.nodes != null && this.nodes.length > 0) {
+        fireTableRowsInserted(0, this.nodes.length - 1);
+      }
+    }
+
+    public void updateNode(Node node) {
+      if (this.nodes != null) {
+        for(int row = 0; row < this.nodes.length; row++) {
+          if (this.nodes[row] == node) {
+            fireTableRowsUpdated(row, row);
+            break;
+          }
+        }
+      }
+    }
+
+  }
+
+  public static abstract class TableData extends AbstractAction {
+    private static final long serialVersionUID = -3045755073722516926L;
+
+    public final String name;
+    public final Class<?> dataClass;
+
+    private JTable table;
+    private TableColumn tableColumn;
+    private int modelIndex = -1;
+
+    protected TableData(String name, Class<?> dataClass) {
+      this(name, name, dataClass);
+    }
+
+    protected TableData(String name, String description, Class<?> dataClass) {
+      super(name);
+      this.name = name;
+      this.dataClass = dataClass;
+      putValue(SHORT_DESCRIPTION, description);
+      setVisible(true);
+    }
+
+    TableData init(JTable table, int modelIndex) {
+      this.table = table;
+      this.modelIndex = modelIndex;
+      if (!isVisible()) {
+        // The column should initially be hidden
+        setColumnVisible(false);
+      }
+      return this;
+    }
+
+    public boolean isVisible() {
+      return Boolean.TRUE.equals(getValue(SELECTED_KEY));
+    }
+
+    public TableData setVisible(boolean isVisible) {
+      putValue(SELECTED_KEY, isVisible);
+      return this;
+    }
+
+    public void actionPerformed(ActionEvent event) {
+      if (modelIndex >= 0) {
+        setColumnVisible(isVisible());
+      }
+    }
+
+    private void setColumnVisible(boolean isVisible) {
+      if (isVisible) {
+        if (tableColumn != null) {
+          int count = table.getColumnCount();
+          table.addColumn(tableColumn);
+          tableColumn = null;
+          packColumn(table, count);
+
+          int newIndex = 0;
+          for(int i = 0; i < modelIndex; i++) {
+            if (table.convertColumnIndexToView(i) >= 0) {
+              // The new column should be after this visible column
+              newIndex++;
+            }
+          }
+          if (newIndex < count) {
+            table.getColumnModel().moveColumn(count, newIndex);
+          }
+        }
+      } else {
+        int columnIndex = table.convertColumnIndexToView(modelIndex);
+        if (columnIndex >= 0 ) {
+          tableColumn = table.getColumnModel().getColumn(columnIndex);
+          table.removeColumn(tableColumn);
+        }
+      }
+    }
+
+    public abstract Object getValue(Node node);
+
   }
 }