JAL-1503 update version in GPL header
[jalview.git] / src / jalview / gui / JDatabaseTree.java
index 708e19e..b2bbdef 100644 (file)
@@ -1,6 +1,25 @@
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.1)
+ * Copyright (C) 2014 The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview 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 3 of the License, or (at your option) any later version.
+ *  
+ * Jalview 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 Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
 package jalview.gui;
 
 import jalview.bin.Cache;
+import jalview.util.MessageManager;
 import jalview.ws.seqfetcher.DbSourceProxy;
 
 import java.awt.BorderLayout;
@@ -8,9 +27,13 @@ import java.awt.Component;
 import java.awt.Container;
 import java.awt.Dimension;
 import java.awt.FlowLayout;
+import java.awt.GridLayout;
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
+import java.awt.event.KeyEvent;
+import java.awt.event.KeyListener;
 import java.util.ArrayList;
+import java.util.HashSet;
 import java.util.Hashtable;
 import java.util.List;
 import java.util.Vector;
@@ -21,25 +44,23 @@ import javax.swing.JLabel;
 import javax.swing.JPanel;
 import javax.swing.JScrollPane;
 import javax.swing.JTree;
-import javax.swing.JViewport;
 import javax.swing.event.TreeSelectionEvent;
 import javax.swing.event.TreeSelectionListener;
 import javax.swing.tree.DefaultMutableTreeNode;
 import javax.swing.tree.DefaultTreeCellRenderer;
 import javax.swing.tree.DefaultTreeModel;
-import javax.swing.tree.MutableTreeNode;
 import javax.swing.tree.TreeCellRenderer;
-import javax.swing.tree.TreeModel;
+import javax.swing.tree.TreeNode;
 import javax.swing.tree.TreePath;
 import javax.swing.tree.TreeSelectionModel;
 
-import com.sun.java.help.search.DBPartParameters;
-
-public class JDatabaseTree extends JalviewDialog
+public class JDatabaseTree extends JalviewDialog implements KeyListener
 {
+  boolean allowMultiSelections = false;
+
   JButton getDatabaseSelectorButton()
   {
-    final JButton viewdbs = new JButton("--- Select Database ---");
+    final JButton viewdbs = new JButton(MessageManager.getString("action.select_ddbb"));
     viewdbs.addActionListener(new ActionListener()
     {
 
@@ -58,7 +79,7 @@ public class JDatabaseTree extends JalviewDialog
 
   private jalview.ws.SequenceFetcher sfetcher;
 
-  private JLabel dbstatus;
+  private JLabel dbstatus, dbstatex;
 
   public JDatabaseTree(jalview.ws.SequenceFetcher sfetch)
   {
@@ -70,11 +91,10 @@ public class JDatabaseTree extends JalviewDialog
      * identical DB sources, and should be collapsed.
      */
     DefaultMutableTreeNode tn = null, root = new DefaultMutableTreeNode();
-    Hashtable<DbSourceProxy, DefaultMutableTreeNode> tns = new Hashtable<DbSourceProxy, DefaultMutableTreeNode>();
     Hashtable<String, DefaultMutableTreeNode> source = new Hashtable<String, DefaultMutableTreeNode>();
     sfetcher = sfetch;
     String dbs[] = sfetch.getSupportedDb();
-    Hashtable ht = new Hashtable();
+    Hashtable<String, String> ht = new Hashtable<String, String>();
     for (int i = 0; i < dbs.length; i++)
     {
       tn = source.get(dbs[i]);
@@ -93,7 +113,8 @@ public class JDatabaseTree extends JalviewDialog
         else
         {
           System.err.println("dupe ig for : " + dbs[i] + " \t"
-                  + dbp.getDbName());
+                  + dbp.getDbName() + " (" + dbp.getDbSource() + ")");
+          source.remove(tn);
         }
       }
     }
@@ -106,11 +127,18 @@ public class JDatabaseTree extends JalviewDialog
       }
       if (tn.getChildCount() == 1)
       {
+        DefaultMutableTreeNode ttn = (DefaultMutableTreeNode) tn
+                .getChildAt(0);
         // remove nodes with only one child
-        source.put(dbs[i], tn = (DefaultMutableTreeNode) tn.getChildAt(0));
+        tn.setUserObject(ttn.getUserObject());
+        tn.removeAllChildren();
+        source.put(dbs[i], tn);
+        tn.setAllowsChildren(false);
       }
       root.add(tn);
     }
+    // and sort the tree
+    sortTreeNodes(root);
     svp = new JScrollPane();
     // svp.setAutoscrolls(true);
     dbviews = new JTree(new DefaultTreeModel(root, false));
@@ -138,20 +166,68 @@ public class JDatabaseTree extends JalviewDialog
     jc.add(svp, BorderLayout.CENTER);
 
     java.awt.Font f;
-    // TODO: make the panel resize and fit this in
+    // TODO: make the panel stay a fixed size for longest dbname+example set.
+    JPanel dbstat = new JPanel(new GridLayout(2, 1));
     dbstatus = new JLabel(" "); // set the height correctly for layout
     dbstatus.setFont(f = JvSwingUtils.getLabelFont(false, true));
     dbstatus.setSize(new Dimension(290, 50));
-    jc.add(dbstatus, BorderLayout.SOUTH);
+    dbstatex = new JLabel(" ");
+    dbstatex.setFont(f);
+    dbstatex.setSize(new Dimension(290, 50));
+    dbstat.add(dbstatus);
+    dbstat.add(dbstatex);
+    jc.add(dbstat, BorderLayout.SOUTH);
     jc.validate();
     // j.setPreferredSize(new Dimension(300,50));
     add(jc, BorderLayout.CENTER);
     j.add(ok);
     j.add(cancel);
     add(j, BorderLayout.SOUTH);
+    dbviews.addKeyListener(this);
     validate();
   }
 
+  private void sortTreeNodes(DefaultMutableTreeNode root)
+  {
+    if (root.getChildCount() == 0)
+    {
+      return;
+    }
+    int count = root.getChildCount();
+    String[] names = new String[count];
+    DefaultMutableTreeNode[] nodes = new DefaultMutableTreeNode[count];
+    for (int i = 0; i < count; i++)
+    {
+      TreeNode node = root.getChildAt(i);
+      if (node instanceof DefaultMutableTreeNode)
+      {
+        DefaultMutableTreeNode child = (DefaultMutableTreeNode) node;
+        nodes[i] = child;
+        if (child.getUserObject() instanceof DbSourceProxy)
+        {
+          names[i] = ((DbSourceProxy) child.getUserObject()).getDbName()
+                  .toLowerCase();
+        }
+        else
+        {
+          names[i] = ((String) child.getUserObject()).toLowerCase();
+          sortTreeNodes(child);
+        }
+      }
+      else
+      {
+        throw new Error(
+                "Implementation Error: Can't reorder this tree. Not DefaultMutableTreeNode.");
+      }
+    }
+    jalview.util.QuickSort.sort(names, nodes);
+    root.removeAllChildren();
+    for (int i = count - 1; i >= 0; i--)
+    {
+      root.add(nodes[i]);
+    }
+  }
+
   private class DbTreeRenderer extends DefaultTreeCellRenderer implements
           TreeCellRenderer
   {
@@ -201,7 +277,9 @@ public class JDatabaseTree extends JalviewDialog
     }
   }
 
-  List<DbSourceProxy> selection = null;
+  List<DbSourceProxy> oldselection, selection = null;
+
+  TreePath[] tsel = null, oldtsel = null;
 
   @Override
   protected void raiseClosed()
@@ -222,11 +300,16 @@ public class JDatabaseTree extends JalviewDialog
   @Override
   protected void cancelPressed()
   {
+    selection = oldselection;
+    tsel = oldtsel;
+    _revertSelectionState();
     closeDialog();
   }
 
   private void showDialog(Container parent)
   {
+    oldselection = selection;
+    oldtsel = tsel;
     validate();
     waitForInput();
   }
@@ -241,53 +324,113 @@ public class JDatabaseTree extends JalviewDialog
     return selection;
   }
 
+  /**
+   * disable or enable selection handler
+   */
+  boolean handleSelections = true;
+
   private void _setSelectionState()
   {
+    if (!handleSelections)
+    {
+      return;
+    }
     if (dbviews.getSelectionCount() == 0)
     {
       selection = null;
     }
+    tsel = dbviews.getSelectionPaths();
+    boolean forcedFirstChild = false;
     List<DbSourceProxy> srcs = new ArrayList<DbSourceProxy>();
-    for (TreePath tp : dbviews.getSelectionPaths())
+    if (tsel != null)
     {
-      DefaultMutableTreeNode dmt = (DefaultMutableTreeNode) tp
-              .getLastPathComponent();
-      if (dmt.getUserObject() != null)
+      for (TreePath tp : tsel)
       {
-        if (dmt.getUserObject() instanceof DbSourceProxy)
-        {
-          srcs.add((DbSourceProxy) dmt.getUserObject());
-        }
-        else
+        DefaultMutableTreeNode admt, dmt = (DefaultMutableTreeNode) tp
+                .getLastPathComponent();
+        if (dmt.getUserObject() != null)
         {
-          srcs.addAll(sfetcher.getSourceProxy((String) dmt.getUserObject()));
+          if (dmt.getUserObject() instanceof DbSourceProxy)
+          {
+            srcs.add((DbSourceProxy) dmt.getUserObject());
+          }
+          else
+          {
+            if (allowMultiSelections)
+            {
+              srcs.addAll(sfetcher.getSourceProxy((String) dmt
+                      .getUserObject()));
+            }
+            else
+            {
+              srcs.add(sfetcher.getSourceProxy((String) dmt
+                      .getUserObject()).get(0));
+              forcedFirstChild = true;
+            }
+          }
         }
       }
     }
-    updateDbStatus(srcs);
+    updateDbStatus(srcs, forcedFirstChild);
     selection = srcs;
   }
 
-  private void updateDbStatus(List<DbSourceProxy> srcs)
+  private void _revertSelectionState()
+  {
+    handleSelections = false;
+    if (selection == null || selection.size() == 0)
+    {
+      dbviews.clearSelection();
+    }
+    else
+    {
+      dbviews.setSelectionPaths(tsel);
+    }
+    handleSelections = true;
+  }
+
+  private void updateDbStatus(List<DbSourceProxy> srcs,
+          boolean forcedFirstChild)
   {
     int x = 0;
+    String nm = "", qr = "";
     for (DbSourceProxy dbs : srcs)
     {
       String tq = dbs.getTestQuery();
-      if (tq != null && tq.trim().length()>0 && dbs.isValidReference(tq))
+      nm = dbs.getDbName();
+      if (tq != null && tq.trim().length() > 0 && dbs.isValidReference(tq))
       {
+        qr = tq;
         x++;
       }
     }
 
-    dbstatus.setText("Selected "
-            + srcs.size()
-            + " database"
-            + (srcs.size() == 1 ? "" : "s")
-            + " to fetch from"
-            + (srcs.size() > 0 ? " with " + x + " test quer"
-                    + (x == 1 ? "y" : "ies")  : "."));
+    if (allowMultiSelections)
+    {
+      dbstatus.setText(MessageManager.formatMessage("label.selected_database_to_fetch_from", new String[]{Integer.valueOf(srcs.size()).toString(),(srcs.size() == 1 ? "" : "s"),(srcs.size() > 0 ? " with " + x + " test quer" + (x == 1 ? "y" : "ies") : ".")}));
+      dbstatex.setText(" ");
+    }
+    else
+    {
+      if (nm.length() > 0)
+      {
+        dbstatus.setText(MessageManager.formatMessage("label.database_param",new String[]{nm}));
+        if (qr.length() > 0)
+        {
+          dbstatex.setText(MessageManager.formatMessage("label.example_param", new String[]{qr}));
+        }
+        else
+        {
+          dbstatex.setText(" ");
+        }
+      }
+      else
+      {
+        dbstatus.setText(" ");
+      }
+    }
     dbstatus.invalidate();
+    dbstatex.invalidate();
   }
 
   public String getSelectedItem()
@@ -306,13 +449,19 @@ public class JDatabaseTree extends JalviewDialog
       return null;
     }
     StringBuffer sb = new StringBuffer();
+    HashSet<String> hs = new HashSet<String>();
     for (DbSourceProxy dbs : getSelectedSources())
     {
-      if (sb.length() > 0)
+      String tq = dbs.getTestQuery();
+      ;
+      if (hs.add(tq))
       {
-        sb.append(";");
+        if (sb.length() > 0)
+        {
+          sb.append(";");
+        }
+        sb.append(tq);
       }
-      sb.append(dbs.getTestQuery());
     }
     return sb.toString();
   }
@@ -377,4 +526,31 @@ public class JDatabaseTree extends JalviewDialog
     } while (nultimes > 0 && foo.isVisible());
     foo.setVisible(false);
   }
+
+  @Override
+  public void keyPressed(KeyEvent arg0)
+  {
+    if (!arg0.isConsumed() && arg0.getKeyCode() == KeyEvent.VK_ENTER)
+    {
+      okPressed();
+    }
+    if (!arg0.isConsumed() && arg0.getKeyChar() == KeyEvent.VK_ESCAPE)
+    {
+      cancelPressed();
+    }
+  }
+
+  @Override
+  public void keyReleased(KeyEvent arg0)
+  {
+    // TODO Auto-generated method stub
+
+  }
+
+  @Override
+  public void keyTyped(KeyEvent arg0)
+  {
+    // TODO Auto-generated method stub
+
+  }
 }