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                 viewport.getAlignment().getHiddenColumns());
  95       }
  96     }
  97     if (gps != null)
  98     {
  99       viewport.getAlignment().deleteAllGroups();
 100       viewport.clearSequenceColours();
 101       viewport.setSelectionGroup(null);
 102       ColourSchemeI colours = viewport.getGlobalColourScheme();
 103       // set view properties for each group
 104       for (int g = 0; g < gps.length; g++)
 105       {
 106         // gps[g].setShowunconserved(viewport.getShowUnconserved());
 107         gps[g].setshowSequenceLogo(viewport.isShowSequenceLogo());
 108         viewport.getAlignment().addGroup(gps[g]);
 109         if (colours != null)
 110         {
 111           gps[g].setColourScheme(colours.getInstance(viewport, gps[g]));
 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     boolean searchSelection = viewport.getSelectionGroup() != null
 171             && !extendCurrent;
 172     SequenceCollectionI sqcol = searchSelection ? viewport
 173             .getSelectionGroup() : 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(MessageManager.formatMessage(key,
 212               new String[] { featureType }));
 213       if (!extendCurrent)
 214       {
 215         cs.clear();
 216         alignPanel.paintAlignment(false, false);
 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 a visible feature of the specified feature type.
 225    * Returns the number of sequences which have the feature visible in the
 226    * selected range.
 227    *
 228    * @param featureType
 229    * @param sqcol
 230    * @param bs
 231    * @return
 232    */
 233   int findColumnsWithFeature(String featureType,
 234           SequenceCollectionI sqcol, BitSet bs)
 235   {
 236     FeatureRenderer fr = alignPanel == null ? null : alignPanel
 237             .getFeatureRenderer();
 238
 239     final int startColumn = sqcol.getStartRes() + 1; // converted to base 1
 240     final int endColumn = sqcol.getEndRes() + 1;
 241     List<SequenceI> seqs = sqcol.getSequences();
 242     int nseq = 0;
 243     for (SequenceI sq : seqs)
 244     {
 245       if (sq != null)
 246       {
 247         // int ist = sq.findPosition(sqcol.getStartRes());
 248         List<SequenceFeature> sfs = sq.findFeatures(startColumn,
 249                 endColumn, featureType);
 250
 251         boolean found = false;
 252         for (SequenceFeature sf : sfs)
 253         {
 254           if (fr.getColour(sf) == null)
 255           {
 256             continue;
 257           }
 258           if (!found)
 259           {
 260             nseq++;
 261           }
 262           found = true;
 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 >= startColumn && sfStartCol <= endColumn)
 274             {
 275               bs.set(sfStartCol - 1);
 276             }
 277             if (sfEndCol >= startColumn && sfEndCol <= endColumn)
 278             {
 279               bs.set(sfEndCol - 1);
 280             }
 281             continue;
 282           }
 283
 284           /*
 285            * contiguous feature - select feature positions (if any)
 286            * within the selected region
 287            */
 288           if (sfStartCol < startColumn)
 289           {
 290             sfStartCol = startColumn;
 291           }
 292           // not sure what the point of this is
 293           // if (sfStartCol < ist)
 294           // {
 295           // sfStartCol = ist;
 296           // }
 297           if (sfEndCol > endColumn)
 298           {
 299             sfEndCol = endColumn;
 300           }
 301           for (; sfStartCol <= sfEndCol; sfStartCol++)
 302           {
 303             bs.set(sfStartCol - 1); // convert to base 0
 304           }
 305         }
 306       }
 307     }
 308     return nseq;
 309   }
 310
 311   @Override
 312   public void sortAlignmentByFeatureDensity(List<String> typ)
 313   {
 314     String methodText = MessageManager.getString("label.sort_by_density");
 315     sortByFeatures(typ, methodText, AlignmentSorter.FEATURE_DENSITY);
 316   }
 317
 318   /**
 319    * Sorts the alignment (or current selection) by either average score or density
 320    * of the specified feature types, and adds to the command history. If
 321    * {@code types} is null, all visible feature types are used for the sort. If no
 322    * feature types apply, does nothing.
 323    *
 324    * @param types
 325    * @param methodText
 326    *                     - text shown in Undo/Redo command
 327    * @param method
 328    *                     - passed to
 329    *                     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(String 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               .formatMessage("No highlighted regions marked"));
 465       if (!extendCurrent)
 466       {
 467         cs.clear();
 468         alignPanel.paintAlignment(false, false);
 469       }
 470     }
 471     return false;
 472   }
 473
 474 }