src/jalview/gui/JDatabaseTree.java

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