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     ok.setEnabled(false);
 192     j.add(ok);
 193     j.add(cancel);
 194     add(j, BorderLayout.SOUTH);
 195     dbviews.addKeyListener(this);
 196     validate();
 197   }
 198
 199   private void sortTreeNodes(DefaultMutableTreeNode root)
 200   {
 201     if (root.getChildCount() == 0)
 202     {
 203       return;
 204     }
 205     int count = root.getChildCount();
 206     String[] names = new String[count];
 207     DefaultMutableTreeNode[] nodes = new DefaultMutableTreeNode[count];
 208     for (int i = 0; i < count; i++)
 209     {
 210       TreeNode node = root.getChildAt(i);
 211       if (node instanceof DefaultMutableTreeNode)
 212       {
 213         DefaultMutableTreeNode child = (DefaultMutableTreeNode) node;
 214         nodes[i] = child;
 215         if (child.getUserObject() instanceof DbSourceProxy)
 216         {
 217           names[i] = ((DbSourceProxy) child.getUserObject()).getDbName()
 218                   .toLowerCase();
 219         }
 220         else
 221         {
 222           names[i] = ((String) child.getUserObject()).toLowerCase();
 223           sortTreeNodes(child);
 224         }
 225       }
 226       else
 227       {
 228         throw new Error(
 229                 MessageManager
 230                         .getString("error.implementation_error_cant_reorder_tree"));
 231       }
 232     }
 233     jalview.util.QuickSort.sort(names, nodes);
 234     root.removeAllChildren();
 235     for (int i = count - 1; i >= 0; i--)
 236     {
 237       root.add(nodes[i]);
 238     }
 239   }
 240
 241   private class DbTreeRenderer extends DefaultTreeCellRenderer implements
 242           TreeCellRenderer
 243   {
 244     JDatabaseTree us;
 245
 246     public DbTreeRenderer(JDatabaseTree me)
 247     {
 248       us = me;
 249       ToolTipManager.sharedInstance().registerComponent(dbviews);
 250     }
 251
 252     private Component returnLabel(String txt)
 253     {
 254       JLabel jl = new JLabel(txt);
 255       jl.setFont(JvSwingUtils.getLabelFont());
 256       return jl;
 257     }
 258
 259     @Override
 260     public Component getTreeCellRendererComponent(JTree tree, Object value,
 261             boolean selected, boolean expanded, boolean leaf, int row,
 262             boolean hasFocus)
 263     {
 264       String val = "";
 265       if (value != null && value instanceof DefaultMutableTreeNode)
 266       {
 267         DefaultMutableTreeNode vl = (DefaultMutableTreeNode) value;
 268         value = vl.getUserObject();
 269         if (value instanceof DbSourceProxy)
 270         {
 271           val = ((DbSourceProxy) value).getDbName();
 272           if (((DbSourceProxy) value).getDescription() != null)
 273           { // getName()
 274             this.setToolTipText(((DbSourceProxy) value).getDescription());
 275           }
 276         }
 277         else
 278         {
 279           if (value instanceof String)
 280           {
 281             val = (String) value;
 282           }
 283         }
 284       }
 285       if (value == null)
 286       {
 287         val = "";
 288       }
 289       return super.getTreeCellRendererComponent(tree, val, selected,
 290               expanded, leaf, row, hasFocus);
 291
 292     }
 293   }
 294
 295   List<DbSourceProxy> oldselection, selection = null;
 296
 297   TreePath[] tsel = null, oldtsel = null;
 298
 299   @Override
 300   protected void raiseClosed()
 301   {
 302     for (ActionListener al : lstners)
 303     {
 304       al.actionPerformed(null);
 305     }
 306   }
 307
 308   @Override
 309   protected void okPressed()
 310   {
 311     _setSelectionState();
 312     closeDialog();
 313   }
 314
 315   @Override
 316   protected void cancelPressed()
 317   {
 318     selection = oldselection;
 319     tsel = oldtsel;
 320     _revertSelectionState();
 321     closeDialog();
 322   }
 323
 324   private void showDialog(Container parent)
 325   {
 326     oldselection = selection;
 327     oldtsel = tsel;
 328     validate();
 329     waitForInput();
 330   }
 331
 332   public boolean hasSelection()
 333   {
 334     return selection == null ? false : selection.size() == 0 ? false : true;
 335   }
 336
 337   public List<DbSourceProxy> getSelectedSources()
 338   {
 339     return selection;
 340   }
 341
 342   /**
 343    * disable or enable selection handler
 344    */
 345   boolean handleSelections = true;
 346
 347   private void _setSelectionState()
 348   {
 349     if (!handleSelections)
 350     {
 351       return;
 352     }
 353     ok.setEnabled(false);
 354     if (dbviews.getSelectionCount() == 0)
 355     {
 356       selection = null;
 357     }
 358
 359     tsel = dbviews.getSelectionPaths();
 360     boolean forcedFirstChild = false;
 361     List<DbSourceProxy> srcs = new ArrayList<DbSourceProxy>();
 362     if (tsel != null)
 363     {
 364       for (TreePath tp : tsel)
 365       {
 366         DefaultMutableTreeNode admt, dmt = (DefaultMutableTreeNode) tp
 367                 .getLastPathComponent();
 368         if (dmt.getUserObject() != null)
 369         {
 370           /*
 371            * enable OK button once a selection has been made
 372            */
 373           ok.setEnabled(true);
 374           if (dmt.getUserObject() instanceof DbSourceProxy)
 375           {
 376             srcs.add((DbSourceProxy) dmt.getUserObject());
 377           }
 378           else
 379           {
 380             if (allowMultiSelections)
 381             {
 382               srcs.addAll(sfetcher.getSourceProxy((String) dmt
 383                       .getUserObject()));
 384             }
 385             else
 386             {
 387               srcs.add(sfetcher
 388                       .getSourceProxy((String) dmt.getUserObject()).get(0));
 389               forcedFirstChild = true;
 390             }
 391           }
 392         }
 393       }
 394     }
 395     updateDbStatus(srcs, forcedFirstChild);
 396     selection = srcs;
 397   }
 398
 399   private void _revertSelectionState()
 400   {
 401     handleSelections = false;
 402     if (selection == null || selection.size() == 0)
 403     {
 404       dbviews.clearSelection();
 405     }
 406     else
 407     {
 408       dbviews.setSelectionPaths(tsel);
 409     }
 410     handleSelections = true;
 411   }
 412
 413   private void updateDbStatus(List<DbSourceProxy> srcs,
 414           boolean forcedFirstChild)
 415   {
 416     int x = 0;
 417     String nm = "", qr = "";
 418     for (DbSourceProxy dbs : srcs)
 419     {
 420       String tq = dbs.getTestQuery();
 421       nm = dbs.getDbName();
 422       if (tq != null && tq.trim().length() > 0 && dbs.isValidReference(tq))
 423       {
 424         qr = tq;
 425         x++;
 426       }
 427     }
 428
 429     dbstatex.setText(" ");
 430     if (allowMultiSelections)
 431     {
 432       dbstatus.setText(MessageManager.formatMessage(
 433               "label.selected_database_to_fetch_from", new String[] {
 434                   Integer.valueOf(srcs.size()).toString(),
 435                   (srcs.size() == 1 ? "" : "s"),
 436                   (srcs.size() > 0 ? " with " + x + " test quer"
 437                           + (x == 1 ? "y" : "ies") : ".") }));
 438     }
 439     else
 440     {
 441       if (nm.length() > 0)
 442       {
 443         dbstatus.setText(MessageManager.formatMessage(
 444                 "label.database_param", new String[] { nm }));
 445         if (qr.length() > 0)
 446         {
 447           dbstatex.setText(MessageManager.formatMessage(
 448                   "label.example_param", new String[] { qr }));
 449         }
 450       }
 451       else
 452       {
 453         dbstatus.setText(" ");
 454       }
 455     }
 456     dbstatus.invalidate();
 457     dbstatex.invalidate();
 458   }
 459
 460   public String getSelectedItem()
 461   {
 462     if (hasSelection())
 463     {
 464       return getSelectedSources().get(0).getDbName();
 465     }
 466     return null;
 467   }
 468
 469   public String getExampleQueries()
 470   {
 471     if (!hasSelection())
 472     {
 473       return null;
 474     }
 475     StringBuffer sb = new StringBuffer();
 476     HashSet<String> hs = new HashSet<String>();
 477     for (DbSourceProxy dbs : getSelectedSources())
 478     {
 479       String tq = dbs.getTestQuery();
 480       ;
 481       if (hs.add(tq))
 482       {
 483         if (sb.length() > 0)
 484         {
 485           sb.append(";");
 486         }
 487         sb.append(tq);
 488       }
 489     }
 490     return sb.toString();
 491   }
 492
 493   List<ActionListener> lstners = new Vector<ActionListener>();
 494
 495   public void addActionListener(ActionListener actionListener)
 496   {
 497     lstners.add(actionListener);
 498   }
 499
 500   public void removeActionListener(ActionListener actionListener)
 501   {
 502     lstners.remove(actionListener);
 503   }
 504
 505   public static void main(String args[])
 506   {
 507     Cache.getDasSourceRegistry();
 508     JDatabaseTree jdt = new JDatabaseTree(new jalview.ws.SequenceFetcher());
 509     JFrame foo = new JFrame();
 510     foo.setLayout(new BorderLayout());
 511     foo.add(jdt.getDatabaseSelectorButton(), BorderLayout.CENTER);
 512     foo.pack();
 513     foo.setVisible(true);
 514     int nultimes = 5;
 515     final Thread us = Thread.currentThread();
 516     jdt.addActionListener(new ActionListener()
 517     {
 518
 519       @Override
 520       public void actionPerformed(ActionEvent e)
 521       {
 522         us.interrupt();
 523       }
 524     });
 525     do
 526     {
 527       try
 528       {
 529         Thread.sleep(50);
 530       } catch (InterruptedException x)
 531       {
 532         nultimes--;
 533         if (!jdt.hasSelection())
 534         {
 535           System.out.println("No Selection");
 536         }
 537         else
 538         {
 539           System.out.println("Selection: " + jdt.getSelectedItem());
 540           int s = 1;
 541           for (DbSourceProxy pr : jdt.getSelectedSources())
 542           {
 543             System.out.println("Source " + s++ + ": " + pr.getDbName()
 544                     + " (" + pr.getDbSource() + ") Version "
 545                     + pr.getDbVersion() + ". Test:\t" + pr.getTestQuery());
 546           }
 547           System.out.println("Test queries: " + jdt.getExampleQueries());
 548         }
 549       }
 550     } while (nultimes > 0 && foo.isVisible());
 551     foo.setVisible(false);
 552   }
 553
 554   @Override
 555   public void keyPressed(KeyEvent arg0)
 556   {
 557     if (!arg0.isConsumed() && arg0.getKeyCode() == KeyEvent.VK_ENTER)
 558     {
 559       action = arg0.getKeyCode();
 560       okPressed();
 561     }
 562     if (!arg0.isConsumed() && arg0.getKeyChar() == KeyEvent.VK_ESCAPE)
 563     {
 564       action = arg0.getKeyCode();
 565       cancelPressed();
 566     }
 567   }
 568
 569   @Override
 570   public void keyReleased(KeyEvent arg0)
 571   {
 572     // TODO Auto-generated method stub
 573
 574   }
 575
 576   @Override
 577   public void keyTyped(KeyEvent arg0)
 578   {
 579     // TODO Auto-generated method stub
 580
 581   }
 582 }