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