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       boolean sequenceHasFeature = false;
 242       if (sq != null)
 243       {
 244         SequenceFeature[] sfs = sq.getSequenceFeatures();
 245         if (sfs != null)
 246         {
 247           int ist = sq.findIndex(sq.getStart());
 248           int iend = sq.findIndex(sq.getEnd());
 249           if (iend < startPosition || ist > endPosition)
 250           {
 251             // sequence not in region
 252             continue;
 253           }
 254           for (SequenceFeature sf : sfs)
 255           {
 256             // future functionality - featureType == null means mark columns
 257             // containing all displayed features
 258             if (sf != null && (featureType.equals(sf.getType())))
 259             {
 260               // optimisation - could consider 'spos,apos' like cursor argument
 261               // - findIndex wastes time by starting from first character and
 262               // counting
 263
 264               int sfStartCol = sq.findIndex(sf.getBegin());
 265               int sfEndCol = sq.findIndex(sf.getEnd());
 266
 267               if (sf.isContactFeature())
 268               {
 269                 /*
 270                  * 'contact' feature - check for 'start' or 'end'
 271                  * position within the selected region
 272                  */
 273                 if (sfStartCol >= startPosition
 274                         && sfStartCol <= endPosition)
 275                 {
 276                   bs.set(sfStartCol - 1);
 277                   sequenceHasFeature = true;
 278                 }
 279                 if (sfEndCol >= startPosition && sfEndCol <= endPosition)
 280                 {
 281                   bs.set(sfEndCol - 1);
 282                   sequenceHasFeature = true;
 283                 }
 284                 continue;
 285               }
 286
 287               /*
 288                * contiguous feature - select feature positions (if any)
 289                * within the selected region
 290                */
 291               if (sfStartCol > endPosition || sfEndCol < startPosition)
 292               {
 293                 // feature is outside selected region
 294                 continue;
 295               }
 296               sequenceHasFeature = true;
 297               if (sfStartCol < startPosition)
 298               {
 299                 sfStartCol = startPosition;
 300               }
 301               if (sfStartCol < ist)
 302               {
 303                 sfStartCol = ist;
 304               }
 305               if (sfEndCol > endPosition)
 306               {
 307                 sfEndCol = endPosition;
 308               }
 309               for (; sfStartCol <= sfEndCol; sfStartCol++)
 310               {
 311                 bs.set(sfStartCol - 1); // convert to base 0
 312               }
 313             }
 314           }
 315         }
 316
 317         if (sequenceHasFeature)
 318         {
 319           nseq++;
 320         }
 321       }
 322     }
 323     return nseq;
 324   }
 325
 326   @Override
 327   public void sortAlignmentByFeatureDensity(List<String> typ)
 328   {
 329     sortBy(typ, "Sort by Density", AlignmentSorter.FEATURE_DENSITY);
 330   }
 331
 332   protected void sortBy(List<String> typ, String methodText,
 333           final String method)
 334   {
 335     FeatureRenderer fr = alignPanel.getFeatureRenderer();
 336     if (typ == null && fr != null)
 337     {
 338       typ = fr.getDisplayedFeatureTypes();
 339     }
 340     List<String> gps = null;
 341     if (fr != null)
 342     {
 343       gps = fr.getDisplayedFeatureGroups();
 344     }
 345     AlignmentI al = viewport.getAlignment();
 346
 347     int start, stop;
 348     SequenceGroup sg = viewport.getSelectionGroup();
 349     if (sg != null)
 350     {
 351       start = sg.getStartRes();
 352       stop = sg.getEndRes();
 353     }
 354     else
 355     {
 356       start = 0;
 357       stop = al.getWidth();
 358     }
 359     SequenceI[] oldOrder = al.getSequencesArray();
 360     AlignmentSorter.sortByFeature(typ, gps, start, stop, al, method);
 361     avcg.addHistoryItem(new OrderCommand(methodText, oldOrder, viewport
 362             .getAlignment()));
 363     alignPanel.paintAlignment(true);
 364
 365   }
 366
 367   @Override
 368   public void sortAlignmentByFeatureScore(List<String> typ)
 369   {
 370     sortBy(typ, "Sort by Feature Score", AlignmentSorter.FEATURE_SCORE);
 371   }
 372
 373   @Override
 374   public boolean parseFeaturesFile(String file, DataSourceType protocol,
 375           boolean relaxedIdMatching)
 376   {
 377     boolean featuresFile = false;
 378     try
 379     {
 380       featuresFile = new FeaturesFile(false, file, protocol).parse(viewport
 381               .getAlignment().getDataset(), alignPanel.getFeatureRenderer()
 382               .getFeatureColours(), false, relaxedIdMatching);
 383     } catch (Exception ex)
 384     {
 385       ex.printStackTrace();
 386     }
 387
 388     if (featuresFile)
 389     {
 390       avcg.refreshFeatureUI(true);
 391       if (alignPanel.getFeatureRenderer() != null)
 392       {
 393         // update the min/max ranges where necessary
 394         alignPanel.getFeatureRenderer().findAllFeatures(true);
 395       }
 396       if (avcg.getFeatureSettingsUI() != null)
 397       {
 398         avcg.getFeatureSettingsUI().discoverAllFeatureData();
 399       }
 400       alignPanel.paintAlignment(true);
 401     }
 402
 403     return featuresFile;
 404
 405   }
 406
 407   @Override
 408   public boolean markHighlightedColumns(boolean invert,
 409           boolean extendCurrent, boolean toggle)
 410   {
 411     if (!viewport.hasSearchResults())
 412     {
 413       // do nothing if no selection exists
 414       return false;
 415     }
 416     // JBPNote this routine could also mark rows, not just columns.
 417     BitSet bs = new BitSet();
 418     SequenceCollectionI sqcol = (viewport.getSelectionGroup() == null || extendCurrent) ? viewport
 419             .getAlignment() : viewport.getSelectionGroup();
 420
 421     // this could be a lambda... - the remains of the method is boilerplate,
 422     // except for the different messages for reporting selection.
 423     int nseq = viewport.getSearchResults().markColumns(sqcol, bs);
 424
 425     ColumnSelection cs = viewport.getColumnSelection();
 426     if (cs == null)
 427     {
 428       cs = new ColumnSelection();
 429     }
 430
 431     if (bs.cardinality() > 0 || invert)
 432     {
 433       boolean changed = cs.markColumns(bs, sqcol.getStartRes(),
 434               sqcol.getEndRes(), invert, extendCurrent, toggle);
 435       if (changed)
 436       {
 437         viewport.setColumnSelection(cs);
 438         alignPanel.paintAlignment(true);
 439         int columnCount = invert ? (sqcol.getEndRes() - sqcol.getStartRes() + 1)
 440                 - bs.cardinality()
 441                 : bs.cardinality();
 442         avcg.setStatus(MessageManager.formatMessage(
 443                 "label.view_controller_toggled_marked",
 444                 new String[] {
 445                     toggle ? MessageManager.getString("label.toggled")
 446                             : MessageManager.getString("label.marked"),
 447                     String.valueOf(columnCount),
 448                     invert ? MessageManager
 449                             .getString("label.not_containing")
 450                             : MessageManager.getString("label.containing"),
 451                     "Highlight", Integer.valueOf(nseq).toString() }));
 452         return true;
 453       }
 454     }
 455     else
 456     {
 457       avcg.setStatus(MessageManager
 458               .formatMessage("No highlighted regions marked"));
 459       if (!extendCurrent)
 460       {
 461         cs.clear();
 462         alignPanel.paintAlignment(true);
 463       }
 464     }
 465     return false;
 466   }
 467
 468 }