JAL-1645 Version-Rel Version 2.9 Year-Rel 2015 Licensing glob
[jalview.git] / src / jalview / gui / TreePanel.java
index d179355..c0b0c68 100755 (executable)
@@ -1,38 +1,66 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4)
- * Copyright (C) 2008 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9)
+ * Copyright (C) 2015 The Jalview Authors
  * 
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
+ * This file is part of Jalview.
  * 
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
  * 
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 package jalview.gui;
 
-import java.beans.*;
-import java.io.*;
-import java.util.*;
-import javax.imageio.*;
-
-import java.awt.*;
-import java.awt.event.*;
-import java.awt.image.*;
-import javax.swing.*;
-
-import org.jibble.epsgraphics.*;
-import jalview.analysis.*;
-import jalview.datamodel.*;
-import jalview.io.*;
-import jalview.jbgui.*;
+import jalview.analysis.AlignmentSorter;
+import jalview.analysis.NJTree;
+import jalview.api.analysis.ScoreModelI;
+import jalview.api.analysis.ViewBasedAnalysisI;
+import jalview.bin.Cache;
+import jalview.commands.CommandI;
+import jalview.commands.OrderCommand;
+import jalview.datamodel.Alignment;
+import jalview.datamodel.AlignmentI;
+import jalview.datamodel.AlignmentView;
+import jalview.datamodel.BinaryNode;
+import jalview.datamodel.ColumnSelection;
+import jalview.datamodel.DBRefEntry;
+import jalview.datamodel.NodeTransformI;
+import jalview.datamodel.SequenceFeature;
+import jalview.datamodel.SequenceI;
+import jalview.datamodel.SequenceNode;
+import jalview.io.JalviewFileChooser;
+import jalview.io.JalviewFileView;
+import jalview.io.NewickFile;
+import jalview.jbgui.GTreePanel;
+import jalview.schemes.ResidueProperties;
+import jalview.util.MessageManager;
+import jalview.viewmodel.AlignmentViewport;
+
+import java.awt.Font;
+import java.awt.Graphics;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.awt.image.BufferedImage;
+import java.beans.PropertyChangeEvent;
+import java.io.FileOutputStream;
+import java.util.ArrayList;
+import java.util.List;
+
+import javax.imageio.ImageIO;
+import javax.swing.ButtonGroup;
+import javax.swing.JMenuItem;
+import javax.swing.JRadioButtonMenuItem;
+
+import org.jibble.epsgraphics.EpsGraphics2D;
 
 /**
  * DOCUMENT ME!
@@ -56,17 +84,17 @@ public class TreePanel extends GTreePanel
    * Creates a new TreePanel object.
    * 
    * @param av
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    * @param seqVector
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    * @param type
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    * @param pwtype
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    * @param s
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    * @param e
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    */
   public TreePanel(AlignmentPanel ap, String type, String pwtype)
   {
@@ -82,15 +110,15 @@ public class TreePanel extends GTreePanel
    * Creates a new TreePanel object.
    * 
    * @param av
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    * @param seqVector
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    * @param newtree
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    * @param type
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    * @param pwtype
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    */
   public TreePanel(AlignmentPanel ap, String type, String pwtype,
           NewickFile newtree)
@@ -111,7 +139,7 @@ public class TreePanel extends GTreePanel
     return treeCanvas.av.getAlignment();
   }
 
-  public AlignViewport getViewPort()
+  public AlignmentViewport getViewPort()
   {
     return treeCanvas.av;
   }
@@ -140,6 +168,10 @@ public class TreePanel extends GTreePanel
           if (tree == null)
           {
             System.out.println("tree is null");
+            // TODO: deal with case when a change event is received whilst a
+            // tree is still being calculated - should save reference for
+            // processing message later.
+            return;
           }
           if (evt.getNewValue() == null)
           {
@@ -147,9 +179,9 @@ public class TreePanel extends GTreePanel
                     .println("new alignment sequences vector value is null");
           }
 
-          tree.UpdatePlaceHolders((Vector) evt.getNewValue());
+          tree.UpdatePlaceHolders((List<SequenceI>) evt.getNewValue());
           treeCanvas.nameHash.clear(); // reset the mapping between canvas
-                                        // rectangles and leafnodes
+          // rectangles and leafnodes
           repaint();
         }
       }
@@ -211,7 +243,8 @@ public class TreePanel extends GTreePanel
       associateLeavesMenu.add(item);
     }
 
-    final JRadioButtonMenuItem itemf = new JRadioButtonMenuItem("All Views");
+    final JRadioButtonMenuItem itemf = new JRadioButtonMenuItem(
+            MessageManager.getString("label.all_views"));
     buttonGroup.add(itemf);
     itemf.setSelected(treeCanvas.applyToAllViews);
     itemf.addActionListener(new ActionListener()
@@ -250,11 +283,11 @@ public class TreePanel extends GTreePanel
       {
         if (odata == null)
         {
-          tree = new NJTree(av.alignment.getSequencesArray(), newtree);
+          tree = new NJTree(av.getAlignment().getSequencesArray(), newtree);
         }
         else
         {
-          tree = new NJTree(av.alignment.getSequencesArray(), odata,
+          tree = new NJTree(av.getAlignment().getSequencesArray(), odata,
                   newtree);
         }
         if (!tree.hasOriginalSequenceData())
@@ -266,22 +299,42 @@ public class TreePanel extends GTreePanel
       {
         int start, end;
         SequenceI[] seqs;
-        AlignmentView seqStrings = av.getAlignmentView(av
-                .getSelectionGroup() != null);
-        if (av.getSelectionGroup() == null)
+        boolean selview = av.getSelectionGroup() != null
+                && av.getSelectionGroup().getSize() > 1;
+        AlignmentView seqStrings = av.getAlignmentView(selview);
+        if (!selview)
         {
           start = 0;
-          end = av.alignment.getWidth();
-          seqs = av.alignment.getSequencesArray();
+          end = av.getAlignment().getWidth();
+          seqs = av.getAlignment().getSequencesArray();
         }
         else
         {
           start = av.getSelectionGroup().getStartRes();
           end = av.getSelectionGroup().getEndRes() + 1;
-          seqs = av.getSelectionGroup().getSequencesInOrder(av.alignment);
+          seqs = av.getSelectionGroup().getSequencesInOrder(
+                  av.getAlignment());
+        }
+        ScoreModelI sm = ResidueProperties.getScoreModel(pwtype);
+        if (sm instanceof ViewBasedAnalysisI)
+        {
+          try
+          {
+            sm = sm.getClass().newInstance();
+            ((ViewBasedAnalysisI) sm)
+                    .configureFromAlignmentView(treeCanvas.ap);
+          } catch (Exception q)
+          {
+            Cache.log.error("Couldn't create a scoremodel instance for "
+                    + sm.getName());
+          }
+          tree = new NJTree(seqs, seqStrings, type, pwtype, sm, start, end);
+        }
+        else
+        {
+          tree = new NJTree(seqs, seqStrings, type, pwtype, null, start,
+                  end);
         }
-
-        tree = new NJTree(seqs, seqStrings, type, pwtype, start, end);
         showDistances(true);
       }
 
@@ -290,7 +343,10 @@ public class TreePanel extends GTreePanel
       treeCanvas.setTree(tree);
       treeCanvas.repaint();
       av.setCurrentTree(tree);
-
+      if (av.getSortByTree())
+      {
+        sortByTree_actionPerformed();
+      }
     }
   }
 
@@ -331,7 +387,7 @@ public class TreePanel extends GTreePanel
    * DOCUMENT ME!
    * 
    * @param e
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    */
   public void textbox_actionPerformed(ActionEvent e)
   {
@@ -357,27 +413,35 @@ public class TreePanel extends GTreePanel
       buffer.append("PID");
     }
 
-    Desktop.addInternalFrame(cap, buffer.toString(), 500, 100);
+    jalview.io.NewickFile fout = new jalview.io.NewickFile(
+            tree.getTopNode());
+    try
+    {
+      cap.setText(fout.print(tree.isHasBootstrap(), tree.isHasDistances(),
+              tree.isHasRootDistance()));
+      Desktop.addInternalFrame(cap, buffer.toString(), 500, 100);
+    } catch (OutOfMemoryError oom)
+    {
+      new OOMWarning("generating newick tree file", oom);
+      cap.dispose();
+    }
 
-    jalview.io.NewickFile fout = new jalview.io.NewickFile(tree
-            .getTopNode());
-    cap.setText(fout.print(tree.isHasBootstrap(), tree.isHasDistances(),
-            tree.isHasRootDistance()));
   }
 
   /**
    * DOCUMENT ME!
    * 
    * @param e
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    */
   public void saveAsNewick_actionPerformed(ActionEvent e)
   {
-    JalviewFileChooser chooser = new JalviewFileChooser(jalview.bin.Cache
-            .getProperty("LAST_DIRECTORY"));
+    JalviewFileChooser chooser = new JalviewFileChooser(
+            jalview.bin.Cache.getProperty("LAST_DIRECTORY"));
     chooser.setFileView(new JalviewFileView());
-    chooser.setDialogTitle("Save tree as newick file");
-    chooser.setToolTipText("Save");
+    chooser.setDialogTitle(MessageManager
+            .getString("label.save_tree_as_newick"));
+    chooser.setToolTipText(MessageManager.getString("action.save"));
 
     int value = chooser.showSaveDialog(null);
 
@@ -389,10 +453,10 @@ public class TreePanel extends GTreePanel
 
       try
       {
-        jalview.io.NewickFile fout = new jalview.io.NewickFile(tree
-                .getTopNode());
-        String output = fout.print(tree.isHasBootstrap(), tree
-                .isHasDistances(), tree.isHasRootDistance());
+        jalview.io.NewickFile fout = new jalview.io.NewickFile(
+                tree.getTopNode());
+        String output = fout.print(tree.isHasBootstrap(),
+                tree.isHasDistances(), tree.isHasRootDistance());
         java.io.PrintWriter out = new java.io.PrintWriter(
                 new java.io.FileWriter(choice));
         out.println(output);
@@ -408,7 +472,7 @@ public class TreePanel extends GTreePanel
    * DOCUMENT ME!
    * 
    * @param e
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    */
   public void printMenu_actionPerformed(ActionEvent e)
   {
@@ -469,8 +533,10 @@ public class TreePanel extends GTreePanel
         // af.addSortByOrderMenuItem(ServiceName + " Ordering",
         // msaorder);
 
-        Desktop.addInternalFrame(af, "Original Data for " + this.title,
-                AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
+        Desktop.addInternalFrame(af, MessageManager.formatMessage(
+                "label.original_data_for_params",
+                new Object[] { this.title }), AlignFrame.DEFAULT_WIDTH,
+                AlignFrame.DEFAULT_HEIGHT);
       }
     }
   }
@@ -479,7 +545,7 @@ public class TreePanel extends GTreePanel
    * DOCUMENT ME!
    * 
    * @param e
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    */
   public void fitToWindow_actionPerformed(ActionEvent e)
   {
@@ -488,10 +554,88 @@ public class TreePanel extends GTreePanel
   }
 
   /**
+   * sort the associated alignment view by the current tree.
+   * 
+   * @param e
+   */
+  @Override
+  public void sortByTree_actionPerformed()
+  {
+
+    if (treeCanvas.applyToAllViews)
+    {
+      final ArrayList<CommandI> commands = new ArrayList<CommandI>();
+      for (AlignmentPanel ap : PaintRefresher.getAssociatedPanels(av
+              .getSequenceSetId()))
+      {
+        commands.add(sortAlignmentIn(ap.av.getAlignPanel()));
+      }
+      av.getAlignPanel().alignFrame.addHistoryItem(new CommandI()
+      {
+
+        @Override
+        public void undoCommand(AlignmentI[] views)
+        {
+          for (CommandI tsort : commands)
+          {
+            tsort.undoCommand(views);
+          }
+        }
+
+        @Override
+        public int getSize()
+        {
+          return commands.size();
+        }
+
+        @Override
+        public String getDescription()
+        {
+          return "Tree Sort (many views)";
+        }
+
+        @Override
+        public void doCommand(AlignmentI[] views)
+        {
+
+          for (CommandI tsort : commands)
+          {
+            tsort.doCommand(views);
+          }
+        }
+      });
+      for (AlignmentPanel ap : PaintRefresher.getAssociatedPanels(av
+              .getSequenceSetId()))
+      {
+        // ensure all the alignFrames refresh their GI after adding an undo item
+        ap.alignFrame.updateEditMenuBar();
+      }
+    }
+    else
+    {
+      treeCanvas.ap.alignFrame
+              .addHistoryItem(sortAlignmentIn(treeCanvas.ap));
+    }
+
+  }
+
+  public CommandI sortAlignmentIn(AlignmentPanel ap)
+  {
+    AlignmentViewport av = ap.av;
+    SequenceI[] oldOrder = av.getAlignment().getSequencesArray();
+    AlignmentSorter.sortByTree(av.getAlignment(), tree);
+    CommandI undo;
+    undo = new OrderCommand("Tree Sort", oldOrder, av.getAlignment());
+
+    ap.paintAlignment(true);
+    return undo;
+  }
+
+  /**
    * DOCUMENT ME!
    * 
    * @param e
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    */
   public void font_actionPerformed(ActionEvent e)
   {
@@ -520,7 +664,7 @@ public class TreePanel extends GTreePanel
    * DOCUMENT ME!
    * 
    * @param e
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    */
   public void distanceMenu_actionPerformed(ActionEvent e)
   {
@@ -531,7 +675,7 @@ public class TreePanel extends GTreePanel
    * DOCUMENT ME!
    * 
    * @param e
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    */
   public void bootstrapMenu_actionPerformed(ActionEvent e)
   {
@@ -542,7 +686,7 @@ public class TreePanel extends GTreePanel
    * DOCUMENT ME!
    * 
    * @param e
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    */
   public void placeholdersMenu_actionPerformed(ActionEvent e)
   {
@@ -553,7 +697,7 @@ public class TreePanel extends GTreePanel
    * DOCUMENT ME!
    * 
    * @param e
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    */
   public void epsTree_actionPerformed(ActionEvent e)
   {
@@ -590,11 +734,12 @@ public class TreePanel extends GTreePanel
     {
       jalview.io.JalviewFileChooser chooser = new jalview.io.JalviewFileChooser(
               jalview.bin.Cache.getProperty("LAST_DIRECTORY"), new String[]
-              { "eps" }, new String[]
-              { "Encapsulated Postscript" }, "Encapsulated Postscript");
+              { "eps" }, new String[] { "Encapsulated Postscript" },
+              "Encapsulated Postscript");
       chooser.setFileView(new jalview.io.JalviewFileView());
-      chooser.setDialogTitle("Create EPS file from tree");
-      chooser.setToolTipText("Save");
+      chooser.setDialogTitle(MessageManager
+              .getString("label.create_eps_from_tree"));
+      chooser.setToolTipText(MessageManager.getString("action.save"));
 
       int value = chooser.showSaveDialog(this);
 
@@ -625,7 +770,7 @@ public class TreePanel extends GTreePanel
    * DOCUMENT ME!
    * 
    * @param e
-   *                DOCUMENT ME!
+   *          DOCUMENT ME!
    */
   public void pngTree_actionPerformed(ActionEvent e)
   {
@@ -636,12 +781,13 @@ public class TreePanel extends GTreePanel
     {
       jalview.io.JalviewFileChooser chooser = new jalview.io.JalviewFileChooser(
               jalview.bin.Cache.getProperty("LAST_DIRECTORY"), new String[]
-              { "png" }, new String[]
-              { "Portable network graphics" }, "Portable network graphics");
+              { "png" }, new String[] { "Portable network graphics" },
+              "Portable network graphics");
 
       chooser.setFileView(new jalview.io.JalviewFileView());
-      chooser.setDialogTitle("Create PNG image from tree");
-      chooser.setToolTipText("Save");
+      chooser.setDialogTitle(MessageManager
+              .getString("label.create_png_from_tree"));
+      chooser.setToolTipText(MessageManager.getString("action.save"));
 
       int value = chooser.showSaveDialog(this);
 
@@ -668,4 +814,75 @@ public class TreePanel extends GTreePanel
       ex.printStackTrace();
     }
   }
+
+  /**
+   * change node labels to the annotation referred to by labelClass TODO:
+   * promote to a datamodel modification that can be undone TODO: make argument
+   * one case of a generic transformation function ie { undoStep = apply(Tree,
+   * TransformFunction)};
+   * 
+   * @param labelClass
+   */
+  public void changeNames(final String labelClass)
+  {
+    tree.applyToNodes(new NodeTransformI()
+    {
+
+      public void transform(BinaryNode node)
+      {
+        if (node instanceof SequenceNode
+                && !((SequenceNode) node).isPlaceholder()
+                && !((SequenceNode) node).isDummy())
+        {
+          String newname = null;
+          SequenceI sq = (SequenceI) ((SequenceNode) node).element();
+          if (sq != null)
+          {
+            // search dbrefs, features and annotation
+            DBRefEntry[] refs = jalview.util.DBRefUtils.selectRefs(
+                    sq.getDBRef(),
+                    new String[] { labelClass.toUpperCase() });
+            if (refs != null)
+            {
+              for (int i = 0; i < refs.length; i++)
+              {
+                if (newname == null)
+                {
+                  newname = new String(refs[i].getAccessionId());
+                }
+                else
+                {
+                  newname = newname + "; " + refs[i].getAccessionId();
+                }
+              }
+            }
+            if (newname == null)
+            {
+              SequenceFeature sf[] = sq.getSequenceFeatures();
+              for (int i = 0; sf != null && i < sf.length; i++)
+              {
+                if (sf[i].getType().equals(labelClass))
+                {
+                  if (newname == null)
+                  {
+                    newname = new String(sf[i].getDescription());
+                  }
+                  else
+                  {
+                    newname = newname + "; " + sf[i].getDescription();
+                  }
+                }
+              }
+            }
+          }
+          if (newname != null)
+          {
+            String oldname = ((SequenceNode) node).getName();
+            // TODO : save in the undo object for this modification.
+            ((SequenceNode) node).setName(newname);
+          }
+        }
+      }
+    });
+  }
 }