src/jalview/gui/JDatabaseTree.java

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