src/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<>();
  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,
 105             MessageManager
 106                     .getString("label.redundancy_threshold_selection"),
 107             true, FRAME_WIDTH, FRAME_HEIGHT, false, true);
 108     frame.addInternalFrameListener(new InternalFrameAdapter()
 109     {
 110       @Override
 111       public void internalFrameClosing(InternalFrameEvent evt)
 112       {
 113         ap.getIdPanel().getIdCanvas().setHighlighted(null);
 114       }
 115     });
 116
 117   }
 118
 119   /**
 120    * This is a copy of remove redundancy in jalivew.datamodel.Alignment except
 121    * we dont want to remove redundancy, just calculate once so we can use the
 122    * slider to dynamically hide redundant sequences
 123    *
 124    * @param threshold
 125    *          DOCUMENT ME!
 126    * @param sel
 127    *          DOCUMENT ME!
 128    *
 129    * @return DOCUMENT ME!
 130    */
 131   @Override
 132   public void run()
 133   {
 134     JProgressBar progress = new JProgressBar();
 135     progress.setIndeterminate(true);
 136     southPanel.add(progress, java.awt.BorderLayout.SOUTH);
 137
 138     label.setText(MessageManager.getString("label.calculating"));
 139
 140     slider.setVisible(false);
 141     applyButton.setEnabled(false);
 142     valueField.setVisible(false);
 143
 144     validate();
 145
 146     String[] omitHidden = null;
 147
 148     SequenceGroup sg = ap.av.getSelectionGroup();
 149     int height;
 150
 151     int start, end;
 152
 153     if ((sg != null) && (sg.getSize() >= 1))
 154     {
 155       originalSequences = sg.getSequencesInOrder(ap.av.getAlignment());
 156       start = sg.getStartRes();
 157       end = sg.getEndRes();
 158     }
 159     else
 160     {
 161       originalSequences = ap.av.getAlignment().getSequencesArray();
 162       start = 0;
 163       end = ap.av.getAlignment().getWidth();
 164     }
 165
 166     height = originalSequences.length;
 167     if (ap.av.hasHiddenColumns())
 168     {
 169       omitHidden = ap.av.getViewAsString(sg != null);
 170     }
 171     redundancy = AlignSeq.computeRedundancyMatrix(originalSequences,
 172             omitHidden, start, end, false);
 173
 174     progress.setIndeterminate(false);
 175     progress.setVisible(false);
 176     progress = null;
 177
 178     label.setText(
 179             MessageManager.getString("label.enter_redundancy_threshold"));
 180     slider.setVisible(true);
 181     applyButton.setEnabled(true);
 182     valueField.setVisible(true);
 183
 184     validate();
 185     sliderValueChanged();
 186     // System.out.println((System.currentTimeMillis()-start));
 187   }
 188
 189   void sliderValueChanged()
 190   {
 191     if (redundancy == null)
 192     {
 193       return;
 194     }
 195
 196     float value = slider.getValue();
 197     List<SequenceI> redundantSequences = new ArrayList<>();
 198     for (int i = 0; i < redundancy.length; i++)
 199     {
 200       if (value <= redundancy[i])
 201       {
 202         redundantSequences.add(originalSequences[i]);
 203       }
 204     }
 205     ap.getIdPanel().getIdCanvas().setHighlighted(redundantSequences);
 206   }
 207
 208   /**
 209    * DOCUMENT ME!
 210    *
 211    * @param e
 212    *          DOCUMENT ME!
 213    */
 214   @Override
 215   public void applyButton_actionPerformed(ActionEvent e)
 216   {
 217     List<SequenceI> del = new ArrayList<>();
 218
 219     undoButton.setEnabled(true);
 220
 221     float value = slider.getValue();
 222     SequenceGroup sg = ap.av.getSelectionGroup();
 223
 224     for (int i = 0; i < redundancy.length; i++)
 225     {
 226       if (value <= redundancy[i])
 227       {
 228         del.add(originalSequences[i]);
 229       }
 230     }
 231
 232     // This has to be done before the restoreHistoryItem method of alignFrame
 233     // will 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] = del.get(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,
 267               ap.av.getAlignment().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,
 293               ap.av.getAlignment().getSequences());
 294       af.updateEditMenuBar();
 295     }
 296
 297     ap.paintAlignment(true, true);
 298
 299     if (historyList.size() == 0)
 300     {
 301       undoButton.setEnabled(false);
 302     }
 303   }
 304
 305 }