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