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