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     boolean searchSelection = viewport.getSelectionGroup() != null
 170             && !extendCurrent;
 171     SequenceCollectionI sqcol = searchSelection
 172             ? viewport.getSelectionGroup()
 173             : viewport.getAlignment();
 174
 175     int nseq = findColumnsWithFeature(featureType, sqcol, bs);
 176
 177     ColumnSelection cs = viewport.getColumnSelection();
 178     if (cs == null)
 179     {
 180       cs = new ColumnSelection();
 181     }
 182
 183     if (bs.cardinality() > 0 || invert)
 184     {
 185       boolean changed = cs.markColumns(bs, sqcol.getStartRes(),
 186               sqcol.getEndRes(), invert, extendCurrent, toggle);
 187       if (changed)
 188       {
 189         viewport.setColumnSelection(cs);
 190         alignPanel.paintAlignment(false, false);
 191         int columnCount = invert
 192                 ? (sqcol.getEndRes() - sqcol.getStartRes() + 1)
 193                         - bs.cardinality()
 194                 : bs.cardinality();
 195         avcg.setStatus(MessageManager.formatMessage(
 196                 "label.view_controller_toggled_marked", new String[]
 197                 { toggle ? MessageManager.getString("label.toggled")
 198                         : MessageManager.getString("label.marked"),
 199                     String.valueOf(columnCount),
 200                     invert ? MessageManager
 201                             .getString("label.not_containing")
 202                             : MessageManager.getString("label.containing"),
 203                     featureType, Integer.valueOf(nseq).toString() }));
 204         return true;
 205       }
 206     }
 207     else
 208     {
 209       String key = searchSelection ? "label.no_feature_found_selection"
 210               : "label.no_feature_of_type_found";
 211       avcg.setStatus(
 212               MessageManager.formatMessage(key, new String[]
 213               { featureType }));
 214       if (!extendCurrent)
 215       {
 216         cs.clear();
 217         alignPanel.paintAlignment(false, false);
 218       }
 219     }
 220     return false;
 221   }
 222
 223   /**
 224    * Sets a bit in the BitSet for each column (base 0) in the sequence
 225    * collection which includes a visible feature of the specified feature type.
 226    * Returns the number of sequences which have the feature visible in the
 227    * selected range.
 228    *
 229    * @param featureType
 230    * @param sqcol
 231    * @param bs
 232    * @return
 233    */
 234   int findColumnsWithFeature(String featureType, SequenceCollectionI sqcol,
 235           BitSet bs)
 236   {
 237     FeatureRenderer fr = alignPanel == null ? null
 238             : alignPanel.getFeatureRenderer();
 239
 240     final int startColumn = sqcol.getStartRes() + 1; // converted to base 1
 241     final int endColumn = sqcol.getEndRes() + 1;
 242     List<SequenceI> seqs = sqcol.getSequences();
 243     int nseq = 0;
 244     for (SequenceI sq : seqs)
 245     {
 246       if (sq != null)
 247       {
 248         // int ist = sq.findPosition(sqcol.getStartRes());
 249         List<SequenceFeature> sfs = sq.findFeatures(startColumn, endColumn,
 250                 featureType);
 251
 252         boolean found = false;
 253         for (SequenceFeature sf : sfs)
 254         {
 255           if (fr.getColour(sf) == null)
 256           {
 257             continue;
 258           }
 259           if (!found)
 260           {
 261             nseq++;
 262           }
 263           found = true;
 264
 265           int sfStartCol = sq.findIndex(sf.getBegin());
 266           int sfEndCol = sq.findIndex(sf.getEnd());
 267
 268           if (sf.isContactFeature())
 269           {
 270             /*
 271              * 'contact' feature - check for 'start' or 'end'
 272              * position within the selected region
 273              */
 274             if (sfStartCol >= startColumn && sfStartCol <= endColumn)
 275             {
 276               bs.set(sfStartCol - 1);
 277             }
 278             if (sfEndCol >= startColumn && sfEndCol <= endColumn)
 279             {
 280               bs.set(sfEndCol - 1);
 281             }
 282             continue;
 283           }
 284
 285           /*
 286            * contiguous feature - select feature positions (if any)
 287            * within the selected region
 288            */
 289           if (sfStartCol < startColumn)
 290           {
 291             sfStartCol = startColumn;
 292           }
 293           // not sure what the point of this is
 294           // if (sfStartCol < ist)
 295           // {
 296           // sfStartCol = ist;
 297           // }
 298           if (sfEndCol > endColumn)
 299           {
 300             sfEndCol = endColumn;
 301           }
 302           for (; sfStartCol <= sfEndCol; sfStartCol++)
 303           {
 304             bs.set(sfStartCol - 1); // convert to base 0
 305           }
 306         }
 307       }
 308     }
 309     return nseq;
 310   }
 311
 312   @Override
 313   public void sortAlignmentByFeatureDensity(List<String> typ)
 314   {
 315     String methodText = MessageManager.getString("label.sort_by_density");
 316     sortByFeatures(typ, methodText, AlignmentSorter.FEATURE_DENSITY);
 317   }
 318
 319   /**
 320    * Sorts the alignment (or current selection) by either average score or
 321    * density of the specified feature types, and adds to the command history. If
 322    * {@code types} is null, all visible feature types are used for the sort. If
 323    * no feature types apply, does nothing.
 324    *
 325    * @param types
 326    * @param methodText
 327    *          - text shown in Undo/Redo command
 328    * @param method
 329    *          - passed to jalview.analysis.AlignmentSorter.sortByFeatures()
 330    */
 331   protected void sortByFeatures(List<String> types, String methodText,
 332           final String method)
 333   {
 334     FeatureRenderer fr = alignPanel.getFeatureRenderer();
 335     if (types == null && fr != null)
 336     {
 337       types = fr.getDisplayedFeatureTypes();
 338     }
 339     if (types.isEmpty())
 340     {
 341       return; // nothing to do
 342     }
 343     List<String> gps = null;
 344     if (fr != null)
 345     {
 346       gps = fr.getDisplayedFeatureGroups();
 347     }
 348     AlignmentI al = viewport.getAlignment();
 349
 350     int start, stop;
 351     SequenceGroup sg = viewport.getSelectionGroup();
 352     if (sg != null)
 353     {
 354       start = sg.getStartRes();
 355       stop = sg.getEndRes();
 356     }
 357     else
 358     {
 359       start = 0;
 360       stop = al.getWidth();
 361     }
 362     SequenceI[] oldOrder = al.getSequencesArray();
 363     AlignmentSorter.sortByFeature(types, gps, start, stop, al, method);
 364     avcg.addHistoryItem(new OrderCommand(methodText, oldOrder,
 365             viewport.getAlignment()));
 366     alignPanel.paintAlignment(true, false);
 367
 368   }
 369
 370   @Override
 371   public void sortAlignmentByFeatureScore(List<String> typ)
 372   {
 373     String methodText = MessageManager.getString("label.sort_by_score");
 374     sortByFeatures(typ, methodText, AlignmentSorter.FEATURE_SCORE);
 375   }
 376
 377   @Override
 378   public boolean parseFeaturesFile(Object file, DataSourceType protocol,
 379           boolean relaxedIdMatching)
 380   {
 381     boolean featuresAdded = false;
 382     FeatureRenderer fr = alignPanel.getFeatureRenderer();
 383     try
 384     {
 385       featuresAdded = new FeaturesFile(false, file, protocol).parse(
 386               viewport.getAlignment().getDataset(), fr.getFeatureColours(),
 387               fr.getFeatureFilters(), false, relaxedIdMatching);
 388     } catch (Exception ex)
 389     {
 390       ex.printStackTrace();
 391     }
 392
 393     if (featuresAdded)
 394     {
 395       avcg.refreshFeatureUI(true);
 396       if (fr != null)
 397       {
 398         // update the min/max ranges where necessary
 399         fr.findAllFeatures(true);
 400       }
 401       if (avcg.getFeatureSettingsUI() != null)
 402       {
 403         avcg.getFeatureSettingsUI().discoverAllFeatureData();
 404       }
 405       alignPanel.paintAlignment(true, true);
 406     }
 407
 408     return featuresAdded;
 409
 410   }
 411
 412   @Override
 413   public boolean markHighlightedColumns(boolean invert,
 414           boolean extendCurrent, boolean toggle)
 415   {
 416     if (!viewport.hasSearchResults())
 417     {
 418       // do nothing if no selection exists
 419       return false;
 420     }
 421     // JBPNote this routine could also mark rows, not just columns.
 422     BitSet bs = new BitSet();
 423     SequenceCollectionI sqcol = (viewport.getSelectionGroup() == null
 424             || extendCurrent) ? viewport.getAlignment()
 425                     : viewport.getSelectionGroup();
 426
 427     // this could be a lambda... - the remains of the method is boilerplate,
 428     // except for the different messages for reporting selection.
 429     int nseq = viewport.getSearchResults().markColumns(sqcol, bs);
 430
 431     ColumnSelection cs = viewport.getColumnSelection();
 432     if (cs == null)
 433     {
 434       cs = new ColumnSelection();
 435     }
 436
 437     if (bs.cardinality() > 0 || invert)
 438     {
 439       boolean changed = cs.markColumns(bs, sqcol.getStartRes(),
 440               sqcol.getEndRes(), invert, extendCurrent, toggle);
 441       if (changed)
 442       {
 443         viewport.setColumnSelection(cs);
 444         alignPanel.paintAlignment(false, false);
 445         int columnCount = invert
 446                 ? (sqcol.getEndRes() - sqcol.getStartRes() + 1)
 447                         - bs.cardinality()
 448                 : bs.cardinality();
 449         avcg.setStatus(MessageManager.formatMessage(
 450                 "label.view_controller_toggled_marked", new String[]
 451                 { toggle ? MessageManager.getString("label.toggled")
 452                         : MessageManager.getString("label.marked"),
 453                     String.valueOf(columnCount),
 454                     invert ? MessageManager
 455                             .getString("label.not_containing")
 456                             : MessageManager.getString("label.containing"),
 457                     "Highlight", Integer.valueOf(nseq).toString() }));
 458         return true;
 459       }
 460     }
 461     else
 462     {
 463       avcg.setStatus(MessageManager
 464               .getString("label.no_highlighted_regions_marked"));
 465       if (!extendCurrent)
 466       {
 467         cs.clear();
 468         alignPanel.paintAlignment(false, false);
 469       }
 470     }
 471     return false;
 472   }
 473
 474 }