src/jalview/analysis/Dna.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.analysis;
  22
  23 import jalview.api.AlignViewportI;
  24 import jalview.datamodel.AlignedCodon;
  25 import jalview.datamodel.AlignedCodonFrame;
  26 import jalview.datamodel.Alignment;
  27 import jalview.datamodel.AlignmentAnnotation;
  28 import jalview.datamodel.AlignmentI;
  29 import jalview.datamodel.Annotation;
  30 import jalview.datamodel.DBRefEntry;
  31 import jalview.datamodel.DBRefSource;
  32 import jalview.datamodel.FeatureProperties;
  33 import jalview.datamodel.GraphLine;
  34 import jalview.datamodel.Mapping;
  35 import jalview.datamodel.Sequence;
  36 import jalview.datamodel.SequenceFeature;
  37 import jalview.datamodel.SequenceI;
  38 import jalview.schemes.ResidueProperties;
  39 import jalview.util.Comparison;
  40 import jalview.util.DBRefUtils;
  41 import jalview.util.MapList;
  42 import jalview.util.ShiftList;
  43
  44 import java.util.ArrayList;
  45 import java.util.Arrays;
  46 import java.util.Comparator;
  47 import java.util.List;
  48 import java.util.Map;
  49
  50 public class Dna
  51 {
  52   private static final String STOP_X = "X";
  53
  54   private static final Comparator<AlignedCodon> comparator = new CodonComparator();
  55
  56   /*
  57    * 'final' variables describe the inputs to the translation, which should not
  58    * be modified.
  59    */
  60   final private List<SequenceI> selection;
  61
  62   final private String[] seqstring;
  63
  64   final private int[] contigs;
  65
  66   final private char gapChar;
  67
  68   final private AlignmentAnnotation[] annotations;
  69
  70   final private int dnaWidth;
  71
  72   final private Alignment dataset;
  73
  74   /*
  75    * Working variables for the translation.
  76    *
  77    * The width of the translation-in-progress protein alignment.
  78    */
  79   private int aaWidth = 0;
  80
  81   /*
  82    * This array will be built up so that position i holds the codon positions
  83    * e.g. [7, 9, 10] that match column i (base 0) in the aligned translation.
  84    * Note this implies a contract that if two codons do not align exactly, their
  85    * translated products must occupy different column positions.
  86    */
  87   private AlignedCodon[] alignedCodons;
  88
  89   /**
  90    * Constructor given a viewport and the visible contigs.
  91    *
  92    * @param viewport
  93    * @param visibleContigs
  94    */
  95   public Dna(AlignViewportI viewport, int[] visibleContigs)
  96   {
  97     this.selection = Arrays.asList(viewport.getSequenceSelection());
  98     this.seqstring = viewport.getViewAsString(true);
  99     this.contigs = visibleContigs;
 100     this.gapChar = viewport.getGapCharacter();
 101     this.annotations = viewport.getAlignment().getAlignmentAnnotation();
 102     this.dnaWidth = viewport.getAlignment().getWidth();
 103     this.dataset = viewport.getAlignment().getDataset();
 104   }
 105
 106   /**
 107    * Test whether codon positions cdp1 should align before, with, or after cdp2.
 108    * Returns zero if all positions match (or either argument is null). Returns
 109    * -1 if any position in the first codon precedes the corresponding position
 110    * in the second codon. Else returns +1 (some position in the second codon
 111    * precedes the corresponding position in the first).
 112    *
 113    * Note this is not necessarily symmetric, for example:
 114    * <ul>
 115    * <li>compareCodonPos([2,5,6], [3,4,5]) returns -1</li>
 116    * <li>compareCodonPos([3,4,5], [2,5,6]) also returns -1</li>
 117    * </ul>
 118    *
 119    * @param ac1
 120    * @param ac2
 121    * @return
 122    */
 123   public static final int compareCodonPos(AlignedCodon ac1, AlignedCodon ac2)
 124   {
 125     return comparator.compare(ac1, ac2);
 126     // return jalview_2_8_2compare(ac1, ac2);
 127   }
 128
 129   /**
 130    * Codon comparison up to Jalview 2.8.2. This rule is sequence order dependent
 131    * - see http://issues.jalview.org/browse/JAL-1635
 132    *
 133    * @param ac1
 134    * @param ac2
 135    * @return
 136    */
 137   private static int jalview_2_8_2compare(AlignedCodon ac1, AlignedCodon ac2)
 138   {
 139     if (ac1 == null || ac2 == null || (ac1.equals(ac2)))
 140     {
 141       return 0;
 142     }
 143     if (ac1.pos1 < ac2.pos1 || ac1.pos2 < ac2.pos2 || ac1.pos3 < ac2.pos3)
 144     {
 145       // one base in cdp1 precedes the corresponding base in the other codon
 146       return -1;
 147     }
 148     // one base in cdp1 appears after the corresponding base in the other codon.
 149     return 1;
 150   }
 151
 152   /**
 153    *
 154    * @return
 155    */
 156   public AlignmentI translateCdna()
 157   {
 158     AlignedCodonFrame acf = new AlignedCodonFrame();
 159
 160     alignedCodons = new AlignedCodon[dnaWidth];
 161
 162     int s;
 163     int sSize = selection.size();
 164     List<SequenceI> pepseqs = new ArrayList<SequenceI>();
 165     for (s = 0; s < sSize; s++)
 166     {
 167       SequenceI newseq = translateCodingRegion(selection.get(s),
 168               seqstring[s], acf, pepseqs);
 169
 170       if (newseq != null)
 171       {
 172         pepseqs.add(newseq);
 173         SequenceI ds = newseq;
 174         if (dataset != null)
 175         {
 176           while (ds.getDatasetSequence() != null)
 177           {
 178             ds = ds.getDatasetSequence();
 179           }
 180           dataset.addSequence(ds);
 181         }
 182       }
 183     }
 184
 185     SequenceI[] newseqs = pepseqs.toArray(new SequenceI[pepseqs.size()]);
 186     AlignmentI al = new Alignment(newseqs);
 187     // ensure we look aligned.
 188     al.padGaps();
 189     // link the protein translation to the DNA dataset
 190     al.setDataset(dataset);
 191     translateAlignedAnnotations(al, acf);
 192     al.addCodonFrame(acf);
 193     return al;
 194   }
 195
 196   /**
 197    * fake the collection of DbRefs with associated exon mappings to identify if
 198    * a translation would generate distinct product in the currently selected
 199    * region.
 200    *
 201    * @param selection
 202    * @param viscontigs
 203    * @return
 204    */
 205   public static boolean canTranslate(SequenceI[] selection,
 206           int viscontigs[])
 207   {
 208     for (int gd = 0; gd < selection.length; gd++)
 209     {
 210       SequenceI dna = selection[gd];
 211       DBRefEntry[] dnarefs = DBRefUtils.selectRefs(dna.getDBRef(),
 212               DBRefSource.DNACODINGDBS);
 213       if (dnarefs != null)
 214       {
 215         // intersect with pep
 216         List<DBRefEntry> mappedrefs = new ArrayList<DBRefEntry>();
 217         DBRefEntry[] refs = dna.getDBRef();
 218         for (int d = 0; d < refs.length; d++)
 219         {
 220           if (refs[d].getMap() != null && refs[d].getMap().getMap() != null
 221                   && refs[d].getMap().getMap().getFromRatio() == 3
 222                   && refs[d].getMap().getMap().getToRatio() == 1)
 223           {
 224             mappedrefs.add(refs[d]); // add translated protein maps
 225           }
 226         }
 227         dnarefs = mappedrefs.toArray(new DBRefEntry[mappedrefs.size()]);
 228         for (int d = 0; d < dnarefs.length; d++)
 229         {
 230           Mapping mp = dnarefs[d].getMap();
 231           if (mp != null)
 232           {
 233             for (int vc = 0; vc < viscontigs.length; vc += 2)
 234             {
 235               int[] mpr = mp.locateMappedRange(viscontigs[vc],
 236                       viscontigs[vc + 1]);
 237               if (mpr != null)
 238               {
 239                 return true;
 240               }
 241             }
 242           }
 243         }
 244       }
 245     }
 246     return false;
 247   }
 248
 249   /**
 250    * Translate nucleotide alignment annotations onto translated amino acid
 251    * alignment using codon mapping codons
 252    *
 253    * @param al
 254    *          the translated protein alignment
 255    */
 256   protected void translateAlignedAnnotations(AlignmentI al,
 257           AlignedCodonFrame acf)
 258   {
 259     // Can only do this for columns with consecutive codons, or where
 260     // annotation is sequence associated.
 261
 262     if (annotations != null)
 263     {
 264       for (AlignmentAnnotation annotation : annotations)
 265       {
 266         /*
 267          * Skip hidden or autogenerated annotation. Also (for now), RNA
 268          * secondary structure annotation. If we want to show this against
 269          * protein we need a smarter way to 'translate' without generating
 270          * invalid (unbalanced) structure annotation.
 271          */
 272         if (annotation.autoCalculated || !annotation.visible
 273                 || annotation.isRNA())
 274         {
 275           continue;
 276         }
 277
 278         int aSize = aaWidth;
 279         Annotation[] anots = (annotation.annotations == null) ? null
 280                 : new Annotation[aSize];
 281         if (anots != null)
 282         {
 283           for (int a = 0; a < aSize; a++)
 284           {
 285             // process through codon map.
 286             if (a < alignedCodons.length && alignedCodons[a] != null
 287                     && alignedCodons[a].pos1 == (alignedCodons[a].pos3 - 2))
 288             {
 289               anots[a] = getCodonAnnotation(alignedCodons[a],
 290                       annotation.annotations);
 291             }
 292           }
 293         }
 294
 295         AlignmentAnnotation aa = new AlignmentAnnotation(annotation.label,
 296                 annotation.description, anots);
 297         aa.graph = annotation.graph;
 298         aa.graphGroup = annotation.graphGroup;
 299         aa.graphHeight = annotation.graphHeight;
 300         if (annotation.getThreshold() != null)
 301         {
 302           aa.setThreshold(new GraphLine(annotation
 303                   .getThreshold()));
 304         }
 305         if (annotation.hasScore)
 306         {
 307           aa.setScore(annotation.getScore());
 308         }
 309
 310         final SequenceI seqRef = annotation.sequenceRef;
 311         if (seqRef != null)
 312         {
 313           SequenceI aaSeq = acf.getAaForDnaSeq(seqRef);
 314           if (aaSeq != null)
 315           {
 316             // aa.compactAnnotationArray(); // throw away alignment annotation
 317             // positioning
 318             aa.setSequenceRef(aaSeq);
 319             // rebuild mapping
 320             aa.createSequenceMapping(aaSeq, aaSeq.getStart(), true);
 321             aa.adjustForAlignment();
 322             aaSeq.addAlignmentAnnotation(aa);
 323           }
 324         }
 325         al.addAnnotation(aa);
 326       }
 327     }
 328   }
 329
 330   private static Annotation getCodonAnnotation(AlignedCodon is,
 331           Annotation[] annotations)
 332   {
 333     // Have a look at all the codon positions for annotation and put the first
 334     // one found into the translated annotation pos.
 335     int contrib = 0;
 336     Annotation annot = null;
 337     for (int p = 1; p <= 3; p++)
 338     {
 339       int dnaCol = is.getBaseColumn(p);
 340       if (annotations[dnaCol] != null)
 341       {
 342         if (annot == null)
 343         {
 344           annot = new Annotation(annotations[dnaCol]);
 345           contrib = 1;
 346         }
 347         else
 348         {
 349           // merge with last
 350           Annotation cpy = new Annotation(annotations[dnaCol]);
 351           if (annot.colour == null)
 352           {
 353             annot.colour = cpy.colour;
 354           }
 355           if (annot.description == null || annot.description.length() == 0)
 356           {
 357             annot.description = cpy.description;
 358           }
 359           if (annot.displayCharacter == null)
 360           {
 361             annot.displayCharacter = cpy.displayCharacter;
 362           }
 363           if (annot.secondaryStructure == 0)
 364           {
 365             annot.secondaryStructure = cpy.secondaryStructure;
 366           }
 367           annot.value += cpy.value;
 368           contrib++;
 369         }
 370       }
 371     }
 372     if (contrib > 1)
 373     {
 374       annot.value /= contrib;
 375     }
 376     return annot;
 377   }
 378
 379   /**
 380    * Translate a na sequence
 381    *
 382    * @param selection
 383    *          sequence displayed under viscontigs visible columns
 384    * @param seqstring
 385    *          ORF read in some global alignment reference frame
 386    * @param acf
 387    *          Definition of global ORF alignment reference frame
 388    * @param proteinSeqs
 389    * @return sequence ready to be added to alignment.
 390    */
 391   protected SequenceI translateCodingRegion(SequenceI selection,
 392           String seqstring, AlignedCodonFrame acf,
 393           List<SequenceI> proteinSeqs)
 394   {
 395     List<int[]> skip = new ArrayList<int[]>();
 396     int skipint[] = null;
 397     ShiftList vismapping = new ShiftList(); // map from viscontigs to seqstring
 398     // intervals
 399     int vc;
 400     int[] scontigs = new int[contigs.length];
 401     int npos = 0;
 402     for (vc = 0; vc < contigs.length; vc += 2)
 403     {
 404       if (vc == 0)
 405       {
 406         vismapping.addShift(npos, contigs[vc]);
 407       }
 408       else
 409       {
 410         // hidden region
 411         vismapping.addShift(npos, contigs[vc] - contigs[vc - 1] + 1);
 412       }
 413       scontigs[vc] = contigs[vc];
 414       scontigs[vc + 1] = contigs[vc + 1];
 415     }
 416
 417     // allocate a roughly sized buffer for the protein sequence
 418     StringBuilder protein = new StringBuilder(seqstring.length() / 2);
 419     String seq = seqstring.replace('U', 'T').replace('u', 'T');
 420     char codon[] = new char[3];
 421     int cdp[] = new int[3];
 422     int rf = 0;
 423     int lastnpos = 0;
 424     int nend;
 425     int aspos = 0;
 426     int resSize = 0;
 427     for (npos = 0, nend = seq.length(); npos < nend; npos++)
 428     {
 429       if (!Comparison.isGap(seq.charAt(npos)))
 430       {
 431         cdp[rf] = npos; // store position
 432         codon[rf++] = seq.charAt(npos); // store base
 433       }
 434       if (rf == 3)
 435       {
 436         /*
 437          * Filled up a reading frame...
 438          */
 439         AlignedCodon alignedCodon = new AlignedCodon(cdp[0], cdp[1], cdp[2]);
 440         String aa = ResidueProperties.codonTranslate(new String(codon));
 441         rf = 0;
 442         final String gapString = String.valueOf(gapChar);
 443         if (aa == null)
 444         {
 445           aa = gapString;
 446           if (skipint == null)
 447           {
 448             skipint = new int[]
 449             { alignedCodon.pos1, alignedCodon.pos3 /* cdp[0], cdp[2] */};
 450           }
 451           skipint[1] = alignedCodon.pos3; // cdp[2];
 452         }
 453         else
 454         {
 455           if (skipint != null)
 456           {
 457             // edit scontigs
 458             skipint[0] = vismapping.shift(skipint[0]);
 459             skipint[1] = vismapping.shift(skipint[1]);
 460             for (vc = 0; vc < scontigs.length;)
 461             {
 462               if (scontigs[vc + 1] < skipint[0])
 463               {
 464                 // before skipint starts
 465                 vc += 2;
 466                 continue;
 467               }
 468               if (scontigs[vc] > skipint[1])
 469               {
 470                 // finished editing so
 471                 break;
 472               }
 473               // Edit the contig list to include the skipped region which did
 474               // not translate
 475               int[] t;
 476               // from : s1 e1 s2 e2 s3 e3
 477               // to s: s1 e1 s2 k0 k1 e2 s3 e3
 478               // list increases by one unless one boundary (s2==k0 or e2==k1)
 479               // matches, and decreases by one if skipint intersects whole
 480               // visible contig
 481               if (scontigs[vc] <= skipint[0])
 482               {
 483                 if (skipint[0] == scontigs[vc])
 484                 {
 485                   // skipint at start of contig
 486                   // shift the start of this contig
 487                   if (scontigs[vc + 1] > skipint[1])
 488                   {
 489                     scontigs[vc] = skipint[1];
 490                     vc += 2;
 491                   }
 492                   else
 493                   {
 494                     if (scontigs[vc + 1] == skipint[1])
 495                     {
 496                       // remove the contig
 497                       t = new int[scontigs.length - 2];
 498                       if (vc > 0)
 499                       {
 500                         System.arraycopy(scontigs, 0, t, 0, vc - 1);
 501                       }
 502                       if (vc + 2 < t.length)
 503                       {
 504                         System.arraycopy(scontigs, vc + 2, t, vc, t.length
 505                                 - vc + 2);
 506                       }
 507                       scontigs = t;
 508                     }
 509                     else
 510                     {
 511                       // truncate contig to before the skipint region
 512                       scontigs[vc + 1] = skipint[0] - 1;
 513                       vc += 2;
 514                     }
 515                   }
 516                 }
 517                 else
 518                 {
 519                   // scontig starts before start of skipint
 520                   if (scontigs[vc + 1] < skipint[1])
 521                   {
 522                     // skipint truncates end of scontig
 523                     scontigs[vc + 1] = skipint[0] - 1;
 524                     vc += 2;
 525                   }
 526                   else
 527                   {
 528                     // divide region to new contigs
 529                     t = new int[scontigs.length + 2];
 530                     System.arraycopy(scontigs, 0, t, 0, vc + 1);
 531                     t[vc + 1] = skipint[0];
 532                     t[vc + 2] = skipint[1];
 533                     System.arraycopy(scontigs, vc + 1, t, vc + 3,
 534                             scontigs.length - (vc + 1));
 535                     scontigs = t;
 536                     vc += 4;
 537                   }
 538                 }
 539               }
 540             }
 541             skip.add(skipint);
 542             skipint = null;
 543           }
 544           if (aa.equals("STOP"))
 545           {
 546             aa = STOP_X;
 547           }
 548           resSize++;
 549         }
 550         boolean findpos = true;
 551         while (findpos)
 552         {
 553           /*
 554            * Compare this codon's base positions with those currently aligned to
 555            * this column in the translation.
 556            */
 557           final int compareCodonPos = compareCodonPos(alignedCodon,
 558                   alignedCodons[aspos]);
 559           switch (compareCodonPos)
 560           {
 561           case -1:
 562
 563             /*
 564              * This codon should precede the mapped positions - need to insert a
 565              * gap in all prior sequences.
 566              */
 567             insertAAGap(aspos, proteinSeqs);
 568             findpos = false;
 569             break;
 570
 571           case +1:
 572
 573             /*
 574              * This codon belongs after the aligned codons at aspos. Prefix it
 575              * with a gap and try the next position.
 576              */
 577             aa = gapString + aa;
 578             aspos++;
 579             break;
 580
 581           case 0:
 582
 583             /*
 584              * Exact match - codon 'belongs' at this translated position.
 585              */
 586             findpos = false;
 587           }
 588         }
 589         protein.append(aa);
 590         lastnpos = npos;
 591         if (alignedCodons[aspos] == null)
 592         {
 593           // mark this column as aligning to this aligned reading frame
 594           alignedCodons[aspos] = alignedCodon;
 595         }
 596         else if (!alignedCodons[aspos].equals(alignedCodon))
 597         {
 598           throw new IllegalStateException("Tried to coalign "
 599                   + alignedCodons[aspos].toString() + " with "
 600                   + alignedCodon.toString());
 601         }
 602         if (aspos >= aaWidth)
 603         {
 604           // update maximum alignment width
 605           aaWidth = aspos;
 606         }
 607         // ready for next translated reading frame alignment position (if any)
 608         aspos++;
 609       }
 610     }
 611     if (resSize > 0)
 612     {
 613       SequenceI newseq = new Sequence(selection.getName(),
 614               protein.toString());
 615       if (rf != 0)
 616       {
 617         final String errMsg = "trimming contigs for incomplete terminal codon.";
 618         System.err.println(errMsg);
 619         // map and trim contigs to ORF region
 620         vc = scontigs.length - 1;
 621         lastnpos = vismapping.shift(lastnpos); // place npos in context of
 622         // whole dna alignment (rather
 623         // than visible contigs)
 624         // incomplete ORF could be broken over one or two visible contig
 625         // intervals.
 626         while (vc >= 0 && scontigs[vc] > lastnpos)
 627         {
 628           if (vc > 0 && scontigs[vc - 1] > lastnpos)
 629           {
 630             vc -= 2;
 631           }
 632           else
 633           {
 634             // correct last interval in list.
 635             scontigs[vc] = lastnpos;
 636           }
 637         }
 638
 639         if (vc > 0 && (vc + 1) < scontigs.length)
 640         {
 641           // truncate map list to just vc elements
 642           int t[] = new int[vc + 1];
 643           System.arraycopy(scontigs, 0, t, 0, vc + 1);
 644           scontigs = t;
 645         }
 646         if (vc <= 0)
 647         {
 648           scontigs = null;
 649         }
 650       }
 651       if (scontigs != null)
 652       {
 653         npos = 0;
 654         // map scontigs to actual sequence positions on selection
 655         for (vc = 0; vc < scontigs.length; vc += 2)
 656         {
 657           scontigs[vc] = selection.findPosition(scontigs[vc]); // not from 1!
 658           scontigs[vc + 1] = selection.findPosition(scontigs[vc + 1]); // exclusive
 659           if (scontigs[vc + 1] == selection.getEnd())
 660           {
 661             break;
 662           }
 663         }
 664         // trim trailing empty intervals.
 665         if ((vc + 2) < scontigs.length)
 666         {
 667           int t[] = new int[vc + 2];
 668           System.arraycopy(scontigs, 0, t, 0, vc + 2);
 669           scontigs = t;
 670         }
 671         /*
 672          * delete intervals in scontigs which are not translated. 1. map skip
 673          * into sequence position intervals 2. truncate existing ranges and add
 674          * new ranges to exclude untranslated regions. if (skip.size()>0) {
 675          * Vector narange = new Vector(); for (vc=0; vc<scontigs.length; vc++) {
 676          * narange.addElement(new int[] {scontigs[vc]}); } int sint=0,iv[]; vc =
 677          * 0; while (sint<skip.size()) { skipint = (int[]) skip.elementAt(sint);
 678          * do { iv = (int[]) narange.elementAt(vc); if (iv[0]>=skipint[0] &&
 679          * iv[0]<=skipint[1]) { if (iv[0]==skipint[0]) { // delete beginning of
 680          * range } else { // truncate range and create new one if necessary iv =
 681          * (int[]) narange.elementAt(vc+1); if (iv[0]<=skipint[1]) { // truncate
 682          * range iv[0] = skipint[1]; } else { } } } else if (iv[0]<skipint[0]) {
 683          * iv = (int[]) narange.elementAt(vc+1); } } while (iv[0]) } }
 684          */
 685         MapList map = new MapList(scontigs, new int[]
 686         { 1, resSize }, 3, 1);
 687
 688         transferCodedFeatures(selection, newseq, map, null, null);
 689
 690         /*
 691          * Construct a dataset sequence for our new peptide.
 692          */
 693         SequenceI rseq = newseq.deriveSequence();
 694
 695         /*
 696          * Store a mapping (between the dataset sequences for the two
 697          * sequences).
 698          */
 699         // SIDE-EFFECT: acf stores the aligned sequence reseq; to remove!
 700         acf.addMap(selection, rseq, map);
 701         return rseq;
 702       }
 703     }
 704     // register the mapping somehow
 705     //
 706     return null;
 707   }
 708
 709   /**
 710    * Insert a gap into the aligned proteins and the codon mapping array.
 711    *
 712    * @param pos
 713    * @param proteinSeqs
 714    * @return
 715    */
 716   protected void insertAAGap(int pos,
 717           List<SequenceI> proteinSeqs)
 718   {
 719     aaWidth++;
 720     for (SequenceI seq : proteinSeqs)
 721     {
 722       seq.insertCharAt(pos, gapChar);
 723     }
 724
 725     checkCodonFrameWidth();
 726     if (pos < aaWidth)
 727     {
 728       aaWidth++;
 729
 730       /*
 731        * Shift from [pos] to the end one to the right, and null out [pos]
 732        */
 733       System.arraycopy(alignedCodons, pos, alignedCodons, pos + 1,
 734               alignedCodons.length - pos - 1);
 735       alignedCodons[pos] = null;
 736     }
 737   }
 738
 739   /**
 740    * Check the codons array can accommodate a single insertion, if not resize
 741    * it.
 742    */
 743   protected void checkCodonFrameWidth()
 744   {
 745     if (alignedCodons[alignedCodons.length - 1] != null)
 746     {
 747       /*
 748        * arraycopy insertion would bump a filled slot off the end, so expand.
 749        */
 750       AlignedCodon[] c = new AlignedCodon[alignedCodons.length + 10];
 751       System.arraycopy(alignedCodons, 0, c, 0, alignedCodons.length);
 752       alignedCodons = c;
 753     }
 754   }
 755
 756   /**
 757    * Given a peptide newly translated from a dna sequence, copy over and set any
 758    * features on the peptide from the DNA. If featureTypes is null, all features
 759    * on the dna sequence are searched (rather than just the displayed ones), and
 760    * similarly for featureGroups.
 761    *
 762    * @param dna
 763    * @param pep
 764    * @param map
 765    * @param featureTypes
 766    *          hash whose keys are the displayed feature type strings
 767    * @param featureGroups
 768    *          hash where keys are feature groups and values are Boolean objects
 769    *          indicating if they are displayed.
 770    */
 771   private static void transferCodedFeatures(SequenceI dna, SequenceI pep,
 772           MapList map, Map<String, Object> featureTypes,
 773           Map<String, Boolean> featureGroups)
 774   {
 775     SequenceFeature[] sfs = dna.getSequenceFeatures();
 776     Boolean fgstate;
 777     DBRefEntry[] dnarefs = DBRefUtils.selectRefs(dna.getDBRef(),
 778             DBRefSource.DNACODINGDBS);
 779     if (dnarefs != null)
 780     {
 781       // intersect with pep
 782       for (int d = 0; d < dnarefs.length; d++)
 783       {
 784         Mapping mp = dnarefs[d].getMap();
 785         if (mp != null)
 786         {
 787         }
 788       }
 789     }
 790     if (sfs != null)
 791     {
 792       for (SequenceFeature sf : sfs)
 793       {
 794         fgstate = (featureGroups == null) ? null : featureGroups
 795                 .get(sf.featureGroup);
 796         if ((featureTypes == null || featureTypes.containsKey(sf.getType()))
 797                 && (fgstate == null || fgstate.booleanValue()))
 798         {
 799           if (FeatureProperties.isCodingFeature(null, sf.getType()))
 800           {
 801             // if (map.intersectsFrom(sf[f].begin, sf[f].end))
 802             {
 803
 804             }
 805           }
 806         }
 807       }
 808     }
 809   }
 810 }