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