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         }
 112         Color col = new Color((int) (Math.random() * 255),
 113                 (int) (Math.random() * 255), (int) (Math.random() * 255));
 114         gps[g].idColour = col;
 115         viewport.setUpdateStructures(true);
 116         viewport.addSequenceGroup(gps[g]);
 117       }
 118       return true;
 119     }
 120     return false;
 121   }
 122
 123   @Override
 124   public boolean createGroup()
 125   {
 126
 127     SequenceGroup sg = viewport.getSelectionGroup();
 128     if (sg != null)
 129     {
 130       viewport.getAlignment().addGroup(sg);
 131       return true;
 132     }
 133     return false;
 134   }
 135
 136   @Override
 137   public boolean unGroup()
 138   {
 139     SequenceGroup sg = viewport.getSelectionGroup();
 140     if (sg != null)
 141     {
 142       viewport.getAlignment().deleteGroup(sg);
 143       return true;
 144     }
 145     return false;
 146   }
 147
 148   @Override
 149   public boolean deleteGroups()
 150   {
 151     if (viewport.getAlignment().getGroups() != null
 152             && viewport.getAlignment().getGroups().size() > 0)
 153     {
 154       viewport.getAlignment().deleteAllGroups();
 155       viewport.clearSequenceColours();
 156       viewport.setSelectionGroup(null);
 157       return true;
 158     }
 159     return false;
 160   }
 161
 162   @Override
 163   public boolean markColumnsContainingFeatures(boolean invert,
 164           boolean extendCurrent, boolean toggle, String featureType)
 165   {
 166     // JBPNote this routine could also mark rows, not just columns.
 167     // need a decent query structure to allow all types of feature searches
 168     BitSet bs = new BitSet();
 169     SequenceCollectionI sqcol = (viewport.getSelectionGroup() == null
 170             || extendCurrent) ? viewport.getAlignment()
 171                     : viewport.getSelectionGroup();
 172
 173     int nseq = findColumnsWithFeature(featureType, sqcol, bs);
 174
 175     ColumnSelection cs = viewport.getColumnSelection();
 176     if (cs == null)
 177     {
 178       cs = new ColumnSelection();
 179     }
 180
 181     if (bs.cardinality() > 0 || invert)
 182     {
 183       boolean changed = cs.markColumns(bs, sqcol.getStartRes(),
 184               sqcol.getEndRes(), invert, extendCurrent, toggle);
 185       if (changed)
 186       {
 187         viewport.setColumnSelection(cs);
 188         alignPanel.paintAlignment(false, false);
 189         int columnCount = invert
 190                 ? (sqcol.getEndRes() - sqcol.getStartRes() + 1)
 191                         - bs.cardinality()
 192                 : bs.cardinality();
 193         avcg.setStatus(MessageManager.formatMessage(
 194                 "label.view_controller_toggled_marked", new String[]
 195                 { toggle ? MessageManager.getString("label.toggled")
 196                         : MessageManager.getString("label.marked"),
 197                     String.valueOf(columnCount),
 198                     invert ? MessageManager
 199                             .getString("label.not_containing")
 200                             : MessageManager.getString("label.containing"),
 201                     featureType, Integer.valueOf(nseq).toString() }));
 202         return true;
 203       }
 204     }
 205     else
 206     {
 207       avcg.setStatus(MessageManager
 208               .formatMessage("label.no_feature_of_type_found", new String[]
 209               { featureType }));
 210       if (!extendCurrent)
 211       {
 212         cs.clear();
 213         alignPanel.paintAlignment(false, false);
 214       }
 215     }
 216     return false;
 217   }
 218
 219   /**
 220    * Sets a bit in the BitSet for each column (base 0) in the sequence
 221    * collection which includes a visible feature of the specified feature type.
 222    * Returns the number of sequences which have the feature visible in the
 223    * selected range.
 224    *
 225    * @param featureType
 226    * @param sqcol
 227    * @param bs
 228    * @return
 229    */
 230   int findColumnsWithFeature(String featureType,
 231           SequenceCollectionI sqcol, BitSet bs)
 232   {
 233     FeatureRenderer fr = alignPanel == null ? null : alignPanel
 234             .getFeatureRenderer();
 235
 236     final int startColumn = sqcol.getStartRes() + 1; // converted to base 1
 237     final int endColumn = sqcol.getEndRes() + 1;
 238     List<SequenceI> seqs = sqcol.getSequences();
 239     int nseq = 0;
 240     for (SequenceI sq : seqs)
 241     {
 242       if (sq != null)
 243       {
 244         // int ist = sq.findPosition(sqcol.getStartRes());
 245         List<SequenceFeature> sfs = sq.findFeatures(startColumn,
 246                 endColumn, featureType);
 247
 248         boolean found = false;
 249         for (SequenceFeature sf : sfs)
 250         {
 251           if (fr.getColour(sf) == null)
 252           {
 253             continue;
 254           }
 255           if (!found)
 256           {
 257             nseq++;
 258           }
 259           found = true;
 260
 261           int sfStartCol = sq.findIndex(sf.getBegin());
 262           int sfEndCol = sq.findIndex(sf.getEnd());
 263
 264           if (sf.isContactFeature())
 265           {
 266             /*
 267              * 'contact' feature - check for 'start' or 'end'
 268              * position within the selected region
 269              */
 270             if (sfStartCol >= startColumn && sfStartCol <= endColumn)
 271             {
 272               bs.set(sfStartCol - 1);
 273             }
 274             if (sfEndCol >= startColumn && sfEndCol <= endColumn)
 275             {
 276               bs.set(sfEndCol - 1);
 277             }
 278             continue;
 279           }
 280
 281           /*
 282            * contiguous feature - select feature positions (if any)
 283            * within the selected region
 284            */
 285           if (sfStartCol < startColumn)
 286           {
 287             sfStartCol = startColumn;
 288           }
 289           // not sure what the point of this is
 290           // if (sfStartCol < ist)
 291           // {
 292           // sfStartCol = ist;
 293           // }
 294           if (sfEndCol > endColumn)
 295           {
 296             sfEndCol = endColumn;
 297           }
 298           for (; sfStartCol <= sfEndCol; sfStartCol++)
 299           {
 300             bs.set(sfStartCol - 1); // convert to base 0
 301           }
 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,
 344             viewport.getAlignment()));
 345     alignPanel.paintAlignment(true, false);
 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(Object file, DataSourceType protocol,
 357           boolean relaxedIdMatching)
 358   {
 359     boolean featuresAdded = false;
 360     FeatureRenderer fr = alignPanel.getFeatureRenderer();
 361     try
 362     {
 363       featuresAdded = new FeaturesFile(false, file, protocol).parse(
 364               viewport.getAlignment().getDataset(), fr.getFeatureColours(),
 365               fr.getFeatureFilters(), false, relaxedIdMatching);
 366     } catch (Exception ex)
 367     {
 368       ex.printStackTrace();
 369     }
 370
 371     if (featuresAdded)
 372     {
 373       avcg.refreshFeatureUI(true);
 374       if (fr != null)
 375       {
 376         // update the min/max ranges where necessary
 377         fr.findAllFeatures(true);
 378       }
 379       if (avcg.getFeatureSettingsUI() != null)
 380       {
 381         avcg.getFeatureSettingsUI().discoverAllFeatureData();
 382       }
 383       alignPanel.paintAlignment(true, true);
 384     }
 385
 386     return featuresAdded;
 387
 388   }
 389
 390   @Override
 391   public boolean markHighlightedColumns(boolean invert,
 392           boolean extendCurrent, boolean toggle)
 393   {
 394     if (!viewport.hasSearchResults())
 395     {
 396       // do nothing if no selection exists
 397       return false;
 398     }
 399     // JBPNote this routine could also mark rows, not just columns.
 400     BitSet bs = new BitSet();
 401     SequenceCollectionI sqcol = (viewport.getSelectionGroup() == null
 402             || extendCurrent) ? viewport.getAlignment()
 403                     : viewport.getSelectionGroup();
 404
 405     // this could be a lambda... - the remains of the method is boilerplate,
 406     // except for the different messages for reporting selection.
 407     int nseq = viewport.getSearchResults().markColumns(sqcol, bs);
 408
 409     ColumnSelection cs = viewport.getColumnSelection();
 410     if (cs == null)
 411     {
 412       cs = new ColumnSelection();
 413     }
 414
 415     if (bs.cardinality() > 0 || invert)
 416     {
 417       boolean changed = cs.markColumns(bs, sqcol.getStartRes(),
 418               sqcol.getEndRes(), invert, extendCurrent, toggle);
 419       if (changed)
 420       {
 421         viewport.setColumnSelection(cs);
 422         alignPanel.paintAlignment(false, false);
 423         int columnCount = invert
 424                 ? (sqcol.getEndRes() - sqcol.getStartRes() + 1)
 425                         - bs.cardinality()
 426                 : bs.cardinality();
 427         avcg.setStatus(MessageManager.formatMessage(
 428                 "label.view_controller_toggled_marked", new String[]
 429                 { toggle ? MessageManager.getString("label.toggled")
 430                         : MessageManager.getString("label.marked"),
 431                     String.valueOf(columnCount),
 432                     invert ? MessageManager
 433                             .getString("label.not_containing")
 434                             : MessageManager.getString("label.containing"),
 435                     "Highlight", Integer.valueOf(nseq).toString() }));
 436         return true;
 437       }
 438     }
 439     else
 440     {
 441       avcg.setStatus(MessageManager
 442               .formatMessage("No highlighted regions marked"));
 443       if (!extendCurrent)
 444       {
 445         cs.clear();
 446         alignPanel.paintAlignment(false, false);
 447       }
 448     }
 449     return false;
 450   }
 451
 452 }