jalview/gui/RedundancyPanel.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.AlignSeq;
  24 import jalview.commands.CommandI;
  25 import jalview.commands.EditCommand;
  26 import jalview.commands.EditCommand.Action;
  27 import jalview.datamodel.SequenceGroup;
  28 import jalview.datamodel.SequenceI;
  29 import jalview.jbgui.GSliderPanel;
  30 import jalview.util.MessageManager;
  31
  32 import java.awt.event.ActionEvent;
  33 import java.util.ArrayList;
  34 import java.util.List;
  35 import java.util.Stack;
  36 import java.util.Vector;
  37
  38 import javax.swing.JInternalFrame;
  39 import javax.swing.JProgressBar;
  40 import javax.swing.event.ChangeEvent;
  41 import javax.swing.event.ChangeListener;
  42 import javax.swing.event.InternalFrameAdapter;
  43 import javax.swing.event.InternalFrameEvent;
  44
  45 /**
  46  * DOCUMENT ME!
  47  *
  48  * @author $author$
  49  * @version $Revision$
  50  */
  51 public class RedundancyPanel extends GSliderPanel implements Runnable
  52 {
  53   AlignFrame af;
  54
  55   AlignmentPanel ap;
  56
  57   Stack<CommandI> historyList = new Stack<CommandI>();
  58
  59   // simpler than synching with alignFrame.
  60
  61   float[] redundancy;
  62
  63   SequenceI[] originalSequences;
  64
  65   JInternalFrame frame;
  66
  67   Vector redundantSeqs;
  68
  69   /**
  70    * Creates a new RedundancyPanel object.
  71    *
  72    * @param ap
  73    *          DOCUMENT ME!
  74    * @param af
  75    *          DOCUMENT ME!
  76    */
  77   public RedundancyPanel(final AlignmentPanel ap, AlignFrame af)
  78   {
  79     this.ap = ap;
  80     this.af = af;
  81     redundantSeqs = new Vector();
  82
  83     slider.addChangeListener(new ChangeListener()
  84     {
  85       @Override
  86       public void stateChanged(ChangeEvent evt)
  87       {
  88         valueField.setText(slider.getValue() + "");
  89         sliderValueChanged();
  90       }
  91     });
  92
  93     applyButton.setText(MessageManager.getString("action.remove"));
  94     allGroupsCheck.setVisible(false);
  95     slider.setMinimum(0);
  96     slider.setMaximum(100);
  97     slider.setValue(100);
  98
  99     Thread worker = new Thread(this);
 100     worker.start();
 101
 102     frame = new JInternalFrame();
 103     frame.setContentPane(this);
 104     Desktop.addInternalFrame(frame, MessageManager
 105             .getString("label.redundancy_threshold_selection"), 400, 100,
 106             false);
 107     frame.addInternalFrameListener(new InternalFrameAdapter()
 108     {
 109       @Override
 110       public void internalFrameClosing(InternalFrameEvent evt)
 111       {
 112         ap.getIdPanel().getIdCanvas().setHighlighted(null);
 113       }
 114     });
 115
 116   }
 117
 118   /**
 119    * This is a copy of remove redundancy in jalivew.datamodel.Alignment except
 120    * we dont want to remove redundancy, just calculate once so we can use the
 121    * slider to dynamically hide redundant sequences
 122    *
 123    * @param threshold
 124    *          DOCUMENT ME!
 125    * @param sel
 126    *          DOCUMENT ME!
 127    *
 128    * @return DOCUMENT ME!
 129    */
 130   @Override
 131   public void run()
 132   {
 133     JProgressBar progress = new JProgressBar();
 134     progress.setIndeterminate(true);
 135     southPanel.add(progress, java.awt.BorderLayout.SOUTH);
 136
 137     label.setText(MessageManager.getString("label.calculating"));
 138
 139     slider.setVisible(false);
 140     applyButton.setEnabled(false);
 141     valueField.setVisible(false);
 142
 143     validate();
 144
 145     String[] omitHidden = null;
 146
 147     SequenceGroup sg = ap.av.getSelectionGroup();
 148     int height;
 149
 150     int start, end;
 151
 152     if ((sg != null) && (sg.getSize() >= 1))
 153     {
 154       originalSequences = sg.getSequencesInOrder(ap.av.getAlignment());
 155       start = sg.getStartRes();
 156       end = sg.getEndRes();
 157     }
 158     else
 159     {
 160       originalSequences = ap.av.getAlignment().getSequencesArray();
 161       start = 0;
 162       end = ap.av.getAlignment().getWidth();
 163     }
 164
 165     height = originalSequences.length;
 166     if (ap.av.hasHiddenColumns())
 167     {
 168       omitHidden = ap.av.getViewAsString(sg != null);
 169     }
 170     redundancy = AlignSeq.computeRedundancyMatrix(originalSequences,
 171             omitHidden, start, end, false);
 172
 173     progress.setIndeterminate(false);
 174     progress.setVisible(false);
 175     progress = null;
 176
 177     label.setText(MessageManager
 178             .getString("label.enter_redundancy_threshold"));
 179     slider.setVisible(true);
 180     applyButton.setEnabled(true);
 181     valueField.setVisible(true);
 182
 183     validate();
 184     sliderValueChanged();
 185     // System.out.println((System.currentTimeMillis()-start));
 186   }
 187
 188   void sliderValueChanged()
 189   {
 190     if (redundancy == null)
 191     {
 192       return;
 193     }
 194
 195     float value = slider.getValue();
 196     List<SequenceI> redundantSequences = new ArrayList<SequenceI>();
 197     for (int i = 0; i < redundancy.length; i++)
 198     {
 199       if (value <= redundancy[i])
 200       {
 201         redundantSequences.add(originalSequences[i]);
 202       }
 203     }
 204     ap.getIdPanel().getIdCanvas().setHighlighted(redundantSequences);
 205   }
 206
 207   /**
 208    * DOCUMENT ME!
 209    *
 210    * @param e
 211    *          DOCUMENT ME!
 212    */
 213   @Override
 214   public void applyButton_actionPerformed(ActionEvent e)
 215   {
 216     Vector del = new Vector();
 217
 218     undoButton.setEnabled(true);
 219
 220     float value = slider.getValue();
 221     SequenceGroup sg = ap.av.getSelectionGroup();
 222
 223     for (int i = 0; i < redundancy.length; i++)
 224     {
 225       if (value <= redundancy[i])
 226       {
 227         del.addElement(originalSequences[i]);
 228       }
 229     }
 230
 231     // This has to be done before the restoreHistoryItem method of alignFrame
 232     // will
 233     // actually restore these sequences.
 234     if (del.size() > 0)
 235     {
 236       SequenceI[] deleted = new SequenceI[del.size()];
 237
 238       int width = 0;
 239       for (int i = 0; i < del.size(); i++)
 240       {
 241         deleted[i] = (SequenceI) del.elementAt(i);
 242         if (deleted[i].getLength() > width)
 243         {
 244           width = deleted[i].getLength();
 245         }
 246       }
 247
 248       EditCommand cut = new EditCommand(
 249               MessageManager.getString("action.remove_redundancy"),
 250               Action.CUT, deleted, 0, width, ap.av.getAlignment());
 251
 252       for (int i = 0; i < del.size(); i++)
 253       {
 254         ap.av.getAlignment().deleteSequence(deleted[i]);
 255         if (sg != null)
 256         {
 257           sg.deleteSequence(deleted[i], false);
 258         }
 259       }
 260
 261       historyList.push(cut);
 262
 263       ap.alignFrame.addHistoryItem(cut);
 264
 265       PaintRefresher.Refresh(this, ap.av.getSequenceSetId(), true, true);
 266       ap.av.firePropertyChange("alignment", null, ap.av.getAlignment()
 267               .getSequences());
 268     }
 269
 270   }
 271
 272   /**
 273    * DOCUMENT ME!
 274    *
 275    * @param e
 276    *          DOCUMENT ME!
 277    */
 278   @Override
 279   public void undoButton_actionPerformed(ActionEvent e)
 280   {
 281     if (historyList == null || historyList.isEmpty())
 282     {
 283       undoButton.setEnabled(false);
 284       return;
 285     }
 286
 287     CommandI command = historyList.pop();
 288     if (ap.av.getHistoryList().contains(command))
 289     {
 290       command.undoCommand(af.getViewAlignments());
 291       ap.av.getHistoryList().remove(command);
 292       ap.av.firePropertyChange("alignment", null, ap.av.getAlignment()
 293               .getSequences());
 294       af.updateEditMenuBar();
 295     }
 296
 297     ap.paintAlignment(true);
 298
 299     if (historyList.size() == 0)
 300     {
 301       undoButton.setEnabled(false);
 302     }
 303   }
 304
 305 }