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