test/jalview/analysis/AlignmentUtilsTests.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 static org.testng.AssertJUnit.assertEquals;
  24 import static org.testng.AssertJUnit.assertFalse;
  25 import static org.testng.AssertJUnit.assertNotNull;
  26 import static org.testng.AssertJUnit.assertNull;
  27 import static org.testng.AssertJUnit.assertSame;
  28 import static org.testng.AssertJUnit.assertTrue;
  29
  30 import jalview.analysis.AlignmentUtils.DnaVariant;
  31 import jalview.datamodel.AlignedCodonFrame;
  32 import jalview.datamodel.Alignment;
  33 import jalview.datamodel.AlignmentAnnotation;
  34 import jalview.datamodel.AlignmentI;
  35 import jalview.datamodel.Annotation;
  36 import jalview.datamodel.DBRefEntry;
  37 import jalview.datamodel.Mapping;
  38 import jalview.datamodel.SearchResults;
  39 import jalview.datamodel.SearchResults.Match;
  40 import jalview.datamodel.Sequence;
  41 import jalview.datamodel.SequenceFeature;
  42 import jalview.datamodel.SequenceI;
  43 import jalview.io.AppletFormatAdapter;
  44 import jalview.io.FormatAdapter;
  45 import jalview.util.MapList;
  46 import jalview.util.MappingUtils;
  47
  48 import java.io.IOException;
  49 import java.util.ArrayList;
  50 import java.util.Arrays;
  51 import java.util.LinkedHashMap;
  52 import java.util.List;
  53 import java.util.Map;
  54 import java.util.TreeMap;
  55
  56 import org.testng.annotations.Test;
  57
  58 public class AlignmentUtilsTests
  59 {
  60   public static Sequence ts = new Sequence("short",
  61           "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklm");
  62
  63   @Test(groups = { "Functional" })
  64   public void testExpandContext()
  65   {
  66     AlignmentI al = new Alignment(new Sequence[] {});
  67     for (int i = 4; i < 14; i += 2)
  68     {
  69       SequenceI s1 = ts.deriveSequence().getSubSequence(i, i + 7);
  70       al.addSequence(s1);
  71     }
  72     System.out.println(new AppletFormatAdapter().formatSequences("Clustal",
  73             al, true));
  74     for (int flnk = -1; flnk < 25; flnk++)
  75     {
  76       AlignmentI exp = AlignmentUtils.expandContext(al, flnk);
  77       System.out.println("\nFlank size: " + flnk);
  78       System.out.println(new AppletFormatAdapter().formatSequences(
  79               "Clustal", exp, true));
  80       if (flnk == -1)
  81       {
  82         /*
  83          * Full expansion to complete sequences
  84          */
  85         for (SequenceI sq : exp.getSequences())
  86         {
  87           String ung = sq.getSequenceAsString().replaceAll("-+", "");
  88           final String errorMsg = "Flanking sequence not the same as original dataset sequence.\n"
  89                   + ung
  90                   + "\n"
  91                   + sq.getDatasetSequence().getSequenceAsString();
  92           assertTrue(errorMsg, ung.equalsIgnoreCase(sq.getDatasetSequence()
  93                   .getSequenceAsString()));
  94         }
  95       }
  96       else if (flnk == 24)
  97       {
  98         /*
  99          * Last sequence is fully expanded, others have leading gaps to match
 100          */
 101         assertTrue(exp.getSequenceAt(4).getSequenceAsString()
 102                 .startsWith("abc"));
 103         assertTrue(exp.getSequenceAt(3).getSequenceAsString()
 104                 .startsWith("--abc"));
 105         assertTrue(exp.getSequenceAt(2).getSequenceAsString()
 106                 .startsWith("----abc"));
 107         assertTrue(exp.getSequenceAt(1).getSequenceAsString()
 108                 .startsWith("------abc"));
 109         assertTrue(exp.getSequenceAt(0).getSequenceAsString()
 110                 .startsWith("--------abc"));
 111       }
 112     }
 113   }
 114
 115   /**
 116    * Test that annotations are correctly adjusted by expandContext
 117    */
 118   @Test(groups = { "Functional" })
 119   public void testExpandContext_annotation()
 120   {
 121     AlignmentI al = new Alignment(new Sequence[] {});
 122     SequenceI ds = new Sequence("Seq1", "ABCDEFGHI");
 123     // subsequence DEF:
 124     SequenceI seq1 = ds.deriveSequence().getSubSequence(3, 6);
 125     al.addSequence(seq1);
 126
 127     /*
 128      * Annotate DEF with 4/5/6 respectively
 129      */
 130     Annotation[] anns = new Annotation[] { new Annotation(4),
 131         new Annotation(5), new Annotation(6) };
 132     AlignmentAnnotation ann = new AlignmentAnnotation("SS",
 133             "secondary structure", anns);
 134     seq1.addAlignmentAnnotation(ann);
 135
 136     /*
 137      * The annotations array should match aligned positions
 138      */
 139     assertEquals(3, ann.annotations.length);
 140     assertEquals(4, ann.annotations[0].value, 0.001);
 141     assertEquals(5, ann.annotations[1].value, 0.001);
 142     assertEquals(6, ann.annotations[2].value, 0.001);
 143
 144     /*
 145      * Check annotation to sequence position mappings before expanding the
 146      * sequence; these are set up in Sequence.addAlignmentAnnotation ->
 147      * Annotation.setSequenceRef -> createSequenceMappings
 148      */
 149     assertNull(ann.getAnnotationForPosition(1));
 150     assertNull(ann.getAnnotationForPosition(2));
 151     assertNull(ann.getAnnotationForPosition(3));
 152     assertEquals(4, ann.getAnnotationForPosition(4).value, 0.001);
 153     assertEquals(5, ann.getAnnotationForPosition(5).value, 0.001);
 154     assertEquals(6, ann.getAnnotationForPosition(6).value, 0.001);
 155     assertNull(ann.getAnnotationForPosition(7));
 156     assertNull(ann.getAnnotationForPosition(8));
 157     assertNull(ann.getAnnotationForPosition(9));
 158
 159     /*
 160      * Expand the subsequence to the full sequence abcDEFghi
 161      */
 162     AlignmentI expanded = AlignmentUtils.expandContext(al, -1);
 163     assertEquals("abcDEFghi", expanded.getSequenceAt(0)
 164             .getSequenceAsString());
 165
 166     /*
 167      * Confirm the alignment and sequence have the same SS annotation,
 168      * referencing the expanded sequence
 169      */
 170     ann = expanded.getSequenceAt(0).getAnnotation()[0];
 171     assertSame(ann, expanded.getAlignmentAnnotation()[0]);
 172     assertSame(expanded.getSequenceAt(0), ann.sequenceRef);
 173
 174     /*
 175      * The annotations array should have null values except for annotated
 176      * positions
 177      */
 178     assertNull(ann.annotations[0]);
 179     assertNull(ann.annotations[1]);
 180     assertNull(ann.annotations[2]);
 181     assertEquals(4, ann.annotations[3].value, 0.001);
 182     assertEquals(5, ann.annotations[4].value, 0.001);
 183     assertEquals(6, ann.annotations[5].value, 0.001);
 184     assertNull(ann.annotations[6]);
 185     assertNull(ann.annotations[7]);
 186     assertNull(ann.annotations[8]);
 187
 188     /*
 189      * sequence position mappings should be unchanged
 190      */
 191     assertNull(ann.getAnnotationForPosition(1));
 192     assertNull(ann.getAnnotationForPosition(2));
 193     assertNull(ann.getAnnotationForPosition(3));
 194     assertEquals(4, ann.getAnnotationForPosition(4).value, 0.001);
 195     assertEquals(5, ann.getAnnotationForPosition(5).value, 0.001);
 196     assertEquals(6, ann.getAnnotationForPosition(6).value, 0.001);
 197     assertNull(ann.getAnnotationForPosition(7));
 198     assertNull(ann.getAnnotationForPosition(8));
 199     assertNull(ann.getAnnotationForPosition(9));
 200   }
 201
 202   /**
 203    * Test method that returns a map of lists of sequences by sequence name.
 204    *
 205    * @throws IOException
 206    */
 207   @Test(groups = { "Functional" })
 208   public void testGetSequencesByName() throws IOException
 209   {
 210     final String data = ">Seq1Name\nKQYL\n" + ">Seq2Name\nRFPW\n"
 211             + ">Seq1Name\nABCD\n";
 212     AlignmentI al = loadAlignment(data, "FASTA");
 213     Map<String, List<SequenceI>> map = AlignmentUtils
 214             .getSequencesByName(al);
 215     assertEquals(2, map.keySet().size());
 216     assertEquals(2, map.get("Seq1Name").size());
 217     assertEquals("KQYL", map.get("Seq1Name").get(0).getSequenceAsString());
 218     assertEquals("ABCD", map.get("Seq1Name").get(1).getSequenceAsString());
 219     assertEquals(1, map.get("Seq2Name").size());
 220     assertEquals("RFPW", map.get("Seq2Name").get(0).getSequenceAsString());
 221   }
 222
 223   /**
 224    * Helper method to load an alignment and ensure dataset sequences are set up.
 225    *
 226    * @param data
 227    * @param format
 228    *          TODO
 229    * @return
 230    * @throws IOException
 231    */
 232   protected AlignmentI loadAlignment(final String data, String format)
 233           throws IOException
 234   {
 235     AlignmentI a = new FormatAdapter().readFile(data,
 236             AppletFormatAdapter.PASTE, format);
 237     a.setDataset(null);
 238     return a;
 239   }
 240
 241   /**
 242    * Test mapping of protein to cDNA, for the case where we have no sequence
 243    * cross-references, so mappings are made first-served 1-1 where sequences
 244    * translate.
 245    *
 246    * @throws IOException
 247    */
 248   @Test(groups = { "Functional" })
 249   public void testMapProteinAlignmentToCdna_noXrefs() throws IOException
 250   {
 251     List<SequenceI> protseqs = new ArrayList<SequenceI>();
 252     protseqs.add(new Sequence("UNIPROT|V12345", "EIQ"));
 253     protseqs.add(new Sequence("UNIPROT|V12346", "EIQ"));
 254     protseqs.add(new Sequence("UNIPROT|V12347", "SAR"));
 255     AlignmentI protein = new Alignment(protseqs.toArray(new SequenceI[3]));
 256     protein.setDataset(null);
 257
 258     List<SequenceI> dnaseqs = new ArrayList<SequenceI>();
 259     dnaseqs.add(new Sequence("EMBL|A11111", "TCAGCACGC")); // = SAR
 260     dnaseqs.add(new Sequence("EMBL|A22222", "GAGATACAA")); // = EIQ
 261     dnaseqs.add(new Sequence("EMBL|A33333", "GAAATCCAG")); // = EIQ
 262     dnaseqs.add(new Sequence("EMBL|A44444", "GAAATTCAG")); // = EIQ
 263     AlignmentI cdna = new Alignment(dnaseqs.toArray(new SequenceI[4]));
 264     cdna.setDataset(null);
 265
 266     assertTrue(AlignmentUtils.mapProteinAlignmentToCdna(protein, cdna));
 267
 268     // 3 mappings made, each from 1 to 1 sequence
 269     assertEquals(3, protein.getCodonFrames().size());
 270     assertEquals(1, protein.getCodonFrame(protein.getSequenceAt(0)).size());
 271     assertEquals(1, protein.getCodonFrame(protein.getSequenceAt(1)).size());
 272     assertEquals(1, protein.getCodonFrame(protein.getSequenceAt(2)).size());
 273
 274     // V12345 mapped to A22222
 275     AlignedCodonFrame acf = protein.getCodonFrame(protein.getSequenceAt(0))
 276             .get(0);
 277     assertEquals(1, acf.getdnaSeqs().length);
 278     assertEquals(cdna.getSequenceAt(1).getDatasetSequence(),
 279             acf.getdnaSeqs()[0]);
 280     Mapping[] protMappings = acf.getProtMappings();
 281     assertEquals(1, protMappings.length);
 282     MapList mapList = protMappings[0].getMap();
 283     assertEquals(3, mapList.getFromRatio());
 284     assertEquals(1, mapList.getToRatio());
 285     assertTrue(Arrays.equals(new int[] { 1, 9 }, mapList.getFromRanges()
 286             .get(0)));
 287     assertEquals(1, mapList.getFromRanges().size());
 288     assertTrue(Arrays.equals(new int[] { 1, 3 },
 289             mapList.getToRanges().get(0)));
 290     assertEquals(1, mapList.getToRanges().size());
 291
 292     // V12346 mapped to A33333
 293     acf = protein.getCodonFrame(protein.getSequenceAt(1)).get(0);
 294     assertEquals(1, acf.getdnaSeqs().length);
 295     assertEquals(cdna.getSequenceAt(2).getDatasetSequence(),
 296             acf.getdnaSeqs()[0]);
 297
 298     // V12347 mapped to A11111
 299     acf = protein.getCodonFrame(protein.getSequenceAt(2)).get(0);
 300     assertEquals(1, acf.getdnaSeqs().length);
 301     assertEquals(cdna.getSequenceAt(0).getDatasetSequence(),
 302             acf.getdnaSeqs()[0]);
 303
 304     // no mapping involving the 'extra' A44444
 305     assertTrue(protein.getCodonFrame(cdna.getSequenceAt(3)).isEmpty());
 306   }
 307
 308   /**
 309    * Test for the alignSequenceAs method that takes two sequences and a mapping.
 310    */
 311   @Test(groups = { "Functional" })
 312   public void testAlignSequenceAs_withMapping_noIntrons()
 313   {
 314     MapList map = new MapList(new int[] { 1, 6 }, new int[] { 1, 2 }, 3, 1);
 315
 316     /*
 317      * No existing gaps in dna:
 318      */
 319     checkAlignSequenceAs("GGGAAA", "-A-L-", false, false, map,
 320             "---GGG---AAA");
 321
 322     /*
 323      * Now introduce gaps in dna but ignore them when realigning.
 324      */
 325     checkAlignSequenceAs("-G-G-G-A-A-A-", "-A-L-", false, false, map,
 326             "---GGG---AAA");
 327
 328     /*
 329      * Now include gaps in dna when realigning. First retaining 'mapped' gaps
 330      * only, i.e. those within the exon region.
 331      */
 332     checkAlignSequenceAs("-G-G--G-A--A-A-", "-A-L-", true, false, map,
 333             "---G-G--G---A--A-A");
 334
 335     /*
 336      * Include all gaps in dna when realigning (within and without the exon
 337      * region). The leading gap, and the gaps between codons, are subsumed by
 338      * the protein alignment gap.
 339      */
 340     checkAlignSequenceAs("-G-GG--AA-A---", "-A-L-", true, true, map,
 341             "---G-GG---AA-A---");
 342
 343     /*
 344      * Include only unmapped gaps in dna when realigning (outside the exon
 345      * region). The leading gap, and the gaps between codons, are subsumed by
 346      * the protein alignment gap.
 347      */
 348     checkAlignSequenceAs("-G-GG--AA-A-", "-A-L-", false, true, map,
 349             "---GGG---AAA---");
 350   }
 351
 352   /**
 353    * Test for the alignSequenceAs method that takes two sequences and a mapping.
 354    */
 355   @Test(groups = { "Functional" })
 356   public void testAlignSequenceAs_withMapping_withIntrons()
 357   {
 358     /*
 359      * Exons at codon 2 (AAA) and 4 (TTT)
 360      */
 361     MapList map = new MapList(new int[] { 4, 6, 10, 12 },
 362             new int[] { 1, 2 }, 3, 1);
 363
 364     /*
 365      * Simple case: no gaps in dna
 366      */
 367     checkAlignSequenceAs("GGGAAACCCTTTGGG", "--A-L-", false, false, map,
 368             "GGG---AAACCCTTTGGG");
 369
 370     /*
 371      * Add gaps to dna - but ignore when realigning.
 372      */
 373     checkAlignSequenceAs("-G-G-G--A--A---AC-CC-T-TT-GG-G-", "--A-L-",
 374             false, false, map, "GGG---AAACCCTTTGGG");
 375
 376     /*
 377      * Add gaps to dna - include within exons only when realigning.
 378      */
 379     checkAlignSequenceAs("-G-G-G--A--A---A-C-CC-T-TT-GG-G-", "--A-L-",
 380             true, false, map, "GGG---A--A---ACCCT-TTGGG");
 381
 382     /*
 383      * Include gaps outside exons only when realigning.
 384      */
 385     checkAlignSequenceAs("-G-G-G--A--A---A-C-CC-T-TT-GG-G-", "--A-L-",
 386             false, true, map, "-G-G-GAAAC-CCTTT-GG-G-");
 387
 388     /*
 389      * Include gaps following first intron if we are 'preserving mapped gaps'
 390      */
 391     checkAlignSequenceAs("-G-G-G--A--A---A-C-CC-T-TT-GG-G-", "--A-L-",
 392             true, true, map, "-G-G-G--A--A---A-C-CC-T-TT-GG-G-");
 393
 394     /*
 395      * Include all gaps in dna when realigning.
 396      */
 397     checkAlignSequenceAs("-G-G-G--A--A---A-C-CC-T-TT-GG-G-", "--A-L-",
 398             true, true, map, "-G-G-G--A--A---A-C-CC-T-TT-GG-G-");
 399   }
 400
 401   /**
 402    * Test for the case where not all of the protein sequence is mapped to cDNA.
 403    */
 404   @Test(groups = { "Functional" })
 405   public void testAlignSequenceAs_withMapping_withUnmappedProtein()
 406   {
 407     /*
 408      * Exons at codon 2 (AAA) and 4 (TTT) mapped to A and P
 409      */
 410     final MapList map = new MapList(new int[] { 4, 6, 10, 12 }, new int[] {
 411         1, 1, 3, 3 }, 3, 1);
 412
 413     /*
 414      * -L- 'aligns' ccc------
 415      */
 416     checkAlignSequenceAs("gggAAAcccTTTggg", "-A-L-P-", false, false, map,
 417             "gggAAAccc------TTTggg");
 418   }
 419
 420   /**
 421    * Helper method that performs and verifies the method under test.
 422    *
 423    * @param alignee
 424    *          the sequence to be realigned
 425    * @param alignModel
 426    *          the sequence whose alignment is to be copied
 427    * @param preserveMappedGaps
 428    * @param preserveUnmappedGaps
 429    * @param map
 430    * @param expected
 431    */
 432   protected void checkAlignSequenceAs(final String alignee,
 433           final String alignModel, final boolean preserveMappedGaps,
 434           final boolean preserveUnmappedGaps, MapList map,
 435           final String expected)
 436   {
 437     SequenceI alignMe = new Sequence("Seq1", alignee);
 438     alignMe.createDatasetSequence();
 439     SequenceI alignFrom = new Sequence("Seq2", alignModel);
 440     alignFrom.createDatasetSequence();
 441     AlignedCodonFrame acf = new AlignedCodonFrame();
 442     acf.addMap(alignMe.getDatasetSequence(), alignFrom.getDatasetSequence(), map);
 443
 444     AlignmentUtils.alignSequenceAs(alignMe, alignFrom, acf, "---", '-',
 445             preserveMappedGaps, preserveUnmappedGaps);
 446     assertEquals(expected, alignMe.getSequenceAsString());
 447   }
 448
 449   /**
 450    * Test for the alignSequenceAs method where we preserve gaps in introns only.
 451    */
 452   @Test(groups = { "Functional" })
 453   public void testAlignSequenceAs_keepIntronGapsOnly()
 454   {
 455
 456     /*
 457      * Intron GGGAAA followed by exon CCCTTT
 458      */
 459     MapList map = new MapList(new int[] { 7, 12 }, new int[] { 1, 2 }, 3, 1);
 460
 461     checkAlignSequenceAs("GG-G-AA-A-C-CC-T-TT", "AL", false, true, map,
 462             "GG-G-AA-ACCCTTT");
 463   }
 464
 465   /**
 466    * Test the method that realigns protein to match mapped codon alignment.
 467    */
 468   @Test(groups = { "Functional" })
 469   public void testAlignProteinAsDna()
 470   {
 471     // seq1 codons are [1,2,3] [4,5,6] [7,8,9] [10,11,12]
 472     SequenceI dna1 = new Sequence("Seq1", "TGCCATTACCAG-");
 473     // seq2 codons are [1,3,4] [5,6,7] [8,9,10] [11,12,13]
 474     SequenceI dna2 = new Sequence("Seq2", "T-GCCATTACCAG");
 475     // seq3 codons are [1,2,3] [4,5,7] [8,9,10] [11,12,13]
 476     SequenceI dna3 = new Sequence("Seq3", "TGCCA-TTACCAG");
 477     AlignmentI dna = new Alignment(new SequenceI[] { dna1, dna2, dna3 });
 478     dna.setDataset(null);
 479
 480     // protein alignment will be realigned like dna
 481     SequenceI prot1 = new Sequence("Seq1", "CHYQ");
 482     SequenceI prot2 = new Sequence("Seq2", "CHYQ");
 483     SequenceI prot3 = new Sequence("Seq3", "CHYQ");
 484     SequenceI prot4 = new Sequence("Seq4", "R-QSV"); // unmapped, unchanged
 485     AlignmentI protein = new Alignment(new SequenceI[] { prot1, prot2,
 486         prot3, prot4 });
 487     protein.setDataset(null);
 488
 489     MapList map = new MapList(new int[] { 1, 12 }, new int[] { 1, 4 }, 3, 1);
 490     AlignedCodonFrame acf = new AlignedCodonFrame();
 491     acf.addMap(dna1.getDatasetSequence(), prot1.getDatasetSequence(), map);
 492     acf.addMap(dna2.getDatasetSequence(), prot2.getDatasetSequence(), map);
 493     acf.addMap(dna3.getDatasetSequence(), prot3.getDatasetSequence(), map);
 494     ArrayList<AlignedCodonFrame> acfs = new ArrayList<AlignedCodonFrame>();
 495     acfs.add(acf);
 496     protein.setCodonFrames(acfs);
 497
 498     /*
 499      * Translated codon order is [1,2,3] [1,3,4] [4,5,6] [4,5,7] [5,6,7] [7,8,9]
 500      * [8,9,10] [10,11,12] [11,12,13]
 501      */
 502     AlignmentUtils.alignProteinAsDna(protein, dna);
 503     assertEquals("C-H--Y-Q-", prot1.getSequenceAsString());
 504     assertEquals("-C--H-Y-Q", prot2.getSequenceAsString());
 505     assertEquals("C--H--Y-Q", prot3.getSequenceAsString());
 506     assertEquals("R-QSV", prot4.getSequenceAsString());
 507   }
 508
 509   /**
 510    * Test the method that tests whether a CDNA sequence translates to a protein
 511    * sequence
 512    */
 513   @Test(groups = { "Functional" })
 514   public void testTranslatesAs()
 515   {
 516     // null arguments check
 517     assertFalse(AlignmentUtils.translatesAs(null, 0, null));
 518     assertFalse(AlignmentUtils.translatesAs(new char[] { 't' }, 0, null));
 519     assertFalse(AlignmentUtils.translatesAs(null, 0, new char[] { 'a' }));
 520
 521     // straight translation
 522     assertTrue(AlignmentUtils.translatesAs("tttcccaaaggg".toCharArray(), 0,
 523             "FPKG".toCharArray()));
 524     // with extra start codon (not in protein)
 525     assertTrue(AlignmentUtils.translatesAs("atgtttcccaaaggg".toCharArray(),
 526             3, "FPKG".toCharArray()));
 527     // with stop codon1 (not in protein)
 528     assertTrue(AlignmentUtils.translatesAs("tttcccaaagggtaa".toCharArray(),
 529             0, "FPKG".toCharArray()));
 530     // with stop codon1 (in protein as *)
 531     assertTrue(AlignmentUtils.translatesAs("tttcccaaagggtaa".toCharArray(),
 532             0, "FPKG*".toCharArray()));
 533     // with stop codon2 (not in protein)
 534     assertTrue(AlignmentUtils.translatesAs("tttcccaaagggtag".toCharArray(),
 535             0, "FPKG".toCharArray()));
 536     // with stop codon3 (not in protein)
 537     assertTrue(AlignmentUtils.translatesAs("tttcccaaagggtga".toCharArray(),
 538             0, "FPKG".toCharArray()));
 539     // with start and stop codon1
 540     assertTrue(AlignmentUtils.translatesAs(
 541             "atgtttcccaaagggtaa".toCharArray(), 3, "FPKG".toCharArray()));
 542     // with start and stop codon1 (in protein as *)
 543     assertTrue(AlignmentUtils.translatesAs(
 544             "atgtttcccaaagggtaa".toCharArray(), 3, "FPKG*".toCharArray()));
 545     // with start and stop codon2
 546     assertTrue(AlignmentUtils.translatesAs(
 547             "atgtttcccaaagggtag".toCharArray(), 3, "FPKG".toCharArray()));
 548     // with start and stop codon3
 549     assertTrue(AlignmentUtils.translatesAs(
 550             "atgtttcccaaagggtga".toCharArray(), 3, "FPKG".toCharArray()));
 551
 552     // with embedded stop codons
 553     assertTrue(AlignmentUtils.translatesAs(
 554             "atgtttTAGcccaaaTAAgggtga".toCharArray(), 3,
 555             "F*PK*G".toCharArray()));
 556
 557     // wrong protein
 558     assertFalse(AlignmentUtils.translatesAs("tttcccaaaggg".toCharArray(),
 559             0, "FPMG".toCharArray()));
 560
 561     // truncated dna
 562     assertFalse(AlignmentUtils.translatesAs("tttcccaaagg".toCharArray(), 0,
 563             "FPKG".toCharArray()));
 564
 565     // truncated protein
 566     assertFalse(AlignmentUtils.translatesAs("tttcccaaaggg".toCharArray(),
 567             0, "FPK".toCharArray()));
 568
 569     // overlong dna (doesn't end in stop codon)
 570     assertFalse(AlignmentUtils.translatesAs(
 571             "tttcccaaagggttt".toCharArray(), 0, "FPKG".toCharArray()));
 572
 573     // dna + stop codon + more
 574     assertFalse(AlignmentUtils.translatesAs(
 575             "tttcccaaagggttaga".toCharArray(), 0, "FPKG".toCharArray()));
 576
 577     // overlong protein
 578     assertFalse(AlignmentUtils.translatesAs("tttcccaaaggg".toCharArray(),
 579             0, "FPKGQ".toCharArray()));
 580   }
 581
 582   /**
 583    * Test mapping of protein to cDNA, for cases where the cDNA has start and/or
 584    * stop codons in addition to the protein coding sequence.
 585    *
 586    * @throws IOException
 587    */
 588   @Test(groups = { "Functional" })
 589   public void testMapProteinAlignmentToCdna_withStartAndStopCodons()
 590           throws IOException
 591   {
 592     List<SequenceI> protseqs = new ArrayList<SequenceI>();
 593     protseqs.add(new Sequence("UNIPROT|V12345", "EIQ"));
 594     protseqs.add(new Sequence("UNIPROT|V12346", "EIQ"));
 595     protseqs.add(new Sequence("UNIPROT|V12347", "SAR"));
 596     AlignmentI protein = new Alignment(protseqs.toArray(new SequenceI[3]));
 597     protein.setDataset(null);
 598
 599     List<SequenceI> dnaseqs = new ArrayList<SequenceI>();
 600     // start + SAR:
 601     dnaseqs.add(new Sequence("EMBL|A11111", "ATGTCAGCACGC"));
 602     // = EIQ + stop
 603     dnaseqs.add(new Sequence("EMBL|A22222", "GAGATACAATAA"));
 604     // = start +EIQ + stop
 605     dnaseqs.add(new Sequence("EMBL|A33333", "ATGGAAATCCAGTAG"));
 606     dnaseqs.add(new Sequence("EMBL|A44444", "GAAATTCAG"));
 607     AlignmentI cdna = new Alignment(dnaseqs.toArray(new SequenceI[4]));
 608     cdna.setDataset(null);
 609
 610     assertTrue(AlignmentUtils.mapProteinAlignmentToCdna(protein, cdna));
 611
 612     // 3 mappings made, each from 1 to 1 sequence
 613     assertEquals(3, protein.getCodonFrames().size());
 614     assertEquals(1, protein.getCodonFrame(protein.getSequenceAt(0)).size());
 615     assertEquals(1, protein.getCodonFrame(protein.getSequenceAt(1)).size());
 616     assertEquals(1, protein.getCodonFrame(protein.getSequenceAt(2)).size());
 617
 618     // V12345 mapped from A22222
 619     AlignedCodonFrame acf = protein.getCodonFrame(protein.getSequenceAt(0))
 620             .get(0);
 621     assertEquals(1, acf.getdnaSeqs().length);
 622     assertEquals(cdna.getSequenceAt(1).getDatasetSequence(),
 623             acf.getdnaSeqs()[0]);
 624     Mapping[] protMappings = acf.getProtMappings();
 625     assertEquals(1, protMappings.length);
 626     MapList mapList = protMappings[0].getMap();
 627     assertEquals(3, mapList.getFromRatio());
 628     assertEquals(1, mapList.getToRatio());
 629     assertTrue(Arrays.equals(new int[] { 1, 9 }, mapList.getFromRanges()
 630             .get(0)));
 631     assertEquals(1, mapList.getFromRanges().size());
 632     assertTrue(Arrays.equals(new int[] { 1, 3 },
 633             mapList.getToRanges().get(0)));
 634     assertEquals(1, mapList.getToRanges().size());
 635
 636     // V12346 mapped from A33333 starting position 4
 637     acf = protein.getCodonFrame(protein.getSequenceAt(1)).get(0);
 638     assertEquals(1, acf.getdnaSeqs().length);
 639     assertEquals(cdna.getSequenceAt(2).getDatasetSequence(),
 640             acf.getdnaSeqs()[0]);
 641     protMappings = acf.getProtMappings();
 642     assertEquals(1, protMappings.length);
 643     mapList = protMappings[0].getMap();
 644     assertEquals(3, mapList.getFromRatio());
 645     assertEquals(1, mapList.getToRatio());
 646     assertTrue(Arrays.equals(new int[] { 4, 12 }, mapList.getFromRanges()
 647             .get(0)));
 648     assertEquals(1, mapList.getFromRanges().size());
 649     assertTrue(Arrays.equals(new int[] { 1, 3 },
 650             mapList.getToRanges().get(0)));
 651     assertEquals(1, mapList.getToRanges().size());
 652
 653     // V12347 mapped to A11111 starting position 4
 654     acf = protein.getCodonFrame(protein.getSequenceAt(2)).get(0);
 655     assertEquals(1, acf.getdnaSeqs().length);
 656     assertEquals(cdna.getSequenceAt(0).getDatasetSequence(),
 657             acf.getdnaSeqs()[0]);
 658     protMappings = acf.getProtMappings();
 659     assertEquals(1, protMappings.length);
 660     mapList = protMappings[0].getMap();
 661     assertEquals(3, mapList.getFromRatio());
 662     assertEquals(1, mapList.getToRatio());
 663     assertTrue(Arrays.equals(new int[] { 4, 12 }, mapList.getFromRanges()
 664             .get(0)));
 665     assertEquals(1, mapList.getFromRanges().size());
 666     assertTrue(Arrays.equals(new int[] { 1, 3 },
 667             mapList.getToRanges().get(0)));
 668     assertEquals(1, mapList.getToRanges().size());
 669
 670     // no mapping involving the 'extra' A44444
 671     assertTrue(protein.getCodonFrame(cdna.getSequenceAt(3)).isEmpty());
 672   }
 673
 674   /**
 675    * Test mapping of protein to cDNA, for the case where we have some sequence
 676    * cross-references. Verify that 1-to-many mappings are made where
 677    * cross-references exist and sequences are mappable.
 678    *
 679    * @throws IOException
 680    */
 681   @Test(groups = { "Functional" })
 682   public void testMapProteinAlignmentToCdna_withXrefs() throws IOException
 683   {
 684     List<SequenceI> protseqs = new ArrayList<SequenceI>();
 685     protseqs.add(new Sequence("UNIPROT|V12345", "EIQ"));
 686     protseqs.add(new Sequence("UNIPROT|V12346", "EIQ"));
 687     protseqs.add(new Sequence("UNIPROT|V12347", "SAR"));
 688     AlignmentI protein = new Alignment(protseqs.toArray(new SequenceI[3]));
 689     protein.setDataset(null);
 690
 691     List<SequenceI> dnaseqs = new ArrayList<SequenceI>();
 692     dnaseqs.add(new Sequence("EMBL|A11111", "TCAGCACGC")); // = SAR
 693     dnaseqs.add(new Sequence("EMBL|A22222", "ATGGAGATACAA")); // = start + EIQ
 694     dnaseqs.add(new Sequence("EMBL|A33333", "GAAATCCAG")); // = EIQ
 695     dnaseqs.add(new Sequence("EMBL|A44444", "GAAATTCAG")); // = EIQ
 696     dnaseqs.add(new Sequence("EMBL|A55555", "GAGATTCAG")); // = EIQ
 697     AlignmentI cdna = new Alignment(dnaseqs.toArray(new SequenceI[5]));
 698     cdna.setDataset(null);
 699
 700     // Xref A22222 to V12345 (should get mapped)
 701     dnaseqs.get(1).addDBRef(new DBRefEntry("UNIPROT", "1", "V12345"));
 702     // Xref V12345 to A44444 (should get mapped)
 703     protseqs.get(0).addDBRef(new DBRefEntry("EMBL", "1", "A44444"));
 704     // Xref A33333 to V12347 (sequence mismatch - should not get mapped)
 705     dnaseqs.get(2).addDBRef(new DBRefEntry("UNIPROT", "1", "V12347"));
 706     // as V12345 is mapped to A22222 and A44444, this leaves V12346 unmapped.
 707     // it should get paired up with the unmapped A33333
 708     // A11111 should be mapped to V12347
 709     // A55555 is spare and has no xref so is not mapped
 710
 711     assertTrue(AlignmentUtils.mapProteinAlignmentToCdna(protein, cdna));
 712
 713     // 4 protein mappings made for 3 proteins, 2 to V12345, 1 each to V12346/7
 714     assertEquals(3, protein.getCodonFrames().size());
 715     assertEquals(1, protein.getCodonFrame(protein.getSequenceAt(0)).size());
 716     assertEquals(1, protein.getCodonFrame(protein.getSequenceAt(1)).size());
 717     assertEquals(1, protein.getCodonFrame(protein.getSequenceAt(2)).size());
 718
 719     // one mapping for each of the first 4 cDNA sequences
 720     assertEquals(1, protein.getCodonFrame(cdna.getSequenceAt(0)).size());
 721     assertEquals(1, protein.getCodonFrame(cdna.getSequenceAt(1)).size());
 722     assertEquals(1, protein.getCodonFrame(cdna.getSequenceAt(2)).size());
 723     assertEquals(1, protein.getCodonFrame(cdna.getSequenceAt(3)).size());
 724
 725     // V12345 mapped to A22222 and A44444
 726     AlignedCodonFrame acf = protein.getCodonFrame(protein.getSequenceAt(0))
 727             .get(0);
 728     assertEquals(2, acf.getdnaSeqs().length);
 729     assertEquals(cdna.getSequenceAt(1).getDatasetSequence(),
 730             acf.getdnaSeqs()[0]);
 731     assertEquals(cdna.getSequenceAt(3).getDatasetSequence(),
 732             acf.getdnaSeqs()[1]);
 733
 734     // V12346 mapped to A33333
 735     acf = protein.getCodonFrame(protein.getSequenceAt(1)).get(0);
 736     assertEquals(1, acf.getdnaSeqs().length);
 737     assertEquals(cdna.getSequenceAt(2).getDatasetSequence(),
 738             acf.getdnaSeqs()[0]);
 739
 740     // V12347 mapped to A11111
 741     acf = protein.getCodonFrame(protein.getSequenceAt(2)).get(0);
 742     assertEquals(1, acf.getdnaSeqs().length);
 743     assertEquals(cdna.getSequenceAt(0).getDatasetSequence(),
 744             acf.getdnaSeqs()[0]);
 745
 746     // no mapping involving the 'extra' A55555
 747     assertTrue(protein.getCodonFrame(cdna.getSequenceAt(4)).isEmpty());
 748   }
 749
 750   /**
 751    * Test mapping of protein to cDNA, for the case where we have some sequence
 752    * cross-references. Verify that once we have made an xref mapping we don't
 753    * also map un-xrefd sequeces.
 754    *
 755    * @throws IOException
 756    */
 757   @Test(groups = { "Functional" })
 758   public void testMapProteinAlignmentToCdna_prioritiseXrefs()
 759           throws IOException
 760   {
 761     List<SequenceI> protseqs = new ArrayList<SequenceI>();
 762     protseqs.add(new Sequence("UNIPROT|V12345", "EIQ"));
 763     protseqs.add(new Sequence("UNIPROT|V12346", "EIQ"));
 764     AlignmentI protein = new Alignment(
 765             protseqs.toArray(new SequenceI[protseqs.size()]));
 766     protein.setDataset(null);
 767
 768     List<SequenceI> dnaseqs = new ArrayList<SequenceI>();
 769     dnaseqs.add(new Sequence("EMBL|A11111", "GAAATCCAG")); // = EIQ
 770     dnaseqs.add(new Sequence("EMBL|A22222", "GAAATTCAG")); // = EIQ
 771     AlignmentI cdna = new Alignment(dnaseqs.toArray(new SequenceI[dnaseqs
 772             .size()]));
 773     cdna.setDataset(null);
 774
 775     // Xref A22222 to V12345 (should get mapped)
 776     // A11111 should then be mapped to the unmapped V12346
 777     dnaseqs.get(1).addDBRef(new DBRefEntry("UNIPROT", "1", "V12345"));
 778
 779     assertTrue(AlignmentUtils.mapProteinAlignmentToCdna(protein, cdna));
 780
 781     // 2 protein mappings made
 782     assertEquals(2, protein.getCodonFrames().size());
 783     assertEquals(1, protein.getCodonFrame(protein.getSequenceAt(0)).size());
 784     assertEquals(1, protein.getCodonFrame(protein.getSequenceAt(1)).size());
 785
 786     // one mapping for each of the cDNA sequences
 787     assertEquals(1, protein.getCodonFrame(cdna.getSequenceAt(0)).size());
 788     assertEquals(1, protein.getCodonFrame(cdna.getSequenceAt(1)).size());
 789
 790     // V12345 mapped to A22222
 791     AlignedCodonFrame acf = protein.getCodonFrame(protein.getSequenceAt(0))
 792             .get(0);
 793     assertEquals(1, acf.getdnaSeqs().length);
 794     assertEquals(cdna.getSequenceAt(1).getDatasetSequence(),
 795             acf.getdnaSeqs()[0]);
 796
 797     // V12346 mapped to A11111
 798     acf = protein.getCodonFrame(protein.getSequenceAt(1)).get(0);
 799     assertEquals(1, acf.getdnaSeqs().length);
 800     assertEquals(cdna.getSequenceAt(0).getDatasetSequence(),
 801             acf.getdnaSeqs()[0]);
 802   }
 803
 804   /**
 805    * Test the method that shows or hides sequence annotations by type(s) and
 806    * selection group.
 807    */
 808   @Test(groups = { "Functional" })
 809   public void testShowOrHideSequenceAnnotations()
 810   {
 811     SequenceI seq1 = new Sequence("Seq1", "AAA");
 812     SequenceI seq2 = new Sequence("Seq2", "BBB");
 813     SequenceI seq3 = new Sequence("Seq3", "CCC");
 814     Annotation[] anns = new Annotation[] { new Annotation(2f) };
 815     AlignmentAnnotation ann1 = new AlignmentAnnotation("Structure", "ann1",
 816             anns);
 817     ann1.setSequenceRef(seq1);
 818     AlignmentAnnotation ann2 = new AlignmentAnnotation("Structure", "ann2",
 819             anns);
 820     ann2.setSequenceRef(seq2);
 821     AlignmentAnnotation ann3 = new AlignmentAnnotation("Structure", "ann3",
 822             anns);
 823     AlignmentAnnotation ann4 = new AlignmentAnnotation("Temp", "ann4", anns);
 824     ann4.setSequenceRef(seq1);
 825     AlignmentAnnotation ann5 = new AlignmentAnnotation("Temp", "ann5", anns);
 826     ann5.setSequenceRef(seq2);
 827     AlignmentAnnotation ann6 = new AlignmentAnnotation("Temp", "ann6", anns);
 828     AlignmentI al = new Alignment(new SequenceI[] { seq1, seq2, seq3 });
 829     al.addAnnotation(ann1); // Structure for Seq1
 830     al.addAnnotation(ann2); // Structure for Seq2
 831     al.addAnnotation(ann3); // Structure for no sequence
 832     al.addAnnotation(ann4); // Temp for seq1
 833     al.addAnnotation(ann5); // Temp for seq2
 834     al.addAnnotation(ann6); // Temp for no sequence
 835     List<String> types = new ArrayList<String>();
 836     List<SequenceI> scope = new ArrayList<SequenceI>();
 837
 838     /*
 839      * Set all sequence related Structure to hidden (ann1, ann2)
 840      */
 841     types.add("Structure");
 842     AlignmentUtils.showOrHideSequenceAnnotations(al, types, null, false,
 843             false);
 844     assertFalse(ann1.visible);
 845     assertFalse(ann2.visible);
 846     assertTrue(ann3.visible); // not sequence-related, not affected
 847     assertTrue(ann4.visible); // not Structure, not affected
 848     assertTrue(ann5.visible); // "
 849     assertTrue(ann6.visible); // not sequence-related, not affected
 850
 851     /*
 852      * Set Temp in {seq1, seq3} to hidden
 853      */
 854     types.clear();
 855     types.add("Temp");
 856     scope.add(seq1);
 857     scope.add(seq3);
 858     AlignmentUtils.showOrHideSequenceAnnotations(al, types, scope, false,
 859             false);
 860     assertFalse(ann1.visible); // unchanged
 861     assertFalse(ann2.visible); // unchanged
 862     assertTrue(ann3.visible); // not sequence-related, not affected
 863     assertFalse(ann4.visible); // Temp for seq1 hidden
 864     assertTrue(ann5.visible); // not in scope, not affected
 865     assertTrue(ann6.visible); // not sequence-related, not affected
 866
 867     /*
 868      * Set Temp in all sequences to hidden
 869      */
 870     types.clear();
 871     types.add("Temp");
 872     scope.add(seq1);
 873     scope.add(seq3);
 874     AlignmentUtils.showOrHideSequenceAnnotations(al, types, null, false,
 875             false);
 876     assertFalse(ann1.visible); // unchanged
 877     assertFalse(ann2.visible); // unchanged
 878     assertTrue(ann3.visible); // not sequence-related, not affected
 879     assertFalse(ann4.visible); // Temp for seq1 hidden
 880     assertFalse(ann5.visible); // Temp for seq2 hidden
 881     assertTrue(ann6.visible); // not sequence-related, not affected
 882
 883     /*
 884      * Set all types in {seq1, seq3} to visible
 885      */
 886     types.clear();
 887     scope.clear();
 888     scope.add(seq1);
 889     scope.add(seq3);
 890     AlignmentUtils.showOrHideSequenceAnnotations(al, types, scope, true,
 891             true);
 892     assertTrue(ann1.visible); // Structure for seq1 set visible
 893     assertFalse(ann2.visible); // not in scope, unchanged
 894     assertTrue(ann3.visible); // not sequence-related, not affected
 895     assertTrue(ann4.visible); // Temp for seq1 set visible
 896     assertFalse(ann5.visible); // not in scope, unchanged
 897     assertTrue(ann6.visible); // not sequence-related, not affected
 898
 899     /*
 900      * Set all types in all scope to hidden
 901      */
 902     AlignmentUtils.showOrHideSequenceAnnotations(al, types, null, true,
 903             false);
 904     assertFalse(ann1.visible);
 905     assertFalse(ann2.visible);
 906     assertTrue(ann3.visible); // not sequence-related, not affected
 907     assertFalse(ann4.visible);
 908     assertFalse(ann5.visible);
 909     assertTrue(ann6.visible); // not sequence-related, not affected
 910   }
 911
 912   /**
 913    * Tests for the method that checks if one sequence cross-references another
 914    */
 915   @Test(groups = { "Functional" })
 916   public void testHasCrossRef()
 917   {
 918     assertFalse(AlignmentUtils.hasCrossRef(null, null));
 919     SequenceI seq1 = new Sequence("EMBL|A12345", "ABCDEF");
 920     assertFalse(AlignmentUtils.hasCrossRef(seq1, null));
 921     assertFalse(AlignmentUtils.hasCrossRef(null, seq1));
 922     SequenceI seq2 = new Sequence("UNIPROT|V20192", "ABCDEF");
 923     assertFalse(AlignmentUtils.hasCrossRef(seq1, seq2));
 924
 925     // different ref
 926     seq1.addDBRef(new DBRefEntry("UNIPROT", "1", "v20193"));
 927     assertFalse(AlignmentUtils.hasCrossRef(seq1, seq2));
 928
 929     // case-insensitive; version number is ignored
 930     seq1.addDBRef(new DBRefEntry("UNIPROT", "1", "v20192"));
 931     assertTrue(AlignmentUtils.hasCrossRef(seq1, seq2));
 932
 933     // right case!
 934     seq1.addDBRef(new DBRefEntry("UNIPROT", "1", "V20192"));
 935     assertTrue(AlignmentUtils.hasCrossRef(seq1, seq2));
 936     // test is one-way only
 937     assertFalse(AlignmentUtils.hasCrossRef(seq2, seq1));
 938   }
 939
 940   /**
 941    * Tests for the method that checks if either sequence cross-references the
 942    * other
 943    */
 944   @Test(groups = { "Functional" })
 945   public void testHaveCrossRef()
 946   {
 947     assertFalse(AlignmentUtils.hasCrossRef(null, null));
 948     SequenceI seq1 = new Sequence("EMBL|A12345", "ABCDEF");
 949     assertFalse(AlignmentUtils.haveCrossRef(seq1, null));
 950     assertFalse(AlignmentUtils.haveCrossRef(null, seq1));
 951     SequenceI seq2 = new Sequence("UNIPROT|V20192", "ABCDEF");
 952     assertFalse(AlignmentUtils.haveCrossRef(seq1, seq2));
 953
 954     seq1.addDBRef(new DBRefEntry("UNIPROT", "1", "V20192"));
 955     assertTrue(AlignmentUtils.haveCrossRef(seq1, seq2));
 956     // next is true for haveCrossRef, false for hasCrossRef
 957     assertTrue(AlignmentUtils.haveCrossRef(seq2, seq1));
 958
 959     // now the other way round
 960     seq1.setDBRefs(null);
 961     seq2.addDBRef(new DBRefEntry("EMBL", "1", "A12345"));
 962     assertTrue(AlignmentUtils.haveCrossRef(seq1, seq2));
 963     assertTrue(AlignmentUtils.haveCrossRef(seq2, seq1));
 964
 965     // now both ways
 966     seq1.addDBRef(new DBRefEntry("UNIPROT", "1", "V20192"));
 967     assertTrue(AlignmentUtils.haveCrossRef(seq1, seq2));
 968     assertTrue(AlignmentUtils.haveCrossRef(seq2, seq1));
 969   }
 970
 971   /**
 972    * Test the method that extracts the cds-only part of a dna alignment.
 973    */
 974   @Test(groups = { "Functional" })
 975   public void testMakeCdsAlignment()
 976   {
 977     /*
 978      * scenario:
 979      *     dna1 --> [4, 6] [10,12]        --> pep1
 980      *     dna2 --> [1, 3] [7, 9] [13,15] --> pep1
 981      */
 982     SequenceI dna1 = new Sequence("dna1", "aaaGGGcccTTTaaa");
 983     SequenceI dna2 = new Sequence("dna2", "GGGcccTTTaaaCCC");
 984     SequenceI pep1 = new Sequence("pep1", "GF");
 985     SequenceI pep2 = new Sequence("pep2", "GFP");
 986     pep1.addDBRef(new DBRefEntry("UNIPROT", "0", "pep1"));
 987     pep2.addDBRef(new DBRefEntry("UNIPROT", "0", "pep2"));
 988     dna1.createDatasetSequence();
 989     dna2.createDatasetSequence();
 990     pep1.createDatasetSequence();
 991     pep2.createDatasetSequence();
 992     AlignmentI dna = new Alignment(new SequenceI[] { dna1, dna2 });
 993     dna.setDataset(null);
 994
 995     /*
 996      * need a sourceDbRef if we are to construct dbrefs to the CDS
 997      * sequence from the dna contig sequences
 998      */
 999     DBRefEntry dbref = new DBRefEntry("ENSEMBL", "0", "dna1");
1000     dna1.getDatasetSequence().setSourceDBRef(dbref);
1001     dbref = new DBRefEntry("ENSEMBL", "0", "dna2");
1002     dna2.getDatasetSequence().setSourceDBRef(dbref);
1003
1004     /*
1005      * CDS sequences are 'discovered' from dna-to-protein mappings on the alignment
1006      * dataset (e.g. added from dbrefs by CrossRef.findXrefSequences)
1007      */
1008     MapList mapfordna1 = new MapList(new int[] { 4, 6, 10, 12 },
1009             new int[] { 1, 2 }, 3, 1);
1010     AlignedCodonFrame acf = new AlignedCodonFrame();
1011     acf.addMap(dna1.getDatasetSequence(), pep1.getDatasetSequence(),
1012             mapfordna1);
1013     dna.addCodonFrame(acf);
1014     MapList mapfordna2 = new MapList(new int[] { 1, 3, 7, 9, 13, 15 },
1015             new int[] { 1, 3 },
1016             3, 1);
1017     acf = new AlignedCodonFrame();
1018     acf.addMap(dna2.getDatasetSequence(), pep2.getDatasetSequence(),
1019             mapfordna2);
1020     dna.addCodonFrame(acf);
1021
1022     /*
1023      * In this case, mappings originally came from matching Uniprot accessions - so need an xref on dna involving those regions. These are normally constructed from CDS annotation
1024      */
1025     DBRefEntry dna1xref = new DBRefEntry("UNIPROT", "ENSEMBL", "pep1",
1026             new Mapping(mapfordna1));
1027     dna1.getDatasetSequence().addDBRef(dna1xref);
1028     DBRefEntry dna2xref = new DBRefEntry("UNIPROT", "ENSEMBL", "pep2",
1029             new Mapping(mapfordna2));
1030     dna2.getDatasetSequence().addDBRef(dna2xref);
1031
1032     /*
1033      * execute method under test:
1034      */
1035     AlignmentI cds = AlignmentUtils.makeCdsAlignment(new SequenceI[] {
1036         dna1, dna2 }, dna.getDataset(), null);
1037
1038     /*
1039      * verify cds sequences
1040      */
1041     assertEquals(2, cds.getSequences().size());
1042     assertEquals("GGGTTT", cds.getSequenceAt(0).getSequenceAsString());
1043     assertEquals("GGGTTTCCC", cds.getSequenceAt(1).getSequenceAsString());
1044
1045     /*
1046      * verify shared, extended alignment dataset
1047      */
1048     assertSame(dna.getDataset(), cds.getDataset());
1049     SequenceI cds1Dss = cds.getSequenceAt(0).getDatasetSequence();
1050     SequenceI cds2Dss = cds.getSequenceAt(1).getDatasetSequence();
1051     assertTrue(dna.getDataset().getSequences().contains(cds1Dss));
1052     assertTrue(dna.getDataset().getSequences().contains(cds2Dss));
1053
1054     /*
1055      * verify CDS has a dbref with mapping to peptide
1056      */
1057     assertNotNull(cds1Dss.getDBRefs());
1058     assertEquals(1, cds1Dss.getDBRefs().length);
1059     dbref = cds1Dss.getDBRefs()[0];
1060     assertEquals(dna1xref.getSource(), dbref.getSource());
1061     // version is via ensembl's primary ref
1062     assertEquals(dna1xref.getVersion(), dbref.getVersion());
1063     assertEquals(dna1xref.getAccessionId(), dbref.getAccessionId());
1064     assertNotNull(dbref.getMap());
1065     assertSame(pep1.getDatasetSequence(), dbref.getMap().getTo());
1066     MapList cdsMapping = new MapList(new int[] { 1, 6 },
1067             new int[] { 1, 2 }, 3, 1);
1068     assertEquals(cdsMapping, dbref.getMap().getMap());
1069
1070     /*
1071      * verify peptide has added a dbref with reverse mapping to CDS
1072      */
1073     assertNotNull(pep1.getDBRefs());
1074     assertEquals(2, pep1.getDBRefs().length);
1075     dbref = pep1.getDBRefs()[1];
1076     assertEquals("ENSEMBL", dbref.getSource());
1077     assertEquals("0", dbref.getVersion());
1078     assertEquals("CDS|dna1", dbref.getAccessionId());
1079     assertNotNull(dbref.getMap());
1080     assertSame(cds1Dss, dbref.getMap().getTo());
1081     assertEquals(cdsMapping.getInverse(), dbref.getMap().getMap());
1082
1083     /*
1084      * Verify mappings from CDS to peptide, cDNA to CDS, and cDNA to peptide
1085      * the mappings are on the shared alignment dataset
1086      * 6 mappings, 2*(DNA->CDS), 2*(DNA->Pep), 2*(CDS->Pep)
1087      */
1088     List<AlignedCodonFrame> cdsMappings = cds.getDataset().getCodonFrames();
1089     assertEquals(6, cdsMappings.size());
1090
1091     /*
1092      * verify that mapping sets for dna and cds alignments are different
1093      * [not current behaviour - all mappings are on the alignment dataset]
1094      */
1095     // select -> subselect type to test.
1096     // Assert.assertNotSame(dna.getCodonFrames(), cds.getCodonFrames());
1097     // assertEquals(4, dna.getCodonFrames().size());
1098     // assertEquals(4, cds.getCodonFrames().size());
1099
1100     /*
1101      * Two mappings involve pep1 (dna to pep1, cds to pep1)
1102      * Mapping from pep1 to GGGTTT in first new exon sequence
1103      */
1104     List<AlignedCodonFrame> pep1Mappings = MappingUtils
1105             .findMappingsForSequence(pep1, cdsMappings);
1106     assertEquals(2, pep1Mappings.size());
1107     List<AlignedCodonFrame> mappings = MappingUtils
1108             .findMappingsForSequence(cds.getSequenceAt(0), pep1Mappings);
1109     assertEquals(1, mappings.size());
1110
1111     // map G to GGG
1112     SearchResults sr = MappingUtils.buildSearchResults(pep1, 1, mappings);
1113     assertEquals(1, sr.getResults().size());
1114     Match m = sr.getResults().get(0);
1115     assertSame(cds1Dss, m.getSequence());
1116     assertEquals(1, m.getStart());
1117     assertEquals(3, m.getEnd());
1118     // map F to TTT
1119     sr = MappingUtils.buildSearchResults(pep1, 2, mappings);
1120     m = sr.getResults().get(0);
1121     assertSame(cds1Dss, m.getSequence());
1122     assertEquals(4, m.getStart());
1123     assertEquals(6, m.getEnd());
1124
1125     /*
1126      * Two mappings involve pep2 (dna to pep2, cds to pep2)
1127      * Verify mapping from pep2 to GGGTTTCCC in second new exon sequence
1128      */
1129     List<AlignedCodonFrame> pep2Mappings = MappingUtils
1130             .findMappingsForSequence(pep2, cdsMappings);
1131     assertEquals(2, pep2Mappings.size());
1132     mappings = MappingUtils.findMappingsForSequence(cds.getSequenceAt(1),
1133             pep2Mappings);
1134     assertEquals(1, mappings.size());
1135     // map G to GGG
1136     sr = MappingUtils.buildSearchResults(pep2, 1, mappings);
1137     assertEquals(1, sr.getResults().size());
1138     m = sr.getResults().get(0);
1139     assertSame(cds2Dss, m.getSequence());
1140     assertEquals(1, m.getStart());
1141     assertEquals(3, m.getEnd());
1142     // map F to TTT
1143     sr = MappingUtils.buildSearchResults(pep2, 2, mappings);
1144     m = sr.getResults().get(0);
1145     assertSame(cds2Dss, m.getSequence());
1146     assertEquals(4, m.getStart());
1147     assertEquals(6, m.getEnd());
1148     // map P to CCC
1149     sr = MappingUtils.buildSearchResults(pep2, 3, mappings);
1150     m = sr.getResults().get(0);
1151     assertSame(cds2Dss, m.getSequence());
1152     assertEquals(7, m.getStart());
1153     assertEquals(9, m.getEnd());
1154   }
1155
1156   /**
1157    * Test the method that makes a cds-only alignment from a DNA sequence and its
1158    * product mappings, for the case where there are multiple exon mappings to
1159    * different protein products.
1160    */
1161   @Test(groups = { "Functional" })
1162   public void testMakeCdsAlignment_multipleProteins()
1163   {
1164     SequenceI dna1 = new Sequence("dna1", "aaaGGGcccTTTaaa");
1165     SequenceI pep1 = new Sequence("pep1", "GF"); // GGGTTT
1166     SequenceI pep2 = new Sequence("pep2", "KP"); // aaaccc
1167     SequenceI pep3 = new Sequence("pep3", "KF"); // aaaTTT
1168     dna1.createDatasetSequence();
1169     pep1.createDatasetSequence();
1170     pep2.createDatasetSequence();
1171     pep3.createDatasetSequence();
1172     pep1.getDatasetSequence().addDBRef(
1173             new DBRefEntry("EMBLCDS", "2", "A12345"));
1174     pep2.getDatasetSequence().addDBRef(
1175             new DBRefEntry("EMBLCDS", "3", "A12346"));
1176     pep3.getDatasetSequence().addDBRef(
1177             new DBRefEntry("EMBLCDS", "4", "A12347"));
1178
1179     /*
1180      * Create the CDS alignment
1181      */
1182     AlignmentI dna = new Alignment(new SequenceI[] { dna1 });
1183     dna.setDataset(null);
1184
1185     /*
1186      * Make the mappings from dna to protein
1187      */
1188     // map ...GGG...TTT to GF
1189     MapList map = new MapList(new int[] { 4, 6, 10, 12 },
1190             new int[] { 1, 2 }, 3, 1);
1191     AlignedCodonFrame acf = new AlignedCodonFrame();
1192     acf.addMap(dna1.getDatasetSequence(), pep1.getDatasetSequence(), map);
1193     dna.addCodonFrame(acf);
1194
1195     // map aaa...ccc to KP
1196     map = new MapList(new int[] { 1, 3, 7, 9 }, new int[] { 1, 2 }, 3, 1);
1197     acf = new AlignedCodonFrame();
1198     acf.addMap(dna1.getDatasetSequence(), pep2.getDatasetSequence(), map);
1199     dna.addCodonFrame(acf);
1200
1201     // map aaa......TTT to KF
1202     map = new MapList(new int[] { 1, 3, 10, 12 }, new int[] { 1, 2 }, 3, 1);
1203     acf = new AlignedCodonFrame();
1204     acf.addMap(dna1.getDatasetSequence(), pep3.getDatasetSequence(), map);
1205     dna.addCodonFrame(acf);
1206
1207     /*
1208      * execute method under test
1209      */
1210     AlignmentI cdsal = AlignmentUtils.makeCdsAlignment(
1211             new SequenceI[] { dna1 }, dna.getDataset(), null);
1212
1213     /*
1214      * Verify we have 3 cds sequences, mapped to pep1/2/3 respectively
1215      */
1216     List<SequenceI> cds = cdsal.getSequences();
1217     assertEquals(3, cds.size());
1218
1219     /*
1220      * verify shared, extended alignment dataset
1221      */
1222     assertSame(cdsal.getDataset(), dna.getDataset());
1223     assertTrue(dna.getDataset().getSequences()
1224             .contains(cds.get(0).getDatasetSequence()));
1225     assertTrue(dna.getDataset().getSequences()
1226             .contains(cds.get(1).getDatasetSequence()));
1227     assertTrue(dna.getDataset().getSequences()
1228             .contains(cds.get(2).getDatasetSequence()));
1229
1230     /*
1231      * verify aligned cds sequences and their xrefs
1232      */
1233     SequenceI cdsSeq = cds.get(0);
1234     assertEquals("GGGTTT", cdsSeq.getSequenceAsString());
1235     // assertEquals("dna1|A12345", cdsSeq.getName());
1236     assertEquals("CDS|dna1", cdsSeq.getName());
1237     // assertEquals(1, cdsSeq.getDBRefs().length);
1238     // DBRefEntry cdsRef = cdsSeq.getDBRefs()[0];
1239     // assertEquals("EMBLCDS", cdsRef.getSource());
1240     // assertEquals("2", cdsRef.getVersion());
1241     // assertEquals("A12345", cdsRef.getAccessionId());
1242
1243     cdsSeq = cds.get(1);
1244     assertEquals("aaaccc", cdsSeq.getSequenceAsString());
1245     // assertEquals("dna1|A12346", cdsSeq.getName());
1246     assertEquals("CDS|dna1", cdsSeq.getName());
1247     // assertEquals(1, cdsSeq.getDBRefs().length);
1248     // cdsRef = cdsSeq.getDBRefs()[0];
1249     // assertEquals("EMBLCDS", cdsRef.getSource());
1250     // assertEquals("3", cdsRef.getVersion());
1251     // assertEquals("A12346", cdsRef.getAccessionId());
1252
1253     cdsSeq = cds.get(2);
1254     assertEquals("aaaTTT", cdsSeq.getSequenceAsString());
1255     // assertEquals("dna1|A12347", cdsSeq.getName());
1256     assertEquals("CDS|dna1", cdsSeq.getName());
1257     // assertEquals(1, cdsSeq.getDBRefs().length);
1258     // cdsRef = cdsSeq.getDBRefs()[0];
1259     // assertEquals("EMBLCDS", cdsRef.getSource());
1260     // assertEquals("4", cdsRef.getVersion());
1261     // assertEquals("A12347", cdsRef.getAccessionId());
1262
1263     /*
1264      * Verify there are mappings from each cds sequence to its protein product
1265      * and also to its dna source
1266      */
1267     List<AlignedCodonFrame> newMappings = cdsal.getCodonFrames();
1268
1269     /*
1270      * 6 mappings involve dna1 (to pep1/2/3, cds1/2/3)
1271      */
1272     List<AlignedCodonFrame> dnaMappings = MappingUtils
1273             .findMappingsForSequence(dna1, newMappings);
1274     assertEquals(6, dnaMappings.size());
1275
1276     /*
1277      * dna1 to pep1
1278      */
1279     List<AlignedCodonFrame> mappings = MappingUtils
1280             .findMappingsForSequence(pep1, dnaMappings);
1281     assertEquals(1, mappings.size());
1282     assertEquals(1, mappings.get(0).getMappings().size());
1283     assertSame(pep1.getDatasetSequence(), mappings.get(0).getMappings()
1284             .get(0).getMapping().getTo());
1285
1286     /*
1287      * dna1 to cds1
1288      */
1289     List<AlignedCodonFrame> dnaToCds1Mappings = MappingUtils
1290             .findMappingsForSequence(cds.get(0), dnaMappings);
1291     Mapping mapping = dnaToCds1Mappings.get(0).getMappings().get(0)
1292             .getMapping();
1293     assertSame(cds.get(0).getDatasetSequence(), mapping
1294             .getTo());
1295     assertEquals("G(1) in CDS should map to G(4) in DNA", 4, mapping
1296             .getMap().getToPosition(1));
1297
1298     /*
1299      * dna1 to pep2
1300      */
1301     mappings = MappingUtils.findMappingsForSequence(pep2, dnaMappings);
1302     assertEquals(1, mappings.size());
1303     assertEquals(1, mappings.get(0).getMappings().size());
1304     assertSame(pep2.getDatasetSequence(), mappings.get(0).getMappings()
1305             .get(0).getMapping().getTo());
1306
1307     /*
1308      * dna1 to cds2
1309      */
1310     List<AlignedCodonFrame> dnaToCds2Mappings = MappingUtils
1311             .findMappingsForSequence(cds.get(1), dnaMappings);
1312     mapping = dnaToCds2Mappings.get(0).getMappings().get(0).getMapping();
1313     assertSame(cds.get(1).getDatasetSequence(), mapping.getTo());
1314     assertEquals("c(4) in CDS should map to c(7) in DNA", 7, mapping
1315             .getMap().getToPosition(4));
1316
1317     /*
1318      * dna1 to pep3
1319      */
1320     mappings = MappingUtils.findMappingsForSequence(pep3, dnaMappings);
1321     assertEquals(1, mappings.size());
1322     assertEquals(1, mappings.get(0).getMappings().size());
1323     assertSame(pep3.getDatasetSequence(), mappings.get(0).getMappings()
1324             .get(0).getMapping().getTo());
1325
1326     /*
1327      * dna1 to cds3
1328      */
1329     List<AlignedCodonFrame> dnaToCds3Mappings = MappingUtils
1330             .findMappingsForSequence(cds.get(2), dnaMappings);
1331     mapping = dnaToCds3Mappings.get(0).getMappings().get(0).getMapping();
1332     assertSame(cds.get(2).getDatasetSequence(), mapping.getTo());
1333     assertEquals("T(4) in CDS should map to T(10) in DNA", 10, mapping
1334             .getMap().getToPosition(4));
1335   }
1336
1337   @Test(groups = { "Functional" })
1338   public void testIsMappable()
1339   {
1340     SequenceI dna1 = new Sequence("dna1", "cgCAGtgGT");
1341     SequenceI aa1 = new Sequence("aa1", "RSG");
1342     AlignmentI al1 = new Alignment(new SequenceI[] { dna1 });
1343     AlignmentI al2 = new Alignment(new SequenceI[] { aa1 });
1344
1345     assertFalse(AlignmentUtils.isMappable(null, null));
1346     assertFalse(AlignmentUtils.isMappable(al1, null));
1347     assertFalse(AlignmentUtils.isMappable(null, al1));
1348     assertFalse(AlignmentUtils.isMappable(al1, al1));
1349     assertFalse(AlignmentUtils.isMappable(al2, al2));
1350
1351     assertTrue(AlignmentUtils.isMappable(al1, al2));
1352     assertTrue(AlignmentUtils.isMappable(al2, al1));
1353   }
1354
1355   /**
1356    * Test creating a mapping when the sequences involved do not start at residue
1357    * 1
1358    *
1359    * @throws IOException
1360    */
1361   @Test(groups = { "Functional" })
1362   public void testMapCdnaToProtein_forSubsequence()
1363           throws IOException
1364   {
1365     SequenceI prot = new Sequence("UNIPROT|V12345", "E-I--Q", 10, 12);
1366     prot.createDatasetSequence();
1367
1368     SequenceI dna = new Sequence("EMBL|A33333", "GAA--AT-C-CAG", 40, 48);
1369     dna.createDatasetSequence();
1370
1371     MapList map = AlignmentUtils.mapCdnaToProtein(prot, dna);
1372     assertEquals(10, map.getToLowest());
1373     assertEquals(12, map.getToHighest());
1374     assertEquals(40, map.getFromLowest());
1375     assertEquals(48, map.getFromHighest());
1376   }
1377
1378   /**
1379    * Test for the alignSequenceAs method where we have protein mapped to protein
1380    */
1381   @Test(groups = { "Functional" })
1382   public void testAlignSequenceAs_mappedProteinProtein()
1383   {
1384
1385     SequenceI alignMe = new Sequence("Match", "MGAASEV");
1386     alignMe.createDatasetSequence();
1387     SequenceI alignFrom = new Sequence("Query", "LQTGYMGAASEVMFSPTRR");
1388     alignFrom.createDatasetSequence();
1389
1390     AlignedCodonFrame acf = new AlignedCodonFrame();
1391     // this is like a domain or motif match of part of a peptide sequence
1392     MapList map = new MapList(new int[] { 6, 12 }, new int[] { 1, 7 }, 1, 1);
1393     acf.addMap(alignFrom.getDatasetSequence(),
1394             alignMe.getDatasetSequence(), map);
1395
1396     AlignmentUtils.alignSequenceAs(alignMe, alignFrom, acf, "-", '-', true,
1397             true);
1398     assertEquals("-----MGAASEV-------", alignMe.getSequenceAsString());
1399   }
1400
1401   /**
1402    * Test for the alignSequenceAs method where there are trailing unmapped
1403    * residues in the model sequence
1404    */
1405   @Test(groups = { "Functional" })
1406   public void testAlignSequenceAs_withTrailingPeptide()
1407   {
1408     // map first 3 codons to KPF; G is a trailing unmapped residue
1409     MapList map = new MapList(new int[] { 1, 9 }, new int[] { 1, 3 }, 3, 1);
1410
1411     checkAlignSequenceAs("AAACCCTTT", "K-PFG", true, true, map,
1412             "AAA---CCCTTT---");
1413   }
1414
1415   /**
1416    * Tests for transferring features between mapped sequences
1417    */
1418   @Test(groups = { "Functional" })
1419   public void testTransferFeatures()
1420   {
1421     SequenceI dna = new Sequence("dna/20-34", "acgTAGcaaGCCcgt");
1422     SequenceI cds = new Sequence("cds/10-15", "TAGGCC");
1423
1424     // no overlap
1425     dna.addSequenceFeature(new SequenceFeature("type1", "desc1", 1, 2, 1f,
1426             null));
1427     // partial overlap - to [1, 1]
1428     dna.addSequenceFeature(new SequenceFeature("type2", "desc2", 3, 4, 2f,
1429             null));
1430     // exact overlap - to [1, 3]
1431     dna.addSequenceFeature(new SequenceFeature("type3", "desc3", 4, 6, 3f,
1432             null));
1433     // spanning overlap - to [2, 5]
1434     dna.addSequenceFeature(new SequenceFeature("type4", "desc4", 5, 11, 4f,
1435             null));
1436     // exactly overlaps whole mapped range [1, 6]
1437     dna.addSequenceFeature(new SequenceFeature("type5", "desc5", 4, 12, 5f,
1438             null));
1439     // no overlap (internal)
1440     dna.addSequenceFeature(new SequenceFeature("type6", "desc6", 7, 9, 6f,
1441             null));
1442     // no overlap (3' end)
1443     dna.addSequenceFeature(new SequenceFeature("type7", "desc7", 13, 15,
1444             7f, null));
1445     // overlap (3' end) - to [6, 6]
1446     dna.addSequenceFeature(new SequenceFeature("type8", "desc8", 12, 12,
1447             8f, null));
1448     // extended overlap - to [6, +]
1449     dna.addSequenceFeature(new SequenceFeature("type9", "desc9", 12, 13,
1450             9f, null));
1451
1452     MapList map = new MapList(new int[] { 4, 6, 10, 12 },
1453             new int[] { 1, 6 }, 1, 1);
1454
1455     /*
1456      * transferFeatures() will build 'partial overlap' for regions
1457      * that partially overlap 5' or 3' (start or end) of target sequence
1458      */
1459     AlignmentUtils.transferFeatures(dna, cds, map, null);
1460     SequenceFeature[] sfs = cds.getSequenceFeatures();
1461     assertEquals(6, sfs.length);
1462
1463     SequenceFeature sf = sfs[0];
1464     assertEquals("type2", sf.getType());
1465     assertEquals("desc2", sf.getDescription());
1466     assertEquals(2f, sf.getScore());
1467     assertEquals(1, sf.getBegin());
1468     assertEquals(1, sf.getEnd());
1469
1470     sf = sfs[1];
1471     assertEquals("type3", sf.getType());
1472     assertEquals("desc3", sf.getDescription());
1473     assertEquals(3f, sf.getScore());
1474     assertEquals(1, sf.getBegin());
1475     assertEquals(3, sf.getEnd());
1476
1477     sf = sfs[2];
1478     assertEquals("type4", sf.getType());
1479     assertEquals(2, sf.getBegin());
1480     assertEquals(5, sf.getEnd());
1481
1482     sf = sfs[3];
1483     assertEquals("type5", sf.getType());
1484     assertEquals(1, sf.getBegin());
1485     assertEquals(6, sf.getEnd());
1486
1487     sf = sfs[4];
1488     assertEquals("type8", sf.getType());
1489     assertEquals(6, sf.getBegin());
1490     assertEquals(6, sf.getEnd());
1491
1492     sf = sfs[5];
1493     assertEquals("type9", sf.getType());
1494     assertEquals(6, sf.getBegin());
1495     assertEquals(6, sf.getEnd());
1496   }
1497
1498   /**
1499    * Tests for transferring features between mapped sequences
1500    */
1501   @Test(groups = { "Functional" })
1502   public void testTransferFeatures_withOmit()
1503   {
1504     SequenceI dna = new Sequence("dna/20-34", "acgTAGcaaGCCcgt");
1505     SequenceI cds = new Sequence("cds/10-15", "TAGGCC");
1506
1507     MapList map = new MapList(new int[] { 4, 6, 10, 12 },
1508             new int[] { 1, 6 }, 1, 1);
1509
1510     // [5, 11] maps to [2, 5]
1511     dna.addSequenceFeature(new SequenceFeature("type4", "desc4", 5, 11, 4f,
1512             null));
1513     // [4, 12] maps to [1, 6]
1514     dna.addSequenceFeature(new SequenceFeature("type5", "desc5", 4, 12, 5f,
1515             null));
1516     // [12, 12] maps to [6, 6]
1517     dna.addSequenceFeature(new SequenceFeature("type8", "desc8", 12, 12,
1518             8f, null));
1519
1520     // desc4 and desc8 are the 'omit these' varargs
1521     AlignmentUtils.transferFeatures(dna, cds, map, null, "type4", "type8");
1522     SequenceFeature[] sfs = cds.getSequenceFeatures();
1523     assertEquals(1, sfs.length);
1524
1525     SequenceFeature sf = sfs[0];
1526     assertEquals("type5", sf.getType());
1527     assertEquals(1, sf.getBegin());
1528     assertEquals(6, sf.getEnd());
1529   }
1530
1531   /**
1532    * Tests for transferring features between mapped sequences
1533    */
1534   @Test(groups = { "Functional" })
1535   public void testTransferFeatures_withSelect()
1536   {
1537     SequenceI dna = new Sequence("dna/20-34", "acgTAGcaaGCCcgt");
1538     SequenceI cds = new Sequence("cds/10-15", "TAGGCC");
1539
1540     MapList map = new MapList(new int[] { 4, 6, 10, 12 },
1541             new int[] { 1, 6 }, 1, 1);
1542
1543     // [5, 11] maps to [2, 5]
1544     dna.addSequenceFeature(new SequenceFeature("type4", "desc4", 5, 11, 4f,
1545             null));
1546     // [4, 12] maps to [1, 6]
1547     dna.addSequenceFeature(new SequenceFeature("type5", "desc5", 4, 12, 5f,
1548             null));
1549     // [12, 12] maps to [6, 6]
1550     dna.addSequenceFeature(new SequenceFeature("type8", "desc8", 12, 12,
1551             8f, null));
1552
1553     // "type5" is the 'select this type' argument
1554     AlignmentUtils.transferFeatures(dna, cds, map, "type5");
1555     SequenceFeature[] sfs = cds.getSequenceFeatures();
1556     assertEquals(1, sfs.length);
1557
1558     SequenceFeature sf = sfs[0];
1559     assertEquals("type5", sf.getType());
1560     assertEquals(1, sf.getBegin());
1561     assertEquals(6, sf.getEnd());
1562   }
1563
1564   /**
1565    * Test the method that extracts the cds-only part of a dna alignment, for the
1566    * case where the cds should be aligned to match its nucleotide sequence.
1567    */
1568   @Test(groups = { "Functional" })
1569   public void testMakeCdsAlignment_alternativeTranscripts()
1570   {
1571     SequenceI dna1 = new Sequence("dna1", "aaaGGGCC-----CTTTaaaGGG");
1572     // alternative transcript of same dna skips CCC codon
1573     SequenceI dna2 = new Sequence("dna2", "aaaGGGCC-----cttTaaaGGG");
1574     // dna3 has no mapping (protein product) so should be ignored here
1575     SequenceI dna3 = new Sequence("dna3", "aaaGGGCCCCCGGGcttTaaaGGG");
1576     SequenceI pep1 = new Sequence("pep1", "GPFG");
1577     SequenceI pep2 = new Sequence("pep2", "GPG");
1578     dna1.createDatasetSequence();
1579     dna2.createDatasetSequence();
1580     dna3.createDatasetSequence();
1581     pep1.createDatasetSequence();
1582     pep2.createDatasetSequence();
1583
1584     AlignmentI dna = new Alignment(new SequenceI[] { dna1, dna2, dna3 });
1585     dna.setDataset(null);
1586
1587     MapList map = new MapList(new int[] { 4, 12, 16, 18 },
1588             new int[] { 1, 4 }, 3, 1);
1589     AlignedCodonFrame acf = new AlignedCodonFrame();
1590     acf.addMap(dna1.getDatasetSequence(), pep1.getDatasetSequence(), map);
1591     dna.addCodonFrame(acf);
1592     map = new MapList(new int[] { 4, 8, 12, 12, 16, 18 },
1593             new int[] { 1, 3 },
1594             3, 1);
1595     acf = new AlignedCodonFrame();
1596     acf.addMap(dna2.getDatasetSequence(), pep2.getDatasetSequence(), map);
1597     dna.addCodonFrame(acf);
1598
1599     AlignmentI cds = AlignmentUtils.makeCdsAlignment(new SequenceI[] {
1600         dna1, dna2, dna3 }, dna.getDataset(), null);
1601     List<SequenceI> cdsSeqs = cds.getSequences();
1602     assertEquals(2, cdsSeqs.size());
1603     assertEquals("GGGCCCTTTGGG", cdsSeqs.get(0).getSequenceAsString());
1604     assertEquals("GGGCCTGGG", cdsSeqs.get(1).getSequenceAsString());
1605
1606     /*
1607      * verify shared, extended alignment dataset
1608      */
1609     assertSame(dna.getDataset(), cds.getDataset());
1610     assertTrue(dna.getDataset().getSequences()
1611             .contains(cdsSeqs.get(0).getDatasetSequence()));
1612     assertTrue(dna.getDataset().getSequences()
1613             .contains(cdsSeqs.get(1).getDatasetSequence()));
1614
1615     /*
1616      * Verify 6 mappings: dna1 to cds1, cds1 to pep1, dna1 to pep1
1617      * and the same for dna2/cds2/pep2
1618      */
1619     List<AlignedCodonFrame> mappings = cds.getCodonFrames();
1620     assertEquals(6, mappings.size());
1621
1622     /*
1623      * 2 mappings involve pep1
1624      */
1625     List<AlignedCodonFrame> pep1Mappings = MappingUtils
1626             .findMappingsForSequence(pep1, mappings);
1627     assertEquals(2, pep1Mappings.size());
1628
1629     /*
1630      * Get mapping of pep1 to cds1 and verify it
1631      * maps GPFG to 1-3,4-6,7-9,10-12
1632      */
1633     List<AlignedCodonFrame> pep1CdsMappings = MappingUtils
1634             .findMappingsForSequence(cds.getSequenceAt(0), pep1Mappings);
1635     assertEquals(1, pep1CdsMappings.size());
1636     SearchResults sr = MappingUtils.buildSearchResults(pep1, 1,
1637             pep1CdsMappings);
1638     assertEquals(1, sr.getResults().size());
1639     Match m = sr.getResults().get(0);
1640     assertEquals(cds.getSequenceAt(0).getDatasetSequence(),
1641             m.getSequence());
1642     assertEquals(1, m.getStart());
1643     assertEquals(3, m.getEnd());
1644     sr = MappingUtils.buildSearchResults(pep1, 2, pep1CdsMappings);
1645     m = sr.getResults().get(0);
1646     assertEquals(4, m.getStart());
1647     assertEquals(6, m.getEnd());
1648     sr = MappingUtils.buildSearchResults(pep1, 3, pep1CdsMappings);
1649     m = sr.getResults().get(0);
1650     assertEquals(7, m.getStart());
1651     assertEquals(9, m.getEnd());
1652     sr = MappingUtils.buildSearchResults(pep1, 4, pep1CdsMappings);
1653     m = sr.getResults().get(0);
1654     assertEquals(10, m.getStart());
1655     assertEquals(12, m.getEnd());
1656
1657     /*
1658      * Get mapping of pep2 to cds2 and verify it
1659      * maps GPG in pep2 to 1-3,4-6,7-9 in second CDS sequence
1660      */
1661     List<AlignedCodonFrame> pep2Mappings = MappingUtils
1662             .findMappingsForSequence(pep2, mappings);
1663     assertEquals(2, pep2Mappings.size());
1664     List<AlignedCodonFrame> pep2CdsMappings = MappingUtils
1665             .findMappingsForSequence(cds.getSequenceAt(1), pep2Mappings);
1666     assertEquals(1, pep2CdsMappings.size());
1667     sr = MappingUtils.buildSearchResults(pep2, 1, pep2CdsMappings);
1668     assertEquals(1, sr.getResults().size());
1669     m = sr.getResults().get(0);
1670     assertEquals(cds.getSequenceAt(1).getDatasetSequence(),
1671             m.getSequence());
1672     assertEquals(1, m.getStart());
1673     assertEquals(3, m.getEnd());
1674     sr = MappingUtils.buildSearchResults(pep2, 2, pep2CdsMappings);
1675     m = sr.getResults().get(0);
1676     assertEquals(4, m.getStart());
1677     assertEquals(6, m.getEnd());
1678     sr = MappingUtils.buildSearchResults(pep2, 3, pep2CdsMappings);
1679     m = sr.getResults().get(0);
1680     assertEquals(7, m.getStart());
1681     assertEquals(9, m.getEnd());
1682   }
1683
1684   /**
1685    * Test the method that realigns protein to match mapped codon alignment.
1686    */
1687   @Test(groups = { "Functional" })
1688   public void testAlignProteinAsDna_incompleteStartCodon()
1689   {
1690     // seq1: incomplete start codon (not mapped), then [3, 11]
1691     SequenceI dna1 = new Sequence("Seq1", "ccAAA-TTT-GGG-");
1692     // seq2 codons are [4, 5], [8, 11]
1693     SequenceI dna2 = new Sequence("Seq2", "ccaAA-ttT-GGG-");
1694     // seq3 incomplete start codon at 'tt'
1695     SequenceI dna3 = new Sequence("Seq3", "ccaaa-ttt-GGG-");
1696     AlignmentI dna = new Alignment(new SequenceI[] { dna1, dna2, dna3 });
1697     dna.setDataset(null);
1698
1699     // prot1 has 'X' for incomplete start codon (not mapped)
1700     SequenceI prot1 = new Sequence("Seq1", "XKFG"); // X for incomplete start
1701     SequenceI prot2 = new Sequence("Seq2", "NG");
1702     SequenceI prot3 = new Sequence("Seq3", "XG"); // X for incomplete start
1703     AlignmentI protein = new Alignment(new SequenceI[] { prot1, prot2,
1704         prot3 });
1705     protein.setDataset(null);
1706
1707     // map dna1 [3, 11] to prot1 [2, 4] KFG
1708     MapList map = new MapList(new int[] { 3, 11 }, new int[] { 2, 4 }, 3, 1);
1709     AlignedCodonFrame acf = new AlignedCodonFrame();
1710     acf.addMap(dna1.getDatasetSequence(), prot1.getDatasetSequence(), map);
1711
1712     // map dna2 [4, 5] [8, 11] to prot2 [1, 2] NG
1713     map = new MapList(new int[] { 4, 5, 8, 11 }, new int[] { 1, 2 }, 3, 1);
1714     acf.addMap(dna2.getDatasetSequence(), prot2.getDatasetSequence(), map);
1715
1716     // map dna3 [9, 11] to prot3 [2, 2] G
1717     map = new MapList(new int[] { 9, 11 }, new int[] { 2, 2 }, 3, 1);
1718     acf.addMap(dna3.getDatasetSequence(), prot3.getDatasetSequence(), map);
1719
1720     ArrayList<AlignedCodonFrame> acfs = new ArrayList<AlignedCodonFrame>();
1721     acfs.add(acf);
1722     protein.setCodonFrames(acfs);
1723
1724     /*
1725      * verify X is included in the aligned proteins, and placed just
1726      * before the first mapped residue
1727      * CCT is between CCC and TTT
1728      */
1729     AlignmentUtils.alignProteinAsDna(protein, dna);
1730     assertEquals("XK-FG", prot1.getSequenceAsString());
1731     assertEquals("--N-G", prot2.getSequenceAsString());
1732     assertEquals("---XG", prot3.getSequenceAsString());
1733   }
1734
1735   /**
1736    * Tests for the method that maps the subset of a dna sequence that has CDS
1737    * (or subtype) feature - case where the start codon is incomplete.
1738    */
1739   @Test(groups = "Functional")
1740   public void testFindCdsPositions_fivePrimeIncomplete()
1741   {
1742     SequenceI dnaSeq = new Sequence("dna", "aaagGGCCCaaaTTTttt");
1743     dnaSeq.createDatasetSequence();
1744     SequenceI ds = dnaSeq.getDatasetSequence();
1745
1746     // CDS for dna 5-6 (incomplete codon), 7-9
1747     SequenceFeature sf = new SequenceFeature("CDS", "", 5, 9, 0f, null);
1748     sf.setPhase("2"); // skip 2 bases to start of next codon
1749     ds.addSequenceFeature(sf);
1750     // CDS for dna 13-15
1751     sf = new SequenceFeature("CDS_predicted", "", 13, 15, 0f, null);
1752     ds.addSequenceFeature(sf);
1753
1754     List<int[]> ranges = AlignmentUtils.findCdsPositions(dnaSeq);
1755
1756     /*
1757      * check the mapping starts with the first complete codon
1758      */
1759     assertEquals(6, MappingUtils.getLength(ranges));
1760     assertEquals(2, ranges.size());
1761     assertEquals(7, ranges.get(0)[0]);
1762     assertEquals(9, ranges.get(0)[1]);
1763     assertEquals(13, ranges.get(1)[0]);
1764     assertEquals(15, ranges.get(1)[1]);
1765   }
1766
1767   /**
1768    * Tests for the method that maps the subset of a dna sequence that has CDS
1769    * (or subtype) feature.
1770    */
1771   @Test(groups = "Functional")
1772   public void testFindCdsPositions()
1773   {
1774     SequenceI dnaSeq = new Sequence("dna", "aaaGGGcccAAATTTttt");
1775     dnaSeq.createDatasetSequence();
1776     SequenceI ds = dnaSeq.getDatasetSequence();
1777
1778     // CDS for dna 10-12
1779     SequenceFeature sf = new SequenceFeature("CDS_predicted", "", 10, 12,
1780             0f, null);
1781     sf.setStrand("+");
1782     ds.addSequenceFeature(sf);
1783     // CDS for dna 4-6
1784     sf = new SequenceFeature("CDS", "", 4, 6, 0f, null);
1785     sf.setStrand("+");
1786     ds.addSequenceFeature(sf);
1787     // exon feature should be ignored here
1788     sf = new SequenceFeature("exon", "", 7, 9, 0f, null);
1789     ds.addSequenceFeature(sf);
1790
1791     List<int[]> ranges = AlignmentUtils.findCdsPositions(dnaSeq);
1792     /*
1793      * verify ranges { [4-6], [12-10] }
1794      * note CDS ranges are ordered ascending even if the CDS
1795      * features are not
1796      */
1797     assertEquals(6, MappingUtils.getLength(ranges));
1798     assertEquals(2, ranges.size());
1799     assertEquals(4, ranges.get(0)[0]);
1800     assertEquals(6, ranges.get(0)[1]);
1801     assertEquals(10, ranges.get(1)[0]);
1802     assertEquals(12, ranges.get(1)[1]);
1803   }
1804
1805   /**
1806    * Test the method that computes a map of codon variants for each protein
1807    * position from "sequence_variant" features on dna
1808    */
1809   @Test(groups = "Functional")
1810   public void testBuildDnaVariantsMap()
1811   {
1812     SequenceI dna = new Sequence("dna", "atgAAATTTGGGCCCtag");
1813     MapList map = new MapList(new int[] { 1, 18 }, new int[] { 1, 5 }, 3, 1);
1814
1815     /*
1816      * first with no variants on dna
1817      */
1818     LinkedHashMap<Integer, List<DnaVariant>[]> variantsMap = AlignmentUtils
1819             .buildDnaVariantsMap(dna, map);
1820     assertTrue(variantsMap.isEmpty());
1821
1822     /*
1823      * single allele codon 1, on base 1
1824      */
1825     SequenceFeature sf1 = new SequenceFeature("sequence_variant", "", 1, 1,
1826             0f, null);
1827     sf1.setValue("alleles", "T");
1828     sf1.setValue("ID", "sequence_variant:rs758803211");
1829     dna.addSequenceFeature(sf1);
1830
1831     /*
1832      * two alleles codon 2, on bases 2 and 3 (distinct variants)
1833      */
1834     SequenceFeature sf2 = new SequenceFeature("sequence_variant", "", 5, 5,
1835             0f, null);
1836     sf2.setValue("alleles", "T");
1837     sf2.setValue("ID", "sequence_variant:rs758803212");
1838     dna.addSequenceFeature(sf2);
1839     SequenceFeature sf3 = new SequenceFeature("sequence_variant", "", 6, 6,
1840             0f, null);
1841     sf3.setValue("alleles", "G");
1842     sf3.setValue("ID", "sequence_variant:rs758803213");
1843     dna.addSequenceFeature(sf3);
1844
1845     /*
1846      * two alleles codon 3, both on base 2 (one variant)
1847      */
1848     SequenceFeature sf4 = new SequenceFeature("sequence_variant", "", 8, 8,
1849             0f, null);
1850     sf4.setValue("alleles", "C, G");
1851     sf4.setValue("ID", "sequence_variant:rs758803214");
1852     dna.addSequenceFeature(sf4);
1853
1854     // no alleles on codon 4
1855
1856     /*
1857      * alleles on codon 5 on all 3 bases (distinct variants)
1858      */
1859     SequenceFeature sf5 = new SequenceFeature("sequence_variant", "", 13,
1860             13, 0f, null);
1861     sf5.setValue("alleles", "C, G"); // (C duplicates given base value)
1862     sf5.setValue("ID", "sequence_variant:rs758803215");
1863     dna.addSequenceFeature(sf5);
1864     SequenceFeature sf6 = new SequenceFeature("sequence_variant", "", 14,
1865             14, 0f, null);
1866     sf6.setValue("alleles", "g, a"); // should force to upper-case
1867     sf6.setValue("ID", "sequence_variant:rs758803216");
1868     dna.addSequenceFeature(sf6);
1869     SequenceFeature sf7 = new SequenceFeature("sequence_variant", "", 15,
1870             15, 0f, null);
1871     sf7.setValue("alleles", "A, T");
1872     sf7.setValue("ID", "sequence_variant:rs758803217");
1873     dna.addSequenceFeature(sf7);
1874
1875     /*
1876      * build map - expect variants on positions 1, 2, 3, 5
1877      */
1878     variantsMap = AlignmentUtils.buildDnaVariantsMap(dna, map);
1879     assertEquals(4, variantsMap.size());
1880
1881     /*
1882      * protein residue 1: variant on codon (ATG) base 1, not on 2 or 3
1883      */
1884     List<DnaVariant>[] pep1Variants = variantsMap.get(1);
1885     assertEquals(3, pep1Variants.length);
1886     assertEquals(1, pep1Variants[0].size());
1887     assertEquals("A", pep1Variants[0].get(0).base); // codon[1] base
1888     assertSame(sf1, pep1Variants[0].get(0).variant); // codon[1] variant
1889     assertEquals(1, pep1Variants[1].size());
1890     assertEquals("T", pep1Variants[1].get(0).base); // codon[2] base
1891     assertNull(pep1Variants[1].get(0).variant); // no variant here
1892     assertEquals(1, pep1Variants[2].size());
1893     assertEquals("G", pep1Variants[2].get(0).base); // codon[3] base
1894     assertNull(pep1Variants[2].get(0).variant); // no variant here
1895
1896     /*
1897      * protein residue 2: variants on codon (AAA) bases 2 and 3
1898      */
1899     List<DnaVariant>[] pep2Variants = variantsMap.get(2);
1900     assertEquals(3, pep2Variants.length);
1901     assertEquals(1, pep2Variants[0].size());
1902     // codon[1] base recorded while processing variant on codon[2]
1903     assertEquals("A", pep2Variants[0].get(0).base);
1904     assertNull(pep2Variants[0].get(0).variant); // no variant here
1905     // codon[2] base and variant:
1906     assertEquals(1, pep2Variants[1].size());
1907     assertEquals("A", pep2Variants[1].get(0).base);
1908     assertSame(sf2, pep2Variants[1].get(0).variant);
1909     // codon[3] base was recorded when processing codon[2] variant
1910     // and then the variant for codon[3] added to it
1911     assertEquals(1, pep2Variants[2].size());
1912     assertEquals("A", pep2Variants[2].get(0).base);
1913     assertSame(sf3, pep2Variants[2].get(0).variant);
1914
1915     /*
1916      * protein residue 3: variants on codon (TTT) base 2 only
1917      */
1918     List<DnaVariant>[] pep3Variants = variantsMap.get(3);
1919     assertEquals(3, pep3Variants.length);
1920     assertEquals(1, pep3Variants[0].size());
1921     assertEquals("T", pep3Variants[0].get(0).base); // codon[1] base
1922     assertNull(pep3Variants[0].get(0).variant); // no variant here
1923     assertEquals(1, pep3Variants[1].size());
1924     assertEquals("T", pep3Variants[1].get(0).base); // codon[2] base
1925     assertSame(sf4, pep3Variants[1].get(0).variant); // codon[2] variant
1926     assertEquals(1, pep3Variants[2].size());
1927     assertEquals("T", pep3Variants[2].get(0).base); // codon[3] base
1928     assertNull(pep3Variants[2].get(0).variant); // no variant here
1929
1930     /*
1931      * three variants on protein position 5
1932      */
1933     List<DnaVariant>[] pep5Variants = variantsMap.get(5);
1934     assertEquals(3, pep5Variants.length);
1935     assertEquals(1, pep5Variants[0].size());
1936     assertEquals("C", pep5Variants[0].get(0).base); // codon[1] base
1937     assertSame(sf5, pep5Variants[0].get(0).variant); // codon[1] variant
1938     assertEquals(1, pep5Variants[1].size());
1939     assertEquals("C", pep5Variants[1].get(0).base); // codon[2] base
1940     assertSame(sf6, pep5Variants[1].get(0).variant); // codon[2] variant
1941     assertEquals(1, pep5Variants[2].size());
1942     assertEquals("C", pep5Variants[2].get(0).base); // codon[3] base
1943     assertSame(sf7, pep5Variants[2].get(0).variant); // codon[3] variant
1944   }
1945
1946   /**
1947    * Tests for the method that computes all peptide variants given codon
1948    * variants
1949    */
1950   @Test(groups = "Functional")
1951   public void testComputePeptideVariants()
1952   {
1953     /*
1954      * scenario: AAATTTCCC codes for KFP, with variants
1955      *           GAA -> E
1956      *           CAA -> Q
1957      *           AAG synonymous
1958      *           AAT -> N
1959      *              TTC synonymous
1960      *                 CAC,CGC -> H,R (as one variant)
1961      */
1962     SequenceI peptide = new Sequence("pep/10-12", "KFP");
1963
1964     /*
1965      * two distinct variants for codon 1 position 1
1966      * second one has clinical significance
1967      */
1968     SequenceFeature sf1 = new SequenceFeature("sequence_variant", "", 1, 1,
1969             0f, null);
1970     sf1.setValue("alleles", "A,G"); // GAA -> E
1971     sf1.setValue("ID", "var1.125A>G");
1972     SequenceFeature sf2 = new SequenceFeature("sequence_variant", "", 1, 1,
1973             0f, null);
1974     sf2.setValue("alleles", "A,C"); // CAA -> Q
1975     sf2.setValue("ID", "var2");
1976     sf2.setValue("clinical_significance", "Dodgy");
1977     SequenceFeature sf3 = new SequenceFeature("sequence_variant", "", 3, 3,
1978             0f, null);
1979     sf3.setValue("alleles", "A,G"); // synonymous
1980     sf3.setValue("ID", "var3");
1981     sf3.setValue("clinical_significance", "None");
1982     SequenceFeature sf4 = new SequenceFeature("sequence_variant", "", 3, 3,
1983             0f, null);
1984     sf4.setValue("alleles", "A,T"); // AAT -> N
1985     sf4.setValue("ID", "sequence_variant:var4"); // prefix gets stripped off
1986     sf4.setValue("clinical_significance", "Benign");
1987     SequenceFeature sf5 = new SequenceFeature("sequence_variant", "", 6, 6,
1988             0f, null);
1989     sf5.setValue("alleles", "T,C"); // synonymous
1990     sf5.setValue("ID", "var5");
1991     sf5.setValue("clinical_significance", "Bad");
1992     SequenceFeature sf6 = new SequenceFeature("sequence_variant", "", 8, 8,
1993             0f, null);
1994     sf6.setValue("alleles", "C,A,G"); // CAC,CGC -> H,R
1995     sf6.setValue("ID", "var6");
1996     sf6.setValue("clinical_significance", "Good");
1997
1998     List<DnaVariant> codon1Variants = new ArrayList<DnaVariant>();
1999     List<DnaVariant> codon2Variants = new ArrayList<DnaVariant>();
2000     List<DnaVariant> codon3Variants = new ArrayList<DnaVariant>();
2001     List<DnaVariant> codonVariants[] = new ArrayList[3];
2002     codonVariants[0] = codon1Variants;
2003     codonVariants[1] = codon2Variants;
2004     codonVariants[2] = codon3Variants;
2005
2006     /*
2007      * compute variants for protein position 1
2008      */
2009     codon1Variants.add(new DnaVariant("A", sf1));
2010     codon1Variants.add(new DnaVariant("A", sf2));
2011     codon2Variants.add(new DnaVariant("A"));
2012     codon2Variants.add(new DnaVariant("A"));
2013     codon3Variants.add(new DnaVariant("A", sf3));
2014     codon3Variants.add(new DnaVariant("A", sf4));
2015     AlignmentUtils.computePeptideVariants(peptide, 1, codonVariants);
2016
2017     /*
2018      * compute variants for protein position 2
2019      */
2020     codon1Variants.clear();
2021     codon2Variants.clear();
2022     codon3Variants.clear();
2023     codon1Variants.add(new DnaVariant("T"));
2024     codon2Variants.add(new DnaVariant("T"));
2025     codon3Variants.add(new DnaVariant("T", sf5));
2026     AlignmentUtils.computePeptideVariants(peptide, 2, codonVariants);
2027
2028     /*
2029      * compute variants for protein position 3
2030      */
2031     codon1Variants.clear();
2032     codon2Variants.clear();
2033     codon3Variants.clear();
2034     codon1Variants.add(new DnaVariant("C"));
2035     codon2Variants.add(new DnaVariant("C", sf6));
2036     codon3Variants.add(new DnaVariant("C"));
2037     AlignmentUtils.computePeptideVariants(peptide, 3, codonVariants);
2038
2039     /*
2040      * verify added sequence features for
2041      * var1 K -> E
2042      * var2 K -> Q
2043      * var4 K -> N
2044      * var6 P -> H
2045      * var6 P -> R
2046      */
2047     SequenceFeature[] sfs = peptide.getSequenceFeatures();
2048     assertEquals(5, sfs.length);
2049     SequenceFeature sf = sfs[0];
2050     assertEquals(1, sf.getBegin());
2051     assertEquals(1, sf.getEnd());
2052     assertEquals("p.Lys1Glu", sf.getDescription());
2053     assertEquals("var1.125A>G", sf.getValue("ID"));
2054     assertNull(sf.getValue("clinical_significance"));
2055     assertEquals("ID=var1.125A>G", sf.getAttributes());
2056     assertEquals(1, sf.links.size());
2057     // link to variation is urlencoded
2058     assertEquals(
2059             "p.Lys1Glu var1.125A>G|http://www.ensembl.org/Homo_sapiens/Variation/Summary?v=var1.125A%3EG",
2060             sf.links.get(0));
2061     assertEquals("Jalview", sf.getFeatureGroup());
2062     sf = sfs[1];
2063     assertEquals(1, sf.getBegin());
2064     assertEquals(1, sf.getEnd());
2065     assertEquals("p.Lys1Gln", sf.getDescription());
2066     assertEquals("var2", sf.getValue("ID"));
2067     assertEquals("Dodgy", sf.getValue("clinical_significance"));
2068     assertEquals("ID=var2;clinical_significance=Dodgy", sf.getAttributes());
2069     assertEquals(1, sf.links.size());
2070     assertEquals(
2071             "p.Lys1Gln var2|http://www.ensembl.org/Homo_sapiens/Variation/Summary?v=var2",
2072             sf.links.get(0));
2073     assertEquals("Jalview", sf.getFeatureGroup());
2074     sf = sfs[2];
2075     assertEquals(1, sf.getBegin());
2076     assertEquals(1, sf.getEnd());
2077     assertEquals("p.Lys1Asn", sf.getDescription());
2078     assertEquals("var4", sf.getValue("ID"));
2079     assertEquals("Benign", sf.getValue("clinical_significance"));
2080     assertEquals("ID=var4;clinical_significance=Benign", sf.getAttributes());
2081     assertEquals(1, sf.links.size());
2082     assertEquals(
2083             "p.Lys1Asn var4|http://www.ensembl.org/Homo_sapiens/Variation/Summary?v=var4",
2084             sf.links.get(0));
2085     assertEquals("Jalview", sf.getFeatureGroup());
2086     sf = sfs[3];
2087     assertEquals(3, sf.getBegin());
2088     assertEquals(3, sf.getEnd());
2089     assertEquals("p.Pro3His", sf.getDescription());
2090     assertEquals("var6", sf.getValue("ID"));
2091     assertEquals("Good", sf.getValue("clinical_significance"));
2092     assertEquals("ID=var6;clinical_significance=Good", sf.getAttributes());
2093     assertEquals(1, sf.links.size());
2094     assertEquals(
2095             "p.Pro3His var6|http://www.ensembl.org/Homo_sapiens/Variation/Summary?v=var6",
2096             sf.links.get(0));
2097     // var5 generates two distinct protein variant features
2098     assertEquals("Jalview", sf.getFeatureGroup());
2099     sf = sfs[4];
2100     assertEquals(3, sf.getBegin());
2101     assertEquals(3, sf.getEnd());
2102     assertEquals("p.Pro3Arg", sf.getDescription());
2103     assertEquals("var6", sf.getValue("ID"));
2104     assertEquals("Good", sf.getValue("clinical_significance"));
2105     assertEquals("ID=var6;clinical_significance=Good", sf.getAttributes());
2106     assertEquals(1, sf.links.size());
2107     assertEquals(
2108             "p.Pro3Arg var6|http://www.ensembl.org/Homo_sapiens/Variation/Summary?v=var6",
2109             sf.links.get(0));
2110     assertEquals("Jalview", sf.getFeatureGroup());
2111   }
2112
2113   /**
2114    * Tests for the method that maps the subset of a dna sequence that has CDS
2115    * (or subtype) feature, with CDS strand = '-' (reverse)
2116    */
2117   // test turned off as currently findCdsPositions is not strand-dependent
2118   // left in case it comes around again...
2119   @Test(groups = "Functional", enabled = false)
2120   public void testFindCdsPositions_reverseStrand()
2121   {
2122     SequenceI dnaSeq = new Sequence("dna", "aaaGGGcccAAATTTttt");
2123     dnaSeq.createDatasetSequence();
2124     SequenceI ds = dnaSeq.getDatasetSequence();
2125
2126     // CDS for dna 4-6
2127     SequenceFeature sf = new SequenceFeature("CDS", "", 4, 6, 0f, null);
2128     sf.setStrand("-");
2129     ds.addSequenceFeature(sf);
2130     // exon feature should be ignored here
2131     sf = new SequenceFeature("exon", "", 7, 9, 0f, null);
2132     ds.addSequenceFeature(sf);
2133     // CDS for dna 10-12
2134     sf = new SequenceFeature("CDS_predicted", "", 10, 12, 0f, null);
2135     sf.setStrand("-");
2136     ds.addSequenceFeature(sf);
2137
2138     List<int[]> ranges = AlignmentUtils.findCdsPositions(dnaSeq);
2139     /*
2140      * verify ranges { [12-10], [6-4] }
2141      */
2142     assertEquals(6, MappingUtils.getLength(ranges));
2143     assertEquals(2, ranges.size());
2144     assertEquals(12, ranges.get(0)[0]);
2145     assertEquals(10, ranges.get(0)[1]);
2146     assertEquals(6, ranges.get(1)[0]);
2147     assertEquals(4, ranges.get(1)[1]);
2148   }
2149
2150   /**
2151    * Tests for the method that maps the subset of a dna sequence that has CDS
2152    * (or subtype) feature - reverse strand case where the start codon is
2153    * incomplete.
2154    */
2155   @Test(groups = "Functional", enabled = false)
2156   // test turned off as currently findCdsPositions is not strand-dependent
2157   // left in case it comes around again...
2158   public void testFindCdsPositions_reverseStrandThreePrimeIncomplete()
2159   {
2160     SequenceI dnaSeq = new Sequence("dna", "aaagGGCCCaaaTTTttt");
2161     dnaSeq.createDatasetSequence();
2162     SequenceI ds = dnaSeq.getDatasetSequence();
2163
2164     // CDS for dna 5-9
2165     SequenceFeature sf = new SequenceFeature("CDS", "", 5, 9, 0f, null);
2166     sf.setStrand("-");
2167     ds.addSequenceFeature(sf);
2168     // CDS for dna 13-15
2169     sf = new SequenceFeature("CDS_predicted", "", 13, 15, 0f, null);
2170     sf.setStrand("-");
2171     sf.setPhase("2"); // skip 2 bases to start of next codon
2172     ds.addSequenceFeature(sf);
2173
2174     List<int[]> ranges = AlignmentUtils.findCdsPositions(dnaSeq);
2175
2176     /*
2177      * check the mapping starts with the first complete codon
2178      * expect ranges [13, 13], [9, 5]
2179      */
2180     assertEquals(6, MappingUtils.getLength(ranges));
2181     assertEquals(2, ranges.size());
2182     assertEquals(13, ranges.get(0)[0]);
2183     assertEquals(13, ranges.get(0)[1]);
2184     assertEquals(9, ranges.get(1)[0]);
2185     assertEquals(5, ranges.get(1)[1]);
2186   }
2187
2188   @Test(groups = "Functional")
2189   public void testAlignAs_alternateTranscriptsUngapped()
2190   {
2191     SequenceI dna1 = new Sequence("dna1", "cccGGGTTTaaa");
2192     SequenceI dna2 = new Sequence("dna2", "CCCgggtttAAA");
2193     AlignmentI dna = new Alignment(new SequenceI[] { dna1, dna2 });
2194     ((Alignment) dna).createDatasetAlignment();
2195     SequenceI cds1 = new Sequence("cds1", "GGGTTT");
2196     SequenceI cds2 = new Sequence("cds2", "CCCAAA");
2197     AlignmentI cds = new Alignment(new SequenceI[] { cds1, cds2 });
2198     ((Alignment) cds).createDatasetAlignment();
2199
2200     AlignedCodonFrame acf = new AlignedCodonFrame();
2201     MapList map = new MapList(new int[] { 4, 9 }, new int[] { 1, 6 }, 1, 1);
2202     acf.addMap(dna1.getDatasetSequence(), cds1.getDatasetSequence(), map);
2203     map = new MapList(new int[] { 1, 3, 10, 12 }, new int[] { 1, 6 }, 1, 1);
2204     acf.addMap(dna2.getDatasetSequence(), cds2.getDatasetSequence(), map);
2205
2206     /*
2207      * verify CDS alignment is as:
2208      *   cccGGGTTTaaa (cdna)
2209      *   CCCgggtttAAA (cdna)
2210      *
2211      *   ---GGGTTT--- (cds)
2212      *   CCC------AAA (cds)
2213      */
2214     dna.addCodonFrame(acf);
2215     AlignmentUtils.alignAs(cds, dna);
2216     assertEquals("---GGGTTT", cds.getSequenceAt(0).getSequenceAsString());
2217     assertEquals("CCC------AAA", cds.getSequenceAt(1).getSequenceAsString());
2218   }
2219
2220   @Test(groups = { "Functional" })
2221   public void testAddMappedPositions()
2222   {
2223     SequenceI from = new Sequence("dna", "ggAA-ATcc-TT-g");
2224     SequenceI seq1 = new Sequence("cds", "AAATTT");
2225     from.createDatasetSequence();
2226     seq1.createDatasetSequence();
2227     Mapping mapping = new Mapping(seq1, new MapList(
2228             new int[] { 3, 6, 9, 10 },
2229             new int[] { 1, 6 }, 1, 1));
2230     Map<Integer, Map<SequenceI, Character>> map = new TreeMap<Integer, Map<SequenceI, Character>>();
2231     AlignmentUtils.addMappedPositions(seq1, from, mapping, map);
2232
2233     /*
2234      * verify map has seq1 residues in columns 3,4,6,7,11,12
2235      */
2236     assertEquals(6, map.size());
2237     assertEquals('A', map.get(3).get(seq1).charValue());
2238     assertEquals('A', map.get(4).get(seq1).charValue());
2239     assertEquals('A', map.get(6).get(seq1).charValue());
2240     assertEquals('T', map.get(7).get(seq1).charValue());
2241     assertEquals('T', map.get(11).get(seq1).charValue());
2242     assertEquals('T', map.get(12).get(seq1).charValue());
2243
2244     /*
2245      *
2246      */
2247   }
2248
2249   /**
2250    * Test case where the mapping 'from' range includes a stop codon which is
2251    * absent in the 'to' range
2252    */
2253   @Test(groups = { "Functional" })
2254   public void testAddMappedPositions_withStopCodon()
2255   {
2256     SequenceI from = new Sequence("dna", "ggAA-ATcc-TT-g");
2257     SequenceI seq1 = new Sequence("cds", "AAATTT");
2258     from.createDatasetSequence();
2259     seq1.createDatasetSequence();
2260     Mapping mapping = new Mapping(seq1, new MapList(
2261             new int[] { 3, 6, 9, 10 },
2262             new int[] { 1, 6 }, 1, 1));
2263     Map<Integer, Map<SequenceI, Character>> map = new TreeMap<Integer, Map<SequenceI, Character>>();
2264     AlignmentUtils.addMappedPositions(seq1, from, mapping, map);
2265
2266     /*
2267      * verify map has seq1 residues in columns 3,4,6,7,11,12
2268      */
2269     assertEquals(6, map.size());
2270     assertEquals('A', map.get(3).get(seq1).charValue());
2271     assertEquals('A', map.get(4).get(seq1).charValue());
2272     assertEquals('A', map.get(6).get(seq1).charValue());
2273     assertEquals('T', map.get(7).get(seq1).charValue());
2274     assertEquals('T', map.get(11).get(seq1).charValue());
2275     assertEquals('T', map.get(12).get(seq1).charValue());
2276   }
2277
2278   /**
2279    * Test for the case where the products for which we want CDS are specified.
2280    * This is to represent the case where EMBL has CDS mappings to both Uniprot
2281    * and EMBLCDSPROTEIN. makeCdsAlignment() should only return the mappings for
2282    * the protein sequences specified.
2283    */
2284   @Test(groups = { "Functional" })
2285   public void testMakeCdsAlignment_filterProducts()
2286   {
2287     SequenceI dna1 = new Sequence("dna1", "aaaGGGcccTTTaaa");
2288     SequenceI dna2 = new Sequence("dna2", "GGGcccTTTaaaCCC");
2289     SequenceI pep1 = new Sequence("Uniprot|pep1", "GF");
2290     SequenceI pep2 = new Sequence("Uniprot|pep2", "GFP");
2291     SequenceI pep3 = new Sequence("EMBL|pep3", "GF");
2292     SequenceI pep4 = new Sequence("EMBL|pep4", "GFP");
2293     dna1.createDatasetSequence();
2294     dna2.createDatasetSequence();
2295     pep1.createDatasetSequence();
2296     pep2.createDatasetSequence();
2297     pep3.createDatasetSequence();
2298     pep4.createDatasetSequence();
2299     AlignmentI dna = new Alignment(new SequenceI[] { dna1, dna2 });
2300     dna.setDataset(null);
2301     AlignmentI emblPeptides = new Alignment(new SequenceI[] { pep3, pep4 });
2302     emblPeptides.setDataset(null);
2303
2304     AlignedCodonFrame acf = new AlignedCodonFrame();
2305     MapList map = new MapList(new int[] { 4, 6, 10, 12 },
2306             new int[] { 1, 2 }, 3, 1);
2307     acf.addMap(dna1.getDatasetSequence(), pep1.getDatasetSequence(), map);
2308     acf.addMap(dna1.getDatasetSequence(), pep3.getDatasetSequence(), map);
2309     dna.addCodonFrame(acf);
2310
2311     acf = new AlignedCodonFrame();
2312     map = new MapList(new int[] { 1, 3, 7, 9, 13, 15 }, new int[] { 1, 3 },
2313             3, 1);
2314     acf.addMap(dna2.getDatasetSequence(), pep2.getDatasetSequence(), map);
2315     acf.addMap(dna2.getDatasetSequence(), pep4.getDatasetSequence(), map);
2316     dna.addCodonFrame(acf);
2317
2318     /*
2319      * execute method under test to find CDS for EMBL peptides only
2320      */
2321     AlignmentI cds = AlignmentUtils.makeCdsAlignment(new SequenceI[] {
2322         dna1, dna2 }, dna.getDataset(), emblPeptides.getSequencesArray());
2323
2324     assertEquals(2, cds.getSequences().size());
2325     assertEquals("GGGTTT", cds.getSequenceAt(0).getSequenceAsString());
2326     assertEquals("GGGTTTCCC", cds.getSequenceAt(1).getSequenceAsString());
2327
2328     /*
2329      * verify shared, extended alignment dataset
2330      */
2331     assertSame(dna.getDataset(), cds.getDataset());
2332     assertTrue(dna.getDataset().getSequences()
2333             .contains(cds.getSequenceAt(0).getDatasetSequence()));
2334     assertTrue(dna.getDataset().getSequences()
2335             .contains(cds.getSequenceAt(1).getDatasetSequence()));
2336
2337     /*
2338      * Verify mappings from CDS to peptide, cDNA to CDS, and cDNA to peptide
2339      * the mappings are on the shared alignment dataset
2340      */
2341     List<AlignedCodonFrame> cdsMappings = cds.getDataset().getCodonFrames();
2342     /*
2343      * 6 mappings, 2*(DNA->CDS), 2*(DNA->Pep), 2*(CDS->Pep)
2344      */
2345     assertEquals(6, cdsMappings.size());
2346
2347     /*
2348      * verify that mapping sets for dna and cds alignments are different
2349      * [not current behaviour - all mappings are on the alignment dataset]
2350      */
2351     // select -> subselect type to test.
2352     // Assert.assertNotSame(dna.getCodonFrames(), cds.getCodonFrames());
2353     // assertEquals(4, dna.getCodonFrames().size());
2354     // assertEquals(4, cds.getCodonFrames().size());
2355
2356     /*
2357      * Two mappings involve pep3 (dna to pep3, cds to pep3)
2358      * Mapping from pep3 to GGGTTT in first new exon sequence
2359      */
2360     List<AlignedCodonFrame> pep3Mappings = MappingUtils
2361             .findMappingsForSequence(pep3, cdsMappings);
2362     assertEquals(2, pep3Mappings.size());
2363     List<AlignedCodonFrame> mappings = MappingUtils
2364             .findMappingsForSequence(cds.getSequenceAt(0), pep3Mappings);
2365     assertEquals(1, mappings.size());
2366
2367     // map G to GGG
2368     SearchResults sr = MappingUtils.buildSearchResults(pep3, 1, mappings);
2369     assertEquals(1, sr.getResults().size());
2370     Match m = sr.getResults().get(0);
2371     assertSame(cds.getSequenceAt(0).getDatasetSequence(), m.getSequence());
2372     assertEquals(1, m.getStart());
2373     assertEquals(3, m.getEnd());
2374     // map F to TTT
2375     sr = MappingUtils.buildSearchResults(pep3, 2, mappings);
2376     m = sr.getResults().get(0);
2377     assertSame(cds.getSequenceAt(0).getDatasetSequence(), m.getSequence());
2378     assertEquals(4, m.getStart());
2379     assertEquals(6, m.getEnd());
2380
2381     /*
2382      * Two mappings involve pep4 (dna to pep4, cds to pep4)
2383      * Verify mapping from pep4 to GGGTTTCCC in second new exon sequence
2384      */
2385     List<AlignedCodonFrame> pep4Mappings = MappingUtils
2386             .findMappingsForSequence(pep4, cdsMappings);
2387     assertEquals(2, pep4Mappings.size());
2388     mappings = MappingUtils.findMappingsForSequence(cds.getSequenceAt(1),
2389             pep4Mappings);
2390     assertEquals(1, mappings.size());
2391     // map G to GGG
2392     sr = MappingUtils.buildSearchResults(pep4, 1, mappings);
2393     assertEquals(1, sr.getResults().size());
2394     m = sr.getResults().get(0);
2395     assertSame(cds.getSequenceAt(1).getDatasetSequence(), m.getSequence());
2396     assertEquals(1, m.getStart());
2397     assertEquals(3, m.getEnd());
2398     // map F to TTT
2399     sr = MappingUtils.buildSearchResults(pep4, 2, mappings);
2400     m = sr.getResults().get(0);
2401     assertSame(cds.getSequenceAt(1).getDatasetSequence(), m.getSequence());
2402     assertEquals(4, m.getStart());
2403     assertEquals(6, m.getEnd());
2404     // map P to CCC
2405     sr = MappingUtils.buildSearchResults(pep4, 3, mappings);
2406     m = sr.getResults().get(0);
2407     assertSame(cds.getSequenceAt(1).getDatasetSequence(), m.getSequence());
2408     assertEquals(7, m.getStart());
2409     assertEquals(9, m.getEnd());
2410   }
2411
2412   /**
2413    * Test the method that just copies aligned sequences, provided all sequences
2414    * to be aligned share the aligned sequence's dataset
2415    */
2416   @Test(groups = "Functional")
2417   public void testAlignAsSameSequences()
2418   {
2419     SequenceI dna1 = new Sequence("dna1", "cccGGGTTTaaa");
2420     SequenceI dna2 = new Sequence("dna2", "CCCgggtttAAA");
2421     AlignmentI al1 = new Alignment(new SequenceI[] { dna1, dna2 });
2422     ((Alignment) al1).createDatasetAlignment();
2423
2424     SequenceI dna3 = new Sequence(dna1);
2425     SequenceI dna4 = new Sequence(dna2);
2426     assertSame(dna3.getDatasetSequence(), dna1.getDatasetSequence());
2427     assertSame(dna4.getDatasetSequence(), dna2.getDatasetSequence());
2428     String seq1 = "-cc-GG-GT-TT--aaa";
2429     dna3.setSequence(seq1);
2430     String seq2 = "C--C-Cgg--gtt-tAA-A-";
2431     dna4.setSequence(seq2);
2432     AlignmentI al2 = new Alignment(new SequenceI[] { dna3, dna4 });
2433     ((Alignment) al2).createDatasetAlignment();
2434
2435     assertTrue(AlignmentUtils.alignAsSameSequences(al1, al2));
2436     assertEquals(seq1, al1.getSequenceAt(0).getSequenceAsString());
2437     assertEquals(seq2, al1.getSequenceAt(1).getSequenceAsString());
2438
2439     /*
2440      * add another sequence to 'aligned' - should still succeed, since
2441      * unaligned sequences still share a dataset with aligned sequences
2442      */
2443     SequenceI dna5 = new Sequence("dna5", "CCCgggtttAAA");
2444     dna5.createDatasetSequence();
2445     al2.addSequence(dna5);
2446     assertTrue(AlignmentUtils.alignAsSameSequences(al1, al2));
2447     assertEquals(seq1, al1.getSequenceAt(0).getSequenceAsString());
2448     assertEquals(seq2, al1.getSequenceAt(1).getSequenceAsString());
2449
2450     /*
2451      * add another sequence to 'unaligned' - should fail, since now not
2452      * all unaligned sequences share a dataset with aligned sequences
2453      */
2454     SequenceI dna6 = new Sequence("dna6", "CCCgggtttAAA");
2455     dna6.createDatasetSequence();
2456     al1.addSequence(dna6);
2457     // JAL-2110 JBP Comment: what's the use case for this behaviour ?
2458     assertFalse(AlignmentUtils.alignAsSameSequences(al1, al2));
2459   }
2460
2461   @Test(groups = "Functional")
2462   public void testAlignAsSameSequencesMultipleSubSeq()
2463   {
2464     SequenceI dna1 = new Sequence("dna1", "cccGGGTTTaaa");
2465     SequenceI dna2 = new Sequence("dna2", "CCCgggtttAAA");
2466     SequenceI as1 = dna1.deriveSequence();
2467     SequenceI as2 = dna1.deriveSequence().getSubSequence(3, 7);
2468     SequenceI as3 = dna2.deriveSequence();
2469     as1.insertCharAt(6, 5, '-');
2470     String s_as1 = as1.getSequenceAsString();
2471     as2.insertCharAt(6, 5, '-');
2472     String s_as2 = as2.getSequenceAsString();
2473     as3.insertCharAt(6, 5, '-');
2474     String s_as3 = as3.getSequenceAsString();
2475     AlignmentI aligned = new Alignment(new SequenceI[] { as1, as2, as3 });
2476
2477     // why do we need to cast this still ?
2478     ((Alignment) aligned).createDatasetAlignment();
2479     SequenceI uas1 = dna1.deriveSequence();
2480     SequenceI uas2 = dna1.deriveSequence().getSubSequence(3, 7);
2481     SequenceI uas3 = dna2.deriveSequence();
2482     AlignmentI tobealigned = new Alignment(new SequenceI[] { uas1, uas2,
2483         uas3 });
2484     ((Alignment) tobealigned).createDatasetAlignment();
2485
2486     assertTrue(AlignmentUtils.alignAsSameSequences(tobealigned, aligned));
2487     assertEquals(s_as1, uas1.getSequenceAsString());
2488     assertEquals(s_as2, uas2.getSequenceAsString());
2489     assertEquals(s_as3, uas3.getSequenceAsString());
2490   }
2491
2492 }