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,
  97             MessageManager
  98                     .getString("label.select_database_retrieval_source"),
  99             650, 490);
 100     /*
 101      * Dynamically generated database list will need a translation function from
 102      * internal source to externally distinct names. UNIPROT and UP_NAME are
 103      * identical DB sources, and should be collapsed.
 104      */
 105     DefaultMutableTreeNode tn = null, root = new DefaultMutableTreeNode();
 106     Hashtable<String, DefaultMutableTreeNode> source = new Hashtable<String, DefaultMutableTreeNode>();
 107     sfetcher = sfetch;
 108     String dbs[] = sfetch.getSupportedDb();
 109     Hashtable<String, String> ht = new Hashtable<String, String>();
 110     for (int i = 0; i < dbs.length; i++)
 111     {
 112       tn = source.get(dbs[i]);
 113       List<DbSourceProxy> srcs = sfetch.getSourceProxy(dbs[i]);
 114       if (tn == null)
 115       {
 116         source.put(dbs[i], tn = new DefaultMutableTreeNode(dbs[i], true));
 117       }
 118       for (DbSourceProxy dbp : srcs)
 119       {
 120         if (ht.get(dbp.getDbName()) == null)
 121         {
 122           tn.add(new DefaultMutableTreeNode(dbp, false));
 123           ht.put(dbp.getDbName(), dbp.getDbName());
 124         }
 125         else
 126         {
 127           System.err.println("dupe ig for : " + dbs[i] + " \t"
 128                   + dbp.getDbName() + " (" + dbp.getDbSource() + ")");
 129           source.remove(tn);
 130         }
 131       }
 132     }
 133     for (int i = 0; i < dbs.length; i++)
 134     {
 135       tn = source.get(dbs[i]);
 136       if (tn == null)
 137       {
 138         continue;
 139       }
 140       if (tn.getChildCount() == 1)
 141       {
 142         DefaultMutableTreeNode ttn = (DefaultMutableTreeNode) tn
 143                 .getChildAt(0);
 144         // remove nodes with only one child
 145         tn.setUserObject(ttn.getUserObject());
 146         tn.removeAllChildren();
 147         source.put(dbs[i], tn);
 148         tn.setAllowsChildren(false);
 149       }
 150       root.add(tn);
 151     }
 152     // and sort the tree
 153     sortTreeNodes(root);
 154     svp = new JScrollPane();
 155     // svp.setAutoscrolls(true);
 156     dbviews = new JTree(new DefaultTreeModel(root, false));
 157     dbviews.setCellRenderer(new DbTreeRenderer(this));
 158
 159     dbviews.getSelectionModel().setSelectionMode(
 160             TreeSelectionModel.SINGLE_TREE_SELECTION);
 161     svp.getViewport().setView(dbviews);
 162     // svp.getViewport().setMinimumSize(new Dimension(300,200));
 163     // svp.setSize(300,250);
 164     // JPanel panel=new JPanel();
 165     // panel.setSize(new Dimension(350,220));
 166     // panel.add(svp);
 167     dbviews.addTreeSelectionListener(new TreeSelectionListener()
 168     {
 169
 170       @Override
 171       public void valueChanged(TreeSelectionEvent arg0)
 172       {
 173         _setSelectionState();
 174       }
 175     });
 176     dbviews.addMouseListener(new MouseAdapter()
 177     {
 178
 179       @Override
 180       public void mousePressed(MouseEvent e)
 181       {
 182         if (e.getClickCount() == 2)
 183         {
 184           okPressed();
 185           closeDialog();
 186         }
 187       }
 188     });
 189     JPanel jc = new JPanel(new BorderLayout()), j = new JPanel(
 190             new FlowLayout());
 191     jc.add(svp, BorderLayout.CENTER);
 192
 193     java.awt.Font f;
 194     // TODO: make the panel stay a fixed size for longest dbname+example set.
 195     JPanel dbstat = new JPanel(new GridLayout(2, 1));
 196     dbstatus = new JLabel(" "); // set the height correctly for layout
 197     dbstatus.setFont(f = JvSwingUtils.getLabelFont(false, true));
 198     dbstatus.setSize(new Dimension(290, 50));
 199     dbstatex = new JLabel(" ");
 200     dbstatex.setFont(f);
 201     dbstatex.setSize(new Dimension(290, 50));
 202     dbstat.add(dbstatus);
 203     dbstat.add(dbstatex);
 204     jc.add(dbstat, BorderLayout.SOUTH);
 205     jc.validate();
 206     // j.setPreferredSize(new Dimension(300,50));
 207     add(jc, BorderLayout.CENTER);
 208     ok.setEnabled(false);
 209     j.add(ok);
 210     j.add(cancel);
 211     add(j, BorderLayout.SOUTH);
 212     dbviews.addKeyListener(this);
 213     validate();
 214   }
 215
 216   private void sortTreeNodes(DefaultMutableTreeNode root)
 217   {
 218     if (root.getChildCount() == 0)
 219     {
 220       return;
 221     }
 222     int count = root.getChildCount();
 223     String[] names = new String[count];
 224     DefaultMutableTreeNode[] nodes = new DefaultMutableTreeNode[count];
 225     for (int i = 0; i < count; i++)
 226     {
 227       TreeNode node = root.getChildAt(i);
 228       if (node instanceof DefaultMutableTreeNode)
 229       {
 230         DefaultMutableTreeNode child = (DefaultMutableTreeNode) node;
 231         nodes[i] = child;
 232         if (child.getUserObject() instanceof DbSourceProxy)
 233         {
 234           names[i] = ((DbSourceProxy) child.getUserObject()).getDbName()
 235                   .toLowerCase();
 236         }
 237         else
 238         {
 239           names[i] = ((String) child.getUserObject()).toLowerCase();
 240           sortTreeNodes(child);
 241         }
 242       }
 243       else
 244       {
 245         throw new Error(
 246                 MessageManager
 247                         .getString("error.implementation_error_cant_reorder_tree"));
 248       }
 249     }
 250     jalview.util.QuickSort.sort(names, nodes);
 251     root.removeAllChildren();
 252     for (int i = count - 1; i >= 0; i--)
 253     {
 254       root.add(nodes[i]);
 255     }
 256   }
 257
 258   private class DbTreeRenderer extends DefaultTreeCellRenderer implements
 259           TreeCellRenderer
 260   {
 261     JDatabaseTree us;
 262
 263     public DbTreeRenderer(JDatabaseTree me)
 264     {
 265       us = me;
 266       ToolTipManager.sharedInstance().registerComponent(dbviews);
 267     }
 268
 269     private Component returnLabel(String txt)
 270     {
 271       JLabel jl = new JLabel(txt);
 272       jl.setFont(JvSwingUtils.getLabelFont());
 273       return jl;
 274     }
 275
 276     @Override
 277     public Component getTreeCellRendererComponent(JTree tree, Object value,
 278             boolean selected, boolean expanded, boolean leaf, int row,
 279             boolean hasFocus)
 280     {
 281       String val = "";
 282       if (value != null && value instanceof DefaultMutableTreeNode)
 283       {
 284         DefaultMutableTreeNode vl = (DefaultMutableTreeNode) value;
 285         value = vl.getUserObject();
 286         if (value instanceof DbSourceProxy)
 287         {
 288           val = ((DbSourceProxy) value).getDbName();
 289           if (((DbSourceProxy) value).getDescription() != null)
 290           { // getName()
 291             this.setToolTipText(((DbSourceProxy) value).getDescription());
 292           }
 293         }
 294         else
 295         {
 296           if (value instanceof String)
 297           {
 298             val = (String) value;
 299           }
 300         }
 301       }
 302       if (value == null)
 303       {
 304         val = "";
 305       }
 306       return super.getTreeCellRendererComponent(tree, val, selected,
 307               expanded, leaf, row, hasFocus);
 308
 309     }
 310   }
 311
 312   List<DbSourceProxy> oldselection, selection = null;
 313
 314   TreePath[] tsel = null, oldtsel = null;
 315
 316   @Override
 317   protected void raiseClosed()
 318   {
 319     for (ActionListener al : lstners)
 320     {
 321       al.actionPerformed(null);
 322     }
 323   }
 324
 325   @Override
 326   protected void okPressed()
 327   {
 328     _setSelectionState();
 329   }
 330
 331   @Override
 332   protected void cancelPressed()
 333   {
 334     selection = oldselection;
 335     tsel = oldtsel;
 336     _revertSelectionState();
 337     closeDialog();
 338   }
 339
 340   void showDialog()
 341   {
 342     oldselection = selection;
 343     oldtsel = tsel;
 344     validate();
 345     waitForInput();
 346   }
 347
 348   public boolean hasSelection()
 349   {
 350     return selection == null ? false : selection.size() == 0 ? false : true;
 351   }
 352
 353   public List<DbSourceProxy> getSelectedSources()
 354   {
 355     return selection;
 356   }
 357
 358   /**
 359    * disable or enable selection handler
 360    */
 361   boolean handleSelections = true;
 362
 363   private void _setSelectionState()
 364   {
 365     if (!handleSelections)
 366     {
 367       return;
 368     }
 369     ok.setEnabled(false);
 370     if (dbviews.getSelectionCount() == 0)
 371     {
 372       selection = null;
 373     }
 374
 375     tsel = dbviews.getSelectionPaths();
 376     boolean forcedFirstChild = false;
 377     List<DbSourceProxy> srcs = new ArrayList<DbSourceProxy>();
 378     if (tsel != null)
 379     {
 380       for (TreePath tp : tsel)
 381       {
 382         DefaultMutableTreeNode admt, dmt = (DefaultMutableTreeNode) tp
 383                 .getLastPathComponent();
 384         if (dmt.getUserObject() != null)
 385         {
 386           /*
 387            * enable OK button once a selection has been made
 388            */
 389           ok.setEnabled(true);
 390           if (dmt.getUserObject() instanceof DbSourceProxy)
 391           {
 392             srcs.add((DbSourceProxy) dmt.getUserObject());
 393           }
 394           else
 395           {
 396             if (allowMultiSelections)
 397             {
 398               srcs.addAll(sfetcher.getSourceProxy((String) dmt
 399                       .getUserObject()));
 400             }
 401             else
 402             {
 403               srcs.add(sfetcher
 404                       .getSourceProxy((String) dmt.getUserObject()).get(0));
 405               forcedFirstChild = true;
 406             }
 407           }
 408         }
 409       }
 410     }
 411     updateDbStatus(srcs, forcedFirstChild);
 412     selection = srcs;
 413   }
 414
 415   private void _revertSelectionState()
 416   {
 417     handleSelections = false;
 418     if (selection == null || selection.size() == 0)
 419     {
 420       dbviews.clearSelection();
 421     }
 422     else
 423     {
 424       dbviews.setSelectionPaths(tsel);
 425     }
 426     handleSelections = true;
 427   }
 428
 429   private void updateDbStatus(List<DbSourceProxy> srcs,
 430           boolean forcedFirstChild)
 431   {
 432     int x = 0;
 433     String nm = "", qr = "";
 434     for (DbSourceProxy dbs : srcs)
 435     {
 436       String tq = dbs.getTestQuery();
 437       nm = dbs.getDbName();
 438       if (tq != null && tq.trim().length() > 0 && dbs.isValidReference(tq))
 439       {
 440         qr = tq;
 441         x++;
 442       }
 443     }
 444
 445     dbstatex.setText(" ");
 446     if (allowMultiSelections)
 447     {
 448       dbstatus.setText(MessageManager.formatMessage(
 449               "label.selected_database_to_fetch_from", new String[] {
 450                   Integer.valueOf(srcs.size()).toString(),
 451                   (srcs.size() == 1 ? "" : "s"),
 452                   (srcs.size() > 0 ? " with " + x + " test quer"
 453                           + (x == 1 ? "y" : "ies") : ".") }));
 454     }
 455     else
 456     {
 457       if (nm.length() > 0)
 458       {
 459         dbstatus.setText(MessageManager.formatMessage(
 460                 "label.database_param", new String[] { nm }));
 461         if (qr.length() > 0)
 462         {
 463           dbstatex.setText(MessageManager.formatMessage(
 464                   "label.example_param", new String[] { 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 }