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