src/jalview/datamodel/Alignment.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.datamodel;
  22
  23 import jalview.analysis.AlignmentUtils;
  24 import jalview.datamodel.AlignedCodonFrame.SequenceToSequenceMapping;
  25 import jalview.io.FastaFile;
  26 import jalview.util.Comparison;
  27 import jalview.util.LinkedIdentityHashSet;
  28 import jalview.util.MessageManager;
  29
  30 import java.util.ArrayList;
  31 import java.util.Arrays;
  32 import java.util.BitSet;
  33 import java.util.Collections;
  34 import java.util.Enumeration;
  35 import java.util.HashSet;
  36 import java.util.Hashtable;
  37 import java.util.Iterator;
  38 import java.util.List;
  39 import java.util.Map;
  40 import java.util.Set;
  41 import java.util.Vector;
  42
  43 /**
  44  * Data structure to hold and manipulate a multiple sequence alignment
  45  */
  46 /**
  47  * @author JimP
  48  *
  49  */
  50 public class Alignment implements AlignmentI
  51 {
  52   private Alignment dataset;
  53
  54   private List<SequenceI> sequences;
  55
  56   protected List<SequenceGroup> groups;
  57
  58   protected char gapCharacter = '-';
  59
  60   private boolean nucleotide = true;
  61
  62   public boolean hasRNAStructure = false;
  63
  64   public AlignmentAnnotation[] annotations;
  65
  66   HiddenSequences hiddenSequences;
  67
  68   HiddenColumns hiddenCols;
  69
  70   public Hashtable alignmentProperties;
  71
  72   private List<AlignedCodonFrame> codonFrameList;
  73
  74   private void initAlignment(SequenceI[] seqs)
  75   {
  76     groups = Collections.synchronizedList(new ArrayList<SequenceGroup>());
  77     hiddenSequences = new HiddenSequences(this);
  78     hiddenCols = new HiddenColumns();
  79     codonFrameList = new ArrayList<>();
  80
  81     nucleotide = Comparison.isNucleotide(seqs);
  82
  83     sequences = Collections.synchronizedList(new ArrayList<SequenceI>());
  84
  85     for (int i = 0; i < seqs.length; i++)
  86     {
  87       sequences.add(seqs[i]);
  88     }
  89
  90   }
  91
  92   /**
  93    * Make a 'copy' alignment - sequences have new copies of features and
  94    * annotations, but share the original dataset sequences.
  95    */
  96   public Alignment(AlignmentI al)
  97   {
  98     SequenceI[] seqs = al.getSequencesArray();
  99     for (int i = 0; i < seqs.length; i++)
 100     {
 101       seqs[i] = new Sequence(seqs[i]);
 102     }
 103
 104     initAlignment(seqs);
 105
 106     /*
 107      * Share the same dataset sequence mappings (if any).
 108      */
 109     if (dataset == null && al.getDataset() == null)
 110     {
 111       this.setCodonFrames(al.getCodonFrames());
 112     }
 113   }
 114
 115   /**
 116    * Make an alignment from an array of Sequences.
 117    *
 118    * @param sequences
 119    */
 120   public Alignment(SequenceI[] seqs)
 121   {
 122     initAlignment(seqs);
 123   }
 124
 125   /**
 126    * Make a new alignment from an array of SeqCigars
 127    *
 128    * @param seqs
 129    *          SeqCigar[]
 130    */
 131   public Alignment(SeqCigar[] alseqs)
 132   {
 133     SequenceI[] seqs = SeqCigar.createAlignmentSequences(alseqs,
 134             gapCharacter, new HiddenColumns(), null);
 135     initAlignment(seqs);
 136   }
 137
 138   /**
 139    * Make a new alignment from an CigarArray JBPNote - can only do this when
 140    * compactAlignment does not contain hidden regions. JBPNote - must also check
 141    * that compactAlignment resolves to a set of SeqCigars - or construct them
 142    * appropriately.
 143    *
 144    * @param compactAlignment
 145    *          CigarArray
 146    */
 147   public static AlignmentI createAlignment(CigarArray compactAlignment)
 148   {
 149     throw new Error(MessageManager
 150             .getString("error.alignment_cigararray_not_implemented"));
 151     // this(compactAlignment.refCigars);
 152   }
 153
 154   @Override
 155   public List<SequenceI> getSequences()
 156   {
 157     return sequences;
 158   }
 159
 160   @Override
 161   public List<SequenceI> getSequences(
 162           Map<SequenceI, SequenceCollectionI> hiddenReps)
 163   {
 164     // TODO: in jalview 2.8 we don't do anything with hiddenreps - fix design to
 165     // work on this.
 166     return sequences;
 167   }
 168
 169   @Override
 170   public SequenceI[] getSequencesArray()
 171   {
 172     if (sequences == null)
 173     {
 174       return null;
 175     }
 176     synchronized (sequences)
 177     {
 178       return sequences.toArray(new SequenceI[sequences.size()]);
 179     }
 180   }
 181
 182   /**
 183    * Returns a map of lists of sequences keyed by sequence name.
 184    *
 185    * @return
 186    */
 187   @Override
 188   public Map<String, List<SequenceI>> getSequencesByName()
 189   {
 190     return AlignmentUtils.getSequencesByName(this);
 191   }
 192
 193   @Override
 194   public SequenceI getSequenceAt(int i)
 195   {
 196     synchronized (sequences)
 197     {
 198
 199       if (i > -1 && i < sequences.size())
 200       {
 201         return sequences.get(i);
 202       }
 203     }
 204
 205     return null;
 206   }
 207
 208   @Override
 209   public SequenceI getSequenceAtAbsoluteIndex(int i)
 210   {
 211     SequenceI seq = null;
 212     if (getHiddenSequences().getSize() > 0)
 213     {
 214       seq = getHiddenSequences().getHiddenSequence(i);
 215       if (seq == null)
 216       {
 217         // didn't find the sequence in the hidden sequences, get it from the
 218         // alignment
 219         int index = getHiddenSequences().findIndexWithoutHiddenSeqs(i);
 220         seq = getSequenceAt(index);
 221       }
 222     }
 223     else
 224     {
 225       seq = getSequenceAt(i);
 226     }
 227     return seq;
 228   }
 229
 230   /**
 231    * Adds a sequence to the alignment. Recalculates maxLength and size. Note
 232    * this currently does not recalculate whether or not the alignment is
 233    * nucleotide, so mixed alignments may have undefined behaviour.
 234    *
 235    * @param snew
 236    */
 237   @Override
 238   public void addSequence(SequenceI snew)
 239   {
 240     if (dataset != null)
 241     {
 242
 243       // maintain dataset integrity
 244       SequenceI dsseq = snew.getDatasetSequence();
 245       if (dsseq == null)
 246       {
 247         // derive new sequence
 248         SequenceI adding = snew.deriveSequence();
 249         snew = adding;
 250         dsseq = snew.getDatasetSequence();
 251       }
 252       if (getDataset().findIndex(dsseq) == -1)
 253       {
 254         getDataset().addSequence(dsseq);
 255       }
 256
 257     }
 258     if (sequences == null)
 259     {
 260       initAlignment(new SequenceI[] { snew });
 261     }
 262     else
 263     {
 264       synchronized (sequences)
 265       {
 266         sequences.add(snew);
 267       }
 268     }
 269     if (hiddenSequences != null)
 270     {
 271       hiddenSequences.adjustHeightSequenceAdded();
 272     }
 273   }
 274
 275   @Override
 276   public SequenceI replaceSequenceAt(int i, SequenceI snew)
 277   {
 278     synchronized (sequences)
 279     {
 280       if (sequences.size() > i)
 281       {
 282         return sequences.set(i, snew);
 283
 284       }
 285       else
 286       {
 287         sequences.add(snew);
 288         hiddenSequences.adjustHeightSequenceAdded();
 289       }
 290       return null;
 291     }
 292   }
 293
 294   /**
 295    * DOCUMENT ME!
 296    *
 297    * @return DOCUMENT ME!
 298    */
 299   @Override
 300   public List<SequenceGroup> getGroups()
 301   {
 302     return groups;
 303   }
 304
 305   @Override
 306   public void finalize() throws Throwable
 307   {
 308     if (getDataset() != null)
 309     {
 310       getDataset().removeAlignmentRef();
 311     }
 312
 313     nullReferences();
 314     super.finalize();
 315   }
 316
 317   /**
 318    * Defensively nulls out references in case this object is not garbage
 319    * collected
 320    */
 321   void nullReferences()
 322   {
 323     dataset = null;
 324     sequences = null;
 325     groups = null;
 326     annotations = null;
 327     hiddenSequences = null;
 328   }
 329
 330   /**
 331    * decrement the alignmentRefs counter by one and null references if it goes
 332    * to zero.
 333    *
 334    * @throws Throwable
 335    */
 336   private void removeAlignmentRef() throws Throwable
 337   {
 338     if (--alignmentRefs == 0)
 339     {
 340       nullReferences();
 341     }
 342   }
 343
 344   @Override
 345   public void deleteSequence(SequenceI s)
 346   {
 347     synchronized (sequences)
 348     {
 349       deleteSequence(findIndex(s));
 350     }
 351   }
 352
 353   @Override
 354   public void deleteSequence(int i)
 355   {
 356     synchronized (sequences)
 357     {
 358       if (i > -1 && i < getHeight())
 359       {
 360         sequences.remove(i);
 361         hiddenSequences.adjustHeightSequenceDeleted(i);
 362       }
 363     }
 364   }
 365
 366   @Override
 367   public void deleteHiddenSequence(int i)
 368   {
 369     synchronized (sequences)
 370     {
 371       if (i > -1 && i < getHeight())
 372       {
 373         sequences.remove(i);
 374       }
 375     }
 376   }
 377
 378   /*
 379    * (non-Javadoc)
 380    *
 381    * @see jalview.datamodel.AlignmentI#findGroup(jalview.datamodel.SequenceI)
 382    */
 383   @Override
 384   public SequenceGroup findGroup(SequenceI seq, int position)
 385   {
 386     synchronized (groups)
 387     {
 388       for (SequenceGroup sg : groups)
 389       {
 390         if (sg.getSequences(null).contains(seq))
 391         {
 392           if (position >= sg.getStartRes() && position <= sg.getEndRes())
 393           {
 394             return sg;
 395           }
 396         }
 397       }
 398     }
 399     return null;
 400   }
 401
 402   /*
 403    * (non-Javadoc)
 404    *
 405    * @see
 406    * jalview.datamodel.AlignmentI#findAllGroups(jalview.datamodel.SequenceI)
 407    */
 408   @Override
 409   public SequenceGroup[] findAllGroups(SequenceI s)
 410   {
 411     ArrayList<SequenceGroup> temp = new ArrayList<>();
 412
 413     synchronized (groups)
 414     {
 415       int gSize = groups.size();
 416       for (int i = 0; i < gSize; i++)
 417       {
 418         SequenceGroup sg = groups.get(i);
 419         if (sg == null || sg.getSequences() == null)
 420         {
 421           this.deleteGroup(sg);
 422           gSize--;
 423           continue;
 424         }
 425
 426         if (sg.getSequences().contains(s))
 427         {
 428           temp.add(sg);
 429         }
 430       }
 431     }
 432     SequenceGroup[] ret = new SequenceGroup[temp.size()];
 433     return temp.toArray(ret);
 434   }
 435
 436   /**    */
 437   @Override
 438   public void addGroup(SequenceGroup sg)
 439   {
 440     synchronized (groups)
 441     {
 442       if (!groups.contains(sg))
 443       {
 444         if (hiddenSequences.getSize() > 0)
 445         {
 446           int i, iSize = sg.getSize();
 447           for (i = 0; i < iSize; i++)
 448           {
 449             if (!sequences.contains(sg.getSequenceAt(i)))
 450             {
 451               sg.deleteSequence(sg.getSequenceAt(i), false);
 452               iSize--;
 453               i--;
 454             }
 455           }
 456
 457           if (sg.getSize() < 1)
 458           {
 459             return;
 460           }
 461         }
 462         sg.setContext(this, true);
 463         groups.add(sg);
 464       }
 465     }
 466   }
 467
 468   /**
 469    * remove any annotation that references gp
 470    *
 471    * @param gp
 472    *          (if null, removes all group associated annotation)
 473    */
 474   private void removeAnnotationForGroup(SequenceGroup gp)
 475   {
 476     if (annotations == null || annotations.length == 0)
 477     {
 478       return;
 479     }
 480     // remove annotation very quickly
 481     AlignmentAnnotation[] t,
 482             todelete = new AlignmentAnnotation[annotations.length],
 483             tokeep = new AlignmentAnnotation[annotations.length];
 484     int i, p, k;
 485     if (gp == null)
 486     {
 487       for (i = 0, p = 0, k = 0; i < annotations.length; i++)
 488       {
 489         if (annotations[i].groupRef != null)
 490         {
 491           todelete[p++] = annotations[i];
 492         }
 493         else
 494         {
 495           tokeep[k++] = annotations[i];
 496         }
 497       }
 498     }
 499     else
 500     {
 501       for (i = 0, p = 0, k = 0; i < annotations.length; i++)
 502       {
 503         if (annotations[i].groupRef == gp)
 504         {
 505           todelete[p++] = annotations[i];
 506         }
 507         else
 508         {
 509           tokeep[k++] = annotations[i];
 510         }
 511       }
 512     }
 513     if (p > 0)
 514     {
 515       // clear out the group associated annotation.
 516       for (i = 0; i < p; i++)
 517       {
 518         unhookAnnotation(todelete[i]);
 519         todelete[i] = null;
 520       }
 521       t = new AlignmentAnnotation[k];
 522       for (i = 0; i < k; i++)
 523       {
 524         t[i] = tokeep[i];
 525       }
 526       annotations = t;
 527     }
 528   }
 529
 530   @Override
 531   public void deleteAllGroups()
 532   {
 533     synchronized (groups)
 534     {
 535       if (annotations != null)
 536       {
 537         removeAnnotationForGroup(null);
 538       }
 539       for (SequenceGroup sg : groups)
 540       {
 541         sg.setContext(null, false);
 542       }
 543       groups.clear();
 544     }
 545   }
 546
 547   /**    */
 548   @Override
 549   public void deleteGroup(SequenceGroup g)
 550   {
 551     synchronized (groups)
 552     {
 553       if (groups.contains(g))
 554       {
 555         removeAnnotationForGroup(g);
 556         groups.remove(g);
 557         g.setContext(null, false);
 558       }
 559     }
 560   }
 561
 562   /**    */
 563   @Override
 564   public SequenceI findName(String name)
 565   {
 566     return findName(name, false);
 567   }
 568
 569   /*
 570    * (non-Javadoc)
 571    *
 572    * @see jalview.datamodel.AlignmentI#findName(java.lang.String, boolean)
 573    */
 574   @Override
 575   public SequenceI findName(String token, boolean b)
 576   {
 577     return findName(null, token, b);
 578   }
 579
 580   /*
 581    * (non-Javadoc)
 582    *
 583    * @see jalview.datamodel.AlignmentI#findName(SequenceI, java.lang.String,
 584    * boolean)
 585    */
 586   @Override
 587   public SequenceI findName(SequenceI startAfter, String token, boolean b)
 588   {
 589
 590     int i = 0;
 591     SequenceI sq = null;
 592     String sqname = null;
 593     int nseq = sequences.size();
 594     if (startAfter != null)
 595     {
 596       // try to find the sequence in the alignment
 597       boolean matched = false;
 598       while (i < nseq)
 599       {
 600         if (getSequenceAt(i++) == startAfter)
 601         {
 602           matched = true;
 603           break;
 604         }
 605       }
 606       if (!matched)
 607       {
 608         i = 0;
 609       }
 610     }
 611     while (i < nseq)
 612     {
 613       sq = getSequenceAt(i);
 614       sqname = sq.getName();
 615       if (sqname.equals(token) // exact match
 616               || (b && // allow imperfect matches - case varies
 617                       (sqname.equalsIgnoreCase(token))))
 618       {
 619         return getSequenceAt(i);
 620       }
 621
 622       i++;
 623     }
 624
 625     return null;
 626   }
 627
 628   @Override
 629   public SequenceI[] findSequenceMatch(String name)
 630   {
 631     Vector matches = new Vector();
 632     int i = 0;
 633
 634     while (i < sequences.size())
 635     {
 636       if (getSequenceAt(i).getName().equals(name))
 637       {
 638         matches.addElement(getSequenceAt(i));
 639       }
 640       i++;
 641     }
 642
 643     SequenceI[] result = new SequenceI[matches.size()];
 644     for (i = 0; i < result.length; i++)
 645     {
 646       result[i] = (SequenceI) matches.elementAt(i);
 647     }
 648
 649     return result;
 650
 651   }
 652
 653   /*
 654    * (non-Javadoc)
 655    *
 656    * @see jalview.datamodel.AlignmentI#findIndex(jalview.datamodel.SequenceI)
 657    */
 658   @Override
 659   public int findIndex(SequenceI s)
 660   {
 661     int i = 0;
 662
 663     while (i < sequences.size())
 664     {
 665       if (s == getSequenceAt(i))
 666       {
 667         return i;
 668       }
 669
 670       i++;
 671     }
 672
 673     return -1;
 674   }
 675
 676   /*
 677    * (non-Javadoc)
 678    *
 679    * @see
 680    * jalview.datamodel.AlignmentI#findIndex(jalview.datamodel.SearchResults)
 681    */
 682   @Override
 683   public int findIndex(SearchResultsI results)
 684   {
 685     int i = 0;
 686
 687     while (i < sequences.size())
 688     {
 689       if (results.involvesSequence(getSequenceAt(i)))
 690       {
 691         return i;
 692       }
 693       i++;
 694     }
 695     return -1;
 696   }
 697
 698   @Override
 699   public int getHeight()
 700   {
 701     return sequences.size();
 702   }
 703
 704   @Override
 705   public int getAbsoluteHeight()
 706   {
 707     return sequences.size() + getHiddenSequences().getSize();
 708   }
 709
 710   @Override
 711   public int getWidth()
 712   {
 713     int maxLength = -1;
 714
 715     for (int i = 0; i < sequences.size(); i++)
 716     {
 717       maxLength = Math.max(maxLength, getSequenceAt(i).getLength());
 718     }
 719     return maxLength;
 720   }
 721
 722   @Override
 723   public int getVisibleWidth()
 724   {
 725     int w = getWidth();
 726     if (hiddenCols != null)
 727     {
 728       w -= hiddenCols.getSize();
 729     }
 730     return w;
 731   }
 732
 733   /**
 734    * DOCUMENT ME!
 735    *
 736    * @param gc
 737    *          DOCUMENT ME!
 738    */
 739   @Override
 740   public void setGapCharacter(char gc)
 741   {
 742     gapCharacter = gc;
 743     synchronized (sequences)
 744     {
 745       for (SequenceI seq : sequences)
 746       {
 747         seq.setSequence(seq.getSequenceAsString().replace('.', gc)
 748                 .replace('-', gc).replace(' ', gc));
 749       }
 750     }
 751   }
 752
 753   /**
 754    * DOCUMENT ME!
 755    *
 756    * @return DOCUMENT ME!
 757    */
 758   @Override
 759   public char getGapCharacter()
 760   {
 761     return gapCharacter;
 762   }
 763
 764   /*
 765    * (non-Javadoc)
 766    *
 767    * @see jalview.datamodel.AlignmentI#isAligned()
 768    */
 769   @Override
 770   public boolean isAligned()
 771   {
 772     return isAligned(false);
 773   }
 774
 775   /*
 776    * (non-Javadoc)
 777    *
 778    * @see jalview.datamodel.AlignmentI#isAligned(boolean)
 779    */
 780   @Override
 781   public boolean isAligned(boolean includeHidden)
 782   {
 783     int width = getWidth();
 784     if (hiddenSequences == null || hiddenSequences.getSize() == 0)
 785     {
 786       includeHidden = true; // no hidden sequences to check against.
 787     }
 788     for (int i = 0; i < sequences.size(); i++)
 789     {
 790       if (includeHidden || !hiddenSequences.isHidden(getSequenceAt(i)))
 791       {
 792         if (getSequenceAt(i).getLength() != width)
 793         {
 794           return false;
 795         }
 796       }
 797     }
 798
 799     return true;
 800   }
 801
 802   @Override
 803   public boolean isHidden(int alignmentIndex)
 804   {
 805     return (getHiddenSequences().getHiddenSequence(alignmentIndex) != null);
 806   }
 807
 808   /**
 809    * Delete all annotations, including auto-calculated if the flag is set true.
 810    * Returns true if at least one annotation was deleted, else false.
 811    *
 812    * @param includingAutoCalculated
 813    * @return
 814    */
 815   @Override
 816   public boolean deleteAllAnnotations(boolean includingAutoCalculated)
 817   {
 818     boolean result = false;
 819     for (AlignmentAnnotation alan : getAlignmentAnnotation())
 820     {
 821       if (!alan.autoCalculated || includingAutoCalculated)
 822       {
 823         deleteAnnotation(alan);
 824         result = true;
 825       }
 826     }
 827     return result;
 828   }
 829
 830   /*
 831    * (non-Javadoc)
 832    *
 833    * @seejalview.datamodel.AlignmentI#deleteAnnotation(jalview.datamodel.
 834    * AlignmentAnnotation)
 835    */
 836   @Override
 837   public boolean deleteAnnotation(AlignmentAnnotation aa)
 838   {
 839     return deleteAnnotation(aa, true);
 840   }
 841
 842   @Override
 843   public boolean deleteAnnotation(AlignmentAnnotation aa, boolean unhook)
 844   {
 845     int aSize = 1;
 846
 847     if (annotations != null)
 848     {
 849       aSize = annotations.length;
 850     }
 851
 852     if (aSize < 1)
 853     {
 854       return false;
 855     }
 856
 857     AlignmentAnnotation[] temp = new AlignmentAnnotation[aSize - 1];
 858
 859     boolean swap = false;
 860     int tIndex = 0;
 861
 862     for (int i = 0; i < aSize; i++)
 863     {
 864       if (annotations[i] == aa)
 865       {
 866         swap = true;
 867         continue;
 868       }
 869       if (tIndex < temp.length)
 870       {
 871         temp[tIndex++] = annotations[i];
 872       }
 873     }
 874
 875     if (swap)
 876     {
 877       annotations = temp;
 878       if (unhook)
 879       {
 880         unhookAnnotation(aa);
 881       }
 882     }
 883     return swap;
 884   }
 885
 886   /**
 887    * remove any object references associated with this annotation
 888    *
 889    * @param aa
 890    */
 891   private void unhookAnnotation(AlignmentAnnotation aa)
 892   {
 893     if (aa.sequenceRef != null)
 894     {
 895       aa.sequenceRef.removeAlignmentAnnotation(aa);
 896     }
 897     if (aa.groupRef != null)
 898     {
 899       // probably need to do more here in the future (post 2.5.0)
 900       aa.groupRef = null;
 901     }
 902   }
 903
 904   /*
 905    * (non-Javadoc)
 906    *
 907    * @seejalview.datamodel.AlignmentI#addAnnotation(jalview.datamodel.
 908    * AlignmentAnnotation)
 909    */
 910   @Override
 911   public void addAnnotation(AlignmentAnnotation aa)
 912   {
 913     addAnnotation(aa, -1);
 914   }
 915
 916   /*
 917    * (non-Javadoc)
 918    *
 919    * @seejalview.datamodel.AlignmentI#addAnnotation(jalview.datamodel.
 920    * AlignmentAnnotation, int)
 921    */
 922   @Override
 923   public void addAnnotation(AlignmentAnnotation aa, int pos)
 924   {
 925     if (aa.getRNAStruc() != null)
 926     {
 927       hasRNAStructure = true;
 928     }
 929
 930     int aSize = 1;
 931     if (annotations != null)
 932     {
 933       aSize = annotations.length + 1;
 934     }
 935
 936     AlignmentAnnotation[] temp = new AlignmentAnnotation[aSize];
 937     int i = 0;
 938     if (pos == -1 || pos >= aSize)
 939     {
 940       temp[aSize - 1] = aa;
 941     }
 942     else
 943     {
 944       temp[pos] = aa;
 945     }
 946     if (aSize > 1)
 947     {
 948       int p = 0;
 949       for (i = 0; i < (aSize - 1); i++, p++)
 950       {
 951         if (p == pos)
 952         {
 953           p++;
 954         }
 955         if (p < temp.length)
 956         {
 957           temp[p] = annotations[i];
 958         }
 959       }
 960     }
 961
 962     annotations = temp;
 963   }
 964
 965   @Override
 966   public void setAnnotationIndex(AlignmentAnnotation aa, int index)
 967   {
 968     if (aa == null || annotations == null || annotations.length - 1 < index)
 969     {
 970       return;
 971     }
 972
 973     int aSize = annotations.length;
 974     AlignmentAnnotation[] temp = new AlignmentAnnotation[aSize];
 975
 976     temp[index] = aa;
 977
 978     for (int i = 0; i < aSize; i++)
 979     {
 980       if (i == index)
 981       {
 982         continue;
 983       }
 984
 985       if (i < index)
 986       {
 987         temp[i] = annotations[i];
 988       }
 989       else
 990       {
 991         temp[i] = annotations[i - 1];
 992       }
 993     }
 994
 995     annotations = temp;
 996   }
 997
 998   @Override
 999   /**
1000    * returns all annotation on the alignment
1001    */
1002   public AlignmentAnnotation[] getAlignmentAnnotation()
1003   {
1004     return annotations;
1005   }
1006
1007   @Override
1008   public boolean isNucleotide()
1009   {
1010     return nucleotide;
1011   }
1012
1013   @Override
1014   public boolean hasRNAStructure()
1015   {
1016     // TODO can it happen that structure is removed from alignment?
1017     return hasRNAStructure;
1018   }
1019
1020   @Override
1021   public void setDataset(AlignmentI data)
1022   {
1023     if (dataset == null && data == null)
1024     {
1025       createDatasetAlignment();
1026     }
1027     else if (dataset == null && data != null)
1028     {
1029       if (data == this)
1030       {
1031         throw new IllegalArgumentException("Circular dataset reference");
1032       }
1033       if (!(data instanceof Alignment))
1034       {
1035         throw new Error(
1036                 "Implementation Error: jalview.datamodel.Alignment does not yet support other implementations of AlignmentI as its dataset reference");
1037       }
1038       dataset = (Alignment) data;
1039       for (int i = 0; i < getHeight(); i++)
1040       {
1041         SequenceI currentSeq = getSequenceAt(i);
1042         SequenceI dsq = currentSeq.getDatasetSequence();
1043         if (dsq == null)
1044         {
1045           dsq = currentSeq.createDatasetSequence();
1046           dataset.addSequence(dsq);
1047         }
1048         else
1049         {
1050           while (dsq.getDatasetSequence() != null)
1051           {
1052             dsq = dsq.getDatasetSequence();
1053           }
1054           if (dataset.findIndex(dsq) == -1)
1055           {
1056             dataset.addSequence(dsq);
1057           }
1058         }
1059       }
1060     }
1061     dataset.addAlignmentRef();
1062   }
1063
1064   /**
1065    * add dataset sequences to seq for currentSeq and any sequences it references
1066    */
1067   private void resolveAndAddDatasetSeq(SequenceI currentSeq,
1068           Set<SequenceI> seqs, boolean createDatasetSequence)
1069   {
1070     SequenceI alignedSeq = currentSeq;
1071     if (currentSeq.getDatasetSequence() != null)
1072     {
1073       currentSeq = currentSeq.getDatasetSequence();
1074     }
1075     else
1076     {
1077       if (createDatasetSequence)
1078       {
1079         currentSeq = currentSeq.createDatasetSequence();
1080       }
1081     }
1082
1083     List<SequenceI> toProcess = new ArrayList<>();
1084     toProcess.add(currentSeq);
1085     while (toProcess.size() > 0)
1086     {
1087       // use a queue ?
1088       SequenceI curDs = toProcess.remove(0);
1089
1090       if (!seqs.add(curDs))
1091       {
1092         continue;
1093       }
1094       // iterate over database references, making sure we add forward referenced
1095       // sequences
1096       if (curDs.getDBRefs() != null)
1097       {
1098         for (DBRefEntry dbr : curDs.getDBRefs())
1099         {
1100           if (dbr.getMap() != null && dbr.getMap().getTo() != null)
1101           {
1102             if (dbr.getMap().getTo() == alignedSeq)
1103             {
1104               /*
1105                * update mapping to be to the newly created dataset sequence
1106                */
1107               dbr.getMap().setTo(currentSeq);
1108             }
1109             if (dbr.getMap().getTo().getDatasetSequence() != null)
1110             {
1111               throw new Error("Implementation error: Map.getTo() for dbref "
1112                       + dbr + " from " + curDs.getName()
1113                       + " is not a dataset sequence.");
1114             }
1115             // we recurse to add all forward references to dataset sequences via
1116             // DBRefs/etc
1117             toProcess.add(dbr.getMap().getTo());
1118           }
1119         }
1120       }
1121     }
1122   }
1123
1124   /**
1125    * Creates a new dataset for this alignment. Can only be done once - if
1126    * dataset is not null this will not be performed.
1127    */
1128   public void createDatasetAlignment()
1129   {
1130     if (dataset != null)
1131     {
1132       return;
1133     }
1134     // try to avoid using SequenceI.equals at this stage, it will be expensive
1135     Set<SequenceI> seqs = new LinkedIdentityHashSet<>();
1136
1137     for (int i = 0; i < getHeight(); i++)
1138     {
1139       SequenceI currentSeq = getSequenceAt(i);
1140       resolveAndAddDatasetSeq(currentSeq, seqs, true);
1141     }
1142
1143     // verify all mappings are in dataset
1144     for (AlignedCodonFrame cf : codonFrameList)
1145     {
1146       for (SequenceToSequenceMapping ssm : cf.getMappings())
1147       {
1148         if (!seqs.contains(ssm.getFromSeq()))
1149         {
1150           resolveAndAddDatasetSeq(ssm.getFromSeq(), seqs, false);
1151         }
1152         if (!seqs.contains(ssm.getMapping().getTo()))
1153         {
1154           resolveAndAddDatasetSeq(ssm.getMapping().getTo(), seqs, false);
1155         }
1156       }
1157     }
1158     // finally construct dataset
1159     dataset = new Alignment(seqs.toArray(new SequenceI[seqs.size()]));
1160     // move mappings to the dataset alignment
1161     dataset.codonFrameList = this.codonFrameList;
1162     this.codonFrameList = null;
1163   }
1164
1165   /**
1166    * reference count for number of alignments referencing this one.
1167    */
1168   int alignmentRefs = 0;
1169
1170   /**
1171    * increase reference count to this alignment.
1172    */
1173   private void addAlignmentRef()
1174   {
1175     alignmentRefs++;
1176   }
1177
1178   @Override
1179   public Alignment getDataset()
1180   {
1181     return dataset;
1182   }
1183
1184   @Override
1185   public boolean padGaps()
1186   {
1187     boolean modified = false;
1188
1189     // Remove excess gaps from the end of alignment
1190     int maxLength = -1;
1191
1192     SequenceI current;
1193     for (int i = 0; i < sequences.size(); i++)
1194     {
1195       current = getSequenceAt(i);
1196       for (int j = current.getLength(); j > maxLength; j--)
1197       {
1198         if (j > maxLength
1199                 && !jalview.util.Comparison.isGap(current.getCharAt(j)))
1200         {
1201           maxLength = j;
1202           break;
1203         }
1204       }
1205     }
1206
1207     maxLength++;
1208
1209     int cLength;
1210     for (int i = 0; i < sequences.size(); i++)
1211     {
1212       current = getSequenceAt(i);
1213       cLength = current.getLength();
1214
1215       if (cLength < maxLength)
1216       {
1217         current.insertCharAt(cLength, maxLength - cLength, gapCharacter);
1218         modified = true;
1219       }
1220       else if (current.getLength() > maxLength)
1221       {
1222         current.deleteChars(maxLength, current.getLength());
1223       }
1224     }
1225     return modified;
1226   }
1227
1228   /**
1229    * Justify the sequences to the left or right by deleting and inserting gaps
1230    * before the initial residue or after the terminal residue
1231    *
1232    * @param right
1233    *          true if alignment padded to right, false to justify to left
1234    * @return true if alignment was changed
1235    */
1236   @Override
1237   public boolean justify(boolean right)
1238   {
1239     boolean modified = false;
1240
1241     // Remove excess gaps from the end of alignment
1242     int maxLength = -1;
1243     int ends[] = new int[sequences.size() * 2];
1244     SequenceI current;
1245     for (int i = 0; i < sequences.size(); i++)
1246     {
1247       current = getSequenceAt(i);
1248       // This should really be a sequence method
1249       ends[i * 2] = current.findIndex(current.getStart());
1250       ends[i * 2 + 1] = current
1251               .findIndex(current.getStart() + current.getLength());
1252       boolean hitres = false;
1253       for (int j = 0, rs = 0, ssiz = current.getLength(); j < ssiz; j++)
1254       {
1255         if (!jalview.util.Comparison.isGap(current.getCharAt(j)))
1256         {
1257           if (!hitres)
1258           {
1259             ends[i * 2] = j;
1260             hitres = true;
1261           }
1262           else
1263           {
1264             ends[i * 2 + 1] = j;
1265             if (j - ends[i * 2] > maxLength)
1266             {
1267               maxLength = j - ends[i * 2];
1268             }
1269           }
1270         }
1271       }
1272     }
1273
1274     maxLength++;
1275     // now edit the flanking gaps to justify to either left or right
1276     int cLength, extent, diff;
1277     for (int i = 0; i < sequences.size(); i++)
1278     {
1279       current = getSequenceAt(i);
1280
1281       cLength = 1 + ends[i * 2 + 1] - ends[i * 2];
1282       diff = maxLength - cLength; // number of gaps to indent
1283       extent = current.getLength();
1284       if (right)
1285       {
1286         // right justify
1287         if (extent > ends[i * 2 + 1])
1288         {
1289           current.deleteChars(ends[i * 2 + 1] + 1, extent);
1290           modified = true;
1291         }
1292         if (ends[i * 2] > diff)
1293         {
1294           current.deleteChars(0, ends[i * 2] - diff);
1295           modified = true;
1296         }
1297         else
1298         {
1299           if (ends[i * 2] < diff)
1300           {
1301             current.insertCharAt(0, diff - ends[i * 2], gapCharacter);
1302             modified = true;
1303           }
1304         }
1305       }
1306       else
1307       {
1308         // left justify
1309         if (ends[i * 2] > 0)
1310         {
1311           current.deleteChars(0, ends[i * 2]);
1312           modified = true;
1313           ends[i * 2 + 1] -= ends[i * 2];
1314           extent -= ends[i * 2];
1315         }
1316         if (extent > maxLength)
1317         {
1318           current.deleteChars(maxLength + 1, extent);
1319           modified = true;
1320         }
1321         else
1322         {
1323           if (extent < maxLength)
1324           {
1325             current.insertCharAt(extent, maxLength - extent, gapCharacter);
1326             modified = true;
1327           }
1328         }
1329       }
1330     }
1331     return modified;
1332   }
1333
1334   @Override
1335   public HiddenSequences getHiddenSequences()
1336   {
1337     return hiddenSequences;
1338   }
1339
1340   @Override
1341   public HiddenColumns getHiddenColumns()
1342   {
1343     return hiddenCols;
1344   }
1345
1346   @Override
1347   public CigarArray getCompactAlignment()
1348   {
1349     synchronized (sequences)
1350     {
1351       SeqCigar alseqs[] = new SeqCigar[sequences.size()];
1352       int i = 0;
1353       for (SequenceI seq : sequences)
1354       {
1355         alseqs[i++] = new SeqCigar(seq);
1356       }
1357       CigarArray cal = new CigarArray(alseqs);
1358       cal.addOperation(CigarArray.M, getWidth());
1359       return cal;
1360     }
1361   }
1362
1363   @Override
1364   public void setProperty(Object key, Object value)
1365   {
1366     if (alignmentProperties == null)
1367     {
1368       alignmentProperties = new Hashtable();
1369     }
1370
1371     alignmentProperties.put(key, value);
1372   }
1373
1374   @Override
1375   public Object getProperty(Object key)
1376   {
1377     if (alignmentProperties != null)
1378     {
1379       return alignmentProperties.get(key);
1380     }
1381     else
1382     {
1383       return null;
1384     }
1385   }
1386
1387   @Override
1388   public Hashtable getProperties()
1389   {
1390     return alignmentProperties;
1391   }
1392
1393   /**
1394    * Adds the given mapping to the stored set. Note this may be held on the
1395    * dataset alignment.
1396    */
1397   @Override
1398   public void addCodonFrame(AlignedCodonFrame codons)
1399   {
1400     List<AlignedCodonFrame> acfs = getCodonFrames();
1401     if (codons != null && acfs != null && !acfs.contains(codons))
1402     {
1403       acfs.add(codons);
1404     }
1405   }
1406
1407   /*
1408    * (non-Javadoc)
1409    *
1410    * @see
1411    * jalview.datamodel.AlignmentI#getCodonFrame(jalview.datamodel.SequenceI)
1412    */
1413   @Override
1414   public List<AlignedCodonFrame> getCodonFrame(SequenceI seq)
1415   {
1416     if (seq == null)
1417     {
1418       return null;
1419     }
1420     List<AlignedCodonFrame> cframes = new ArrayList<>();
1421     for (AlignedCodonFrame acf : getCodonFrames())
1422     {
1423       if (acf.involvesSequence(seq))
1424       {
1425         cframes.add(acf);
1426       }
1427     }
1428     return cframes;
1429   }
1430
1431   /**
1432    * Sets the codon frame mappings (replacing any existing mappings). Note the
1433    * mappings are set on the dataset alignment instead if there is one.
1434    *
1435    * @see jalview.datamodel.AlignmentI#setCodonFrames()
1436    */
1437   @Override
1438   public void setCodonFrames(List<AlignedCodonFrame> acfs)
1439   {
1440     if (dataset != null)
1441     {
1442       dataset.setCodonFrames(acfs);
1443     }
1444     else
1445     {
1446       this.codonFrameList = acfs;
1447     }
1448   }
1449
1450   /**
1451    * Returns the set of codon frame mappings. Any changes to the returned set
1452    * will affect the alignment. The mappings are held on (and read from) the
1453    * dataset alignment if there is one.
1454    *
1455    * @see jalview.datamodel.AlignmentI#getCodonFrames()
1456    */
1457   @Override
1458   public List<AlignedCodonFrame> getCodonFrames()
1459   {
1460     // TODO: Fix this method to fix failing AlignedCodonFrame tests
1461     // this behaviour is currently incorrect. method should return codon frames
1462     // for just the alignment,
1463     // selected from dataset
1464     return dataset != null ? dataset.getCodonFrames() : codonFrameList;
1465   }
1466
1467   /**
1468    * Removes the given mapping from the stored set. Note that the mappings are
1469    * held on the dataset alignment if there is one.
1470    */
1471   @Override
1472   public boolean removeCodonFrame(AlignedCodonFrame codons)
1473   {
1474     List<AlignedCodonFrame> acfs = getCodonFrames();
1475     if (codons == null || acfs == null)
1476     {
1477       return false;
1478     }
1479     return acfs.remove(codons);
1480   }
1481
1482   @Override
1483   public void append(AlignmentI toappend)
1484   {
1485     // TODO JAL-1270 needs test coverage
1486     // currently tested for use in jalview.gui.SequenceFetcher
1487     char oldc = toappend.getGapCharacter();
1488     boolean samegap = oldc == getGapCharacter();
1489     boolean hashidden = toappend.getHiddenSequences() != null
1490             && toappend.getHiddenSequences().hiddenSequences != null;
1491     // get all sequences including any hidden ones
1492     List<SequenceI> sqs = (hashidden)
1493             ? toappend.getHiddenSequences().getFullAlignment()
1494                     .getSequences()
1495             : toappend.getSequences();
1496     if (sqs != null)
1497     {
1498       // avoid self append deadlock by
1499       List<SequenceI> toappendsq = new ArrayList<>();
1500       synchronized (sqs)
1501       {
1502         for (SequenceI addedsq : sqs)
1503         {
1504           if (!samegap)
1505           {
1506             addedsq.replace(oldc, gapCharacter);
1507           }
1508           toappendsq.add(addedsq);
1509         }
1510       }
1511       for (SequenceI addedsq : toappendsq)
1512       {
1513         addSequence(addedsq);
1514       }
1515     }
1516     AlignmentAnnotation[] alan = toappend.getAlignmentAnnotation();
1517     for (int a = 0; alan != null && a < alan.length; a++)
1518     {
1519       addAnnotation(alan[a]);
1520     }
1521
1522     // use add method
1523     getCodonFrames().addAll(toappend.getCodonFrames());
1524
1525     List<SequenceGroup> sg = toappend.getGroups();
1526     if (sg != null)
1527     {
1528       for (SequenceGroup _sg : sg)
1529       {
1530         addGroup(_sg);
1531       }
1532     }
1533     if (toappend.getHiddenSequences() != null)
1534     {
1535       HiddenSequences hs = toappend.getHiddenSequences();
1536       if (hiddenSequences == null)
1537       {
1538         hiddenSequences = new HiddenSequences(this);
1539       }
1540       if (hs.hiddenSequences != null)
1541       {
1542         for (int s = 0; s < hs.hiddenSequences.length; s++)
1543         {
1544           // hide the newly appended sequence in the alignment
1545           if (hs.hiddenSequences[s] != null)
1546           {
1547             hiddenSequences.hideSequence(hs.hiddenSequences[s]);
1548           }
1549         }
1550       }
1551     }
1552     if (toappend.getProperties() != null)
1553     {
1554       // we really can't do very much here - just try to concatenate strings
1555       // where property collisions occur.
1556       Enumeration key = toappend.getProperties().keys();
1557       while (key.hasMoreElements())
1558       {
1559         Object k = key.nextElement();
1560         Object ourval = this.getProperty(k);
1561         Object toapprop = toappend.getProperty(k);
1562         if (ourval != null)
1563         {
1564           if (ourval.getClass().equals(toapprop.getClass())
1565                   && !ourval.equals(toapprop))
1566           {
1567             if (ourval instanceof String)
1568             {
1569               // append strings
1570               this.setProperty(k,
1571                       ((String) ourval) + "; " + ((String) toapprop));
1572             }
1573             else
1574             {
1575               if (ourval instanceof Vector)
1576               {
1577                 // append vectors
1578                 Enumeration theirv = ((Vector) toapprop).elements();
1579                 while (theirv.hasMoreElements())
1580                 {
1581                   ((Vector) ourval).addElement(theirv);
1582                 }
1583               }
1584             }
1585           }
1586         }
1587         else
1588         {
1589           // just add new property directly
1590           setProperty(k, toapprop);
1591         }
1592
1593       }
1594     }
1595   }
1596
1597   @Override
1598   public AlignmentAnnotation findOrCreateAnnotation(String name,
1599           String calcId, boolean autoCalc, SequenceI seqRef,
1600           SequenceGroup groupRef)
1601   {
1602     if (annotations != null)
1603     {
1604       for (AlignmentAnnotation annot : getAlignmentAnnotation())
1605       {
1606         if (annot.autoCalculated == autoCalc && (name.equals(annot.label))
1607                 && (calcId == null || annot.getCalcId().equals(calcId))
1608                 && annot.sequenceRef == seqRef
1609                 && annot.groupRef == groupRef)
1610         {
1611           return annot;
1612         }
1613       }
1614     }
1615     AlignmentAnnotation annot = new AlignmentAnnotation(name, name,
1616             new Annotation[1], 0f, 0f, AlignmentAnnotation.BAR_GRAPH);
1617     annot.hasText = false;
1618     if (calcId != null)
1619     {
1620       annot.setCalcId(new String(calcId));
1621     }
1622     annot.autoCalculated = autoCalc;
1623     if (seqRef != null)
1624     {
1625       annot.setSequenceRef(seqRef);
1626     }
1627     annot.groupRef = groupRef;
1628     addAnnotation(annot);
1629
1630     return annot;
1631   }
1632
1633   @Override
1634   public Iterable<AlignmentAnnotation> findAnnotation(String calcId)
1635   {
1636     AlignmentAnnotation[] alignmentAnnotation = getAlignmentAnnotation();
1637     if (alignmentAnnotation != null)
1638     {
1639       return AlignmentAnnotation.findAnnotation(
1640               Arrays.asList(getAlignmentAnnotation()), calcId);
1641     }
1642     return Arrays.asList(new AlignmentAnnotation[] {});
1643   }
1644
1645   @Override
1646   public Iterable<AlignmentAnnotation> findAnnotations(SequenceI seq,
1647           String calcId, String label)
1648   {
1649     return AlignmentAnnotation.findAnnotations(
1650             Arrays.asList(getAlignmentAnnotation()), seq, calcId, label);
1651   }
1652
1653   @Override
1654   public void moveSelectedSequencesByOne(SequenceGroup sg,
1655           Map<SequenceI, SequenceCollectionI> map, boolean up)
1656   {
1657     synchronized (sequences)
1658     {
1659       if (up)
1660       {
1661
1662         for (int i = 1, iSize = sequences.size(); i < iSize; i++)
1663         {
1664           SequenceI seq = sequences.get(i);
1665           if (!sg.getSequences(map).contains(seq))
1666           {
1667             continue;
1668           }
1669
1670           SequenceI temp = sequences.get(i - 1);
1671           if (sg.getSequences(null).contains(temp))
1672           {
1673             continue;
1674           }
1675
1676           sequences.set(i, temp);
1677           sequences.set(i - 1, seq);
1678         }
1679       }
1680       else
1681       {
1682         for (int i = sequences.size() - 2; i > -1; i--)
1683         {
1684           SequenceI seq = sequences.get(i);
1685           if (!sg.getSequences(map).contains(seq))
1686           {
1687             continue;
1688           }
1689
1690           SequenceI temp = sequences.get(i + 1);
1691           if (sg.getSequences(map).contains(temp))
1692           {
1693             continue;
1694           }
1695
1696           sequences.set(i, temp);
1697           sequences.set(i + 1, seq);
1698         }
1699       }
1700
1701     }
1702   }
1703
1704   @Override
1705   public void validateAnnotation(AlignmentAnnotation alignmentAnnotation)
1706   {
1707     alignmentAnnotation.validateRangeAndDisplay();
1708     if (isNucleotide() && alignmentAnnotation.isValidStruc())
1709     {
1710       hasRNAStructure = true;
1711     }
1712   }
1713
1714   private SequenceI seqrep = null;
1715
1716   /**
1717    *
1718    * @return the representative sequence for this group
1719    */
1720   @Override
1721   public SequenceI getSeqrep()
1722   {
1723     return seqrep;
1724   }
1725
1726   /**
1727    * set the representative sequence for this group. Note - this affects the
1728    * interpretation of the Hidereps attribute.
1729    *
1730    * @param seqrep
1731    *          the seqrep to set (null means no sequence representative)
1732    */
1733   @Override
1734   public void setSeqrep(SequenceI seqrep)
1735   {
1736     this.seqrep = seqrep;
1737   }
1738
1739   /**
1740    *
1741    * @return true if group has a sequence representative
1742    */
1743   @Override
1744   public boolean hasSeqrep()
1745   {
1746     return seqrep != null;
1747   }
1748
1749   @Override
1750   public int getEndRes()
1751   {
1752     return getWidth() - 1;
1753   }
1754
1755   @Override
1756   public int getStartRes()
1757   {
1758     return 0;
1759   }
1760
1761   /*
1762    * In the case of AlignmentI - returns the dataset for the alignment, if set
1763    * (non-Javadoc)
1764    *
1765    * @see jalview.datamodel.AnnotatedCollectionI#getContext()
1766    */
1767   @Override
1768   public AnnotatedCollectionI getContext()
1769   {
1770     return dataset;
1771   }
1772
1773   /**
1774    * Align this alignment like the given (mapped) one.
1775    */
1776   @Override
1777   public int alignAs(AlignmentI al)
1778   {
1779     /*
1780      * Currently retains unmapped gaps (in introns), regaps mapped regions
1781      * (exons)
1782      */
1783     return alignAs(al, false, true);
1784   }
1785
1786   /**
1787    * Align this alignment 'the same as' the given one. Mapped sequences only are
1788    * realigned. If both of the same type (nucleotide/protein) then align both
1789    * identically. If this is nucleotide and the other is protein, make 3 gaps
1790    * for each gap in the protein sequences. If this is protein and the other is
1791    * nucleotide, insert a gap for each 3 gaps (or part thereof) between
1792    * nucleotide bases. If this is protein and the other is nucleotide, gaps
1793    * protein to match the relative ordering of codons in the nucleotide.
1794    *
1795    * Parameters control whether gaps in exon (mapped) and intron (unmapped)
1796    * regions are preserved. Gaps that connect introns to exons are treated
1797    * conservatively, i.e. only preserved if both intron and exon gaps are
1798    * preserved. TODO: check caveats below where the implementation fails
1799    *
1800    * @param al
1801    *          - must have same dataset, and sequences in al must have equivalent
1802    *          dataset sequence and start/end bounds under given mapping
1803    * @param preserveMappedGaps
1804    *          if true, gaps within and between mapped codons are preserved
1805    * @param preserveUnmappedGaps
1806    *          if true, gaps within and between unmapped codons are preserved
1807    */
1808   // @Override
1809   public int alignAs(AlignmentI al, boolean preserveMappedGaps,
1810           boolean preserveUnmappedGaps)
1811   {
1812     // TODO should this method signature be the one in the interface?
1813     // JBPComment - yes - neither flag is used, so should be deleted.
1814     boolean thisIsNucleotide = this.isNucleotide();
1815     boolean thatIsProtein = !al.isNucleotide();
1816     if (!thatIsProtein && !thisIsNucleotide)
1817     {
1818       return AlignmentUtils.alignProteinAsDna(this, al);
1819     }
1820     else if (thatIsProtein && thisIsNucleotide)
1821     {
1822       return AlignmentUtils.alignCdsAsProtein(this, al);
1823     }
1824     return AlignmentUtils.alignAs(this, al);
1825   }
1826
1827   /**
1828    * Returns the alignment in Fasta format. Behaviour of this method is not
1829    * guaranteed between versions.
1830    */
1831   @Override
1832   public String toString()
1833   {
1834     return new FastaFile().print(getSequencesArray(), true);
1835   }
1836
1837   /**
1838    * Returns the set of distinct sequence names. No ordering is guaranteed.
1839    */
1840   @Override
1841   public Set<String> getSequenceNames()
1842   {
1843     Set<String> names = new HashSet<>();
1844     for (SequenceI seq : getSequences())
1845     {
1846       names.add(seq.getName());
1847     }
1848     return names;
1849   }
1850
1851   @Override
1852   public boolean hasValidSequence()
1853   {
1854     boolean hasValidSeq = false;
1855     for (SequenceI seq : getSequences())
1856     {
1857       if ((seq.getEnd() - seq.getStart()) > 0)
1858       {
1859         hasValidSeq = true;
1860         break;
1861       }
1862     }
1863     return hasValidSeq;
1864   }
1865
1866   /**
1867    * Update any mappings to 'virtual' sequences to compatible real ones, if
1868    * present in the added sequences. Returns a count of mappings updated.
1869    *
1870    * @param seqs
1871    * @return
1872    */
1873   @Override
1874   public int realiseMappings(List<SequenceI> seqs)
1875   {
1876     int count = 0;
1877     for (SequenceI seq : seqs)
1878     {
1879       for (AlignedCodonFrame mapping : getCodonFrames())
1880       {
1881         count += mapping.realiseWith(seq);
1882       }
1883     }
1884     return count;
1885   }
1886
1887   /**
1888    * Returns the first AlignedCodonFrame that has a mapping between the given
1889    * dataset sequences
1890    *
1891    * @param mapFrom
1892    * @param mapTo
1893    * @return
1894    */
1895   @Override
1896   public AlignedCodonFrame getMapping(SequenceI mapFrom, SequenceI mapTo)
1897   {
1898     for (AlignedCodonFrame acf : getCodonFrames())
1899     {
1900       if (acf.getAaForDnaSeq(mapFrom) == mapTo)
1901       {
1902         return acf;
1903       }
1904     }
1905     return null;
1906   }
1907
1908   @Override
1909   public boolean setHiddenColumns(HiddenColumns cols)
1910   {
1911     boolean changed = cols == null ? hiddenCols != null
1912             : !cols.equals(hiddenCols);
1913     hiddenCols = cols;
1914     return changed;
1915   }
1916
1917   @Override
1918   public void setupJPredAlignment()
1919   {
1920     SequenceI repseq = getSequenceAt(0);
1921     setSeqrep(repseq);
1922     HiddenColumns cs = new HiddenColumns();
1923     cs.hideList(repseq.getInsertions());
1924     setHiddenColumns(cs);
1925   }
1926
1927   @Override
1928   public HiddenColumns propagateInsertions(SequenceI profileseq,
1929           AlignmentView input)
1930   {
1931     int profsqpos = 0;
1932
1933     char gc = getGapCharacter();
1934     Object[] alandhidden = input.getAlignmentAndHiddenColumns(gc);
1935     HiddenColumns nview = (HiddenColumns) alandhidden[1];
1936     SequenceI origseq = ((SequenceI[]) alandhidden[0])[profsqpos];
1937     return propagateInsertions(profileseq, origseq, nview);
1938   }
1939
1940   /**
1941    *
1942    * @param profileseq
1943    *          sequence in al which corresponds to origseq
1944    * @param al
1945    *          alignment which is to have gaps inserted into it
1946    * @param origseq
1947    *          sequence corresponding to profileseq which defines gap map for
1948    *          modifying al
1949    */
1950   private HiddenColumns propagateInsertions(SequenceI profileseq,
1951           SequenceI origseq, HiddenColumns hc)
1952   {
1953     // take the set of hidden columns, and the set of gaps in origseq,
1954     // and remove all the hidden gaps from hiddenColumns
1955
1956     // first get the gaps as a Bitset
1957     // then calculate hidden ^ not(gap)
1958     BitSet gaps = origseq.gapBitset();
1959     hc.andNot(gaps);
1960
1961     // for each sequence in the alignment, except the profile sequence,
1962     // insert gaps corresponding to each hidden region but where each hidden
1963     // column region is shifted backwards by the number of preceding visible
1964     // gaps update hidden columns at the same time
1965     HiddenColumns newhidden = new HiddenColumns();
1966
1967     int numGapsBefore = 0;
1968     int gapPosition = 0;
1969     Iterator<int[]> it = hc.iterator();
1970     while (it.hasNext())
1971     {
1972       int[] region = it.next();
1973
1974       // get region coordinates accounting for gaps
1975       // we can rely on gaps not being *in* hidden regions because we already
1976       // removed those
1977       while (gapPosition < region[0])
1978       {
1979         gapPosition++;
1980         if (gaps.get(gapPosition))
1981         {
1982           numGapsBefore++;
1983         }
1984       }
1985
1986       int left = region[0] - numGapsBefore;
1987       int right = region[1] - numGapsBefore;
1988
1989       newhidden.hideColumns(left, right);
1990       padGaps(left, right, profileseq);
1991     }
1992     return newhidden;
1993   }
1994
1995   /**
1996    * Pad gaps in all sequences in alignment except profileseq
1997    *
1998    * @param left
1999    *          position of first gap to insert
2000    * @param right
2001    *          position of last gap to insert
2002    * @param profileseq
2003    *          sequence not to pad
2004    */
2005   private void padGaps(int left, int right, SequenceI profileseq)
2006   {
2007     char gc = getGapCharacter();
2008
2009     // make a string with number of gaps = length of hidden region
2010     StringBuilder sb = new StringBuilder();
2011     for (int g = 0; g < right - left + 1; g++)
2012     {
2013       sb.append(gc);
2014     }
2015
2016     // loop over the sequences and pad with gaps where required
2017     for (int s = 0, ns = getHeight(); s < ns; s++)
2018     {
2019       SequenceI sqobj = getSequenceAt(s);
2020       if ((sqobj != profileseq) && (sqobj.getLength() >= left))
2021       {
2022         String sq = sqobj.getSequenceAsString();
2023         sqobj.setSequence(
2024                 sq.substring(0, left) + sb.toString() + sq.substring(left));
2025       }
2026     }
2027   }
2028
2029 }