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.analysis.Grouping;
  25 import jalview.api.AlignViewControllerGuiI;
  26 import jalview.api.AlignViewControllerI;
  27 import jalview.api.AlignViewportI;
  28 import jalview.api.AlignmentViewPanel;
  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.util.MessageManager;
  39
  40 import java.awt.Color;
  41 import java.util.ArrayList;
  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
  88             && (cs == null || cs.getSelected() == null || cs.size() == 0))
  89     {
  90       gps = Grouping.makeGroupsFrom(
  91               viewport.getSequenceSelection(),
  92               viewport.getAlignmentView(true).getSequenceStrings(
  93                       viewport.getGapCharacter()), viewport.getAlignment()
  94                       .getGroups());
  95     } else {
  96       if (cs!=null) {
  97         gps = 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       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       if (cs == null)
 242       {
 243         cs = new ColumnSelection();
 244       }
 245       else
 246       {
 247         if (!extendCurrent)
 248         {
 249           cs.clear();
 250         }
 251       }
 252       if (invert)
 253       {
 254         // invert only in the currently selected sequence region
 255         for (int i = bs.nextClearBit(alStart), ibs = bs.nextSetBit(alStart); i >= alStart
 256                 && i < (alw);)
 257         {
 258           if (ibs < 0 || i < ibs)
 259           {
 260             if (toggle && cs.contains(i))
 261             {
 262               cs.removeElement(i++);
 263             }
 264             else
 265             {
 266               cs.addElement(i++);
 267             }
 268           }
 269           else
 270           {
 271             i = bs.nextClearBit(ibs);
 272             ibs = bs.nextSetBit(i);
 273           }
 274         }
 275       }
 276       else
 277       {
 278         for (int i = bs.nextSetBit(alStart); i >= alStart; i = bs
 279                 .nextSetBit(i + 1))
 280         {
 281           if (toggle && cs.contains(i))
 282           {
 283             cs.removeElement(i);
 284           }
 285           else
 286           {
 287             cs.addElement(i);
 288           }
 289         }
 290       }
 291       viewport.setColumnSelection(cs);
 292       alignPanel.paintAlignment(true);
 293       avcg.setStatus(MessageManager.formatMessage("label.view_controller_toggled_marked",
 294                   new String[]{
 295                                 (toggle ? MessageManager.getString("label.toggled") : MessageManager.getString("label.marked")),
 296                                 (invert ? (Integer.valueOf((alw - alStart) - bs.cardinality()).toString()):(Integer.valueOf(bs.cardinality()).toString())),
 297                                 featureType, Integer.valueOf(nseq).toString()
 298                         }));
 299       return true;
 300     }
 301     else
 302     {
 303       avcg.setStatus(MessageManager.formatMessage("label.no_feature_of_type_found", new String[]{featureType}));
 304       if (!extendCurrent && cs != null)
 305       {
 306         cs.clear();
 307         alignPanel.paintAlignment(true);
 308       }
 309       return false;
 310     }
 311   }
 312
 313
 314
 315   @Override
 316   public void sortAlignmentByFeatureDensity(String[] typ)
 317   {
 318     sortBy(typ, "Sort by Density", AlignmentSorter.FEATURE_DENSITY);
 319   }
 320
 321   protected void sortBy(String[] typ, String methodText, final String method)
 322   {
 323     FeatureRenderer fr = alignPanel.getFeatureRenderer();
 324     if (typ == null)
 325     {
 326       typ = fr==null ? null : fr.getDisplayedFeatureTypes();
 327     }
 328     String gps[] = null;
 329     gps = fr==null ? null : fr.getDisplayedFeatureGroups();
 330     if (typ != null)
 331     {
 332       ArrayList types = new ArrayList();
 333       for (int i = 0; i < typ.length; i++)
 334       {
 335         if (typ[i] != null)
 336         {
 337           types.add(typ[i]);
 338         }
 339         typ = new String[types.size()];
 340         types.toArray(typ);
 341       }
 342     }
 343     if (gps != null)
 344     {
 345       ArrayList grps = new ArrayList();
 346
 347       for (int i = 0; i < gps.length; i++)
 348       {
 349         if (gps[i] != null)
 350         {
 351           grps.add(gps[i]);
 352         }
 353       }
 354       gps = new String[grps.size()];
 355       grps.toArray(gps);
 356     }
 357     AlignmentI al = viewport.getAlignment();
 358
 359     int start, stop;
 360     SequenceGroup sg = viewport.getSelectionGroup();
 361     if (sg != null)
 362     {
 363       start = sg.getStartRes();
 364       stop = sg.getEndRes();
 365     }
 366     else
 367     {
 368       start = 0;
 369       stop = al.getWidth();
 370     }
 371     SequenceI[] oldOrder = al.getSequencesArray();
 372     AlignmentSorter.sortByFeature(typ, gps, start, stop, al, method);
 373     avcg.addHistoryItem(new OrderCommand(methodText, oldOrder, viewport
 374             .getAlignment()));
 375     alignPanel.paintAlignment(true);
 376
 377   }
 378
 379   @Override
 380   public void sortAlignmentByFeatureScore(String[] typ)
 381   {
 382     sortBy(typ, "Sort by Feature Score", AlignmentSorter.FEATURE_SCORE);
 383   }
 384
 385   @Override
 386   public boolean parseFeaturesFile(String file, String protocol,
 387           boolean relaxedIdMatching)
 388   {
 389     boolean featuresFile = false;
 390     try
 391     {
 392       featuresFile = new FeaturesFile(file, protocol).parse(viewport
 393               .getAlignment().getDataset(), alignPanel.getFeatureRenderer()
 394               .getFeatureColours(), false, relaxedIdMatching);
 395     } catch (Exception ex)
 396     {
 397       ex.printStackTrace();
 398     }
 399
 400     if (featuresFile)
 401     {
 402       avcg.refreshFeatureUI(true);
 403       if (alignPanel.getFeatureRenderer() != null)
 404       {
 405         // update the min/max ranges where necessary
 406         alignPanel.getFeatureRenderer().findAllFeatures(true);
 407       }
 408       if (avcg.getFeatureSettingsUI() != null)
 409       {
 410         avcg.getFeatureSettingsUI().discoverAllFeatureData();
 411       }
 412       alignPanel.paintAlignment(true);
 413     }
 414
 415     return featuresFile;
 416
 417   }
 418 }