sequences are private in SequenceGroup
[jalview.git] / src / jalview / gui / RedundancyPanel.java
index 3eec476..78d8424 100755 (executable)
+/*\r
+ * Jalview - A Sequence Alignment Editor and Viewer\r
+ * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
+ *\r
+ * This program is free software; you can redistribute it and/or\r
+ * modify it under the terms of the GNU General Public License\r
+ * as published by the Free Software Foundation; either version 2\r
+ * of the License, or (at your option) any later version.\r
+ *\r
+ * This program is distributed in the hope that it will be useful,\r
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
+ * GNU General Public License for more details.\r
+ *\r
+ * You should have received a copy of the GNU General Public License\r
+ * along with this program; if not, write to the Free Software\r
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
+ */\r
 package jalview.gui;\r
 \r
-import jalview.jbgui.*;\r
 import jalview.datamodel.*;\r
+\r
+import jalview.jbgui.*;\r
+\r
 import java.awt.event.*;\r
+\r
 import java.util.*;\r
+\r
 import javax.swing.event.*;\r
+import jalview.util.Comparison;\r
+import javax.swing.*;\r
+\r
 \r
-public class RedundancyPanel extends GSliderPanel\r
+/**\r
+ * DOCUMENT ME!\r
+ *\r
+ * @author $author$\r
+ * @version $Revision$\r
+ */\r
+public class RedundancyPanel extends GSliderPanel implements Runnable\r
 {\r
-  AlignmentPanel ap;\r
+    AlignFrame af;\r
+    AlignmentPanel ap;\r
+    Stack historyList = new Stack(); // simpler than synching with alignFrame.\r
+    float [] redundancy;\r
+    Vector originalSequences;\r
+    Hashtable originalColours;\r
+    JInternalFrame frame;\r
+\r
+    /**\r
+     * Creates a new RedundancyPanel object.\r
+     *\r
+     * @param ap DOCUMENT ME!\r
+     * @param af DOCUMENT ME!\r
+     */\r
+    public RedundancyPanel(AlignmentPanel ap, AlignFrame af)\r
+    {\r
+        this.ap = ap;\r
+        this.af = af;\r
+\r
+        slider.addChangeListener(new ChangeListener()\r
+            {\r
+                public void stateChanged(ChangeEvent evt)\r
+                {\r
+                    valueField.setText(slider.getValue() + "");\r
+                    sliderValueChanged();\r
+                }\r
+            });\r
+\r
+        applyButton.setText("Remove");\r
+        allGroupsCheck.setVisible(false);\r
+        slider.setMinimum(60);\r
+        slider.setMaximum(100);\r
+        slider.setValue(100);\r
+\r
+        Thread worker = new Thread(this);\r
+        worker.start();\r
+\r
+        frame = new JInternalFrame();\r
+        frame.setContentPane(this);\r
+        Desktop.addInternalFrame(frame, "Redundancy threshold selection", 400,\r
+                         100, false);\r
+        frame.addInternalFrameListener(new InternalFrameAdapter()\r
+            {\r
+              public void internalFrameClosing(InternalFrameEvent evt)\r
+              {\r
+                resetColours();\r
+              }\r
+            }\r
+            );\r
+\r
+    }\r
+\r
+\r
+    /**\r
+     * This is a copy of remove redundancy in jalivew.datamodel.Alignment\r
+     * except we dont want to remove redundancy, just calculate once\r
+     * so we can use the slider to dynamically hide redundant sequences\r
+     *\r
+     * @param threshold DOCUMENT ME!\r
+     * @param sel DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public void run()\r
+    {\r
+        JProgressBar progress = new JProgressBar();\r
+        progress.setIndeterminate(true);\r
+        southPanel.add(progress, java.awt.BorderLayout.SOUTH);\r
+\r
+        label.setText("Calculating....");\r
+\r
+        slider.setVisible(false);\r
+        applyButton.setEnabled(false);\r
+        valueField.setVisible(false);\r
+\r
+        validate();\r
+\r
+        Vector sel = new Vector();\r
+        SequenceGroup sg = ap.av.getSelectionGroup();\r
+        int height;\r
+        originalSequences = new Vector();\r
+        originalColours = new Hashtable();\r
+\r
+        if ( (sg != null) && (sg.getSize(false) >= 1))\r
+        {\r
+           height = sg.getSize(false);\r
+          for (int i = 0; i < sg.getSize(false); i++)\r
+          {\r
+            sel.addElement(sg.getSequenceAt(i));\r
+          }\r
+        }\r
+        else\r
+        {\r
+          height = ap.av.alignment.getHeight();\r
+          for (int i = 0; i < ap.av.alignment.getHeight(); i++)\r
+          {\r
+            sel.addElement(ap.av.alignment.getSequenceAt(i));\r
+          }\r
+        }\r
+\r
+        redundancy = new float[height];\r
+        for (int i = 0; i < height; i++)\r
+        {\r
+          redundancy[i] = 0f;\r
+        }\r
+\r
+\r
+       // long start = System.currentTimeMillis();\r
+\r
+        float pid;\r
+        SequenceI seqi, seqj;\r
+        for (int i = 0; i < sel.size(); i++)\r
+        {\r
+            originalSequences.addElement(sel.elementAt(i));\r
+            originalColours.put(sel.elementAt(i),\r
+                               ((SequenceI) sel.elementAt(i)).getColor());\r
+\r
+            for (int j = 0; j < i; j++)\r
+            {\r
+              if(i==j)\r
+                continue;\r
+\r
+              seqi = (SequenceI) sel.elementAt(i);\r
+              seqj = (SequenceI) sel.elementAt(j);\r
+\r
+              if (sg != null)\r
+                pid = Comparison.PID( seqi,\r
+                                     seqj,\r
+                                     sg.getStartRes(), sg.getEndRes());\r
+              else\r
+                pid = Comparison.PID( seqi,  seqj );\r
+\r
 \r
-  SequenceI[] oldAlignment;\r
+              if(seqj.getLength() < seqi.getLength())\r
+                redundancy[j] = Math.max(pid, redundancy[j]);\r
+              else\r
+                redundancy[i] = Math.max(pid, redundancy[i]);\r
+\r
+            }\r
+        }\r
 \r
 \r
-  public RedundancyPanel(AlignmentPanel ap)\r
-  {\r
-    this.ap = ap;\r
+        progress.setIndeterminate(false);\r
+        progress.setVisible(false);\r
+        progress = null;\r
 \r
-    label.setText("Enter the redundancy threshold");\r
+        label.setText("Enter the redundancy threshold");\r
+        slider.setVisible(true);\r
+        applyButton.setEnabled(true);\r
+        valueField.setVisible(true);\r
 \r
-    slider.addChangeListener(new ChangeListener()\r
+        validate();\r
+       // System.out.println("blob done "+ (System.currentTimeMillis()-start));\r
+    }\r
+\r
+    void sliderValueChanged()\r
     {\r
-      public void stateChanged(ChangeEvent evt)\r
+      if(redundancy==null)\r
+        return;\r
+\r
+      float value = slider.getValue();\r
+\r
+      for(int i=0; i<redundancy.length; i++)\r
       {\r
-        valueField.setText( slider.getValue()+"" );\r
+        if (value > redundancy[i])\r
+           ((SequenceI)originalSequences.elementAt(i)).setColor(java.awt.Color.white);\r
+        else\r
+           ((SequenceI)originalSequences.elementAt(i)).setColor(java.awt.Color.red);\r
       }\r
-    });\r
 \r
-    slider.setMinimum(0);\r
-    slider.setMaximum(100);\r
-    slider.setValue(100 );\r
+      PaintRefresher.Refresh(null,ap.av.alignment);\r
 \r
-  }\r
+    }\r
 \r
-  public void applyButton_actionPerformed(ActionEvent e)\r
-  {\r
-       float threshold = slider.getValue();\r
-       Vector del;\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param e DOCUMENT ME!\r
+     */\r
+    public void applyButton_actionPerformed(ActionEvent e)\r
+    {\r
+        historyList.push(new HistoryItem("Remove redundancy",\r
+                    ap.av.alignment, HistoryItem.HIDE));\r
 \r
-       oldAlignment = new SequenceI[ap.av.alignment.getHeight()];\r
-        for (int i = 0; i < ap.av.alignment.getHeight(); i++)\r
+        if ((historyList.size() == 1) ||\r
+                !af.historyList.contains(historyList.firstElement()))\r
         {\r
-           oldAlignment[i] = new Sequence(ap.av.alignment.getSequenceAt(i).getName(),\r
-                                ap.av.alignment.getSequenceAt(i).\r
-                                getSequence());\r
+            af.addHistoryItem((HistoryItem) historyList.firstElement());\r
+            af.updateEditMenuBar();\r
         }\r
 \r
+        Vector del = new Vector();\r
+\r
         undoButton.setEnabled(true);\r
 \r
+        float value = slider.getValue();\r
         SequenceGroup sg = ap.av.getSelectionGroup();\r
-       if (sg != null && sg.getSize() > 1)\r
-       {\r
-\r
-         del = ap.av.alignment.removeRedundancy(threshold, sg.sequences);\r
-         for (int i = 0; i < del.size(); i++)\r
-           if (sg.sequences.contains( (SequenceI) del.elementAt(i)))\r
-             sg.deleteSequence( (SequenceI) del.elementAt(i));\r
-\r
-         }\r
-         else\r
-         {\r
-           Vector s = new Vector();\r
-           int i=0;\r
-           while(i < ap.av.alignment.getHeight())\r
-           {\r
-             s.addElement( ap.av.alignment.getSequenceAt(i) );\r
-             i++;\r
-           }\r
-            del = ap.av.alignment.removeRedundancy(threshold,s);\r
-           for (int j=0; j < del.size(); j++)\r
-           {\r
-               if (sg.sequences.contains((SequenceI)del.elementAt(j)))\r
-               sg.deleteSequence((SequenceI)del.elementAt(j));\r
-\r
-           }\r
-         }\r
-\r
-         ap.RefreshPanels();\r
-\r
-  }\r
-\r
-  public void undoButton_actionPerformed(ActionEvent e)\r
-  {\r
-      undoButton.setEnabled(false);\r
-      ap.av.setAlignment( new Alignment(oldAlignment) );\r
-      oldAlignment = null;\r
-      ap.RefreshPanels();\r
-  }\r
-\r
-\r
-  public void valueField_actionPerformed(ActionEvent e)\r
-  {\r
-    try{\r
-      int i = Integer.parseInt(valueField.getText());\r
-      slider.setValue(i);\r
+\r
+        for (int i = 0; i < redundancy.length; i++)\r
+        {\r
+          if (value <= redundancy[i])\r
+          {\r
+            SequenceI seq = (SequenceI) originalSequences.elementAt(i);\r
+            ap.av.alignment.deleteSequence(seq);\r
+            del.add(seq);\r
+            if (sg != null)\r
+            {\r
+              sg.deleteSequence(seq, false);\r
+            }\r
+          }\r
+        }\r
+\r
+\r
+        // This has to be done before the restoreHistoryItem method of alignFrame will\r
+        // actually restore these sequences.\r
+        if (del.size() > 0)\r
+        {\r
+            for (int i = 0, j = del.size(); i < j; i++)\r
+            {\r
+                SequenceI sq = (SequenceI) del.elementAt(i);\r
+                sq.deleteChars(0, sq.getLength());\r
+            }\r
+        }\r
+\r
+        ap.av.firePropertyChange("alignment", null, ap.av.getAlignment().getSequences());\r
+        af.updateEditMenuBar();\r
     }\r
-    catch(Exception ex)\r
+\r
+    void resetColours()\r
     {\r
-      valueField.setText( slider.getValue()+"" );\r
+      for(int i=0; i<originalSequences.size(); i++)\r
+      {\r
+        SequenceI seq = (SequenceI)originalSequences.elementAt(i);\r
+        seq.setColor( (java.awt.Color)originalColours.get(seq));\r
+      }\r
+\r
+      PaintRefresher.Refresh(ap.av.alignment);\r
+    }\r
+\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param e DOCUMENT ME!\r
+     */\r
+    public void undoButton_actionPerformed(ActionEvent e)\r
+    {\r
+      HistoryItem hi = (HistoryItem) historyList.pop();\r
+      af.restoreHistoryItem(hi);\r
+\r
+      if (historyList.size() == 0)\r
+      {\r
+        undoButton.setEnabled(false);\r
+\r
+        if (af.historyList.contains(hi))\r
+        {\r
+          af.historyList.remove(hi);\r
+          af.updateEditMenuBar();\r
+        }\r
+      }\r
     }\r
-  }\r
+\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param e DOCUMENT ME!\r
+     */\r
+    public void valueField_actionPerformed(ActionEvent e)\r
+    {\r
+        try\r
+        {\r
+            int i = Integer.parseInt(valueField.getText());\r
+            slider.setValue(i);\r
+        }\r
+        catch (Exception ex)\r
+        {\r
+            valueField.setText(slider.getValue() + "");\r
+        }\r
+    }\r
+\r
+\r
 }\r