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