src/jalview/gui/JDatabaseTree.java

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