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