src/jalview/controller/AlignViewController.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.controller;
  22
  23 import jalview.analysis.AlignmentSorter;
  24 import jalview.api.AlignViewControllerGuiI;
  25 import jalview.api.AlignViewControllerI;
  26 import jalview.api.AlignViewportI;
  27 import jalview.api.AlignmentViewPanel;
  28 import jalview.api.FeatureRenderer;
  29 import jalview.commands.OrderCommand;
  30 import jalview.datamodel.AlignmentI;
  31 import jalview.datamodel.ColumnSelection;
  32 import jalview.datamodel.SequenceCollectionI;
  33 import jalview.datamodel.SequenceFeature;
  34 import jalview.datamodel.SequenceGroup;
  35 import jalview.datamodel.SequenceI;
  36 import jalview.io.DataSourceType;
  37 import jalview.io.FeaturesFile;
  38 import jalview.util.MessageManager;
  39
  40 import java.awt.Color;
  41 import java.util.BitSet;
  42 import java.util.List;
  43
  44 public class AlignViewController implements AlignViewControllerI
  45 {
  46   AlignViewportI viewport = null;
  47
  48   AlignmentViewPanel alignPanel = null;
  49
  50   /**
  51    * the GUI container that is handling interactions with the user
  52    */
  53   private AlignViewControllerGuiI avcg;
  54
  55   @Override
  56   protected void finalize() throws Throwable
  57   {
  58     viewport = null;
  59     alignPanel = null;
  60     avcg = null;
  61   };
  62
  63   public AlignViewController(AlignViewControllerGuiI alignFrame,
  64           AlignViewportI viewport, AlignmentViewPanel alignPanel)
  65   {
  66     this.avcg = alignFrame;
  67     this.viewport = viewport;
  68     this.alignPanel = alignPanel;
  69   }
  70
  71   @Override
  72   public void setViewportAndAlignmentPanel(AlignViewportI viewport,
  73           AlignmentViewPanel alignPanel)
  74   {
  75     this.alignPanel = alignPanel;
  76     this.viewport = viewport;
  77
  78   }
  79
  80   @Override
  81   public boolean makeGroupsFromSelection()
  82   {
  83     SequenceGroup sg = viewport.getSelectionGroup();
  84     ColumnSelection cs = viewport.getColumnSelection();
  85     SequenceGroup[] gps = null;
  86     if (sg != null && (cs == null || cs.isEmpty()))
  87     {
  88       gps = jalview.analysis.Grouping.makeGroupsFrom(viewport
  89               .getSequenceSelection(), viewport.getAlignmentView(true)
  90               .getSequenceStrings(viewport.getGapCharacter()), viewport
  91               .getAlignment().getGroups());
  92     }
  93     else
  94     {
  95       if (cs != null)
  96       {
  97         gps = jalview.analysis.Grouping.makeGroupsFromCols(
  98                 (sg == null) ? viewport.getAlignment().getSequencesArray()
  99                         : sg.getSequences().toArray(new SequenceI[0]), cs,
 100                 viewport.getAlignment().getGroups());
 101       }
 102     }
 103     if (gps != null)
 104     {
 105       viewport.getAlignment().deleteAllGroups();
 106       viewport.clearSequenceColours();
 107       viewport.setSelectionGroup(null);
 108       // set view properties for each group
 109       for (int g = 0; g < gps.length; g++)
 110       {
 111         // gps[g].setShowunconserved(viewport.getShowUnconserved());
 112         gps[g].setshowSequenceLogo(viewport.isShowSequenceLogo());
 113         viewport.getAlignment().addGroup(gps[g]);
 114         Color col = new Color((int) (Math.random() * 255),
 115                 (int) (Math.random() * 255), (int) (Math.random() * 255));
 116         col = col.brighter();
 117         for (SequenceI sq : gps[g].getSequences(null))
 118         {
 119           viewport.setSequenceColour(sq, col);
 120         }
 121       }
 122       return true;
 123     }
 124     return false;
 125   }
 126
 127   @Override
 128   public boolean createGroup()
 129   {
 130
 131     SequenceGroup sg = viewport.getSelectionGroup();
 132     if (sg != null)
 133     {
 134       viewport.getAlignment().addGroup(sg);
 135       return true;
 136     }
 137     return false;
 138   }
 139
 140   @Override
 141   public boolean unGroup()
 142   {
 143     SequenceGroup sg = viewport.getSelectionGroup();
 144     if (sg != null)
 145     {
 146       viewport.getAlignment().deleteGroup(sg);
 147       return true;
 148     }
 149     return false;
 150   }
 151
 152   @Override
 153   public boolean deleteGroups()
 154   {
 155     if (viewport.getAlignment().getGroups() != null
 156             && viewport.getAlignment().getGroups().size() > 0)
 157     {
 158       viewport.getAlignment().deleteAllGroups();
 159       viewport.clearSequenceColours();
 160       viewport.setSelectionGroup(null);
 161       return true;
 162     }
 163     return false;
 164   }
 165
 166   @Override
 167   public boolean markColumnsContainingFeatures(boolean invert,
 168           boolean extendCurrent, boolean toggle, String featureType)
 169   {
 170     // JBPNote this routine could also mark rows, not just columns.
 171     // need a decent query structure to allow all types of feature searches
 172     BitSet bs = new BitSet();
 173     SequenceCollectionI sqcol = (viewport.getSelectionGroup() == null || extendCurrent) ? viewport
 174             .getAlignment() : viewport.getSelectionGroup();
 175
 176     int nseq = findColumnsWithFeature(featureType, sqcol, bs);
 177
 178     ColumnSelection cs = viewport.getColumnSelection();
 179     if (cs == null)
 180     {
 181       cs = new ColumnSelection();
 182     }
 183
 184     if (bs.cardinality() > 0 || invert)
 185     {
 186       boolean changed = cs.markColumns(bs, sqcol.getStartRes(),
 187               sqcol.getEndRes(), invert, extendCurrent, toggle);
 188       if (changed)
 189       {
 190         viewport.setColumnSelection(cs);
 191         alignPanel.paintAlignment(true);
 192         int columnCount = invert ? (sqcol.getEndRes() - sqcol.getStartRes() + 1)
 193                 - bs.cardinality()
 194                 : bs.cardinality();
 195         avcg.setStatus(MessageManager.formatMessage(
 196                 "label.view_controller_toggled_marked",
 197                 new String[] {
 198                     toggle ? MessageManager.getString("label.toggled")
 199                             : MessageManager.getString("label.marked"),
 200                     String.valueOf(columnCount),
 201                     invert ? MessageManager
 202                             .getString("label.not_containing")
 203                             : MessageManager.getString("label.containing"),
 204                     featureType, Integer.valueOf(nseq).toString() }));
 205         return true;
 206       }
 207     }
 208     else
 209     {
 210       avcg.setStatus(MessageManager.formatMessage(
 211               "label.no_feature_of_type_found",
 212               new String[] { featureType }));
 213       if (!extendCurrent)
 214       {
 215         cs.clear();
 216         alignPanel.paintAlignment(true);
 217       }
 218     }
 219     return false;
 220   }
 221
 222   /**
 223    * Sets a bit in the BitSet for each column (base 0) in the sequence
 224    * collection which includes the specified feature type. Returns the number of
 225    * sequences which have the feature in the selected range.
 226    *
 227    * @param featureType
 228    * @param sqcol
 229    * @param bs
 230    * @return
 231    */
 232   static int findColumnsWithFeature(String featureType,
 233           SequenceCollectionI sqcol, BitSet bs)
 234   {
 235     final int startPosition = sqcol.getStartRes() + 1; // converted to base 1
 236     final int endPosition = sqcol.getEndRes() + 1;
 237     List<SequenceI> seqs = sqcol.getSequences();
 238     int nseq = 0;
 239     for (SequenceI sq : seqs)
 240     {
 241       if (sq != null)
 242       {
 243         int ist = sq.findPosition(sqcol.getStartRes());
 244         int iend = sq.findPosition(sqcol.getEndRes()); // see JAL-2526
 245         List<SequenceFeature> sfs = sq.getFeatures().findFeatures(ist,
 246                 iend, featureType);
 247         boolean overlap = false;
 248         for (SequenceFeature sf : sfs)
 249         {
 250           // future functionality - featureType == null means mark columns
 251           // containing all displayed features
 252           if (sf != null && (featureType.equals(sf.getType())))
 253           {
 254             int sfStartCol = sq.findIndex(sf.getBegin());
 255             int sfEndCol = sq.findIndex(sf.getEnd()); // inefficient - JAL-2526
 256
 257             if (sf.isContactFeature())
 258             {
 259               /*
 260                * 'contact' feature - check for 'start' or 'end'
 261                * position within the selected region
 262                */
 263               if (sfStartCol >= startPosition && sfStartCol <= endPosition)
 264               {
 265                 bs.set(sfStartCol - 1);
 266                 overlap = true;
 267               }
 268               if (sfEndCol >= startPosition && sfEndCol <= endPosition)
 269               {
 270                 bs.set(sfEndCol - 1);
 271                 overlap = true;
 272               }
 273               continue;
 274             }
 275
 276             /*
 277              * contiguous feature - select feature positions (if any)
 278              * within the selected region
 279              */
 280             if (sfStartCol < startPosition)
 281             {
 282               sfStartCol = startPosition;
 283             }
 284             if (sfStartCol < ist)
 285             {
 286               sfStartCol = ist;
 287             }
 288             if (sfEndCol > endPosition)
 289             {
 290               sfEndCol = endPosition;
 291             }
 292             for (; sfStartCol <= sfEndCol; sfStartCol++)
 293             {
 294               bs.set(sfStartCol - 1); // convert to base 0
 295               overlap = true;
 296             }
 297           }
 298         }
 299         if (overlap)
 300         {
 301           nseq++;
 302         }
 303       }
 304     }
 305     return nseq;
 306   }
 307
 308   @Override
 309   public void sortAlignmentByFeatureDensity(List<String> typ)
 310   {
 311     sortBy(typ, "Sort by Density", AlignmentSorter.FEATURE_DENSITY);
 312   }
 313
 314   protected void sortBy(List<String> typ, String methodText,
 315           final String method)
 316   {
 317     FeatureRenderer fr = alignPanel.getFeatureRenderer();
 318     if (typ == null && fr != null)
 319     {
 320       typ = fr.getDisplayedFeatureTypes();
 321     }
 322     List<String> gps = null;
 323     if (fr != null)
 324     {
 325       gps = fr.getDisplayedFeatureGroups();
 326     }
 327     AlignmentI al = viewport.getAlignment();
 328
 329     int start, stop;
 330     SequenceGroup sg = viewport.getSelectionGroup();
 331     if (sg != null)
 332     {
 333       start = sg.getStartRes();
 334       stop = sg.getEndRes();
 335     }
 336     else
 337     {
 338       start = 0;
 339       stop = al.getWidth();
 340     }
 341     SequenceI[] oldOrder = al.getSequencesArray();
 342     AlignmentSorter.sortByFeature(typ, gps, start, stop, al, method);
 343     avcg.addHistoryItem(new OrderCommand(methodText, oldOrder, viewport
 344             .getAlignment()));
 345     alignPanel.paintAlignment(true);
 346
 347   }
 348
 349   @Override
 350   public void sortAlignmentByFeatureScore(List<String> typ)
 351   {
 352     sortBy(typ, "Sort by Feature Score", AlignmentSorter.FEATURE_SCORE);
 353   }
 354
 355   @Override
 356   public boolean parseFeaturesFile(String file, DataSourceType protocol,
 357           boolean relaxedIdMatching)
 358   {
 359     boolean featuresFile = false;
 360     try
 361     {
 362       featuresFile = new FeaturesFile(false, file, protocol).parse(viewport
 363               .getAlignment().getDataset(), alignPanel.getFeatureRenderer()
 364               .getFeatureColours(), false, relaxedIdMatching);
 365     } catch (Exception ex)
 366     {
 367       ex.printStackTrace();
 368     }
 369
 370     if (featuresFile)
 371     {
 372       avcg.refreshFeatureUI(true);
 373       if (alignPanel.getFeatureRenderer() != null)
 374       {
 375         // update the min/max ranges where necessary
 376         alignPanel.getFeatureRenderer().findAllFeatures(true);
 377       }
 378       if (avcg.getFeatureSettingsUI() != null)
 379       {
 380         avcg.getFeatureSettingsUI().discoverAllFeatureData();
 381       }
 382       alignPanel.paintAlignment(true);
 383     }
 384
 385     return featuresFile;
 386
 387   }
 388
 389   @Override
 390   public boolean markHighlightedColumns(boolean invert,
 391           boolean extendCurrent, boolean toggle)
 392   {
 393     if (!viewport.hasSearchResults())
 394     {
 395       // do nothing if no selection exists
 396       return false;
 397     }
 398     // JBPNote this routine could also mark rows, not just columns.
 399     BitSet bs = new BitSet();
 400     SequenceCollectionI sqcol = (viewport.getSelectionGroup() == null || extendCurrent) ? viewport
 401             .getAlignment() : viewport.getSelectionGroup();
 402
 403     // this could be a lambda... - the remains of the method is boilerplate,
 404     // except for the different messages for reporting selection.
 405     int nseq = viewport.getSearchResults().markColumns(sqcol, bs);
 406
 407     ColumnSelection cs = viewport.getColumnSelection();
 408     if (cs == null)
 409     {
 410       cs = new ColumnSelection();
 411     }
 412
 413     if (bs.cardinality() > 0 || invert)
 414     {
 415       boolean changed = cs.markColumns(bs, sqcol.getStartRes(),
 416               sqcol.getEndRes(), invert, extendCurrent, toggle);
 417       if (changed)
 418       {
 419         viewport.setColumnSelection(cs);
 420         alignPanel.paintAlignment(true);
 421         int columnCount = invert ? (sqcol.getEndRes() - sqcol.getStartRes() + 1)
 422                 - bs.cardinality()
 423                 : bs.cardinality();
 424         avcg.setStatus(MessageManager.formatMessage(
 425                 "label.view_controller_toggled_marked",
 426                 new String[] {
 427                     toggle ? MessageManager.getString("label.toggled")
 428                             : MessageManager.getString("label.marked"),
 429                     String.valueOf(columnCount),
 430                     invert ? MessageManager
 431                             .getString("label.not_containing")
 432                             : MessageManager.getString("label.containing"),
 433                     "Highlight", Integer.valueOf(nseq).toString() }));
 434         return true;
 435       }
 436     }
 437     else
 438     {
 439       avcg.setStatus(MessageManager
 440               .formatMessage("No highlighted regions marked"));
 441       if (!extendCurrent)
 442       {
 443         cs.clear();
 444         alignPanel.paintAlignment(true);
 445       }
 446     }
 447     return false;
 448   }
 449
 450 }