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.ColorI;
  29 import jalview.api.FeatureRenderer;
  30 import jalview.commands.OrderCommand;
  31 import jalview.datamodel.AlignmentI;
  32 import jalview.datamodel.ColumnSelection;
  33 import jalview.datamodel.SequenceCollectionI;
  34 import jalview.datamodel.SequenceFeature;
  35 import jalview.datamodel.SequenceGroup;
  36 import jalview.datamodel.SequenceI;
  37 import jalview.io.FeaturesFile;
  38 import jalview.schemes.Colour;
  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   @Override
  57   protected void finalize() throws Throwable
  58   {
  59     viewport = null;
  60     alignPanel = null;
  61     avcg = null;
  62   };
  63
  64   public AlignViewController(AlignViewControllerGuiI alignFrame,
  65           AlignViewportI viewport, AlignmentViewPanel alignPanel)
  66   {
  67     this.avcg = alignFrame;
  68     this.viewport = viewport;
  69     this.alignPanel = alignPanel;
  70   }
  71
  72   @Override
  73   public void setViewportAndAlignmentPanel(AlignViewportI viewport,
  74           AlignmentViewPanel alignPanel)
  75   {
  76     this.alignPanel = alignPanel;
  77     this.viewport = viewport;
  78
  79   }
  80
  81   @Override
  82   public boolean makeGroupsFromSelection()
  83   {
  84     SequenceGroup sg = viewport.getSelectionGroup();
  85     ColumnSelection cs = viewport.getColumnSelection();
  86     SequenceGroup[] gps = null;
  87     if (sg != null && (cs == null || cs.isEmpty()))
  88     {
  89       gps = jalview.analysis.Grouping.makeGroupsFrom(viewport
  90               .getSequenceSelection(), viewport.getAlignmentView(true)
  91               .getSequenceStrings(viewport.getGapCharacter()), viewport
  92               .getAlignment().getGroups());
  93     }
  94     else
  95     {
  96       if (cs != null)
  97       {
  98         gps = jalview.analysis.Grouping.makeGroupsFromCols(
  99                 (sg == null) ? viewport.getAlignment().getSequencesArray()
 100                         : sg.getSequences().toArray(new SequenceI[0]), cs,
 101                 viewport.getAlignment().getGroups());
 102       }
 103     }
 104     if (gps != null)
 105     {
 106       viewport.getAlignment().deleteAllGroups();
 107       viewport.clearSequenceColours();
 108       viewport.setSelectionGroup(null);
 109       // set view properties for each group
 110       for (int g = 0; g < gps.length; g++)
 111       {
 112         // gps[g].setShowunconserved(viewport.getShowUnconserved());
 113         gps[g].setshowSequenceLogo(viewport.isShowSequenceLogo());
 114         viewport.getAlignment().addGroup(gps[g]);
 115         Color col = new Color((int) (Math.random() * 255),
 116                 (int) (Math.random() * 255), (int) (Math.random() * 255));
 117         ColorI newcol = new Colour(col.brighter());
 118         for (SequenceI sq : gps[g].getSequences(null))
 119         {
 120           viewport.setSequenceColour(sq, newcol);
 121         }
 122       }
 123       return true;
 124     }
 125     return false;
 126   }
 127
 128   @Override
 129   public boolean createGroup()
 130   {
 131
 132     SequenceGroup sg = viewport.getSelectionGroup();
 133     if (sg != null)
 134     {
 135       viewport.getAlignment().addGroup(sg);
 136       return true;
 137     }
 138     return false;
 139   }
 140
 141   @Override
 142   public boolean unGroup()
 143   {
 144     SequenceGroup sg = viewport.getSelectionGroup();
 145     if (sg != null)
 146     {
 147       viewport.getAlignment().deleteGroup(sg);
 148       return true;
 149     }
 150     return false;
 151   }
 152
 153   @Override
 154   public boolean deleteGroups()
 155   {
 156     if (viewport.getAlignment().getGroups() != null
 157             && viewport.getAlignment().getGroups().size() > 0)
 158     {
 159       viewport.getAlignment().deleteAllGroups();
 160       viewport.clearSequenceColours();
 161       viewport.setSelectionGroup(null);
 162       return true;
 163     }
 164     return false;
 165   }
 166
 167   @Override
 168   public boolean markColumnsContainingFeatures(boolean invert,
 169           boolean extendCurrent, boolean toggle, String featureType)
 170   {
 171     // JBPNote this routine could also mark rows, not just columns.
 172     // need a decent query structure to allow all types of feature searches
 173     BitSet bs = new BitSet();
 174     int alw, alStart;
 175     SequenceCollectionI sqcol = (viewport.getSelectionGroup() == null ? viewport
 176             .getAlignment() : viewport.getSelectionGroup());
 177     alStart = sqcol.getStartRes();
 178     alw = sqcol.getEndRes() + 1;
 179     List<SequenceI> seqs = sqcol.getSequences();
 180     int nseq = 0;
 181     for (SequenceI sq : seqs)
 182     {
 183       int tfeat = 0;
 184       if (sq != null)
 185       {
 186         SequenceFeature[] sf = sq.getSequenceFeatures();
 187         if (sf != null)
 188         {
 189           int ist = sq.findIndex(sq.getStart());
 190           int iend = sq.findIndex(sq.getEnd());
 191           if (iend < alStart || ist > alw)
 192           {
 193             // sequence not in region
 194             continue;
 195           }
 196           for (SequenceFeature sfpos : sf)
 197           {
 198             // future functionalty - featureType == null means mark columns
 199             // containing all displayed features
 200             if (sfpos != null && (featureType.equals(sfpos.getType())))
 201             {
 202               tfeat++;
 203               // optimisation - could consider 'spos,apos' like cursor argument
 204               // - findIndex wastes time by starting from first character and
 205               // counting
 206
 207               int i = sq.findIndex(sfpos.getBegin());
 208               int j = sq.findIndex(sfpos.getEnd());
 209               if (j < alStart || i > alw)
 210               {
 211                 // feature is outside selected region
 212                 continue;
 213               }
 214               if (i < alStart)
 215               {
 216                 i = alStart;
 217               }
 218               if (i < ist)
 219               {
 220                 i = ist;
 221               }
 222               if (j > alw)
 223               {
 224                 j = alw;
 225               }
 226               for (; i <= j; i++)
 227               {
 228                 bs.set(i - 1);
 229               }
 230             }
 231           }
 232         }
 233
 234         if (tfeat > 0)
 235         {
 236           nseq++;
 237         }
 238       }
 239     }
 240     ColumnSelection cs = viewport.getColumnSelection();
 241     if (bs.cardinality() > 0 || invert)
 242     {
 243       boolean changed = false;
 244       if (cs == null)
 245       {
 246         cs = new ColumnSelection();
 247       }
 248       else
 249       {
 250         if (!extendCurrent)
 251         {
 252           changed = !cs.isEmpty();
 253           cs.clear();
 254         }
 255       }
 256       if (invert)
 257       {
 258         // invert only in the currently selected sequence region
 259         for (int i = bs.nextClearBit(alStart), ibs = bs.nextSetBit(alStart); i >= alStart
 260                 && i < (alw);)
 261         {
 262           if (ibs < 0 || i < ibs)
 263           {
 264             changed = true;
 265             if (toggle && cs.contains(i))
 266             {
 267               cs.removeElement(i++);
 268             }
 269             else
 270             {
 271               cs.addElement(i++);
 272             }
 273           }
 274           else
 275           {
 276             i = bs.nextClearBit(ibs);
 277             ibs = bs.nextSetBit(i);
 278           }
 279         }
 280       }
 281       else
 282       {
 283         for (int i = bs.nextSetBit(alStart); i >= alStart; i = bs
 284                 .nextSetBit(i + 1))
 285         {
 286           changed = true;
 287           if (toggle && cs.contains(i))
 288           {
 289             cs.removeElement(i);
 290           }
 291           else
 292           {
 293             cs.addElement(i);
 294           }
 295         }
 296       }
 297       if (changed)
 298       {
 299         viewport.setColumnSelection(cs);
 300         alignPanel.paintAlignment(true);
 301         avcg.setStatus(MessageManager.formatMessage(
 302                 "label.view_controller_toggled_marked",
 303                 new String[] {
 304                     (toggle ? MessageManager.getString("label.toggled")
 305                             : MessageManager.getString("label.marked")),
 306                     (invert ? (Integer.valueOf((alw - alStart)
 307                             - bs.cardinality()).toString()) : (Integer
 308                             .valueOf(bs.cardinality()).toString())),
 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 }