src/jalview/gui/JDatabaseTree.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.1)
   3  * Copyright (C) 2014 The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  * The Jalview Authors are detailed in the 'AUTHORS' file.
  18  */
  19 package jalview.gui;
  20
  21 import jalview.bin.Cache;
  22 import jalview.util.MessageManager;
  23 import jalview.ws.seqfetcher.DbSourceProxy;
  24
  25 import java.awt.BorderLayout;
  26 import java.awt.Component;
  27 import java.awt.Container;
  28 import java.awt.Dimension;
  29 import java.awt.FlowLayout;
  30 import java.awt.GridLayout;
  31 import java.awt.event.ActionEvent;
  32 import java.awt.event.ActionListener;
  33 import java.awt.event.KeyEvent;
  34 import java.awt.event.KeyListener;
  35 import java.util.ArrayList;
  36 import java.util.HashSet;
  37 import java.util.Hashtable;
  38 import java.util.List;
  39 import java.util.Vector;
  40
  41 import javax.swing.JButton;
  42 import javax.swing.JFrame;
  43 import javax.swing.JLabel;
  44 import javax.swing.JPanel;
  45 import javax.swing.JScrollPane;
  46 import javax.swing.JTree;
  47 import javax.swing.event.TreeSelectionEvent;
  48 import javax.swing.event.TreeSelectionListener;
  49 import javax.swing.tree.DefaultMutableTreeNode;
  50 import javax.swing.tree.DefaultTreeCellRenderer;
  51 import javax.swing.tree.DefaultTreeModel;
  52 import javax.swing.tree.TreeCellRenderer;
  53 import javax.swing.tree.TreeNode;
  54 import javax.swing.tree.TreePath;
  55 import javax.swing.tree.TreeSelectionModel;
  56
  57 public class JDatabaseTree extends JalviewDialog implements KeyListener
  58 {
  59   boolean allowMultiSelections = false;
  60
  61   JButton getDatabaseSelectorButton()
  62   {
  63     final JButton viewdbs = new JButton(MessageManager.getString("action.select_ddbb"));
  64     viewdbs.addActionListener(new ActionListener()
  65     {
  66
  67       @Override
  68       public void actionPerformed(ActionEvent arg0)
  69       {
  70         showDialog(null);
  71       }
  72     });
  73     return viewdbs;
  74   }
  75
  76   JScrollPane svp;
  77
  78   JTree dbviews;
  79
  80   private jalview.ws.SequenceFetcher sfetcher;
  81
  82   private JLabel dbstatus, dbstatex;
  83
  84   public JDatabaseTree(jalview.ws.SequenceFetcher sfetch)
  85   {
  86     initDialogFrame(this, true, false, "Select Database Retrieval Source",
  87             650, 490);
  88     /*
  89      * Dynamically generated database list will need a translation function from
  90      * internal source to externally distinct names. UNIPROT and UP_NAME are
  91      * identical DB sources, and should be collapsed.
  92      */
  93     DefaultMutableTreeNode tn = null, root = new DefaultMutableTreeNode();
  94     Hashtable<String, DefaultMutableTreeNode> source = new Hashtable<String, DefaultMutableTreeNode>();
  95     sfetcher = sfetch;
  96     String dbs[] = sfetch.getSupportedDb();
  97     Hashtable<String, String> ht = new Hashtable<String, String>();
  98     for (int i = 0; i < dbs.length; i++)
  99     {
 100       tn = source.get(dbs[i]);
 101       List<DbSourceProxy> srcs = sfetch.getSourceProxy(dbs[i]);
 102       if (tn == null)
 103       {
 104         source.put(dbs[i], tn = new DefaultMutableTreeNode(dbs[i], true));
 105       }
 106       for (DbSourceProxy dbp : srcs)
 107       {
 108         if (ht.get(dbp.getDbName()) == null)
 109         {
 110           tn.add(new DefaultMutableTreeNode(dbp, false));
 111           ht.put(dbp.getDbName(), dbp.getDbName());
 112         }
 113         else
 114         {
 115           System.err.println("dupe ig for : " + dbs[i] + " \t"
 116                   + dbp.getDbName() + " (" + dbp.getDbSource() + ")");
 117           source.remove(tn);
 118         }
 119       }
 120     }
 121     for (int i = 0; i < dbs.length; i++)
 122     {
 123       tn = source.get(dbs[i]);
 124       if (tn == null)
 125       {
 126         continue;
 127       }
 128       if (tn.getChildCount() == 1)
 129       {
 130         DefaultMutableTreeNode ttn = (DefaultMutableTreeNode) tn
 131                 .getChildAt(0);
 132         // remove nodes with only one child
 133         tn.setUserObject(ttn.getUserObject());
 134         tn.removeAllChildren();
 135         source.put(dbs[i], tn);
 136         tn.setAllowsChildren(false);
 137       }
 138       root.add(tn);
 139     }
 140     // and sort the tree
 141     sortTreeNodes(root);
 142     svp = new JScrollPane();
 143     // svp.setAutoscrolls(true);
 144     dbviews = new JTree(new DefaultTreeModel(root, false));
 145     dbviews.setCellRenderer(new DbTreeRenderer(this));
 146
 147     dbviews.getSelectionModel().setSelectionMode(
 148             TreeSelectionModel.SINGLE_TREE_SELECTION);
 149     svp.getViewport().setView(dbviews);
 150     // svp.getViewport().setMinimumSize(new Dimension(300,200));
 151     // svp.setSize(300,250);
 152     // JPanel panel=new JPanel();
 153     // panel.setSize(new Dimension(350,220));
 154     // panel.add(svp);
 155     dbviews.addTreeSelectionListener(new TreeSelectionListener()
 156     {
 157
 158       @Override
 159       public void valueChanged(TreeSelectionEvent arg0)
 160       {
 161         _setSelectionState();
 162       }
 163     });
 164     JPanel jc = new JPanel(new BorderLayout()), j = new JPanel(
 165             new FlowLayout());
 166     jc.add(svp, BorderLayout.CENTER);
 167
 168     java.awt.Font f;
 169     // TODO: make the panel stay a fixed size for longest dbname+example set.
 170     JPanel dbstat = new JPanel(new GridLayout(2, 1));
 171     dbstatus = new JLabel(" "); // set the height correctly for layout
 172     dbstatus.setFont(f = JvSwingUtils.getLabelFont(false, true));
 173     dbstatus.setSize(new Dimension(290, 50));
 174     dbstatex = new JLabel(" ");
 175     dbstatex.setFont(f);
 176     dbstatex.setSize(new Dimension(290, 50));
 177     dbstat.add(dbstatus);
 178     dbstat.add(dbstatex);
 179     jc.add(dbstat, BorderLayout.SOUTH);
 180     jc.validate();
 181     // j.setPreferredSize(new Dimension(300,50));
 182     add(jc, BorderLayout.CENTER);
 183     j.add(ok);
 184     j.add(cancel);
 185     add(j, BorderLayout.SOUTH);
 186     dbviews.addKeyListener(this);
 187     validate();
 188   }
 189
 190   private void sortTreeNodes(DefaultMutableTreeNode root)
 191   {
 192     if (root.getChildCount() == 0)
 193     {
 194       return;
 195     }
 196     int count = root.getChildCount();
 197     String[] names = new String[count];
 198     DefaultMutableTreeNode[] nodes = new DefaultMutableTreeNode[count];
 199     for (int i = 0; i < count; i++)
 200     {
 201       TreeNode node = root.getChildAt(i);
 202       if (node instanceof DefaultMutableTreeNode)
 203       {
 204         DefaultMutableTreeNode child = (DefaultMutableTreeNode) node;
 205         nodes[i] = child;
 206         if (child.getUserObject() instanceof DbSourceProxy)
 207         {
 208           names[i] = ((DbSourceProxy) child.getUserObject()).getDbName()
 209                   .toLowerCase();
 210         }
 211         else
 212         {
 213           names[i] = ((String) child.getUserObject()).toLowerCase();
 214           sortTreeNodes(child);
 215         }
 216       }
 217       else
 218       {
 219         throw new Error(
 220                 "Implementation Error: Can't reorder this tree. Not DefaultMutableTreeNode.");
 221       }
 222     }
 223     jalview.util.QuickSort.sort(names, nodes);
 224     root.removeAllChildren();
 225     for (int i = count - 1; i >= 0; i--)
 226     {
 227       root.add(nodes[i]);
 228     }
 229   }
 230
 231   private class DbTreeRenderer extends DefaultTreeCellRenderer implements
 232           TreeCellRenderer
 233   {
 234     JDatabaseTree us;
 235
 236     public DbTreeRenderer(JDatabaseTree me)
 237     {
 238       us = me;
 239     }
 240
 241     private Component returnLabel(String txt)
 242     {
 243       JLabel jl = new JLabel(txt);
 244       jl.setFont(JvSwingUtils.getLabelFont());
 245       return jl;
 246     }
 247
 248     @Override
 249     public Component getTreeCellRendererComponent(JTree tree, Object value,
 250             boolean selected, boolean expanded, boolean leaf, int row,
 251             boolean hasFocus)
 252     {
 253       String val = "";
 254       if (value != null && value instanceof DefaultMutableTreeNode)
 255       {
 256         DefaultMutableTreeNode vl = (DefaultMutableTreeNode) value;
 257         value = vl.getUserObject();
 258         if (value instanceof DbSourceProxy)
 259         {
 260           val = (((DbSourceProxy) value).getDbName());
 261         }
 262         else
 263         {
 264           if (value instanceof String)
 265           {
 266             val = ((String) value);
 267           }
 268         }
 269       }
 270       if (value == null)
 271       {
 272         val = ("");
 273       }
 274       return super.getTreeCellRendererComponent(tree, val, selected,
 275               expanded, leaf, row, hasFocus);
 276
 277     }
 278   }
 279
 280   List<DbSourceProxy> oldselection, selection = null;
 281
 282   TreePath[] tsel = null, oldtsel = null;
 283
 284   @Override
 285   protected void raiseClosed()
 286   {
 287     for (ActionListener al : lstners)
 288     {
 289       al.actionPerformed(null);
 290     }
 291   }
 292
 293   @Override
 294   protected void okPressed()
 295   {
 296     _setSelectionState();
 297     closeDialog();
 298   }
 299
 300   @Override
 301   protected void cancelPressed()
 302   {
 303     selection = oldselection;
 304     tsel = oldtsel;
 305     _revertSelectionState();
 306     closeDialog();
 307   }
 308
 309   private void showDialog(Container parent)
 310   {
 311     oldselection = selection;
 312     oldtsel = tsel;
 313     validate();
 314     waitForInput();
 315   }
 316
 317   public boolean hasSelection()
 318   {
 319     return selection == null ? false : selection.size() == 0 ? false : true;
 320   }
 321
 322   public List<DbSourceProxy> getSelectedSources()
 323   {
 324     return selection;
 325   }
 326
 327   /**
 328    * disable or enable selection handler
 329    */
 330   boolean handleSelections = true;
 331
 332   private void _setSelectionState()
 333   {
 334     if (!handleSelections)
 335     {
 336       return;
 337     }
 338     if (dbviews.getSelectionCount() == 0)
 339     {
 340       selection = null;
 341     }
 342     tsel = dbviews.getSelectionPaths();
 343     boolean forcedFirstChild = false;
 344     List<DbSourceProxy> srcs = new ArrayList<DbSourceProxy>();
 345     if (tsel != null)
 346     {
 347       for (TreePath tp : tsel)
 348       {
 349         DefaultMutableTreeNode admt, dmt = (DefaultMutableTreeNode) tp
 350                 .getLastPathComponent();
 351         if (dmt.getUserObject() != null)
 352         {
 353           if (dmt.getUserObject() instanceof DbSourceProxy)
 354           {
 355             srcs.add((DbSourceProxy) dmt.getUserObject());
 356           }
 357           else
 358           {
 359             if (allowMultiSelections)
 360             {
 361               srcs.addAll(sfetcher.getSourceProxy((String) dmt
 362                       .getUserObject()));
 363             }
 364             else
 365             {
 366               srcs.add(sfetcher.getSourceProxy((String) dmt
 367                       .getUserObject()).get(0));
 368               forcedFirstChild = true;
 369             }
 370           }
 371         }
 372       }
 373     }
 374     updateDbStatus(srcs, forcedFirstChild);
 375     selection = srcs;
 376   }
 377
 378   private void _revertSelectionState()
 379   {
 380     handleSelections = false;
 381     if (selection == null || selection.size() == 0)
 382     {
 383       dbviews.clearSelection();
 384     }
 385     else
 386     {
 387       dbviews.setSelectionPaths(tsel);
 388     }
 389     handleSelections = true;
 390   }
 391
 392   private void updateDbStatus(List<DbSourceProxy> srcs,
 393           boolean forcedFirstChild)
 394   {
 395     int x = 0;
 396     String nm = "", qr = "";
 397     for (DbSourceProxy dbs : srcs)
 398     {
 399       String tq = dbs.getTestQuery();
 400       nm = dbs.getDbName();
 401       if (tq != null && tq.trim().length() > 0 && dbs.isValidReference(tq))
 402       {
 403         qr = tq;
 404         x++;
 405       }
 406     }
 407
 408     if (allowMultiSelections)
 409     {
 410       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") : ".")}));
 411       dbstatex.setText(" ");
 412     }
 413     else
 414     {
 415       if (nm.length() > 0)
 416       {
 417         dbstatus.setText(MessageManager.formatMessage("label.database_param",new String[]{nm}));
 418         if (qr.length() > 0)
 419         {
 420           dbstatex.setText(MessageManager.formatMessage("label.example_param", new String[]{qr}));
 421         }
 422         else
 423         {
 424           dbstatex.setText(" ");
 425         }
 426       }
 427       else
 428       {
 429         dbstatus.setText(" ");
 430       }
 431     }
 432     dbstatus.invalidate();
 433     dbstatex.invalidate();
 434   }
 435
 436   public String getSelectedItem()
 437   {
 438     if (hasSelection())
 439     {
 440       return getSelectedSources().get(0).getDbName();
 441     }
 442     return null;
 443   }
 444
 445   public String getExampleQueries()
 446   {
 447     if (!hasSelection())
 448     {
 449       return null;
 450     }
 451     StringBuffer sb = new StringBuffer();
 452     HashSet<String> hs = new HashSet<String>();
 453     for (DbSourceProxy dbs : getSelectedSources())
 454     {
 455       String tq = dbs.getTestQuery();
 456       ;
 457       if (hs.add(tq))
 458       {
 459         if (sb.length() > 0)
 460         {
 461           sb.append(";");
 462         }
 463         sb.append(tq);
 464       }
 465     }
 466     return sb.toString();
 467   }
 468
 469   List<ActionListener> lstners = new Vector<ActionListener>();
 470
 471   public void addActionListener(ActionListener actionListener)
 472   {
 473     lstners.add(actionListener);
 474   }
 475
 476   public void removeActionListener(ActionListener actionListener)
 477   {
 478     lstners.remove(actionListener);
 479   }
 480
 481   public static void main(String args[])
 482   {
 483     Cache.getDasSourceRegistry();
 484     JDatabaseTree jdt = new JDatabaseTree(new jalview.ws.SequenceFetcher());
 485     JFrame foo = new JFrame();
 486     foo.setLayout(new BorderLayout());
 487     foo.add(jdt.getDatabaseSelectorButton(), BorderLayout.CENTER);
 488     foo.pack();
 489     foo.setVisible(true);
 490     int nultimes = 5;
 491     final Thread us = Thread.currentThread();
 492     jdt.addActionListener(new ActionListener()
 493     {
 494
 495       @Override
 496       public void actionPerformed(ActionEvent e)
 497       {
 498         us.interrupt();
 499       }
 500     });
 501     do
 502     {
 503       try
 504       {
 505         Thread.sleep(50);
 506       } catch (InterruptedException x)
 507       {
 508         nultimes--;
 509         if (!jdt.hasSelection())
 510         {
 511           System.out.println("No Selection");
 512         }
 513         else
 514         {
 515           System.out.println("Selection: " + jdt.getSelectedItem());
 516           int s = 1;
 517           for (DbSourceProxy pr : jdt.getSelectedSources())
 518           {
 519             System.out.println("Source " + s++ + ": " + pr.getDbName()
 520                     + " (" + pr.getDbSource() + ") Version "
 521                     + pr.getDbVersion() + ". Test:\t" + pr.getTestQuery());
 522           }
 523           System.out.println("Test queries: " + jdt.getExampleQueries());
 524         }
 525       }
 526     } while (nultimes > 0 && foo.isVisible());
 527     foo.setVisible(false);
 528   }
 529
 530   @Override
 531   public void keyPressed(KeyEvent arg0)
 532   {
 533     if (!arg0.isConsumed() && arg0.getKeyCode() == KeyEvent.VK_ENTER)
 534     {
 535       okPressed();
 536     }
 537     if (!arg0.isConsumed() && arg0.getKeyChar() == KeyEvent.VK_ESCAPE)
 538     {
 539       cancelPressed();
 540     }
 541   }
 542
 543   @Override
 544   public void keyReleased(KeyEvent arg0)
 545   {
 546     // TODO Auto-generated method stub
 547
 548   }
 549
 550   @Override
 551   public void keyTyped(KeyEvent arg0)
 552   {
 553     // TODO Auto-generated method stub
 554
 555   }
 556 }