67ac83621e9fa783224b6adeab1e2fad09e45938
[jalview.git] / src / jalview / gui / TreePanel.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.AlignmentSorter;
24 import jalview.analysis.TreeModel;
25 import jalview.bin.Cache;
26 import jalview.commands.CommandI;
27 import jalview.commands.OrderCommand;
28 import jalview.datamodel.Alignment;
29 import jalview.datamodel.AlignmentI;
30 import jalview.datamodel.AlignmentView;
31 import jalview.datamodel.BinaryNode;
32 import jalview.datamodel.DBRefEntry;
33 import jalview.datamodel.HiddenColumns;
34 import jalview.datamodel.NodeTransformI;
35 import jalview.datamodel.SequenceFeature;
36 import jalview.datamodel.SequenceI;
37 import jalview.datamodel.SequenceNode;
38 import jalview.ext.archaeopteryx.ArchaeopteryxNewickInit;
39 import jalview.io.JalviewFileChooser;
40 import jalview.io.JalviewFileView;
41 import jalview.io.NewickFile;
42 import jalview.jbgui.GTreePanel;
43 import jalview.util.ImageMaker;
44 import jalview.util.MessageManager;
45 import jalview.viewmodel.AlignmentViewport;
46
47 import java.awt.Font;
48 import java.awt.Graphics;
49 import java.awt.event.ActionEvent;
50 import java.awt.event.ActionListener;
51 import java.awt.image.BufferedImage;
52 import java.beans.PropertyChangeEvent;
53 import java.io.FileOutputStream;
54 import java.util.ArrayList;
55 import java.util.List;
56
57 import javax.imageio.ImageIO;
58 import javax.swing.ButtonGroup;
59 import javax.swing.JMenuItem;
60 import javax.swing.JRadioButtonMenuItem;
61
62 import org.jibble.epsgraphics.EpsGraphics2D;
63
64 /**
65  * DOCUMENT ME!
66  * 
67  * @author $author$
68  * @version $Revision$
69  */
70 public class TreePanel extends GTreePanel
71 {
72   String substitutionMatrix;
73
74   String treeType;
75
76   String treeTitle; // if tree loaded
77
78   TreeCanvas treeCanvas;
79
80   TreeModel tree;
81
82   AlignViewport av;
83
84   /**
85    * Creates a new TreePanel object.
86    * 
87    * @param ap
88    * @param tree
89    */
90   public TreePanel(AlignmentPanel ap, TreeModel tree, String treeType,
91           String substitutionMatrix)
92   {
93     super();
94     this.treeType = treeType;
95     this.substitutionMatrix = substitutionMatrix;
96     this.tree = tree;
97     initNewTreePanel(ap, tree);
98
99     // We know this tree has distances. JBPNote TODO: prolly should add this as
100     // a userdefined default
101     // showDistances(true);
102   }
103
104   /**
105    * Creates a new TreePanel object.
106    * 
107    * @param alignPanel
108    * @param newtree
109    * @param theTitle
110    * @param inputData
111    * @param viewport
112    */
113   public TreePanel(AlignmentPanel alignPanel, NewickFile newtree,
114           String theTitle, AlignmentView inputData)
115   {
116     super();
117     this.treeTitle = theTitle;
118     initLoadedTreePanel(alignPanel, newtree, inputData);
119   }
120
121   public AlignmentI getAlignment()
122   {
123     return treeCanvas.av.getAlignment();
124   }
125
126   public AlignmentViewport getViewPort()
127   {
128     return treeCanvas.av;
129   }
130
131   void initNewTreePanel(AlignmentPanel ap, TreeModel tree)
132   {
133     buildTreeCanvas(ap);
134
135     TreeLoader tl = new TreeLoader(null, null);
136     tl.start();
137
138   }
139   void initLoadedTreePanel(AlignmentPanel ap, 
140           NewickFile newTree, AlignmentView inputData)
141   {
142     buildTreeCanvas(ap);
143
144     TreeLoader tl = new TreeLoader(newTree, inputData);
145     tl.start();
146   }
147
148 public void buildTreeCanvas(AlignmentPanel ap) { 
149      av = ap.av;
150
151     treeCanvas = new TreeCanvas(this, ap, scrollPane);
152     scrollPane.setViewportView(treeCanvas);
153
154
155     PaintRefresher.Register(this, ap.av.getSequenceSetId());
156
157     buildAssociatedViewMenu();
158
159     av.addPropertyChangeListener(new java.beans.PropertyChangeListener()
160     {
161       @Override
162       public void propertyChange(PropertyChangeEvent evt)
163       {
164         if (evt.getPropertyName().equals("alignment"))
165         {
166           if (tree == null)
167           {
168             System.out.println("tree is null");
169             // TODO: deal with case when a change event is received whilst a
170             // tree is still being calculated - should save reference for
171             // processing message later.
172             return;
173           }
174           if (evt.getNewValue() == null)
175           {
176             System.out.println(
177                     "new alignment sequences vector value is null");
178           }
179
180           tree.updatePlaceHolders((List<SequenceI>) evt.getNewValue());
181           treeCanvas.nameHash.clear(); // reset the mapping between canvas
182           // rectangles and leafnodes
183           repaint();
184         }
185       }
186     });
187
188
189   
190
191   }
192
193   @Override
194   public void viewMenu_menuSelected()
195   {
196     buildAssociatedViewMenu();
197   }
198
199   void buildAssociatedViewMenu()
200   {
201     AlignmentPanel[] aps = PaintRefresher
202             .getAssociatedPanels(av.getSequenceSetId());
203     if (aps.length == 1 && treeCanvas.ap == aps[0])
204     {
205       associateLeavesMenu.setVisible(false);
206       return;
207     }
208
209     associateLeavesMenu.setVisible(true);
210
211     if ((viewMenu
212             .getItem(viewMenu.getItemCount() - 2) instanceof JMenuItem))
213     {
214       viewMenu.insertSeparator(viewMenu.getItemCount() - 1);
215     }
216
217     associateLeavesMenu.removeAll();
218
219     JRadioButtonMenuItem item;
220     ButtonGroup buttonGroup = new ButtonGroup();
221     int i, iSize = aps.length;
222     final TreePanel thisTreePanel = this;
223     for (i = 0; i < iSize; i++)
224     {
225       final AlignmentPanel ap = aps[i];
226       item = new JRadioButtonMenuItem(ap.av.viewName, ap == treeCanvas.ap);
227       buttonGroup.add(item);
228       item.addActionListener(new ActionListener()
229       {
230         @Override
231         public void actionPerformed(ActionEvent evt)
232         {
233           treeCanvas.applyToAllViews = false;
234           treeCanvas.ap = ap;
235           treeCanvas.av = ap.av;
236           PaintRefresher.Register(thisTreePanel, ap.av.getSequenceSetId());
237         }
238       });
239
240       associateLeavesMenu.add(item);
241     }
242
243     final JRadioButtonMenuItem itemf = new JRadioButtonMenuItem(
244             MessageManager.getString("label.all_views"));
245     buttonGroup.add(itemf);
246     itemf.setSelected(treeCanvas.applyToAllViews);
247     itemf.addActionListener(new ActionListener()
248     {
249       @Override
250       public void actionPerformed(ActionEvent evt)
251       {
252         treeCanvas.applyToAllViews = itemf.isSelected();
253       }
254     });
255     associateLeavesMenu.add(itemf);
256
257   }
258
259   class TreeLoader extends Thread
260   {
261     private NewickFile newTree;
262
263     private AlignmentView odata = null;
264
265     public TreeLoader(NewickFile newickFile, AlignmentView inputData)
266     {
267       this.newTree = newickFile;
268       this.odata = inputData;
269
270       if (newTree != null)
271       {
272         // Must be outside run(), as Jalview2XML tries to
273         // update distance/bootstrap visibility at the same time
274         showBootstrap(newTree.hasBootstrap());
275         showDistances(newTree.hasDistances());
276
277       }
278
279     }
280
281     @Override
282     public void run()
283     {
284
285       if (newTree != null)
286       {
287         tree = new TreeModel(av.getAlignment().getSequencesArray(), odata,
288                 newTree);
289         if (tree.getOriginalData() == null)
290         {
291           originalSeqData.setVisible(false);
292         }
293
294
295
296       }
297       showTree(tree);
298
299     }
300       
301     public void showTree(TreeModel tree)
302     {
303       tree.reCount(tree.getTopNode());
304       tree.findHeight(tree.getTopNode());
305       treeCanvas.setTree(tree);
306       treeCanvas.repaint();
307
308       av.setCurrentTree(tree);
309       if (av.getSortByTree())
310       {
311         sortByTree_actionPerformed();
312       }
313
314       ArchaeopteryxNewickInit archae = new ArchaeopteryxNewickInit(tree);
315       archae.startArchaeopteryx();
316     }
317   }
318
319   public void showDistances(boolean b)
320   {
321     treeCanvas.setShowDistances(b);
322     distanceMenu.setSelected(b);
323   }
324
325   public void showBootstrap(boolean b)
326   {
327     treeCanvas.setShowBootstrap(b);
328     bootstrapMenu.setSelected(b);
329   }
330
331   public void showPlaceholders(boolean b)
332   {
333     placeholdersMenu.setState(b);
334     treeCanvas.setMarkPlaceholders(b);
335   }
336
337   /**
338    * DOCUMENT ME!
339    * 
340    * @return DOCUMENT ME!
341    */
342   public TreeModel getTree()
343   {
344     return tree;
345   }
346
347   /**
348    * DOCUMENT ME!
349    * 
350    * @param e
351    *          DOCUMENT ME!
352    */
353   @Override
354   public void textbox_actionPerformed(ActionEvent e)
355   {
356     CutAndPasteTransfer cap = new CutAndPasteTransfer();
357
358     String newTitle = getPanelTitle();
359
360     NewickFile fout = new NewickFile(tree.getTopNode());
361     try
362     {
363       cap.setText(fout.print(tree.hasBootstrap(), tree.hasDistances(),
364               tree.hasRootDistance()));
365       Desktop.addInternalFrame(cap, newTitle, 500, 100);
366     } catch (OutOfMemoryError oom)
367     {
368       new OOMWarning("generating newick tree file", oom);
369       cap.dispose();
370     }
371
372   }
373
374   /**
375    * DOCUMENT ME!
376    * 
377    * @param e
378    *          DOCUMENT ME!
379    */
380   @Override
381   public void saveAsNewick_actionPerformed(ActionEvent e)
382   {
383     JalviewFileChooser chooser = new JalviewFileChooser(
384             jalview.bin.Cache.getProperty("LAST_DIRECTORY"));
385     chooser.setFileView(new JalviewFileView());
386     chooser.setDialogTitle(
387             MessageManager.getString("label.save_tree_as_newick"));
388     chooser.setToolTipText(MessageManager.getString("action.save"));
389
390     int value = chooser.showSaveDialog(null);
391
392     if (value == JalviewFileChooser.APPROVE_OPTION)
393     {
394       String choice = chooser.getSelectedFile().getPath();
395       jalview.bin.Cache.setProperty("LAST_DIRECTORY",
396               chooser.getSelectedFile().getParent());
397
398       try
399       {
400         jalview.io.NewickFile fout = new jalview.io.NewickFile(
401                 tree.getTopNode());
402         String output = fout.print(tree.hasBootstrap(), tree.hasDistances(),
403                 tree.hasRootDistance());
404         java.io.PrintWriter out = new java.io.PrintWriter(
405                 new java.io.FileWriter(choice));
406         out.println(output);
407         out.close();
408       } catch (Exception ex)
409       {
410         ex.printStackTrace();
411       }
412     }
413   }
414
415   /**
416    * DOCUMENT ME!
417    * 
418    * @param e
419    *          DOCUMENT ME!
420    */
421   @Override
422   public void printMenu_actionPerformed(ActionEvent e)
423   {
424     // Putting in a thread avoids Swing painting problems
425     treeCanvas.startPrinting();
426   }
427
428   @Override
429   public void originalSeqData_actionPerformed(ActionEvent e)
430   {
431     AlignmentView originalData = tree.getOriginalData();
432     if (originalData == null)
433     {
434       jalview.bin.Cache.log.info(
435               "Unexpected call to originalSeqData_actionPerformed - should have hidden this menu action.");
436       return;
437     }
438     // decide if av alignment is sufficiently different to original data to
439     // warrant a new window to be created
440     // create new alignmnt window with hidden regions (unhiding hidden regions
441     // yields unaligned seqs)
442     // or create a selection box around columns in alignment view
443     // test Alignment(SeqCigar[])
444     char gc = '-';
445     try
446     {
447       // we try to get the associated view's gap character
448       // but this may fail if the view was closed...
449       gc = av.getGapCharacter();
450
451     } catch (Exception ex)
452     {
453     }
454
455     Object[] alAndColsel = originalData.getAlignmentAndHiddenColumns(gc);
456
457     if (alAndColsel != null && alAndColsel[0] != null)
458     {
459       // AlignmentOrder origorder = new AlignmentOrder(alAndColsel[0]);
460
461       AlignmentI al = new Alignment((SequenceI[]) alAndColsel[0]);
462       AlignmentI dataset = (av != null && av.getAlignment() != null)
463               ? av.getAlignment().getDataset()
464               : null;
465       if (dataset != null)
466       {
467         al.setDataset(dataset);
468       }
469
470       if (true)
471       {
472         // make a new frame!
473         AlignFrame af = new AlignFrame(al, (HiddenColumns) alAndColsel[1],
474                 AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
475
476         // >>>This is a fix for the moment, until a better solution is
477         // found!!<<<
478         // af.getFeatureRenderer().transferSettings(alignFrame.getFeatureRenderer());
479
480         // af.addSortByOrderMenuItem(ServiceName + " Ordering",
481         // msaorder);
482
483         Desktop.addInternalFrame(af, MessageManager.formatMessage(
484                 "label.original_data_for_params", new Object[]
485                 { this.title }), AlignFrame.DEFAULT_WIDTH,
486                 AlignFrame.DEFAULT_HEIGHT);
487       }
488     }
489   }
490
491   /**
492    * DOCUMENT ME!
493    * 
494    * @param e
495    *          DOCUMENT ME!
496    */
497   @Override
498   public void fitToWindow_actionPerformed(ActionEvent e)
499   {
500     treeCanvas.fitToWindow = fitToWindow.isSelected();
501     repaint();
502   }
503
504   /**
505    * sort the associated alignment view by the current tree.
506    * 
507    * @param e
508    */
509   @Override
510   public void sortByTree_actionPerformed()
511   {
512
513     if (treeCanvas.applyToAllViews)
514     {
515       final ArrayList<CommandI> commands = new ArrayList<>();
516       for (AlignmentPanel ap : PaintRefresher
517               .getAssociatedPanels(av.getSequenceSetId()))
518       {
519         commands.add(sortAlignmentIn(ap.av.getAlignPanel()));
520       }
521       av.getAlignPanel().alignFrame.addHistoryItem(new CommandI()
522       {
523
524         @Override
525         public void undoCommand(AlignmentI[] views)
526         {
527           for (CommandI tsort : commands)
528           {
529             tsort.undoCommand(views);
530           }
531         }
532
533         @Override
534         public int getSize()
535         {
536           return commands.size();
537         }
538
539         @Override
540         public String getDescription()
541         {
542           return "Tree Sort (many views)";
543         }
544
545         @Override
546         public void doCommand(AlignmentI[] views)
547         {
548
549           for (CommandI tsort : commands)
550           {
551             tsort.doCommand(views);
552           }
553         }
554       });
555       for (AlignmentPanel ap : PaintRefresher
556               .getAssociatedPanels(av.getSequenceSetId()))
557       {
558         // ensure all the alignFrames refresh their GI after adding an undo item
559         ap.alignFrame.updateEditMenuBar();
560       }
561     }
562     else
563     {
564       treeCanvas.ap.alignFrame
565               .addHistoryItem(sortAlignmentIn(treeCanvas.ap));
566     }
567
568   }
569
570   public CommandI sortAlignmentIn(AlignmentPanel ap)
571   {
572     AlignmentViewport viewport = ap.av;
573     SequenceI[] oldOrder = viewport.getAlignment().getSequencesArray();
574     AlignmentSorter.sortByTree(viewport.getAlignment(), tree);
575     CommandI undo;
576     undo = new OrderCommand("Tree Sort", oldOrder, viewport.getAlignment());
577
578     ap.paintAlignment(true);
579     return undo;
580   }
581
582   /**
583    * DOCUMENT ME!
584    * 
585    * @param e
586    *          DOCUMENT ME!
587    */
588   @Override
589   public void font_actionPerformed(ActionEvent e)
590   {
591     if (treeCanvas == null)
592     {
593       return;
594     }
595
596     new FontChooser(this);
597   }
598
599   public Font getTreeFont()
600   {
601     return treeCanvas.font;
602   }
603
604   public void setTreeFont(Font f)
605   {
606     if (treeCanvas != null)
607     {
608       treeCanvas.setFont(f);
609     }
610   }
611
612   /**
613    * DOCUMENT ME!
614    * 
615    * @param e
616    *          DOCUMENT ME!
617    */
618   @Override
619   public void distanceMenu_actionPerformed(ActionEvent e)
620   {
621     treeCanvas.setShowDistances(distanceMenu.isSelected());
622   }
623
624   /**
625    * DOCUMENT ME!
626    * 
627    * @param e
628    *          DOCUMENT ME!
629    */
630   @Override
631   public void bootstrapMenu_actionPerformed(ActionEvent e)
632   {
633     treeCanvas.setShowBootstrap(bootstrapMenu.isSelected());
634   }
635
636   /**
637    * DOCUMENT ME!
638    * 
639    * @param e
640    *          DOCUMENT ME!
641    */
642   @Override
643   public void placeholdersMenu_actionPerformed(ActionEvent e)
644   {
645     treeCanvas.setMarkPlaceholders(placeholdersMenu.isSelected());
646   }
647
648   /**
649    * DOCUMENT ME!
650    * 
651    * @param e
652    *          DOCUMENT ME!
653    */
654   @Override
655   public void epsTree_actionPerformed(ActionEvent e)
656   {
657     boolean accurateText = true;
658
659     String renderStyle = jalview.bin.Cache.getDefault("EPS_RENDERING",
660             "Prompt each time");
661
662     // If we need to prompt, and if the GUI is visible then
663     // Prompt for EPS rendering style
664     if (renderStyle.equalsIgnoreCase("Prompt each time")
665             && !(System.getProperty("java.awt.headless") != null && System
666                     .getProperty("java.awt.headless").equals("true")))
667     {
668       EPSOptions eps = new EPSOptions();
669       renderStyle = eps.getValue();
670
671       if (renderStyle == null || eps.cancelled)
672       {
673         return;
674       }
675
676     }
677
678     if (renderStyle.equalsIgnoreCase("text"))
679     {
680       accurateText = false;
681     }
682
683     int width = treeCanvas.getWidth();
684     int height = treeCanvas.getHeight();
685
686     try
687     {
688       JalviewFileChooser chooser = new JalviewFileChooser(
689               ImageMaker.EPS_EXTENSION, ImageMaker.EPS_EXTENSION);
690       chooser.setFileView(new JalviewFileView());
691       chooser.setDialogTitle(
692               MessageManager.getString("label.create_eps_from_tree"));
693       chooser.setToolTipText(MessageManager.getString("action.save"));
694
695       int value = chooser.showSaveDialog(this);
696
697       if (value != JalviewFileChooser.APPROVE_OPTION)
698       {
699         return;
700       }
701
702       Cache.setProperty("LAST_DIRECTORY",
703               chooser.getSelectedFile().getParent());
704
705       FileOutputStream out = new FileOutputStream(
706               chooser.getSelectedFile());
707       EpsGraphics2D pg = new EpsGraphics2D("Tree", out, 0, 0, width,
708               height);
709
710       pg.setAccurateTextMode(accurateText);
711
712       treeCanvas.draw(pg, width, height);
713
714       pg.flush();
715       pg.close();
716     } catch (Exception ex)
717     {
718       ex.printStackTrace();
719     }
720   }
721
722   /**
723    * DOCUMENT ME!
724    * 
725    * @param e
726    *          DOCUMENT ME!
727    */
728   @Override
729   public void pngTree_actionPerformed(ActionEvent e)
730   {
731     int width = treeCanvas.getWidth();
732     int height = treeCanvas.getHeight();
733
734     try
735     {
736       JalviewFileChooser chooser = new JalviewFileChooser(
737               ImageMaker.PNG_EXTENSION, ImageMaker.PNG_DESCRIPTION);
738
739       chooser.setFileView(new jalview.io.JalviewFileView());
740       chooser.setDialogTitle(
741               MessageManager.getString("label.create_png_from_tree"));
742       chooser.setToolTipText(MessageManager.getString("action.save"));
743
744       int value = chooser.showSaveDialog(this);
745
746       if (value != jalview.io.JalviewFileChooser.APPROVE_OPTION)
747       {
748         return;
749       }
750
751       jalview.bin.Cache.setProperty("LAST_DIRECTORY",
752               chooser.getSelectedFile().getParent());
753
754       FileOutputStream out = new FileOutputStream(
755               chooser.getSelectedFile());
756
757       BufferedImage bi = new BufferedImage(width, height,
758               BufferedImage.TYPE_INT_RGB);
759       Graphics png = bi.getGraphics();
760
761       treeCanvas.draw(png, width, height);
762
763       ImageIO.write(bi, "png", out);
764       out.close();
765     } catch (Exception ex)
766     {
767       ex.printStackTrace();
768     }
769   }
770
771   /**
772    * change node labels to the annotation referred to by labelClass TODO:
773    * promote to a datamodel modification that can be undone TODO: make argument
774    * one case of a generic transformation function ie { undoStep = apply(Tree,
775    * TransformFunction)};
776    * 
777    * @param labelClass
778    */
779   public void changeNames(final String labelClass)
780   {
781     tree.applyToNodes(new NodeTransformI()
782     {
783
784       @Override
785       public void transform(BinaryNode node)
786       {
787         if (node instanceof SequenceNode
788                 && !((SequenceNode) node).isPlaceholder()
789                 && !((SequenceNode) node).isDummy())
790         {
791           String newname = null;
792           SequenceI sq = (SequenceI) ((SequenceNode) node).element();
793           if (sq != null)
794           {
795             // search dbrefs, features and annotation
796             DBRefEntry[] refs = jalview.util.DBRefUtils
797                     .selectRefs(sq.getDBRefs(), new String[]
798                     { labelClass.toUpperCase() });
799             if (refs != null)
800             {
801               for (int i = 0; i < refs.length; i++)
802               {
803                 if (newname == null)
804                 {
805                   newname = new String(refs[i].getAccessionId());
806                 }
807                 else
808                 {
809                   newname = newname + "; " + refs[i].getAccessionId();
810                 }
811               }
812             }
813             if (newname == null)
814             {
815               List<SequenceFeature> features = sq.getFeatures()
816                       .getPositionalFeatures(labelClass);
817               for (SequenceFeature feature : features)
818               {
819                 if (newname == null)
820                 {
821                   newname = feature.getDescription();
822                 }
823                 else
824                 {
825                   newname = newname + "; " + feature.getDescription();
826                 }
827               }
828             }
829           }
830           if (newname != null)
831           {
832             // String oldname = ((SequenceNode) node).getName();
833             // TODO : save oldname in the undo object for this modification.
834             ((SequenceNode) node).setName(newname);
835           }
836         }
837       }
838     });
839   }
840
841   /**
842    * Formats a localised title for the tree panel, like
843    * <p>
844    * Neighbour Joining Using BLOSUM62
845    * <p>
846    * For a tree loaded from file, just uses the file name
847    * 
848    * @return
849    */
850   public String getPanelTitle() // to be moved/fixed
851   {
852     if (treeTitle != null)
853     {
854       return treeTitle;
855     }
856     else
857     {
858       /*
859        * i18n description of Neighbour Joining or Average Distance method
860        */
861       String treecalcnm = MessageManager
862               .getString("label.tree_calc_" + treeType.toLowerCase());
863
864       /*
865        * short score model name (long description can be too long)
866        */
867       String smn = substitutionMatrix;
868
869       /*
870        * put them together as <method> Using <model>
871        */
872       final String ttl = MessageManager
873               .formatMessage("label.treecalc_title", treecalcnm, smn);
874       return ttl;
875     }
876   }
877 }