src/jalview/gui/JDatabaseTree.java

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