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.FeaturesFile;
  37 import jalview.util.MessageManager;
  38
  39 import java.awt.Color;
  40 import java.util.BitSet;
  41 import java.util.List;
  42
  43 public class AlignViewController implements AlignViewControllerI
  44 {
  45   AlignViewportI viewport = null;
  46
  47   AlignmentViewPanel alignPanel = null;
  48
  49   /**
  50    * the GUI container that is handling interactions with the user
  51    */
  52   private AlignViewControllerGuiI avcg;
  53
  54   @Override
  55   protected void finalize() throws Throwable
  56   {
  57     viewport = null;
  58     alignPanel = null;
  59     avcg = null;
  60   };
  61
  62   public AlignViewController(AlignViewControllerGuiI alignFrame,
  63           AlignViewportI viewport, AlignmentViewPanel alignPanel)
  64   {
  65     this.avcg = alignFrame;
  66     this.viewport = viewport;
  67     this.alignPanel = alignPanel;
  68   }
  69
  70   @Override
  71   public void setViewportAndAlignmentPanel(AlignViewportI viewport,
  72           AlignmentViewPanel alignPanel)
  73   {
  74     this.alignPanel = alignPanel;
  75     this.viewport = viewport;
  76
  77   }
  78
  79   @Override
  80   public boolean makeGroupsFromSelection()
  81   {
  82     SequenceGroup sg = viewport.getSelectionGroup();
  83     ColumnSelection cs = viewport.getColumnSelection();
  84     SequenceGroup[] gps = null;
  85     if (sg != null && (cs == null || cs.isEmpty()))
  86     {
  87       gps = jalview.analysis.Grouping.makeGroupsFrom(viewport
  88               .getSequenceSelection(), viewport.getAlignmentView(true)
  89               .getSequenceStrings(viewport.getGapCharacter()), viewport
  90               .getAlignment().getGroups());
  91     }
  92     else
  93     {
  94       if (cs != null)
  95       {
  96         gps = jalview.analysis.Grouping.makeGroupsFromCols(
  97                 (sg == null) ? viewport.getAlignment().getSequencesArray()
  98                         : sg.getSequences().toArray(new SequenceI[0]), cs,
  99                 viewport.getAlignment().getGroups());
 100       }
 101     }
 102     if (gps != null)
 103     {
 104       viewport.getAlignment().deleteAllGroups();
 105       viewport.clearSequenceColours();
 106       viewport.setSelectionGroup(null);
 107       // set view properties for each group
 108       for (int g = 0; g < gps.length; g++)
 109       {
 110         // gps[g].setShowunconserved(viewport.getShowUnconserved());
 111         gps[g].setshowSequenceLogo(viewport.isShowSequenceLogo());
 112         viewport.getAlignment().addGroup(gps[g]);
 113         Color col = new Color((int) (Math.random() * 255),
 114                 (int) (Math.random() * 255), (int) (Math.random() * 255));
 115         col = col.brighter();
 116         for (SequenceI sq : gps[g].getSequences(null))
 117         {
 118           viewport.setSequenceColour(sq, col);
 119         }
 120       }
 121       return true;
 122     }
 123     return false;
 124   }
 125
 126   @Override
 127   public boolean createGroup()
 128   {
 129
 130     SequenceGroup sg = viewport.getSelectionGroup();
 131     if (sg != null)
 132     {
 133       viewport.getAlignment().addGroup(sg);
 134       return true;
 135     }
 136     return false;
 137   }
 138
 139   @Override
 140   public boolean unGroup()
 141   {
 142     SequenceGroup sg = viewport.getSelectionGroup();
 143     if (sg != null)
 144     {
 145       viewport.getAlignment().deleteGroup(sg);
 146       return true;
 147     }
 148     return false;
 149   }
 150
 151   @Override
 152   public boolean deleteGroups()
 153   {
 154     if (viewport.getAlignment().getGroups() != null
 155             && viewport.getAlignment().getGroups().size() > 0)
 156     {
 157       viewport.getAlignment().deleteAllGroups();
 158       viewport.clearSequenceColours();
 159       viewport.setSelectionGroup(null);
 160       return true;
 161     }
 162     return false;
 163   }
 164
 165   @Override
 166   public boolean markColumnsContainingFeatures(boolean invert,
 167           boolean extendCurrent, boolean toggle, String featureType)
 168   {
 169     // JBPNote this routine could also mark rows, not just columns.
 170     // need a decent query structure to allow all types of feature searches
 171     BitSet bs = new BitSet();
 172     int alw, alStart;
 173     SequenceCollectionI sqcol = (viewport.getSelectionGroup() == null ? viewport
 174             .getAlignment() : viewport.getSelectionGroup());
 175     alStart = sqcol.getStartRes();
 176     alw = sqcol.getEndRes() + 1;
 177     List<SequenceI> seqs = sqcol.getSequences();
 178     int nseq = 0;
 179     for (SequenceI sq : seqs)
 180     {
 181       int tfeat = 0;
 182       if (sq != null)
 183       {
 184         SequenceFeature[] sf = sq.getSequenceFeatures();
 185         if (sf != null)
 186         {
 187           int ist = sq.findIndex(sq.getStart());
 188           int iend = sq.findIndex(sq.getEnd());
 189           if (iend < alStart || ist > alw)
 190           {
 191             // sequence not in region
 192             continue;
 193           }
 194           for (SequenceFeature sfpos : sf)
 195           {
 196             // future functionalty - featureType == null means mark columns
 197             // containing all displayed features
 198             if (sfpos != null && (featureType.equals(sfpos.getType())))
 199             {
 200               tfeat++;
 201               // optimisation - could consider 'spos,apos' like cursor argument
 202               // - findIndex wastes time by starting from first character and
 203               // counting
 204
 205               int i = sq.findIndex(sfpos.getBegin());
 206               int j = sq.findIndex(sfpos.getEnd());
 207               if (j < alStart || i > alw)
 208               {
 209                 // feature is outside selected region
 210                 continue;
 211               }
 212               if (i < alStart)
 213               {
 214                 i = alStart;
 215               }
 216               if (i < ist)
 217               {
 218                 i = ist;
 219               }
 220               if (j > alw)
 221               {
 222                 j = alw;
 223               }
 224               for (; i <= j; i++)
 225               {
 226                 bs.set(i - 1);
 227               }
 228             }
 229           }
 230         }
 231
 232         if (tfeat > 0)
 233         {
 234           nseq++;
 235         }
 236       }
 237     }
 238     ColumnSelection cs = viewport.getColumnSelection();
 239     if (bs.cardinality() > 0 || invert)
 240     {
 241       boolean changed = false;
 242       if (cs == null)
 243       {
 244         cs = new ColumnSelection();
 245       }
 246       else
 247       {
 248         if (!extendCurrent)
 249         {
 250           changed = !cs.isEmpty();
 251           cs.clear();
 252         }
 253       }
 254       if (invert)
 255       {
 256         // invert only in the currently selected sequence region
 257         for (int i = bs.nextClearBit(alStart), ibs = bs.nextSetBit(alStart); i >= alStart
 258                 && i < (alw);)
 259         {
 260           if (ibs < 0 || i < ibs)
 261           {
 262             changed = true;
 263             if (toggle && cs.contains(i))
 264             {
 265               cs.removeElement(i++);
 266             }
 267             else
 268             {
 269               cs.addElement(i++);
 270             }
 271           }
 272           else
 273           {
 274             i = bs.nextClearBit(ibs);
 275             ibs = bs.nextSetBit(i);
 276           }
 277         }
 278       }
 279       else
 280       {
 281         for (int i = bs.nextSetBit(alStart); i >= alStart; i = bs
 282                 .nextSetBit(i + 1))
 283         {
 284           changed = true;
 285           if (toggle && cs.contains(i))
 286           {
 287             cs.removeElement(i);
 288           }
 289           else
 290           {
 291             cs.addElement(i);
 292           }
 293         }
 294       }
 295       if (changed)
 296       {
 297         viewport.setColumnSelection(cs);
 298         alignPanel.paintAlignment(true);
 299         avcg.setStatus(MessageManager.formatMessage(
 300                 "label.view_controller_toggled_marked",
 301                 new String[] {
 302                     MessageManager.getString(toggle ? "label.toggled"
 303                             : "label.marked"),
 304                     String.valueOf(invert ? alw - alStart
 305                             - bs.cardinality() : bs.cardinality()),
 306                     MessageManager
 307                             .getString(invert ? "label.not_containing"
 308                                     : "label.containing"),
 309                     featureType, Integer.valueOf(nseq).toString() }));
 310         return true;
 311       }
 312     }
 313     else
 314     {
 315       avcg.setStatus(MessageManager.formatMessage(
 316               "label.no_feature_of_type_found",
 317               new String[] { featureType }));
 318       if (!extendCurrent && cs != null)
 319       {
 320         cs.clear();
 321         alignPanel.paintAlignment(true);
 322       }
 323     }
 324     return false;
 325   }
 326
 327   @Override
 328   public void sortAlignmentByFeatureDensity(List<String> typ)
 329   {
 330     sortBy(typ, "Sort by Density", AlignmentSorter.FEATURE_DENSITY);
 331   }
 332
 333   protected void sortBy(List<String> typ, String methodText,
 334           final String method)
 335   {
 336     FeatureRenderer fr = alignPanel.getFeatureRenderer();
 337     if (typ == null && fr != null)
 338     {
 339       typ = fr.getDisplayedFeatureTypes();
 340     }
 341     List<String> gps = null;
 342     if (fr != null)
 343     {
 344       gps = fr.getDisplayedFeatureGroups();
 345     }
 346     AlignmentI al = viewport.getAlignment();
 347
 348     int start, stop;
 349     SequenceGroup sg = viewport.getSelectionGroup();
 350     if (sg != null)
 351     {
 352       start = sg.getStartRes();
 353       stop = sg.getEndRes();
 354     }
 355     else
 356     {
 357       start = 0;
 358       stop = al.getWidth();
 359     }
 360     SequenceI[] oldOrder = al.getSequencesArray();
 361     AlignmentSorter.sortByFeature(typ, gps, start, stop, al, method);
 362     avcg.addHistoryItem(new OrderCommand(methodText, oldOrder, viewport
 363             .getAlignment()));
 364     alignPanel.paintAlignment(true);
 365
 366   }
 367
 368   @Override
 369   public void sortAlignmentByFeatureScore(List<String> typ)
 370   {
 371     sortBy(typ, "Sort by Feature Score", AlignmentSorter.FEATURE_SCORE);
 372   }
 373
 374   @Override
 375   public boolean parseFeaturesFile(String file, String protocol,
 376           boolean relaxedIdMatching)
 377   {
 378     boolean featuresFile = false;
 379     try
 380     {
 381       featuresFile = new FeaturesFile(false, file, protocol).parse(viewport
 382               .getAlignment().getDataset(), alignPanel.getFeatureRenderer()
 383               .getFeatureColours(), false, relaxedIdMatching);
 384     } catch (Exception ex)
 385     {
 386       ex.printStackTrace();
 387     }
 388
 389     if (featuresFile)
 390     {
 391       avcg.refreshFeatureUI(true);
 392       if (alignPanel.getFeatureRenderer() != null)
 393       {
 394         // update the min/max ranges where necessary
 395         alignPanel.getFeatureRenderer().findAllFeatures(true);
 396       }
 397       if (avcg.getFeatureSettingsUI() != null)
 398       {
 399         avcg.getFeatureSettingsUI().discoverAllFeatureData();
 400       }
 401       alignPanel.paintAlignment(true);
 402     }
 403
 404     return featuresFile;
 405
 406   }
 407 }