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