9abef1f7711dcc151a8d7d55c51d44a15bdc666f
[jalview.git] / src / jalview / gui / CalculationChooser.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.analysis.TreeBuilder;
24 import jalview.analysis.scoremodels.ScoreModels;
25 import jalview.analysis.scoremodels.SimilarityParams;
26 import jalview.api.AlignViewportI;
27 import jalview.api.analysis.ScoreModelI;
28 import jalview.api.analysis.SimilarityParamsI;
29 import jalview.bin.Cache;
30 import jalview.datamodel.SequenceGroup;
31 import jalview.util.MessageManager;
32 import jalview.viewmodel.AlignmentViewport;
33
34 import java.awt.BorderLayout;
35 import java.awt.Color;
36 import java.awt.Component;
37 import java.awt.Dimension;
38 import java.awt.FlowLayout;
39 import java.awt.Font;
40 import java.awt.GridLayout;
41 import java.awt.Insets;
42 import java.awt.event.ActionEvent;
43 import java.awt.event.ActionListener;
44 import java.awt.event.FocusEvent;
45 import java.awt.event.FocusListener;
46 import java.awt.event.MouseAdapter;
47 import java.awt.event.MouseEvent;
48 import java.beans.PropertyVetoException;
49 import java.util.ArrayList;
50 import java.util.List;
51
52 import javax.swing.BorderFactory;
53 import javax.swing.ButtonGroup;
54 import javax.swing.DefaultComboBoxModel;
55 import javax.swing.JButton;
56 import javax.swing.JCheckBox;
57 import javax.swing.JComboBox;
58 import javax.swing.JInternalFrame;
59 import javax.swing.JLabel;
60 import javax.swing.JLayeredPane;
61 import javax.swing.JPanel;
62 import javax.swing.JRadioButton;
63 import javax.swing.event.InternalFrameAdapter;
64 import javax.swing.event.InternalFrameEvent;
65
66 /**
67  * A dialog where a user can choose and action Tree or PCA calculation options
68  */
69 public class CalculationChooser extends JPanel
70 {
71   /*
72    * flag for whether gap matches residue in the PID calculation for a Tree
73    * - true gives Jalview 2.10.1 behaviour
74    * - set to false (using Groovy) for a more correct tree
75    * (JAL-374)
76    */
77   private static boolean treeMatchGaps = true;
78
79   private static final Font VERDANA_11PT = new Font("Verdana", 0, 11);
80
81   private static final int MIN_TREE_SELECTION = 3;
82
83   private static final int MIN_PCA_SELECTION = 4;
84
85   AlignFrame af;
86
87   JRadioButton pca;
88
89   JRadioButton neighbourJoining;
90
91   JRadioButton averageDistance;
92
93   JComboBox<String> modelNames;
94
95   JButton calculate;
96
97   private JInternalFrame frame;
98
99   private JCheckBox includeGaps;
100
101   private JCheckBox matchGaps;
102
103   private JCheckBox includeGappedColumns;
104
105   private JCheckBox shorterSequence;
106
107   final ComboBoxTooltipRenderer renderer = new ComboBoxTooltipRenderer();
108
109   List<String> tips = new ArrayList<>();
110
111   /*
112    * the most recently opened PCA results panel
113    */
114   private PCAPanel pcaPanel;
115
116   /**
117    * Constructor
118    * 
119    * @param af
120    */
121   public CalculationChooser(AlignFrame alignFrame)
122   {
123     this.af = alignFrame;
124     init();
125     af.alignPanel.setCalculationDialog(this);
126   }
127
128   /**
129    * Lays out the panel and adds it to the desktop
130    */
131   void init()
132   {
133     setLayout(new BorderLayout());
134     frame = new JInternalFrame();
135     frame.setContentPane(this);
136     this.setBackground(Color.white);
137     frame.addFocusListener(new FocusListener()
138     {
139
140       @Override
141       public void focusLost(FocusEvent e)
142       {
143       }
144
145       @Override
146       public void focusGained(FocusEvent e)
147       {
148         validateCalcTypes();
149       }
150     });
151     /*
152      * Layout consists of 3 or 4 panels:
153      * - first with choice of PCA or tree method NJ or AV
154      * - second with choice of score model
155      * - third with score model parameter options [suppressed]
156      * - fourth with OK and Cancel
157      */
158     pca = new JRadioButton(
159             MessageManager.getString("label.principal_component_analysis"));
160     pca.setOpaque(false);
161     neighbourJoining = new JRadioButton(
162             MessageManager.getString("label.tree_calc_nj"));
163     neighbourJoining.setSelected(true);
164     averageDistance = new JRadioButton(
165             MessageManager.getString("label.tree_calc_av"));
166     neighbourJoining.setOpaque(false);
167
168     JPanel calcChoicePanel = new JPanel(new FlowLayout(FlowLayout.LEFT));
169     calcChoicePanel.setOpaque(false);
170
171     // first create the Tree calculation's border panel
172     JPanel treePanel = new JPanel(new FlowLayout(FlowLayout.LEFT));
173     treePanel.setOpaque(false);
174
175     JvSwingUtils.createTitledBorder(treePanel,
176             MessageManager.getString("label.tree"), true);
177
178     // then copy the inset dimensions for the border-less PCA panel
179     JPanel pcaBorderless = new JPanel(new FlowLayout(FlowLayout.LEFT));
180     Insets b = treePanel.getBorder().getBorderInsets(treePanel);
181     pcaBorderless.setBorder(
182             BorderFactory.createEmptyBorder(2, b.left, 2, b.right));
183     pcaBorderless.setOpaque(false);
184
185     pcaBorderless.add(pca, FlowLayout.LEFT);
186     calcChoicePanel.add(pcaBorderless, FlowLayout.LEFT);
187
188     treePanel.add(neighbourJoining);
189     treePanel.add(averageDistance);
190
191     calcChoicePanel.add(treePanel);
192
193     ButtonGroup calcTypes = new ButtonGroup();
194     calcTypes.add(pca);
195     calcTypes.add(neighbourJoining);
196     calcTypes.add(averageDistance);
197
198     ActionListener calcChanged = new ActionListener()
199     {
200       @Override
201       public void actionPerformed(ActionEvent e)
202       {
203         validateCalcTypes();
204       }
205     };
206     pca.addActionListener(calcChanged);
207     neighbourJoining.addActionListener(calcChanged);
208     averageDistance.addActionListener(calcChanged);
209
210     /*
211      * score models drop-down - with added tooltips!
212      */
213     modelNames = buildModelOptionsList();
214
215     JPanel scoreModelPanel = new JPanel(new FlowLayout(FlowLayout.CENTER));
216     scoreModelPanel.setOpaque(false);
217     scoreModelPanel.add(modelNames);
218
219     /*
220      * score model parameters
221      */
222     JPanel paramsPanel = new JPanel(new GridLayout(5, 1));
223     paramsPanel.setOpaque(false);
224     includeGaps = new JCheckBox("Include gaps");
225     matchGaps = new JCheckBox("Match gaps");
226     includeGappedColumns = new JCheckBox("Include gapped columns");
227     shorterSequence = new JCheckBox("Match on shorter sequence");
228     paramsPanel.add(new JLabel("Pairwise sequence scoring options"));
229     paramsPanel.add(includeGaps);
230     paramsPanel.add(matchGaps);
231     paramsPanel.add(includeGappedColumns);
232     paramsPanel.add(shorterSequence);
233
234     /*
235      * OK / Cancel buttons
236      */
237     calculate = new JButton(MessageManager.getString("action.calculate"));
238     calculate.setFont(VERDANA_11PT);
239     calculate.addActionListener(new java.awt.event.ActionListener()
240     {
241       @Override
242       public void actionPerformed(ActionEvent e)
243       {
244         calculate_actionPerformed();
245       }
246     });
247     JButton close = new JButton(MessageManager.getString("action.close"));
248     close.setFont(VERDANA_11PT);
249     close.addActionListener(new java.awt.event.ActionListener()
250     {
251       @Override
252       public void actionPerformed(ActionEvent e)
253       {
254         close_actionPerformed();
255       }
256     });
257     JPanel actionPanel = new JPanel();
258     actionPanel.setOpaque(false);
259     actionPanel.add(calculate);
260     actionPanel.add(close);
261
262     boolean includeParams = false;
263     this.add(calcChoicePanel, BorderLayout.CENTER);
264     calcChoicePanel.add(scoreModelPanel);
265     if (includeParams)
266     {
267       scoreModelPanel.add(paramsPanel);
268     }
269     this.add(actionPanel, BorderLayout.SOUTH);
270
271     int width = 350;
272     int height = includeParams ? 420 : 240;
273
274     setMinimumSize(new Dimension(325, height - 10));
275     String title = MessageManager.getString("label.choose_calculation");
276     if (af.getViewport().getViewName() != null)
277     {
278       title = title + " (" + af.getViewport().getViewName() + ")";
279     }
280
281     Desktop.addInternalFrame(frame, title, width, height, false);
282     calcChoicePanel.doLayout();
283     revalidate();
284     /*
285      * null the AlignmentPanel's reference to the dialog when it is closed
286      */
287     frame.addInternalFrameListener(new InternalFrameAdapter()
288     {
289       @Override
290       public void internalFrameClosed(InternalFrameEvent evt)
291       {
292         af.alignPanel.setCalculationDialog(null);
293       };
294     });
295
296     frame.setLayer(JLayeredPane.PALETTE_LAYER);
297   }
298
299   /**
300    * enable calculations applicable for the current alignment or selection.
301    */
302   protected void validateCalcTypes()
303   {
304     int size = af.getViewport().getAlignment().getHeight();
305     if (af.getViewport().getSelectionGroup() != null)
306     {
307       size = af.getViewport().getSelectionGroup().getSize();
308     }
309
310     /*
311      * disable calc options for which there is insufficient input data
312      * return value of true means enabled and selected
313      */
314     boolean checkPca = checkEnabled(pca, size, MIN_PCA_SELECTION);
315     boolean checkNeighbourJoining = checkEnabled(neighbourJoining, size,
316             MIN_TREE_SELECTION);
317     boolean checkAverageDistance = checkEnabled(averageDistance, size,
318             MIN_TREE_SELECTION);
319
320     if (checkPca || checkNeighbourJoining || checkAverageDistance)
321     {
322       calculate.setToolTipText(null);
323       calculate.setEnabled(true);
324     }
325     else
326     {
327       calculate.setEnabled(false);
328     }
329     updateScoreModels(modelNames, tips);
330   }
331
332   /**
333    * Check the input and disable a calculation's radio button if necessary. A
334    * tooltip is shown for disabled calculations.
335    * 
336    * @param calc
337    *          - radio button for the calculation being validated
338    * @param size
339    *          - size of input to calculation
340    * @param minsize
341    *          - minimum size for calculation
342    * @return true if size >= minsize and calc.isSelected
343    */
344   private boolean checkEnabled(JRadioButton calc, int size, int minsize)
345   {
346     String ttip = MessageManager
347             .formatMessage("label.you_need_at_least_n_sequences", minsize);
348
349     calc.setEnabled(size >= minsize);
350     if (!calc.isEnabled())
351     {
352       calc.setToolTipText(ttip);
353     }
354     else
355     {
356       calc.setToolTipText(null);
357     }
358     if (calc.isSelected())
359     {
360       modelNames.setEnabled(calc.isEnabled());
361       if (calc.isEnabled())
362       {
363         return true;
364       }
365       else
366       {
367         calculate.setToolTipText(ttip);
368       }
369     }
370     return false;
371   }
372
373   /**
374    * A rather elaborate helper method (blame Swing, not me) that builds a
375    * drop-down list of score models (by name) with descriptions as tooltips.
376    * There is also a tooltip shown for the currently selected item when hovering
377    * over it (without opening the list).
378    */
379   protected JComboBox<String> buildModelOptionsList()
380   {
381     final JComboBox<String> scoreModelsCombo = new JComboBox<>();
382     scoreModelsCombo.setRenderer(renderer);
383
384     /*
385      * show tooltip on mouse over the combobox
386      * note the listener has to be on the components that make up
387      * the combobox, doesn't work if just on the combobox
388      */
389     final MouseAdapter mouseListener = new MouseAdapter()
390     {
391       @Override
392       public void mouseEntered(MouseEvent e)
393       {
394         scoreModelsCombo.setToolTipText(
395                 tips.get(scoreModelsCombo.getSelectedIndex()));
396       }
397
398       @Override
399       public void mouseExited(MouseEvent e)
400       {
401         scoreModelsCombo.setToolTipText(null);
402       }
403     };
404     for (Component c : scoreModelsCombo.getComponents())
405     {
406       c.addMouseListener(mouseListener);
407     }
408
409     updateScoreModels(scoreModelsCombo, tips);
410
411     /*
412      * set the list of tooltips on the combobox's renderer
413      */
414     renderer.setTooltips(tips);
415
416     return scoreModelsCombo;
417   }
418
419   private void updateScoreModels(JComboBox<String> comboBox,
420           List<String> toolTips)
421   {
422     Object curSel = comboBox.getSelectedItem();
423     toolTips.clear();
424     DefaultComboBoxModel<String> model = new DefaultComboBoxModel<>();
425
426     /*
427      * select the score models applicable to the alignment type
428      */
429     boolean nucleotide = af.getViewport().getAlignment().isNucleotide();
430     List<ScoreModelI> models = getApplicableScoreModels(nucleotide,
431             pca.isSelected());
432
433     /*
434      * now we can actually add entries to the combobox,
435      * remembering their descriptions for tooltips
436      */
437     boolean selectedIsPresent = false;
438     for (ScoreModelI sm : models)
439     {
440       if (curSel != null && sm.getName().equals(curSel))
441       {
442         selectedIsPresent = true;
443         curSel = sm.getName();
444       }
445       model.addElement(sm.getName());
446
447       /*
448        * tooltip is description if provided, else text lookup with
449        * fallback on the model name
450        */
451       String tooltip = sm.getDescription();
452       if (tooltip == null)
453       {
454         tooltip = MessageManager.getStringOrReturn("label.score_model_",
455                 sm.getName());
456       }
457       toolTips.add(tooltip);
458     }
459
460     if (selectedIsPresent)
461     {
462       model.setSelectedItem(curSel);
463     }
464     // finally, update the model
465     comboBox.setModel(model);
466   }
467
468   /**
469    * Builds a list of score models which are applicable for the alignment and
470    * calculation type (peptide or generic models for protein, nucleotide or
471    * generic models for nucleotide).
472    * <p>
473    * As a special case, includes BLOSUM62 as an extra option for nucleotide PCA.
474    * This is for backwards compatibility with Jalview prior to 2.8 when BLOSUM62
475    * was the only score matrix supported. This is included if property
476    * BLOSUM62_PCA_FOR_NUCLEOTIDE is set to true in the Jalview properties file.
477    * 
478    * @param nucleotide
479    * @param forPca
480    * @return
481    */
482   protected static List<ScoreModelI> getApplicableScoreModels(
483           boolean nucleotide, boolean forPca)
484   {
485     List<ScoreModelI> filtered = new ArrayList<>();
486
487     ScoreModels scoreModels = ScoreModels.getInstance();
488     for (ScoreModelI sm : scoreModels.getModels())
489     {
490       if (!nucleotide && sm.isProtein() || nucleotide && sm.isDNA())
491       {
492         filtered.add(sm);
493       }
494     }
495
496     /*
497      * special case: add BLOSUM62 as last option for nucleotide PCA, 
498      * for backwards compatibility with Jalview < 2.8 (JAL-2962)
499      */
500     if (nucleotide && forPca
501             && Cache.getDefault("BLOSUM62_PCA_FOR_NUCLEOTIDE", false))
502     {
503       filtered.add(scoreModels.getBlosum62());
504     }
505
506     return filtered;
507   }
508
509   /**
510    * Open and calculate the selected tree or PCA on 'OK'
511    */
512   protected void calculate_actionPerformed()
513   {
514     boolean doPCA = pca.isSelected();
515     String modelName = modelNames.getSelectedItem().toString();
516     SimilarityParamsI params = getSimilarityParameters(doPCA);
517
518     if (doPCA)
519     {
520       openPcaPanel(modelName, params);
521     }
522     else
523     {
524       openTreePanel(modelName, params);
525     }
526
527     // closeFrame();
528   }
529
530   /**
531    * Open a new Tree panel on the desktop
532    * 
533    * @param modelName
534    * @param params
535    */
536   protected void openTreePanel(String modelName, SimilarityParamsI params)
537   {
538     /*
539      * gui validation shouldn't allow insufficient sequences here, but leave
540      * this check in in case this method gets exposed programmatically in future
541      */
542     AlignViewportI viewport = af.getViewport();
543     SequenceGroup sg = viewport.getSelectionGroup();
544     if (sg != null && sg.getSize() < MIN_TREE_SELECTION)
545     {
546       JvOptionPane.showMessageDialog(Desktop.desktop,
547               MessageManager.formatMessage(
548                       "label.you_need_at_least_n_sequences",
549                       MIN_TREE_SELECTION),
550               MessageManager.getString("label.not_enough_sequences"),
551               JvOptionPane.WARNING_MESSAGE);
552       return;
553     }
554
555     String treeType = neighbourJoining.isSelected()
556             ? TreeBuilder.NEIGHBOUR_JOINING
557             : TreeBuilder.AVERAGE_DISTANCE;
558     af.newTreePanel(treeType, modelName, params);
559   }
560
561   /**
562    * Open a new PCA panel on the desktop
563    * 
564    * @param modelName
565    * @param params
566    */
567   protected void openPcaPanel(String modelName, SimilarityParamsI params)
568   {
569     AlignViewportI viewport = af.getViewport();
570
571     /*
572      * gui validation shouldn't allow insufficient sequences here, but leave
573      * this check in in case this method gets exposed programmatically in future
574      */
575     if (((viewport.getSelectionGroup() != null)
576             && (viewport.getSelectionGroup().getSize() < MIN_PCA_SELECTION)
577             && (viewport.getSelectionGroup().getSize() > 0))
578             || (viewport.getAlignment().getHeight() < MIN_PCA_SELECTION))
579     {
580       JvOptionPane.showInternalMessageDialog(this,
581               MessageManager.formatMessage(
582                       "label.you_need_at_least_n_sequences",
583                       MIN_PCA_SELECTION),
584               MessageManager
585                       .getString("label.sequence_selection_insufficient"),
586               JvOptionPane.WARNING_MESSAGE);
587       return;
588     }
589
590     /*
591      * construct the panel and kick off its calculation thread
592      */
593     pcaPanel = new PCAPanel(af.alignPanel, modelName, params);
594     new Thread(pcaPanel).start();
595
596   }
597
598   /**
599    * 
600    */
601   protected void closeFrame()
602   {
603     try
604     {
605       frame.setClosed(true);
606     } catch (PropertyVetoException ex)
607     {
608     }
609   }
610
611   /**
612    * Returns a data bean holding parameters for similarity (or distance) model
613    * calculation
614    * 
615    * @param doPCA
616    * @return
617    */
618   protected SimilarityParamsI getSimilarityParameters(boolean doPCA)
619   {
620     // commented out: parameter choices read from gui widgets
621     // SimilarityParamsI params = new SimilarityParams(
622     // includeGappedColumns.isSelected(), matchGaps.isSelected(),
623     // includeGaps.isSelected(), shorterSequence.isSelected());
624
625     boolean includeGapGap = true;
626     boolean includeGapResidue = true;
627     boolean matchOnShortestLength = false;
628
629     /*
630      * 'matchGaps' flag is only used in the PID calculation
631      * - set to false for PCA so that PCA using PID reproduces SeqSpace PCA
632      * - set to true for Tree to reproduce Jalview 2.10.1 calculation
633      * - set to false for Tree for a more correct calculation (JAL-374)
634      */
635     boolean matchGap = doPCA ? false : treeMatchGaps;
636
637     return new SimilarityParams(includeGapGap, matchGap, includeGapResidue,
638             matchOnShortestLength);
639   }
640
641   /**
642    * Closes dialog on Close button press
643    */
644   protected void close_actionPerformed()
645   {
646     try
647     {
648       frame.setClosed(true);
649     } catch (Exception ex)
650     {
651     }
652   }
653
654   public PCAPanel getPcaPanel()
655   {
656     return pcaPanel;
657   }
658 }