src/jalview/viewmodel/AlignmentViewport.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.viewmodel;
  22
  23 import jalview.analysis.AnnotationSorter.SequenceAnnotationOrder;
  24 import jalview.analysis.Conservation;
  25 import jalview.api.AlignCalcManagerI;
  26 import jalview.api.AlignViewportI;
  27 import jalview.api.AlignmentViewPanel;
  28 import jalview.api.FeaturesDisplayedI;
  29 import jalview.api.ViewStyleI;
  30 import jalview.commands.CommandI;
  31 import jalview.datamodel.AlignedCodonFrame;
  32 import jalview.datamodel.AlignmentAnnotation;
  33 import jalview.datamodel.AlignmentI;
  34 import jalview.datamodel.AlignmentView;
  35 import jalview.datamodel.Annotation;
  36 import jalview.datamodel.CigarArray;
  37 import jalview.datamodel.ColumnSelection;
  38 import jalview.datamodel.HiddenSequences;
  39 import jalview.datamodel.SearchResults;
  40 import jalview.datamodel.Sequence;
  41 import jalview.datamodel.SequenceCollectionI;
  42 import jalview.datamodel.SequenceGroup;
  43 import jalview.datamodel.SequenceI;
  44 import jalview.schemes.Blosum62ColourScheme;
  45 import jalview.schemes.ColourSchemeI;
  46 import jalview.schemes.PIDColourScheme;
  47 import jalview.schemes.ResidueProperties;
  48 import jalview.structure.CommandListener;
  49 import jalview.structure.StructureSelectionManager;
  50 import jalview.structure.VamsasSource;
  51 import jalview.util.Comparison;
  52 import jalview.util.MappingUtils;
  53 import jalview.viewmodel.styles.ViewStyle;
  54 import jalview.workers.AlignCalcManager;
  55 import jalview.workers.ComplementConsensusThread;
  56 import jalview.workers.ConsensusThread;
  57 import jalview.workers.StrucConsensusThread;
  58
  59 import java.awt.Color;
  60 import java.util.ArrayDeque;
  61 import java.util.ArrayList;
  62 import java.util.BitSet;
  63 import java.util.Deque;
  64 import java.util.HashMap;
  65 import java.util.Hashtable;
  66 import java.util.List;
  67 import java.util.Map;
  68 import java.util.Set;
  69
  70 /**
  71  * base class holding visualization and analysis attributes and common logic for
  72  * an active alignment view displayed in the GUI
  73  *
  74  * @author jimp
  75  *
  76  */
  77 public abstract class AlignmentViewport implements AlignViewportI,
  78         CommandListener, VamsasSource
  79 {
  80   protected ViewStyleI viewStyle = new ViewStyle();
  81
  82   /**
  83    * A viewport that hosts the cDna view of this (protein), or vice versa (if
  84    * set).
  85    */
  86   AlignViewportI codingComplement = null;
  87
  88   FeaturesDisplayedI featuresDisplayed = null;
  89
  90   protected Deque<CommandI> historyList = new ArrayDeque<CommandI>();
  91
  92   protected Deque<CommandI> redoList = new ArrayDeque<CommandI>();
  93
  94   /**
  95    * @param name
  96    * @see jalview.api.ViewStyleI#setFontName(java.lang.String)
  97    */
  98   @Override
  99   public void setFontName(String name)
 100   {
 101     viewStyle.setFontName(name);
 102   }
 103
 104   /**
 105    * @param style
 106    * @see jalview.api.ViewStyleI#setFontStyle(int)
 107    */
 108   @Override
 109   public void setFontStyle(int style)
 110   {
 111     viewStyle.setFontStyle(style);
 112   }
 113
 114   /**
 115    * @param size
 116    * @see jalview.api.ViewStyleI#setFontSize(int)
 117    */
 118   @Override
 119   public void setFontSize(int size)
 120   {
 121     viewStyle.setFontSize(size);
 122   }
 123
 124   /**
 125    * @return
 126    * @see jalview.api.ViewStyleI#getFontStyle()
 127    */
 128   @Override
 129   public int getFontStyle()
 130   {
 131     return viewStyle.getFontStyle();
 132   }
 133
 134   /**
 135    * @return
 136    * @see jalview.api.ViewStyleI#getFontName()
 137    */
 138   @Override
 139   public String getFontName()
 140   {
 141     return viewStyle.getFontName();
 142   }
 143
 144   /**
 145    * @return
 146    * @see jalview.api.ViewStyleI#getFontSize()
 147    */
 148   @Override
 149   public int getFontSize()
 150   {
 151     return viewStyle.getFontSize();
 152   }
 153
 154   /**
 155    * @param upperCasebold
 156    * @see jalview.api.ViewStyleI#setUpperCasebold(boolean)
 157    */
 158   @Override
 159   public void setUpperCasebold(boolean upperCasebold)
 160   {
 161     viewStyle.setUpperCasebold(upperCasebold);
 162   }
 163
 164   /**
 165    * @return
 166    * @see jalview.api.ViewStyleI#isUpperCasebold()
 167    */
 168   @Override
 169   public boolean isUpperCasebold()
 170   {
 171     return viewStyle.isUpperCasebold();
 172   }
 173
 174   /**
 175    * @return
 176    * @see jalview.api.ViewStyleI#isSeqNameItalics()
 177    */
 178   @Override
 179   public boolean isSeqNameItalics()
 180   {
 181     return viewStyle.isSeqNameItalics();
 182   }
 183
 184   /**
 185    * @param colourByReferenceSeq
 186    * @see jalview.api.ViewStyleI#setColourByReferenceSeq(boolean)
 187    */
 188   @Override
 189   public void setColourByReferenceSeq(boolean colourByReferenceSeq)
 190   {
 191     viewStyle.setColourByReferenceSeq(colourByReferenceSeq);
 192   }
 193
 194   /**
 195    * @param b
 196    * @see jalview.api.ViewStyleI#setColourAppliesToAllGroups(boolean)
 197    */
 198   @Override
 199   public void setColourAppliesToAllGroups(boolean b)
 200   {
 201     viewStyle.setColourAppliesToAllGroups(b);
 202   }
 203
 204   /**
 205    * @return
 206    * @see jalview.api.ViewStyleI#getColourAppliesToAllGroups()
 207    */
 208   @Override
 209   public boolean getColourAppliesToAllGroups()
 210   {
 211     return viewStyle.getColourAppliesToAllGroups();
 212   }
 213
 214   /**
 215    * @return
 216    * @see jalview.api.ViewStyleI#getAbovePIDThreshold()
 217    */
 218   @Override
 219   public boolean getAbovePIDThreshold()
 220   {
 221     return viewStyle.getAbovePIDThreshold();
 222   }
 223
 224   /**
 225    * @param inc
 226    * @see jalview.api.ViewStyleI#setIncrement(int)
 227    */
 228   @Override
 229   public void setIncrement(int inc)
 230   {
 231     viewStyle.setIncrement(inc);
 232   }
 233
 234   /**
 235    * @return
 236    * @see jalview.api.ViewStyleI#getIncrement()
 237    */
 238   @Override
 239   public int getIncrement()
 240   {
 241     return viewStyle.getIncrement();
 242   }
 243
 244   /**
 245    * @param b
 246    * @see jalview.api.ViewStyleI#setConservationSelected(boolean)
 247    */
 248   @Override
 249   public void setConservationSelected(boolean b)
 250   {
 251     viewStyle.setConservationSelected(b);
 252   }
 253
 254   /**
 255    * @param show
 256    * @see jalview.api.ViewStyleI#setShowHiddenMarkers(boolean)
 257    */
 258   @Override
 259   public void setShowHiddenMarkers(boolean show)
 260   {
 261     viewStyle.setShowHiddenMarkers(show);
 262   }
 263
 264   /**
 265    * @return
 266    * @see jalview.api.ViewStyleI#getShowHiddenMarkers()
 267    */
 268   @Override
 269   public boolean getShowHiddenMarkers()
 270   {
 271     return viewStyle.getShowHiddenMarkers();
 272   }
 273
 274   /**
 275    * @param b
 276    * @see jalview.api.ViewStyleI#setScaleRightWrapped(boolean)
 277    */
 278   @Override
 279   public void setScaleRightWrapped(boolean b)
 280   {
 281     viewStyle.setScaleRightWrapped(b);
 282   }
 283
 284   /**
 285    * @param b
 286    * @see jalview.api.ViewStyleI#setScaleLeftWrapped(boolean)
 287    */
 288   @Override
 289   public void setScaleLeftWrapped(boolean b)
 290   {
 291     viewStyle.setScaleLeftWrapped(b);
 292   }
 293
 294   /**
 295    * @param b
 296    * @see jalview.api.ViewStyleI#setScaleAboveWrapped(boolean)
 297    */
 298   @Override
 299   public void setScaleAboveWrapped(boolean b)
 300   {
 301     viewStyle.setScaleAboveWrapped(b);
 302   }
 303
 304   /**
 305    * @return
 306    * @see jalview.api.ViewStyleI#getScaleLeftWrapped()
 307    */
 308   @Override
 309   public boolean getScaleLeftWrapped()
 310   {
 311     return viewStyle.getScaleLeftWrapped();
 312   }
 313
 314   /**
 315    * @return
 316    * @see jalview.api.ViewStyleI#getScaleAboveWrapped()
 317    */
 318   @Override
 319   public boolean getScaleAboveWrapped()
 320   {
 321     return viewStyle.getScaleAboveWrapped();
 322   }
 323
 324   /**
 325    * @return
 326    * @see jalview.api.ViewStyleI#getScaleRightWrapped()
 327    */
 328   @Override
 329   public boolean getScaleRightWrapped()
 330   {
 331     return viewStyle.getScaleRightWrapped();
 332   }
 333
 334   /**
 335    * @param b
 336    * @see jalview.api.ViewStyleI#setAbovePIDThreshold(boolean)
 337    */
 338   @Override
 339   public void setAbovePIDThreshold(boolean b)
 340   {
 341     viewStyle.setAbovePIDThreshold(b);
 342   }
 343
 344   /**
 345    * @param thresh
 346    * @see jalview.api.ViewStyleI#setThreshold(int)
 347    */
 348   @Override
 349   public void setThreshold(int thresh)
 350   {
 351     viewStyle.setThreshold(thresh);
 352   }
 353
 354   /**
 355    * @return
 356    * @see jalview.api.ViewStyleI#getThreshold()
 357    */
 358   @Override
 359   public int getThreshold()
 360   {
 361     return viewStyle.getThreshold();
 362   }
 363
 364   /**
 365    * @return
 366    * @see jalview.api.ViewStyleI#getShowJVSuffix()
 367    */
 368   @Override
 369   public boolean getShowJVSuffix()
 370   {
 371     return viewStyle.getShowJVSuffix();
 372   }
 373
 374   /**
 375    * @param b
 376    * @see jalview.api.ViewStyleI#setShowJVSuffix(boolean)
 377    */
 378   @Override
 379   public void setShowJVSuffix(boolean b)
 380   {
 381     viewStyle.setShowJVSuffix(b);
 382   }
 383
 384   /**
 385    * @param state
 386    * @see jalview.api.ViewStyleI#setWrapAlignment(boolean)
 387    */
 388   @Override
 389   public void setWrapAlignment(boolean state)
 390   {
 391     viewStyle.setWrapAlignment(state);
 392   }
 393
 394   /**
 395    * @param state
 396    * @see jalview.api.ViewStyleI#setShowText(boolean)
 397    */
 398   @Override
 399   public void setShowText(boolean state)
 400   {
 401     viewStyle.setShowText(state);
 402   }
 403
 404   /**
 405    * @param state
 406    * @see jalview.api.ViewStyleI#setRenderGaps(boolean)
 407    */
 408   @Override
 409   public void setRenderGaps(boolean state)
 410   {
 411     viewStyle.setRenderGaps(state);
 412   }
 413
 414   /**
 415    * @return
 416    * @see jalview.api.ViewStyleI#getColourText()
 417    */
 418   @Override
 419   public boolean getColourText()
 420   {
 421     return viewStyle.getColourText();
 422   }
 423
 424   /**
 425    * @param state
 426    * @see jalview.api.ViewStyleI#setColourText(boolean)
 427    */
 428   @Override
 429   public void setColourText(boolean state)
 430   {
 431     viewStyle.setColourText(state);
 432   }
 433
 434   /**
 435    * @return
 436    * @see jalview.api.ViewStyleI#getWrapAlignment()
 437    */
 438   @Override
 439   public boolean getWrapAlignment()
 440   {
 441     return viewStyle.getWrapAlignment();
 442   }
 443
 444   /**
 445    * @return
 446    * @see jalview.api.ViewStyleI#getShowText()
 447    */
 448   @Override
 449   public boolean getShowText()
 450   {
 451     return viewStyle.getShowText();
 452   }
 453
 454   /**
 455    * @return
 456    * @see jalview.api.ViewStyleI#getWrappedWidth()
 457    */
 458   @Override
 459   public int getWrappedWidth()
 460   {
 461     return viewStyle.getWrappedWidth();
 462   }
 463
 464   /**
 465    * @param w
 466    * @see jalview.api.ViewStyleI#setWrappedWidth(int)
 467    */
 468   @Override
 469   public void setWrappedWidth(int w)
 470   {
 471     viewStyle.setWrappedWidth(w);
 472   }
 473
 474   /**
 475    * @return
 476    * @see jalview.api.ViewStyleI#getCharHeight()
 477    */
 478   @Override
 479   public int getCharHeight()
 480   {
 481     return viewStyle.getCharHeight();
 482   }
 483
 484   /**
 485    * @param h
 486    * @see jalview.api.ViewStyleI#setCharHeight(int)
 487    */
 488   @Override
 489   public void setCharHeight(int h)
 490   {
 491     viewStyle.setCharHeight(h);
 492   }
 493
 494   /**
 495    * @return
 496    * @see jalview.api.ViewStyleI#getCharWidth()
 497    */
 498   @Override
 499   public int getCharWidth()
 500   {
 501     return viewStyle.getCharWidth();
 502   }
 503
 504   /**
 505    * @param w
 506    * @see jalview.api.ViewStyleI#setCharWidth(int)
 507    */
 508   @Override
 509   public void setCharWidth(int w)
 510   {
 511     viewStyle.setCharWidth(w);
 512   }
 513
 514   /**
 515    * @return
 516    * @see jalview.api.ViewStyleI#getShowBoxes()
 517    */
 518   @Override
 519   public boolean getShowBoxes()
 520   {
 521     return viewStyle.getShowBoxes();
 522   }
 523
 524   /**
 525    * @return
 526    * @see jalview.api.ViewStyleI#getShowUnconserved()
 527    */
 528   @Override
 529   public boolean getShowUnconserved()
 530   {
 531     return viewStyle.getShowUnconserved();
 532   }
 533
 534   /**
 535    * @param showunconserved
 536    * @see jalview.api.ViewStyleI#setShowUnconserved(boolean)
 537    */
 538   @Override
 539   public void setShowUnconserved(boolean showunconserved)
 540   {
 541     viewStyle.setShowUnconserved(showunconserved);
 542   }
 543
 544   /**
 545    * @param default1
 546    * @see jalview.api.ViewStyleI#setSeqNameItalics(boolean)
 547    */
 548   @Override
 549   public void setSeqNameItalics(boolean default1)
 550   {
 551     viewStyle.setSeqNameItalics(default1);
 552   }
 553
 554   /**
 555    * alignment displayed in the viewport. Please use get/setter
 556    */
 557   protected AlignmentI alignment;
 558
 559   @Override
 560   public AlignmentI getAlignment()
 561   {
 562     return alignment;
 563   }
 564
 565   @Override
 566   public char getGapCharacter()
 567   {
 568     return alignment.getGapCharacter();
 569   }
 570
 571   protected String sequenceSetID;
 572
 573   /**
 574    * probably unused indicator that view is of a dataset rather than an
 575    * alignment
 576    */
 577   protected boolean isDataset = false;
 578
 579   public void setDataset(boolean b)
 580   {
 581     isDataset = b;
 582   }
 583
 584   public boolean isDataset()
 585   {
 586     return isDataset;
 587   }
 588
 589   private Map<SequenceI, SequenceCollectionI> hiddenRepSequences;
 590
 591   protected ColumnSelection colSel = new ColumnSelection();
 592
 593   public boolean autoCalculateConsensus = true;
 594
 595   protected boolean autoCalculateStrucConsensus = true;
 596
 597   protected boolean ignoreGapsInConsensusCalculation = false;
 598
 599   protected ColourSchemeI globalColourScheme = null;
 600
 601   @Override
 602   public void setGlobalColourScheme(ColourSchemeI cs)
 603   {
 604     // TODO: logic refactored from AlignFrame changeColour -
 605     // TODO: autorecalc stuff should be changed to rely on the worker system
 606     // check to see if we should implement a changeColour(cs) method rather than
 607     // put th logic in here
 608     // - means that caller decides if they want to just modify state and defer
 609     // calculation till later or to do all calculations in thread.
 610     // via changecolour
 611     globalColourScheme = cs;
 612     boolean recalc = false;
 613     if (cs != null)
 614     {
 615       cs.setConservationApplied(recalc = getConservationSelected());
 616       if (getAbovePIDThreshold() || cs instanceof PIDColourScheme
 617               || cs instanceof Blosum62ColourScheme)
 618       {
 619         recalc = true;
 620         cs.setThreshold(viewStyle.getThreshold(),
 621                 ignoreGapsInConsensusCalculation);
 622       }
 623       else
 624       {
 625         cs.setThreshold(0, ignoreGapsInConsensusCalculation);
 626       }
 627       if (recalc)
 628       {
 629         cs.setConsensus(hconsensus);
 630         cs.setConservation(hconservation);
 631       }
 632       cs.alignmentChanged(alignment, hiddenRepSequences);
 633     }
 634     if (getColourAppliesToAllGroups())
 635     {
 636       for (SequenceGroup sg : getAlignment().getGroups())
 637       {
 638         if (cs == null)
 639         {
 640           sg.cs = null;
 641           continue;
 642         }
 643         sg.cs = cs.applyTo(sg, getHiddenRepSequences());
 644         sg.setConsPercGaps(ConsPercGaps);
 645         if (getAbovePIDThreshold() || cs instanceof PIDColourScheme
 646                 || cs instanceof Blosum62ColourScheme)
 647         {
 648           sg.cs.setThreshold(viewStyle.getThreshold(),
 649                   isIgnoreGapsConsensus());
 650           recalc = true;
 651         }
 652         else
 653         {
 654           sg.cs.setThreshold(0, isIgnoreGapsConsensus());
 655         }
 656
 657         if (getConservationSelected())
 658         {
 659           sg.cs.setConservationApplied(true);
 660           recalc = true;
 661         }
 662         else
 663         {
 664           sg.cs.setConservation(null);
 665           // sg.cs.setThreshold(0, getIgnoreGapsConsensus());
 666         }
 667         if (recalc)
 668         {
 669           sg.recalcConservation();
 670         }
 671         else
 672         {
 673           sg.cs.alignmentChanged(sg, hiddenRepSequences);
 674         }
 675       }
 676     }
 677   }
 678
 679   @Override
 680   public ColourSchemeI getGlobalColourScheme()
 681   {
 682     return globalColourScheme;
 683   }
 684
 685   protected AlignmentAnnotation consensus;
 686
 687   protected AlignmentAnnotation complementConsensus;
 688
 689   protected AlignmentAnnotation strucConsensus;
 690
 691   protected AlignmentAnnotation conservation;
 692
 693   protected AlignmentAnnotation quality;
 694
 695   protected AlignmentAnnotation[] groupConsensus;
 696
 697   protected AlignmentAnnotation[] groupConservation;
 698
 699   /**
 700    * results of alignment consensus analysis for visible portion of view
 701    */
 702   protected Hashtable[] hconsensus = null;
 703
 704   /**
 705    * results of cDNA complement consensus visible portion of view
 706    */
 707   protected Hashtable[] hcomplementConsensus = null;
 708
 709   /**
 710    * results of secondary structure base pair consensus for visible portion of
 711    * view
 712    */
 713   protected Hashtable[] hStrucConsensus = null;
 714
 715   protected Conservation hconservation = null;
 716
 717   @Override
 718   public void setConservation(Conservation cons)
 719   {
 720     hconservation = cons;
 721   }
 722
 723   /**
 724    * percentage gaps allowed in a column before all amino acid properties should
 725    * be considered unconserved
 726    */
 727   int ConsPercGaps = 25; // JBPNote : This should be a scalable property!
 728
 729   @Override
 730   public int getConsPercGaps()
 731   {
 732     return ConsPercGaps;
 733   }
 734
 735   @Override
 736   public void setSequenceConsensusHash(Hashtable[] hconsensus)
 737   {
 738     this.hconsensus = hconsensus;
 739   }
 740
 741   @Override
 742   public void setComplementConsensusHash(Hashtable[] hconsensus)
 743   {
 744     this.hcomplementConsensus = hconsensus;
 745   }
 746
 747   @Override
 748   public Hashtable[] getSequenceConsensusHash()
 749   {
 750     return hconsensus;
 751   }
 752
 753   @Override
 754   public Hashtable[] getComplementConsensusHash()
 755   {
 756     return hcomplementConsensus;
 757   }
 758
 759   @Override
 760   public Hashtable[] getRnaStructureConsensusHash()
 761   {
 762     return hStrucConsensus;
 763   }
 764
 765   @Override
 766   public void setRnaStructureConsensusHash(Hashtable[] hStrucConsensus)
 767   {
 768     this.hStrucConsensus = hStrucConsensus;
 769
 770   }
 771
 772   @Override
 773   public AlignmentAnnotation getAlignmentQualityAnnot()
 774   {
 775     return quality;
 776   }
 777
 778   @Override
 779   public AlignmentAnnotation getAlignmentConservationAnnotation()
 780   {
 781     return conservation;
 782   }
 783
 784   @Override
 785   public AlignmentAnnotation getAlignmentConsensusAnnotation()
 786   {
 787     return consensus;
 788   }
 789
 790   @Override
 791   public AlignmentAnnotation getComplementConsensusAnnotation()
 792   {
 793     return complementConsensus;
 794   }
 795
 796   @Override
 797   public AlignmentAnnotation getAlignmentStrucConsensusAnnotation()
 798   {
 799     return strucConsensus;
 800   }
 801
 802   protected AlignCalcManagerI calculator = new AlignCalcManager();
 803
 804   /**
 805    * trigger update of conservation annotation
 806    */
 807   public void updateConservation(final AlignmentViewPanel ap)
 808   {
 809     // see note in mantis : issue number 8585
 810     if (alignment.isNucleotide() || conservation == null
 811             || !autoCalculateConsensus)
 812     {
 813       return;
 814     }
 815     if (calculator
 816             .getRegisteredWorkersOfClass(jalview.workers.ConservationThread.class) == null)
 817     {
 818       calculator.registerWorker(new jalview.workers.ConservationThread(
 819               this, ap));
 820     }
 821   }
 822
 823   /**
 824    * trigger update of consensus annotation
 825    */
 826   public void updateConsensus(final AlignmentViewPanel ap)
 827   {
 828     // see note in mantis : issue number 8585
 829     if (consensus == null || !autoCalculateConsensus)
 830     {
 831       return;
 832     }
 833     if (calculator.getRegisteredWorkersOfClass(ConsensusThread.class) == null)
 834     {
 835       calculator.registerWorker(new ConsensusThread(this, ap));
 836     }
 837
 838     /*
 839      * A separate thread to compute cDNA consensus for a protein alignment
 840      */
 841     final AlignmentI al = this.getAlignment();
 842     if (!al.isNucleotide() && al.getCodonFrames() != null
 843             && !al.getCodonFrames().isEmpty())
 844     {
 845       if (calculator
 846               .getRegisteredWorkersOfClass(ComplementConsensusThread.class) == null)
 847       {
 848         calculator.registerWorker(new ComplementConsensusThread(this, ap));
 849       }
 850     }
 851   }
 852
 853   // --------START Structure Conservation
 854   public void updateStrucConsensus(final AlignmentViewPanel ap)
 855   {
 856     if (autoCalculateStrucConsensus && strucConsensus == null
 857             && alignment.isNucleotide() && alignment.hasRNAStructure())
 858     {
 859       // secondary structure has been added - so init the consensus line
 860       initRNAStructure();
 861     }
 862
 863     // see note in mantis : issue number 8585
 864     if (strucConsensus == null || !autoCalculateStrucConsensus)
 865     {
 866       return;
 867     }
 868     if (calculator.getRegisteredWorkersOfClass(StrucConsensusThread.class) == null)
 869     {
 870       calculator.registerWorker(new StrucConsensusThread(this, ap));
 871     }
 872   }
 873
 874   public boolean isCalcInProgress()
 875   {
 876     return calculator.isWorking();
 877   }
 878
 879   @Override
 880   public boolean isCalculationInProgress(
 881           AlignmentAnnotation alignmentAnnotation)
 882   {
 883     if (!alignmentAnnotation.autoCalculated)
 884     {
 885       return false;
 886     }
 887     if (calculator.workingInvolvedWith(alignmentAnnotation))
 888     {
 889       // System.err.println("grey out ("+alignmentAnnotation.label+")");
 890       return true;
 891     }
 892     return false;
 893   }
 894
 895   @Override
 896   public boolean isClosed()
 897   {
 898     // TODO: check that this isClosed is only true after panel is closed, not
 899     // before it is fully constructed.
 900     return alignment == null;
 901   }
 902
 903   @Override
 904   public AlignCalcManagerI getCalcManager()
 905   {
 906     return calculator;
 907   }
 908
 909   /**
 910    * should conservation rows be shown for groups
 911    */
 912   protected boolean showGroupConservation = false;
 913
 914   /**
 915    * should consensus rows be shown for groups
 916    */
 917   protected boolean showGroupConsensus = false;
 918
 919   /**
 920    * should consensus profile be rendered by default
 921    */
 922   protected boolean showSequenceLogo = false;
 923
 924   /**
 925    * should consensus profile be rendered normalised to row height
 926    */
 927   protected boolean normaliseSequenceLogo = false;
 928
 929   /**
 930    * should consensus histograms be rendered by default
 931    */
 932   protected boolean showConsensusHistogram = true;
 933
 934   /**
 935    * @return the showConsensusProfile
 936    */
 937   @Override
 938   public boolean isShowSequenceLogo()
 939   {
 940     return showSequenceLogo;
 941   }
 942
 943   /**
 944    * @param showSequenceLogo
 945    *          the new value
 946    */
 947   public void setShowSequenceLogo(boolean showSequenceLogo)
 948   {
 949     if (showSequenceLogo != this.showSequenceLogo)
 950     {
 951       // TODO: decouple settings setting from calculation when refactoring
 952       // annotation update method from alignframe to viewport
 953       this.showSequenceLogo = showSequenceLogo;
 954       calculator.updateAnnotationFor(ConsensusThread.class);
 955       calculator.updateAnnotationFor(ComplementConsensusThread.class);
 956       calculator.updateAnnotationFor(StrucConsensusThread.class);
 957     }
 958     this.showSequenceLogo = showSequenceLogo;
 959   }
 960
 961   /**
 962    * @param showConsensusHistogram
 963    *          the showConsensusHistogram to set
 964    */
 965   public void setShowConsensusHistogram(boolean showConsensusHistogram)
 966   {
 967     this.showConsensusHistogram = showConsensusHistogram;
 968   }
 969
 970   /**
 971    * @return the showGroupConservation
 972    */
 973   public boolean isShowGroupConservation()
 974   {
 975     return showGroupConservation;
 976   }
 977
 978   /**
 979    * @param showGroupConservation
 980    *          the showGroupConservation to set
 981    */
 982   public void setShowGroupConservation(boolean showGroupConservation)
 983   {
 984     this.showGroupConservation = showGroupConservation;
 985   }
 986
 987   /**
 988    * @return the showGroupConsensus
 989    */
 990   public boolean isShowGroupConsensus()
 991   {
 992     return showGroupConsensus;
 993   }
 994
 995   /**
 996    * @param showGroupConsensus
 997    *          the showGroupConsensus to set
 998    */
 999   public void setShowGroupConsensus(boolean showGroupConsensus)
1000   {
1001     this.showGroupConsensus = showGroupConsensus;
1002   }
1003
1004   /**
1005    *
1006    * @return flag to indicate if the consensus histogram should be rendered by
1007    *         default
1008    */
1009   @Override
1010   public boolean isShowConsensusHistogram()
1011   {
1012     return this.showConsensusHistogram;
1013   }
1014
1015   /**
1016    * when set, updateAlignment will always ensure sequences are of equal length
1017    */
1018   private boolean padGaps = false;
1019
1020   /**
1021    * when set, alignment should be reordered according to a newly opened tree
1022    */
1023   public boolean sortByTree = false;
1024
1025   /**
1026    *
1027    *
1028    * @return null or the currently selected sequence region
1029    */
1030   @Override
1031   public SequenceGroup getSelectionGroup()
1032   {
1033     return selectionGroup;
1034   }
1035
1036   /**
1037    * Set the selection group for this window.
1038    *
1039    * @param sg
1040    *          - group holding references to sequences in this alignment view
1041    *
1042    */
1043   @Override
1044   public void setSelectionGroup(SequenceGroup sg)
1045   {
1046     selectionGroup = sg;
1047   }
1048
1049   public void setHiddenColumns(ColumnSelection colsel)
1050   {
1051     this.colSel = colsel;
1052   }
1053
1054   @Override
1055   public ColumnSelection getColumnSelection()
1056   {
1057     return colSel;
1058   }
1059
1060   @Override
1061   public void setColumnSelection(ColumnSelection colSel)
1062   {
1063     this.colSel = colSel;
1064     if (colSel != null)
1065     {
1066       updateHiddenColumns();
1067     }
1068   }
1069
1070   /**
1071    *
1072    * @return
1073    */
1074   @Override
1075   public Map<SequenceI, SequenceCollectionI> getHiddenRepSequences()
1076   {
1077     return hiddenRepSequences;
1078   }
1079
1080   @Override
1081   public void setHiddenRepSequences(
1082           Map<SequenceI, SequenceCollectionI> hiddenRepSequences)
1083   {
1084     this.hiddenRepSequences = hiddenRepSequences;
1085   }
1086
1087   @Override
1088   public boolean hasHiddenColumns()
1089   {
1090     return colSel != null && colSel.hasHiddenColumns();
1091   }
1092
1093   public void updateHiddenColumns()
1094   {
1095     // this method doesn't really do anything now. But - it could, since a
1096     // column Selection could be in the process of modification
1097     // hasHiddenColumns = colSel.hasHiddenColumns();
1098   }
1099
1100   @Override
1101   public boolean hasHiddenRows()
1102   {
1103     return alignment.getHiddenSequences().getSize() > 0;
1104   }
1105
1106   protected SequenceGroup selectionGroup;
1107
1108   public void setSequenceSetId(String newid)
1109   {
1110     if (sequenceSetID != null)
1111     {
1112       System.err
1113               .println("Warning - overwriting a sequenceSetId for a viewport!");
1114     }
1115     sequenceSetID = new String(newid);
1116   }
1117
1118   @Override
1119   public String getSequenceSetId()
1120   {
1121     if (sequenceSetID == null)
1122     {
1123       sequenceSetID = alignment.hashCode() + "";
1124     }
1125
1126     return sequenceSetID;
1127   }
1128
1129   /**
1130    * unique viewId for synchronizing state (e.g. with stored Jalview Project)
1131    *
1132    */
1133   protected String viewId = null;
1134
1135   @Override
1136   public String getViewId()
1137   {
1138     if (viewId == null)
1139     {
1140       viewId = this.getSequenceSetId() + "." + this.hashCode() + "";
1141     }
1142     return viewId;
1143   }
1144
1145   public void setIgnoreGapsConsensus(boolean b, AlignmentViewPanel ap)
1146   {
1147     ignoreGapsInConsensusCalculation = b;
1148     if (ap != null)
1149     {
1150       updateConsensus(ap);
1151       if (globalColourScheme != null)
1152       {
1153         globalColourScheme.setThreshold(globalColourScheme.getThreshold(),
1154                 ignoreGapsInConsensusCalculation);
1155       }
1156     }
1157
1158   }
1159
1160   private long sgrouphash = -1, colselhash = -1;
1161
1162   /**
1163    * checks current SelectionGroup against record of last hash value, and
1164    * updates record.
1165    *
1166    * @param b
1167    *          update the record of last hash value
1168    *
1169    * @return true if SelectionGroup changed since last call (when b is true)
1170    */
1171   public boolean isSelectionGroupChanged(boolean b)
1172   {
1173     int hc = (selectionGroup == null || selectionGroup.getSize() == 0) ? -1
1174             : selectionGroup.hashCode();
1175     if (hc != -1 && hc != sgrouphash)
1176     {
1177       if (b)
1178       {
1179         sgrouphash = hc;
1180       }
1181       return true;
1182     }
1183     return false;
1184   }
1185
1186   /**
1187    * checks current colsel against record of last hash value, and optionally
1188    * updates record.
1189    *
1190    * @param b
1191    *          update the record of last hash value
1192    * @return true if colsel changed since last call (when b is true)
1193    */
1194   public boolean isColSelChanged(boolean b)
1195   {
1196     int hc = (colSel == null || colSel.isEmpty()) ? -1 : colSel
1197             .hashCode();
1198     if (hc != -1 && hc != colselhash)
1199     {
1200       if (b)
1201       {
1202         colselhash = hc;
1203       }
1204       return true;
1205     }
1206     return false;
1207   }
1208
1209   @Override
1210   public boolean isIgnoreGapsConsensus()
1211   {
1212     return ignoreGapsInConsensusCalculation;
1213   }
1214
1215   // / property change stuff
1216
1217   // JBPNote Prolly only need this in the applet version.
1218   private final java.beans.PropertyChangeSupport changeSupport = new java.beans.PropertyChangeSupport(
1219           this);
1220
1221   protected boolean showConservation = true;
1222
1223   protected boolean showQuality = true;
1224
1225   protected boolean showConsensus = true;
1226
1227   private Map<SequenceI, Color> sequenceColours = new HashMap<SequenceI, Color>();
1228
1229   protected SequenceAnnotationOrder sortAnnotationsBy = null;
1230
1231   protected boolean showAutocalculatedAbove;
1232
1233   /**
1234    * when set, view will scroll to show the highlighted position
1235    */
1236   private boolean followHighlight = true;
1237
1238   // TODO private with getters and setters?
1239   public int startRes;
1240
1241   public int endRes;
1242
1243   public int startSeq;
1244
1245   public int endSeq;
1246
1247   /**
1248    * Property change listener for changes in alignment
1249    *
1250    * @param listener
1251    *          DOCUMENT ME!
1252    */
1253   public void addPropertyChangeListener(
1254           java.beans.PropertyChangeListener listener)
1255   {
1256     changeSupport.addPropertyChangeListener(listener);
1257   }
1258
1259   /**
1260    * DOCUMENT ME!
1261    *
1262    * @param listener
1263    *          DOCUMENT ME!
1264    */
1265   public void removePropertyChangeListener(
1266           java.beans.PropertyChangeListener listener)
1267   {
1268     changeSupport.removePropertyChangeListener(listener);
1269   }
1270
1271   /**
1272    * Property change listener for changes in alignment
1273    *
1274    * @param prop
1275    *          DOCUMENT ME!
1276    * @param oldvalue
1277    *          DOCUMENT ME!
1278    * @param newvalue
1279    *          DOCUMENT ME!
1280    */
1281   public void firePropertyChange(String prop, Object oldvalue,
1282           Object newvalue)
1283   {
1284     changeSupport.firePropertyChange(prop, oldvalue, newvalue);
1285   }
1286
1287   // common hide/show column stuff
1288
1289   public void hideSelectedColumns()
1290   {
1291     if (colSel.isEmpty())
1292     {
1293       return;
1294     }
1295
1296     colSel.hideSelectedColumns();
1297     setSelectionGroup(null);
1298
1299   }
1300
1301   public void hideColumns(int start, int end)
1302   {
1303     if (start == end)
1304     {
1305       colSel.hideColumns(start);
1306     }
1307     else
1308     {
1309       colSel.hideColumns(start, end);
1310     }
1311   }
1312
1313   public void showColumn(int col)
1314   {
1315     colSel.revealHiddenColumns(col);
1316
1317   }
1318
1319   public void showAllHiddenColumns()
1320   {
1321     colSel.revealAllHiddenColumns();
1322   }
1323
1324   // common hide/show seq stuff
1325   public void showAllHiddenSeqs()
1326   {
1327     if (alignment.getHiddenSequences().getSize() > 0)
1328     {
1329       if (selectionGroup == null)
1330       {
1331         selectionGroup = new SequenceGroup();
1332         selectionGroup.setEndRes(alignment.getWidth() - 1);
1333       }
1334       List<SequenceI> tmp = alignment.getHiddenSequences().showAll(
1335               hiddenRepSequences);
1336       for (SequenceI seq : tmp)
1337       {
1338         selectionGroup.addSequence(seq, false);
1339         setSequenceAnnotationsVisible(seq, true);
1340       }
1341
1342       hiddenRepSequences = null;
1343
1344       firePropertyChange("alignment", null, alignment.getSequences());
1345       // used to set hasHiddenRows/hiddenRepSequences here, after the property
1346       // changed event
1347       sendSelection();
1348     }
1349   }
1350
1351   public void showSequence(int index)
1352   {
1353     List<SequenceI> tmp = alignment.getHiddenSequences().showSequence(
1354             index, hiddenRepSequences);
1355     if (tmp.size() > 0)
1356     {
1357       if (selectionGroup == null)
1358       {
1359         selectionGroup = new SequenceGroup();
1360         selectionGroup.setEndRes(alignment.getWidth() - 1);
1361       }
1362
1363       for (SequenceI seq : tmp)
1364       {
1365         selectionGroup.addSequence(seq, false);
1366         setSequenceAnnotationsVisible(seq, true);
1367       }
1368       firePropertyChange("alignment", null, alignment.getSequences());
1369       sendSelection();
1370     }
1371   }
1372
1373   public void hideAllSelectedSeqs()
1374   {
1375     if (selectionGroup == null || selectionGroup.getSize() < 1)
1376     {
1377       return;
1378     }
1379
1380     SequenceI[] seqs = selectionGroup.getSequencesInOrder(alignment);
1381
1382     hideSequence(seqs);
1383
1384     setSelectionGroup(null);
1385   }
1386
1387   public void hideSequence(SequenceI[] seq)
1388   {
1389     if (seq != null)
1390     {
1391       for (int i = 0; i < seq.length; i++)
1392       {
1393         alignment.getHiddenSequences().hideSequence(seq[i]);
1394         setSequenceAnnotationsVisible(seq[i], false);
1395       }
1396       firePropertyChange("alignment", null, alignment.getSequences());
1397     }
1398   }
1399
1400   /**
1401    * Set visibility for any annotations for the given sequence.
1402    *
1403    * @param sequenceI
1404    */
1405   protected void setSequenceAnnotationsVisible(SequenceI sequenceI,
1406           boolean visible)
1407   {
1408     for (AlignmentAnnotation ann : alignment.getAlignmentAnnotation())
1409     {
1410       if (ann.sequenceRef == sequenceI)
1411       {
1412         ann.visible = visible;
1413       }
1414     }
1415   }
1416
1417   public void hideRepSequences(SequenceI repSequence, SequenceGroup sg)
1418   {
1419     int sSize = sg.getSize();
1420     if (sSize < 2)
1421     {
1422       return;
1423     }
1424
1425     if (hiddenRepSequences == null)
1426     {
1427       hiddenRepSequences = new Hashtable();
1428     }
1429
1430     hiddenRepSequences.put(repSequence, sg);
1431
1432     // Hide all sequences except the repSequence
1433     SequenceI[] seqs = new SequenceI[sSize - 1];
1434     int index = 0;
1435     for (int i = 0; i < sSize; i++)
1436     {
1437       if (sg.getSequenceAt(i) != repSequence)
1438       {
1439         if (index == sSize - 1)
1440         {
1441           return;
1442         }
1443
1444         seqs[index++] = sg.getSequenceAt(i);
1445       }
1446     }
1447     sg.setSeqrep(repSequence); // note: not done in 2.7applet
1448     sg.setHidereps(true); // note: not done in 2.7applet
1449     hideSequence(seqs);
1450
1451   }
1452
1453   public boolean isHiddenRepSequence(SequenceI seq)
1454   {
1455     return alignment.getSeqrep() == seq
1456             || (hiddenRepSequences != null && hiddenRepSequences
1457                     .containsKey(seq));
1458   }
1459
1460   public SequenceGroup getRepresentedSequences(SequenceI seq)
1461   {
1462     return (SequenceGroup) (hiddenRepSequences == null ? null
1463             : hiddenRepSequences.get(seq));
1464   }
1465
1466   @Override
1467   public int adjustForHiddenSeqs(int alignmentIndex)
1468   {
1469     return alignment.getHiddenSequences().adjustForHiddenSeqs(
1470             alignmentIndex);
1471   }
1472
1473   @Override
1474   public void invertColumnSelection()
1475   {
1476     colSel.invertColumnSelection(0, alignment.getWidth());
1477   }
1478
1479   @Override
1480   public SequenceI[] getSelectionAsNewSequence()
1481   {
1482     SequenceI[] sequences;
1483     // JBPNote: Need to test jalviewLite.getSelectedSequencesAsAlignmentFrom -
1484     // this was the only caller in the applet for this method
1485     // JBPNote: in applet, this method returned references to the alignment
1486     // sequences, and it did not honour the presence/absence of annotation
1487     // attached to the alignment (probably!)
1488     if (selectionGroup == null || selectionGroup.getSize() == 0)
1489     {
1490       sequences = alignment.getSequencesArray();
1491       AlignmentAnnotation[] annots = alignment.getAlignmentAnnotation();
1492       for (int i = 0; i < sequences.length; i++)
1493       {
1494         // construct new sequence with subset of visible annotation
1495         sequences[i] = new Sequence(sequences[i], annots);
1496       }
1497     }
1498     else
1499     {
1500       sequences = selectionGroup.getSelectionAsNewSequences(alignment);
1501     }
1502
1503     return sequences;
1504   }
1505
1506   @Override
1507   public SequenceI[] getSequenceSelection()
1508   {
1509     SequenceI[] sequences = null;
1510     if (selectionGroup != null)
1511     {
1512       sequences = selectionGroup.getSequencesInOrder(alignment);
1513     }
1514     if (sequences == null)
1515     {
1516       sequences = alignment.getSequencesArray();
1517     }
1518     return sequences;
1519   }
1520
1521   @Override
1522   public CigarArray getViewAsCigars(boolean selectedRegionOnly)
1523   {
1524     return new CigarArray(alignment, colSel,
1525             (selectedRegionOnly ? selectionGroup : null));
1526   }
1527
1528   @Override
1529   public jalview.datamodel.AlignmentView getAlignmentView(
1530           boolean selectedOnly)
1531   {
1532     return getAlignmentView(selectedOnly, false);
1533   }
1534
1535   @Override
1536   public jalview.datamodel.AlignmentView getAlignmentView(
1537           boolean selectedOnly, boolean markGroups)
1538   {
1539     return new AlignmentView(alignment, colSel, selectionGroup,
1540             colSel != null && colSel.hasHiddenColumns(), selectedOnly,
1541             markGroups);
1542   }
1543
1544   @Override
1545   public String[] getViewAsString(boolean selectedRegionOnly)
1546   {
1547     String[] selection = null;
1548     SequenceI[] seqs = null;
1549     int i, iSize;
1550     int start = 0, end = 0;
1551     if (selectedRegionOnly && selectionGroup != null)
1552     {
1553       iSize = selectionGroup.getSize();
1554       seqs = selectionGroup.getSequencesInOrder(alignment);
1555       start = selectionGroup.getStartRes();
1556       end = selectionGroup.getEndRes() + 1;
1557     }
1558     else
1559     {
1560       if (hasHiddenRows())
1561       {
1562         iSize = alignment.getHiddenSequences().getFullAlignment()
1563                 .getHeight();
1564         seqs = alignment.getHiddenSequences().getFullAlignment()
1565                 .getSequencesArray();
1566         end = alignment.getHiddenSequences().getFullAlignment().getWidth();
1567       }
1568       else
1569       {
1570         iSize = alignment.getHeight();
1571         seqs = alignment.getSequencesArray();
1572         end = alignment.getWidth();
1573       }
1574     }
1575
1576     selection = new String[iSize];
1577     if (colSel != null && colSel.hasHiddenColumns())
1578     {
1579       selection = colSel.getVisibleSequenceStrings(start, end, seqs);
1580     }
1581     else
1582     {
1583       for (i = 0; i < iSize; i++)
1584       {
1585         selection[i] = seqs[i].getSequenceAsString(start, end);
1586       }
1587
1588     }
1589     return selection;
1590   }
1591
1592   @Override
1593   public List<int[]> getVisibleRegionBoundaries(int min, int max)
1594   {
1595     ArrayList<int[]> regions = new ArrayList<int[]>();
1596     int start = min;
1597     int end = max;
1598
1599     do
1600     {
1601       if (colSel != null && colSel.hasHiddenColumns())
1602       {
1603         if (start == 0)
1604         {
1605           start = colSel.adjustForHiddenColumns(start);
1606         }
1607
1608         end = colSel.getHiddenBoundaryRight(start);
1609         if (start == end)
1610         {
1611           end = max;
1612         }
1613         if (end > max)
1614         {
1615           end = max;
1616         }
1617       }
1618
1619       regions.add(new int[] { start, end });
1620
1621       if (colSel != null && colSel.hasHiddenColumns())
1622       {
1623         start = colSel.adjustForHiddenColumns(end);
1624         start = colSel.getHiddenBoundaryLeft(start) + 1;
1625       }
1626     } while (end < max);
1627
1628     int[][] startEnd = new int[regions.size()][2];
1629
1630     return regions;
1631   }
1632
1633   @Override
1634   public List<AlignmentAnnotation> getVisibleAlignmentAnnotation(
1635           boolean selectedOnly)
1636   {
1637     ArrayList<AlignmentAnnotation> ala = new ArrayList<AlignmentAnnotation>();
1638     AlignmentAnnotation[] aa;
1639     if ((aa = alignment.getAlignmentAnnotation()) != null)
1640     {
1641       for (AlignmentAnnotation annot : aa)
1642       {
1643         AlignmentAnnotation clone = new AlignmentAnnotation(annot);
1644         if (selectedOnly && selectionGroup != null)
1645         {
1646           colSel.makeVisibleAnnotation(selectionGroup.getStartRes(),
1647                   selectionGroup.getEndRes(), clone);
1648         }
1649         else
1650         {
1651           colSel.makeVisibleAnnotation(clone);
1652         }
1653         ala.add(clone);
1654       }
1655     }
1656     return ala;
1657   }
1658
1659   @Override
1660   public boolean isPadGaps()
1661   {
1662     return padGaps;
1663   }
1664
1665   @Override
1666   public void setPadGaps(boolean padGaps)
1667   {
1668     this.padGaps = padGaps;
1669   }
1670
1671   /**
1672    * apply any post-edit constraints and trigger any calculations needed after
1673    * an edit has been performed on the alignment
1674    *
1675    * @param ap
1676    */
1677   @Override
1678   public void alignmentChanged(AlignmentViewPanel ap)
1679   {
1680     if (isPadGaps())
1681     {
1682       alignment.padGaps();
1683     }
1684     if (autoCalculateConsensus)
1685     {
1686       updateConsensus(ap);
1687     }
1688     if (hconsensus != null && autoCalculateConsensus)
1689     {
1690       updateConservation(ap);
1691     }
1692     if (autoCalculateStrucConsensus)
1693     {
1694       updateStrucConsensus(ap);
1695     }
1696
1697     // Reset endRes of groups if beyond alignment width
1698     int alWidth = alignment.getWidth();
1699     List<SequenceGroup> groups = alignment.getGroups();
1700     if (groups != null)
1701     {
1702       for (SequenceGroup sg : groups)
1703       {
1704         if (sg.getEndRes() > alWidth)
1705         {
1706           sg.setEndRes(alWidth - 1);
1707         }
1708       }
1709     }
1710
1711     if (selectionGroup != null && selectionGroup.getEndRes() > alWidth)
1712     {
1713       selectionGroup.setEndRes(alWidth - 1);
1714     }
1715
1716     resetAllColourSchemes();
1717     calculator.restartWorkers();
1718     // alignment.adjustSequenceAnnotations();
1719   }
1720
1721   /**
1722    * reset scope and do calculations for all applied colourschemes on alignment
1723    */
1724   void resetAllColourSchemes()
1725   {
1726     ColourSchemeI cs = globalColourScheme;
1727     if (cs != null)
1728     {
1729       cs.alignmentChanged(alignment, hiddenRepSequences);
1730
1731       cs.setConsensus(hconsensus);
1732       if (cs.conservationApplied())
1733       {
1734         cs.setConservation(Conservation.calculateConservation("All",
1735                 ResidueProperties.propHash, 3, alignment.getSequences(), 0,
1736                 alignment.getWidth(), false, getConsPercGaps(), false));
1737       }
1738     }
1739
1740     for (SequenceGroup sg : alignment.getGroups())
1741     {
1742       if (sg.cs != null)
1743       {
1744         sg.cs.alignmentChanged(sg, hiddenRepSequences);
1745       }
1746       sg.recalcConservation();
1747     }
1748   }
1749
1750   protected void initAutoAnnotation()
1751   {
1752     // TODO: add menu option action that nulls or creates consensus object
1753     // depending on if the user wants to see the annotation or not in a
1754     // specific alignment
1755
1756     if (hconsensus == null && !isDataset)
1757     {
1758       if (!alignment.isNucleotide())
1759       {
1760         initConservation();
1761         initQuality();
1762       }
1763       else
1764       {
1765         initRNAStructure();
1766       }
1767       consensus = new AlignmentAnnotation("Consensus", "PID",
1768               new Annotation[1], 0f, 100f, AlignmentAnnotation.BAR_GRAPH);
1769       initConsensus(consensus);
1770
1771       initComplementConsensus();
1772     }
1773   }
1774
1775   /**
1776    * If this is a protein alignment and there are mappings to cDNA, add the cDNA
1777    * consensus annotation.
1778    */
1779   public void initComplementConsensus()
1780   {
1781     if (!alignment.isNucleotide())
1782     {
1783       final Set<AlignedCodonFrame> codonMappings = alignment
1784               .getCodonFrames();
1785       if (codonMappings != null && !codonMappings.isEmpty())
1786       {
1787         complementConsensus = new AlignmentAnnotation("cDNA Consensus",
1788                 "PID for cDNA", new Annotation[1], 0f, 100f,
1789                 AlignmentAnnotation.BAR_GRAPH);
1790         initConsensus(complementConsensus);
1791       }
1792     }
1793   }
1794
1795   private void initConsensus(AlignmentAnnotation aa)
1796   {
1797     aa.hasText = true;
1798     aa.autoCalculated = true;
1799
1800     if (showConsensus)
1801     {
1802       alignment.addAnnotation(aa);
1803     }
1804   }
1805
1806   private void initConservation()
1807   {
1808     if (showConservation)
1809     {
1810       if (conservation == null)
1811       {
1812         conservation = new AlignmentAnnotation("Conservation",
1813                 "Conservation of total alignment less than "
1814                         + getConsPercGaps() + "% gaps", new Annotation[1],
1815                 0f, 11f, AlignmentAnnotation.BAR_GRAPH);
1816         conservation.hasText = true;
1817         conservation.autoCalculated = true;
1818         alignment.addAnnotation(conservation);
1819       }
1820     }
1821   }
1822
1823   private void initQuality()
1824   {
1825     if (showQuality)
1826     {
1827       if (quality == null)
1828       {
1829         quality = new AlignmentAnnotation("Quality",
1830                 "Alignment Quality based on Blosum62 scores",
1831                 new Annotation[1], 0f, 11f, AlignmentAnnotation.BAR_GRAPH);
1832         quality.hasText = true;
1833         quality.autoCalculated = true;
1834         alignment.addAnnotation(quality);
1835       }
1836     }
1837   }
1838
1839   private void initRNAStructure()
1840   {
1841     if (alignment.hasRNAStructure() && strucConsensus == null)
1842     {
1843       strucConsensus = new AlignmentAnnotation("StrucConsensus", "PID",
1844               new Annotation[1], 0f, 100f, AlignmentAnnotation.BAR_GRAPH);
1845       strucConsensus.hasText = true;
1846       strucConsensus.autoCalculated = true;
1847
1848       if (showConsensus)
1849       {
1850         alignment.addAnnotation(strucConsensus);
1851       }
1852     }
1853   }
1854
1855   /*
1856    * (non-Javadoc)
1857    *
1858    * @see jalview.api.AlignViewportI#calcPanelHeight()
1859    */
1860   @Override
1861   public int calcPanelHeight()
1862   {
1863     // setHeight of panels
1864     AlignmentAnnotation[] anns = getAlignment().getAlignmentAnnotation();
1865     int height = 0;
1866     int charHeight = getCharHeight();
1867     if (anns != null)
1868     {
1869       BitSet graphgrp = new BitSet();
1870       for (AlignmentAnnotation aa : anns)
1871       {
1872         if (aa == null)
1873         {
1874           System.err.println("Null annotation row: ignoring.");
1875           continue;
1876         }
1877         if (!aa.visible)
1878         {
1879           continue;
1880         }
1881         if (aa.graphGroup > -1)
1882         {
1883           if (graphgrp.get(aa.graphGroup))
1884           {
1885             continue;
1886           }
1887           else
1888           {
1889             graphgrp.set(aa.graphGroup);
1890           }
1891         }
1892         aa.height = 0;
1893
1894         if (aa.hasText)
1895         {
1896           aa.height += charHeight;
1897         }
1898
1899         if (aa.hasIcons)
1900         {
1901           aa.height += 16;
1902         }
1903
1904         if (aa.graph > 0)
1905         {
1906           aa.height += aa.graphHeight;
1907         }
1908
1909         if (aa.height == 0)
1910         {
1911           aa.height = 20;
1912         }
1913
1914         height += aa.height;
1915       }
1916     }
1917     if (height == 0)
1918     {
1919       // set minimum
1920       height = 20;
1921     }
1922     return height;
1923   }
1924
1925   @Override
1926   public void updateGroupAnnotationSettings(boolean applyGlobalSettings,
1927           boolean preserveNewGroupSettings)
1928   {
1929     boolean updateCalcs = false;
1930     boolean conv = isShowGroupConservation();
1931     boolean cons = isShowGroupConsensus();
1932     boolean showprf = isShowSequenceLogo();
1933     boolean showConsHist = isShowConsensusHistogram();
1934     boolean normLogo = isNormaliseSequenceLogo();
1935
1936     /**
1937      * TODO reorder the annotation rows according to group/sequence ordering on
1938      * alignment
1939      */
1940     boolean sortg = true;
1941
1942     // remove old automatic annotation
1943     // add any new annotation
1944
1945     // intersect alignment annotation with alignment groups
1946
1947     AlignmentAnnotation[] aan = alignment.getAlignmentAnnotation();
1948     List<SequenceGroup> oldrfs = new ArrayList<SequenceGroup>();
1949     if (aan != null)
1950     {
1951       for (int an = 0; an < aan.length; an++)
1952       {
1953         if (aan[an].autoCalculated && aan[an].groupRef != null)
1954         {
1955           oldrfs.add(aan[an].groupRef);
1956           alignment.deleteAnnotation(aan[an], false);
1957         }
1958       }
1959     }
1960     if (alignment.getGroups() != null)
1961     {
1962       for (SequenceGroup sg : alignment.getGroups())
1963       {
1964         updateCalcs = false;
1965         if (applyGlobalSettings
1966                 || (!preserveNewGroupSettings && !oldrfs.contains(sg)))
1967         {
1968           // set defaults for this group's conservation/consensus
1969           sg.setshowSequenceLogo(showprf);
1970           sg.setShowConsensusHistogram(showConsHist);
1971           sg.setNormaliseSequenceLogo(normLogo);
1972         }
1973         if (conv)
1974         {
1975           updateCalcs = true;
1976           alignment.addAnnotation(sg.getConservationRow(), 0);
1977         }
1978         if (cons)
1979         {
1980           updateCalcs = true;
1981           alignment.addAnnotation(sg.getConsensus(), 0);
1982         }
1983         // refresh the annotation rows
1984         if (updateCalcs)
1985         {
1986           sg.recalcConservation();
1987         }
1988       }
1989     }
1990     oldrfs.clear();
1991   }
1992
1993   @Override
1994   public boolean isDisplayReferenceSeq()
1995   {
1996     return alignment.hasSeqrep() && viewStyle.isDisplayReferenceSeq();
1997   }
1998
1999   @Override
2000   public void setDisplayReferenceSeq(boolean displayReferenceSeq)
2001   {
2002     viewStyle.setDisplayReferenceSeq(displayReferenceSeq);
2003   }
2004
2005   @Override
2006   public boolean isColourByReferenceSeq()
2007   {
2008     return alignment.hasSeqrep() && viewStyle.isColourByReferenceSeq();
2009   }
2010
2011   @Override
2012   public Color getSequenceColour(SequenceI seq)
2013   {
2014     Color sqc = sequenceColours.get(seq);
2015     return (sqc == null ? Color.white : sqc);
2016   }
2017
2018   @Override
2019   public void setSequenceColour(SequenceI seq, Color col)
2020   {
2021     if (col == null)
2022     {
2023       sequenceColours.remove(seq);
2024     }
2025     else
2026     {
2027       sequenceColours.put(seq, col);
2028     }
2029   }
2030
2031   @Override
2032   public void updateSequenceIdColours()
2033   {
2034     for (SequenceGroup sg : alignment.getGroups())
2035     {
2036       if (sg.idColour != null)
2037       {
2038         for (SequenceI s : sg.getSequences(getHiddenRepSequences()))
2039         {
2040           sequenceColours.put(s, sg.idColour);
2041         }
2042       }
2043     }
2044   }
2045
2046   @Override
2047   public void clearSequenceColours()
2048   {
2049     sequenceColours.clear();
2050   };
2051
2052   @Override
2053   public AlignViewportI getCodingComplement()
2054   {
2055     return this.codingComplement;
2056   }
2057
2058   /**
2059    * Set this as the (cDna/protein) complement of the given viewport. Also
2060    * ensures the reverse relationship is set on the given viewport.
2061    */
2062   @Override
2063   public void setCodingComplement(AlignViewportI av)
2064   {
2065     if (this == av)
2066     {
2067       System.err.println("Ignoring recursive setCodingComplement request");
2068     }
2069     else
2070     {
2071       this.codingComplement = av;
2072       // avoid infinite recursion!
2073       if (av.getCodingComplement() != this)
2074       {
2075         av.setCodingComplement(this);
2076       }
2077     }
2078   }
2079
2080   @Override
2081   public boolean isNucleotide()
2082   {
2083     return getAlignment() == null ? false : getAlignment().isNucleotide();
2084   }
2085
2086   @Override
2087   public FeaturesDisplayedI getFeaturesDisplayed()
2088   {
2089     return featuresDisplayed;
2090   }
2091
2092   @Override
2093   public void setFeaturesDisplayed(FeaturesDisplayedI featuresDisplayedI)
2094   {
2095     featuresDisplayed = featuresDisplayedI;
2096   }
2097
2098   @Override
2099   public boolean areFeaturesDisplayed()
2100   {
2101     return featuresDisplayed != null
2102             && featuresDisplayed.getRegisterdFeaturesCount() > 0;
2103   }
2104
2105   /**
2106    * set the flag
2107    *
2108    * @param b
2109    *          features are displayed if true
2110    */
2111   @Override
2112   public void setShowSequenceFeatures(boolean b)
2113   {
2114     viewStyle.setShowSequenceFeatures(b);
2115   }
2116
2117   @Override
2118   public boolean isShowSequenceFeatures()
2119   {
2120     return viewStyle.isShowSequenceFeatures();
2121   }
2122
2123   @Override
2124   public void setShowSequenceFeaturesHeight(boolean selected)
2125   {
2126     viewStyle.setShowSequenceFeaturesHeight(selected);
2127   }
2128
2129   @Override
2130   public boolean isShowSequenceFeaturesHeight()
2131   {
2132     return viewStyle.isShowSequenceFeaturesHeight();
2133   }
2134
2135   @Override
2136   public void setShowAnnotation(boolean b)
2137   {
2138     viewStyle.setShowAnnotation(b);
2139   }
2140
2141   @Override
2142   public boolean isShowAnnotation()
2143   {
2144     return viewStyle.isShowAnnotation();
2145   }
2146
2147   @Override
2148   public boolean isRightAlignIds()
2149   {
2150     return viewStyle.isRightAlignIds();
2151   }
2152
2153   @Override
2154   public void setRightAlignIds(boolean rightAlignIds)
2155   {
2156     viewStyle.setRightAlignIds(rightAlignIds);
2157   }
2158
2159   @Override
2160   public boolean getConservationSelected()
2161   {
2162     return viewStyle.getConservationSelected();
2163   }
2164
2165   @Override
2166   public void setShowBoxes(boolean state)
2167   {
2168     viewStyle.setShowBoxes(state);
2169   }
2170
2171   /**
2172    * @return
2173    * @see jalview.api.ViewStyleI#getTextColour()
2174    */
2175   @Override
2176   public Color getTextColour()
2177   {
2178     return viewStyle.getTextColour();
2179   }
2180
2181   /**
2182    * @return
2183    * @see jalview.api.ViewStyleI#getTextColour2()
2184    */
2185   @Override
2186   public Color getTextColour2()
2187   {
2188     return viewStyle.getTextColour2();
2189   }
2190
2191   /**
2192    * @return
2193    * @see jalview.api.ViewStyleI#getThresholdTextColour()
2194    */
2195   @Override
2196   public int getThresholdTextColour()
2197   {
2198     return viewStyle.getThresholdTextColour();
2199   }
2200
2201   /**
2202    * @return
2203    * @see jalview.api.ViewStyleI#isConservationColourSelected()
2204    */
2205   @Override
2206   public boolean isConservationColourSelected()
2207   {
2208     return viewStyle.isConservationColourSelected();
2209   }
2210
2211   /**
2212    * @return
2213    * @see jalview.api.ViewStyleI#isRenderGaps()
2214    */
2215   @Override
2216   public boolean isRenderGaps()
2217   {
2218     return viewStyle.isRenderGaps();
2219   }
2220
2221   /**
2222    * @return
2223    * @see jalview.api.ViewStyleI#isShowColourText()
2224    */
2225   @Override
2226   public boolean isShowColourText()
2227   {
2228     return viewStyle.isShowColourText();
2229   }
2230
2231   /**
2232    * @param conservationColourSelected
2233    * @see jalview.api.ViewStyleI#setConservationColourSelected(boolean)
2234    */
2235   @Override
2236   public void setConservationColourSelected(
2237           boolean conservationColourSelected)
2238   {
2239     viewStyle.setConservationColourSelected(conservationColourSelected);
2240   }
2241
2242   /**
2243    * @param showColourText
2244    * @see jalview.api.ViewStyleI#setShowColourText(boolean)
2245    */
2246   @Override
2247   public void setShowColourText(boolean showColourText)
2248   {
2249     viewStyle.setShowColourText(showColourText);
2250   }
2251
2252   /**
2253    * @param textColour
2254    * @see jalview.api.ViewStyleI#setTextColour(java.awt.Color)
2255    */
2256   @Override
2257   public void setTextColour(Color textColour)
2258   {
2259     viewStyle.setTextColour(textColour);
2260   }
2261
2262   /**
2263    * @param thresholdTextColour
2264    * @see jalview.api.ViewStyleI#setThresholdTextColour(int)
2265    */
2266   @Override
2267   public void setThresholdTextColour(int thresholdTextColour)
2268   {
2269     viewStyle.setThresholdTextColour(thresholdTextColour);
2270   }
2271
2272   /**
2273    * @param textColour2
2274    * @see jalview.api.ViewStyleI#setTextColour2(java.awt.Color)
2275    */
2276   @Override
2277   public void setTextColour2(Color textColour2)
2278   {
2279     viewStyle.setTextColour2(textColour2);
2280   }
2281
2282   @Override
2283   public ViewStyleI getViewStyle()
2284   {
2285     return new ViewStyle(viewStyle);
2286   }
2287
2288   @Override
2289   public void setViewStyle(ViewStyleI settingsForView)
2290   {
2291     viewStyle = new ViewStyle(settingsForView);
2292   }
2293
2294   @Override
2295   public boolean sameStyle(ViewStyleI them)
2296   {
2297     return viewStyle.sameStyle(them);
2298   }
2299
2300   /**
2301    * @return
2302    * @see jalview.api.ViewStyleI#getIdWidth()
2303    */
2304   @Override
2305   public int getIdWidth()
2306   {
2307     return viewStyle.getIdWidth();
2308   }
2309
2310   /**
2311    * @param i
2312    * @see jalview.api.ViewStyleI#setIdWidth(int)
2313    */
2314   @Override
2315   public void setIdWidth(int i)
2316   {
2317     viewStyle.setIdWidth(i);
2318   }
2319
2320   /**
2321    * @return
2322    * @see jalview.api.ViewStyleI#isCentreColumnLabels()
2323    */
2324   @Override
2325   public boolean isCentreColumnLabels()
2326   {
2327     return viewStyle.isCentreColumnLabels();
2328   }
2329
2330   /**
2331    * @param centreColumnLabels
2332    * @see jalview.api.ViewStyleI#setCentreColumnLabels(boolean)
2333    */
2334   @Override
2335   public void setCentreColumnLabels(boolean centreColumnLabels)
2336   {
2337     viewStyle.setCentreColumnLabels(centreColumnLabels);
2338   }
2339
2340   /**
2341    * @param showdbrefs
2342    * @see jalview.api.ViewStyleI#setShowDBRefs(boolean)
2343    */
2344   @Override
2345   public void setShowDBRefs(boolean showdbrefs)
2346   {
2347     viewStyle.setShowDBRefs(showdbrefs);
2348   }
2349
2350   /**
2351    * @return
2352    * @see jalview.api.ViewStyleI#isShowDBRefs()
2353    */
2354   @Override
2355   public boolean isShowDBRefs()
2356   {
2357     return viewStyle.isShowDBRefs();
2358   }
2359
2360   /**
2361    * @return
2362    * @see jalview.api.ViewStyleI#isShowNPFeats()
2363    */
2364   @Override
2365   public boolean isShowNPFeats()
2366   {
2367     return viewStyle.isShowNPFeats();
2368   }
2369
2370   /**
2371    * @param shownpfeats
2372    * @see jalview.api.ViewStyleI#setShowNPFeats(boolean)
2373    */
2374   @Override
2375   public void setShowNPFeats(boolean shownpfeats)
2376   {
2377     viewStyle.setShowNPFeats(shownpfeats);
2378   }
2379
2380   public abstract StructureSelectionManager getStructureSelectionManager();
2381
2382   /**
2383    * Add one command to the command history list.
2384    *
2385    * @param command
2386    */
2387   public void addToHistoryList(CommandI command)
2388   {
2389     if (this.historyList != null)
2390     {
2391       this.historyList.push(command);
2392       broadcastCommand(command, false);
2393     }
2394   }
2395
2396   protected void broadcastCommand(CommandI command, boolean undo)
2397   {
2398     getStructureSelectionManager().commandPerformed(command, undo,
2399             getVamsasSource());
2400   }
2401
2402   /**
2403    * Add one command to the command redo list.
2404    *
2405    * @param command
2406    */
2407   public void addToRedoList(CommandI command)
2408   {
2409     if (this.redoList != null)
2410     {
2411       this.redoList.push(command);
2412     }
2413     broadcastCommand(command, true);
2414   }
2415
2416   /**
2417    * Clear the command redo list.
2418    */
2419   public void clearRedoList()
2420   {
2421     if (this.redoList != null)
2422     {
2423       this.redoList.clear();
2424     }
2425   }
2426
2427   public void setHistoryList(Deque<CommandI> list)
2428   {
2429     this.historyList = list;
2430   }
2431
2432   public Deque<CommandI> getHistoryList()
2433   {
2434     return this.historyList;
2435   }
2436
2437   public void setRedoList(Deque<CommandI> list)
2438   {
2439     this.redoList = list;
2440   }
2441
2442   public Deque<CommandI> getRedoList()
2443   {
2444     return this.redoList;
2445   }
2446
2447   @Override
2448   public VamsasSource getVamsasSource()
2449   {
2450     return this;
2451   }
2452
2453   public SequenceAnnotationOrder getSortAnnotationsBy()
2454   {
2455     return sortAnnotationsBy;
2456   }
2457
2458   public void setSortAnnotationsBy(SequenceAnnotationOrder sortAnnotationsBy)
2459   {
2460     this.sortAnnotationsBy = sortAnnotationsBy;
2461   }
2462
2463   public boolean isShowAutocalculatedAbove()
2464   {
2465     return showAutocalculatedAbove;
2466   }
2467
2468   public void setShowAutocalculatedAbove(boolean showAutocalculatedAbove)
2469   {
2470     this.showAutocalculatedAbove = showAutocalculatedAbove;
2471   }
2472
2473   @Override
2474   public boolean isScaleProteinAsCdna()
2475   {
2476     return viewStyle.isScaleProteinAsCdna();
2477   }
2478
2479   @Override
2480   public void setScaleProteinAsCdna(boolean b)
2481   {
2482     viewStyle.setScaleProteinAsCdna(b);
2483   }
2484
2485   /**
2486    * @return true if view should scroll to show the highlighted region of a
2487    *         sequence
2488    * @return
2489    */
2490   @Override
2491   public final boolean isFollowHighlight()
2492   {
2493     return followHighlight;
2494   }
2495
2496   @Override
2497   public final void setFollowHighlight(boolean b)
2498   {
2499     this.followHighlight = b;
2500   }
2501
2502   public int getStartRes()
2503   {
2504     return startRes;
2505   }
2506
2507   @Override
2508   public int getEndRes()
2509   {
2510     return endRes;
2511   }
2512
2513   public int getStartSeq()
2514   {
2515     return startSeq;
2516   }
2517
2518   public void setStartRes(int res)
2519   {
2520     this.startRes = res;
2521   }
2522
2523   public void setStartSeq(int seq)
2524   {
2525     this.startSeq = seq;
2526   }
2527
2528   public void setEndRes(int res)
2529   {
2530     if (res > alignment.getWidth() - 1)
2531     {
2532       // log.System.out.println(" Corrected res from " + res + " to maximum " +
2533       // (alignment.getWidth()-1));
2534       res = alignment.getWidth() - 1;
2535     }
2536     if (res < 0)
2537     {
2538       res = 0;
2539     }
2540     this.endRes = res;
2541   }
2542
2543   public void setEndSeq(int seq)
2544   {
2545     if (seq > alignment.getHeight())
2546     {
2547       seq = alignment.getHeight();
2548     }
2549     if (seq < 0)
2550     {
2551       seq = 0;
2552     }
2553     this.endSeq = seq;
2554   }
2555
2556   public int getEndSeq()
2557   {
2558     return endSeq;
2559   }
2560
2561   /**
2562    * Helper method to populate the SearchResults with the location in the
2563    * complementary alignment to scroll to, in order to match this one.
2564    *
2565    * @param sr
2566    *          the SearchResults to add to
2567    * @return the offset (below top of visible region) of the matched sequence
2568    */
2569   protected int findComplementScrollTarget(SearchResults sr)
2570   {
2571     final AlignViewportI complement = getCodingComplement();
2572     if (complement == null || !complement.isFollowHighlight())
2573     {
2574       return 0;
2575     }
2576     boolean iAmProtein = !getAlignment().isNucleotide();
2577     AlignmentI proteinAlignment = iAmProtein ? getAlignment() : complement
2578             .getAlignment();
2579     if (proteinAlignment == null)
2580     {
2581       return 0;
2582     }
2583     final Set<AlignedCodonFrame> mappings = proteinAlignment
2584             .getCodonFrames();
2585
2586     /*
2587      * Heuristic: find the first mapped sequence (if any) with a non-gapped
2588      * residue in the middle column of the visible region. Scroll the
2589      * complementary alignment to line up the corresponding residue.
2590      */
2591     int seqOffset = 0;
2592     SequenceI sequence = null;
2593
2594     /*
2595      * locate 'middle' column (true middle if an odd number visible, left of
2596      * middle if an even number visible)
2597      */
2598     int middleColumn = getStartRes() + (getEndRes() - getStartRes()) / 2;
2599     final HiddenSequences hiddenSequences = getAlignment()
2600             .getHiddenSequences();
2601
2602     /*
2603      * searching to the bottom of the alignment gives smoother scrolling across
2604      * all gapped visible regions
2605      */
2606     int lastSeq = alignment.getHeight() - 1;
2607     for (int seqNo = getStartSeq(); seqNo < lastSeq; seqNo++, seqOffset++)
2608     {
2609       sequence = getAlignment().getSequenceAt(seqNo);
2610       if (hiddenSequences != null && hiddenSequences.isHidden(sequence))
2611       {
2612         continue;
2613       }
2614       if (Comparison.isGap(sequence.getCharAt(middleColumn)))
2615       {
2616         continue;
2617       }
2618       List<AlignedCodonFrame> seqMappings = MappingUtils
2619               .findMappingsForSequence(sequence, mappings);
2620       if (!seqMappings.isEmpty())
2621       {
2622         break;
2623       }
2624     }
2625
2626     if (sequence == null)
2627     {
2628       /*
2629        * No ungapped mapped sequence in middle column - do nothing
2630        */
2631       return 0;
2632     }
2633     MappingUtils.addSearchResults(sr, sequence,
2634             sequence.findPosition(middleColumn), mappings);
2635     return seqOffset;
2636   }
2637 }