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.util.ArrayList;
  37 import java.util.HashSet;
  38 import java.util.Hashtable;
  39 import java.util.List;
  40 import java.util.Vector;
  41
  42 import javax.swing.JButton;
  43 import javax.swing.JFrame;
  44 import javax.swing.JLabel;
  45 import javax.swing.JPanel;
  46 import javax.swing.JScrollPane;
  47 import javax.swing.JTree;
  48 import javax.swing.ToolTipManager;
  49 import javax.swing.event.TreeSelectionEvent;
  50 import javax.swing.event.TreeSelectionListener;
  51 import javax.swing.tree.DefaultMutableTreeNode;
  52 import javax.swing.tree.DefaultTreeCellRenderer;
  53 import javax.swing.tree.DefaultTreeModel;
  54 import javax.swing.tree.TreeCellRenderer;
  55 import javax.swing.tree.TreeNode;
  56 import javax.swing.tree.TreePath;
  57 import javax.swing.tree.TreeSelectionModel;
  58
  59 public class JDatabaseTree extends JalviewDialog implements KeyListener
  60 {
  61   boolean allowMultiSelections = false;
  62
  63   public int action;
  64
  65   JButton getDatabaseSelectorButton()
  66   {
  67     final JButton viewdbs = new JButton(
  68             MessageManager.getString("action.select_ddbb"));
  69     viewdbs.addActionListener(new ActionListener()
  70     {
  71
  72       @Override
  73       public void actionPerformed(ActionEvent arg0)
  74       {
  75         showDialog();
  76       }
  77     });
  78     return viewdbs;
  79   }
  80
  81   JScrollPane svp;
  82
  83   JTree dbviews;
  84
  85   private jalview.ws.SequenceFetcher sfetcher;
  86
  87   private JLabel dbstatus, dbstatex;
  88
  89   public JDatabaseTree(jalview.ws.SequenceFetcher sfetch)
  90   {
  91     initDialogFrame(this, true, false,
  92             MessageManager
  93                     .getString("label.select_database_retrieval_source"),
  94             650, 490);
  95     /*
  96      * Dynamically generated database list will need a translation function from
  97      * internal source to externally distinct names. UNIPROT and UP_NAME are
  98      * identical DB sources, and should be collapsed.
  99      */
 100     DefaultMutableTreeNode tn = null, root = new DefaultMutableTreeNode();
 101     Hashtable<String, DefaultMutableTreeNode> source = new Hashtable<String, DefaultMutableTreeNode>();
 102     sfetcher = sfetch;
 103     String dbs[] = sfetch.getSupportedDb();
 104     Hashtable<String, String> ht = new Hashtable<String, String>();
 105     for (int i = 0; i < dbs.length; i++)
 106     {
 107       tn = source.get(dbs[i]);
 108       List<DbSourceProxy> srcs = sfetch.getSourceProxy(dbs[i]);
 109       if (tn == null)
 110       {
 111         source.put(dbs[i], tn = new DefaultMutableTreeNode(dbs[i], true));
 112       }
 113       for (DbSourceProxy dbp : srcs)
 114       {
 115         if (ht.get(dbp.getDbName()) == null)
 116         {
 117           tn.add(new DefaultMutableTreeNode(dbp, false));
 118           ht.put(dbp.getDbName(), dbp.getDbName());
 119         }
 120         else
 121         {
 122           System.err.println("dupe ig for : " + dbs[i] + " \t"
 123                   + dbp.getDbName() + " (" + dbp.getDbSource() + ")");
 124           source.remove(tn);
 125         }
 126       }
 127     }
 128     for (int i = 0; i < dbs.length; i++)
 129     {
 130       tn = source.get(dbs[i]);
 131       if (tn == null)
 132       {
 133         continue;
 134       }
 135       if (tn.getChildCount() == 1)
 136       {
 137         DefaultMutableTreeNode ttn = (DefaultMutableTreeNode) tn
 138                 .getChildAt(0);
 139         // remove nodes with only one child
 140         tn.setUserObject(ttn.getUserObject());
 141         tn.removeAllChildren();
 142         source.put(dbs[i], tn);
 143         tn.setAllowsChildren(false);
 144       }
 145       root.add(tn);
 146     }
 147     // and sort the tree
 148     sortTreeNodes(root);
 149     svp = new JScrollPane();
 150     // svp.setAutoscrolls(true);
 151     dbviews = new JTree(new DefaultTreeModel(root, false));
 152     dbviews.setCellRenderer(new DbTreeRenderer(this));
 153
 154     dbviews.getSelectionModel().setSelectionMode(
 155             TreeSelectionModel.SINGLE_TREE_SELECTION);
 156     svp.getViewport().setView(dbviews);
 157     // svp.getViewport().setMinimumSize(new Dimension(300,200));
 158     // svp.setSize(300,250);
 159     // JPanel panel=new JPanel();
 160     // panel.setSize(new Dimension(350,220));
 161     // panel.add(svp);
 162     dbviews.addTreeSelectionListener(new TreeSelectionListener()
 163     {
 164
 165       @Override
 166       public void valueChanged(TreeSelectionEvent arg0)
 167       {
 168         _setSelectionState();
 169       }
 170     });
 171     JPanel jc = new JPanel(new BorderLayout()), j = new JPanel(
 172             new FlowLayout());
 173     jc.add(svp, BorderLayout.CENTER);
 174
 175     java.awt.Font f;
 176     // TODO: make the panel stay a fixed size for longest dbname+example set.
 177     JPanel dbstat = new JPanel(new GridLayout(2, 1));
 178     dbstatus = new JLabel(" "); // set the height correctly for layout
 179     dbstatus.setFont(f = JvSwingUtils.getLabelFont(false, true));
 180     dbstatus.setSize(new Dimension(290, 50));
 181     dbstatex = new JLabel(" ");
 182     dbstatex.setFont(f);
 183     dbstatex.setSize(new Dimension(290, 50));
 184     dbstat.add(dbstatus);
 185     dbstat.add(dbstatex);
 186     jc.add(dbstat, BorderLayout.SOUTH);
 187     jc.validate();
 188     // j.setPreferredSize(new Dimension(300,50));
 189     add(jc, BorderLayout.CENTER);
 190     ok.setEnabled(false);
 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   void showDialog()
 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     ok.setEnabled(false);
 353     if (dbviews.getSelectionCount() == 0)
 354     {
 355       selection = null;
 356     }
 357
 358     tsel = dbviews.getSelectionPaths();
 359     boolean forcedFirstChild = false;
 360     List<DbSourceProxy> srcs = new ArrayList<DbSourceProxy>();
 361     if (tsel != null)
 362     {
 363       for (TreePath tp : tsel)
 364       {
 365         DefaultMutableTreeNode admt, dmt = (DefaultMutableTreeNode) tp
 366                 .getLastPathComponent();
 367         if (dmt.getUserObject() != null)
 368         {
 369           /*
 370            * enable OK button once a selection has been made
 371            */
 372           ok.setEnabled(true);
 373           if (dmt.getUserObject() instanceof DbSourceProxy)
 374           {
 375             srcs.add((DbSourceProxy) dmt.getUserObject());
 376           }
 377           else
 378           {
 379             if (allowMultiSelections)
 380             {
 381               srcs.addAll(sfetcher.getSourceProxy((String) dmt
 382                       .getUserObject()));
 383             }
 384             else
 385             {
 386               srcs.add(sfetcher
 387                       .getSourceProxy((String) dmt.getUserObject()).get(0));
 388               forcedFirstChild = true;
 389             }
 390           }
 391         }
 392       }
 393     }
 394     updateDbStatus(srcs, forcedFirstChild);
 395     selection = srcs;
 396   }
 397
 398   private void _revertSelectionState()
 399   {
 400     handleSelections = false;
 401     if (selection == null || selection.size() == 0)
 402     {
 403       dbviews.clearSelection();
 404     }
 405     else
 406     {
 407       dbviews.setSelectionPaths(tsel);
 408     }
 409     handleSelections = true;
 410   }
 411
 412   private void updateDbStatus(List<DbSourceProxy> srcs,
 413           boolean forcedFirstChild)
 414   {
 415     int x = 0;
 416     String nm = "", qr = "";
 417     for (DbSourceProxy dbs : srcs)
 418     {
 419       String tq = dbs.getTestQuery();
 420       nm = dbs.getDbName();
 421       if (tq != null && tq.trim().length() > 0 && dbs.isValidReference(tq))
 422       {
 423         qr = tq;
 424         x++;
 425       }
 426     }
 427
 428     dbstatex.setText(" ");
 429     if (allowMultiSelections)
 430     {
 431       dbstatus.setText(MessageManager.formatMessage(
 432               "label.selected_database_to_fetch_from", new String[] {
 433                   Integer.valueOf(srcs.size()).toString(),
 434                   (srcs.size() == 1 ? "" : "s"),
 435                   (srcs.size() > 0 ? " with " + x + " test quer"
 436                           + (x == 1 ? "y" : "ies") : ".") }));
 437     }
 438     else
 439     {
 440       if (nm.length() > 0)
 441       {
 442         dbstatus.setText(MessageManager.formatMessage(
 443                 "label.database_param", new String[] { nm }));
 444         if (qr.length() > 0)
 445         {
 446           dbstatex.setText(MessageManager.formatMessage(
 447                   "label.example_param", new String[] { qr }));
 448         }
 449       }
 450       else
 451       {
 452         dbstatus.setText(" ");
 453       }
 454     }
 455     dbstatus.invalidate();
 456     dbstatex.invalidate();
 457   }
 458
 459   public String getSelectedItem()
 460   {
 461     if (hasSelection())
 462     {
 463       return getSelectedSources().get(0).getDbName();
 464     }
 465     return null;
 466   }
 467
 468   public String getExampleQueries()
 469   {
 470     if (!hasSelection())
 471     {
 472       return null;
 473     }
 474     StringBuffer sb = new StringBuffer();
 475     HashSet<String> hs = new HashSet<String>();
 476     for (DbSourceProxy dbs : getSelectedSources())
 477     {
 478       String tq = dbs.getTestQuery();
 479       ;
 480       if (hs.add(tq))
 481       {
 482         if (sb.length() > 0)
 483         {
 484           sb.append(";");
 485         }
 486         sb.append(tq);
 487       }
 488     }
 489     return sb.toString();
 490   }
 491
 492   List<ActionListener> lstners = new Vector<ActionListener>();
 493
 494   public void addActionListener(ActionListener actionListener)
 495   {
 496     lstners.add(actionListener);
 497   }
 498
 499   public void removeActionListener(ActionListener actionListener)
 500   {
 501     lstners.remove(actionListener);
 502   }
 503
 504   public static void main(String args[])
 505   {
 506     Cache.getDasSourceRegistry();
 507     JDatabaseTree jdt = new JDatabaseTree(new jalview.ws.SequenceFetcher());
 508     JFrame foo = new JFrame();
 509     foo.setLayout(new BorderLayout());
 510     foo.add(jdt.getDatabaseSelectorButton(), BorderLayout.CENTER);
 511     foo.pack();
 512     foo.setVisible(true);
 513     int nultimes = 5;
 514     final Thread us = Thread.currentThread();
 515     jdt.addActionListener(new ActionListener()
 516     {
 517
 518       @Override
 519       public void actionPerformed(ActionEvent e)
 520       {
 521         us.interrupt();
 522       }
 523     });
 524     do
 525     {
 526       try
 527       {
 528         Thread.sleep(50);
 529       } catch (InterruptedException x)
 530       {
 531         nultimes--;
 532         if (!jdt.hasSelection())
 533         {
 534           System.out.println("No Selection");
 535         }
 536         else
 537         {
 538           System.out.println("Selection: " + jdt.getSelectedItem());
 539           int s = 1;
 540           for (DbSourceProxy pr : jdt.getSelectedSources())
 541           {
 542             System.out.println("Source " + s++ + ": " + pr.getDbName()
 543                     + " (" + pr.getDbSource() + ") Version "
 544                     + pr.getDbVersion() + ". Test:\t" + pr.getTestQuery());
 545           }
 546           System.out.println("Test queries: " + jdt.getExampleQueries());
 547         }
 548       }
 549     } while (nultimes > 0 && foo.isVisible());
 550     foo.setVisible(false);
 551   }
 552
 553   @Override
 554   public void keyPressed(KeyEvent arg0)
 555   {
 556     if (!arg0.isConsumed() && arg0.getKeyCode() == KeyEvent.VK_ENTER)
 557     {
 558       action = arg0.getKeyCode();
 559       okPressed();
 560     }
 561     if (!arg0.isConsumed() && arg0.getKeyChar() == KeyEvent.VK_ESCAPE)
 562     {
 563       action = arg0.getKeyCode();
 564       cancelPressed();
 565     }
 566   }
 567
 568   @Override
 569   public void keyReleased(KeyEvent arg0)
 570   {
 571     // TODO Auto-generated method stub
 572
 573   }
 574
 575   @Override
 576   public void keyTyped(KeyEvent arg0)
 577   {
 578     // TODO Auto-generated method stub
 579
 580   }
 581 }