test/jalview/analysis/CrossRefTest.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.assertNotSame;
  27 import static org.testng.AssertJUnit.assertNull;
  28 import static org.testng.AssertJUnit.assertSame;
  29 import static org.testng.AssertJUnit.assertTrue;
  30 import static org.testng.internal.junit.ArrayAsserts.assertArrayEquals;
  31
  32 import jalview.datamodel.Alignment;
  33 import jalview.datamodel.AlignmentI;
  34 import jalview.datamodel.DBRefEntry;
  35 import jalview.datamodel.Mapping;
  36 import jalview.datamodel.Sequence;
  37 import jalview.datamodel.SequenceFeature;
  38 import jalview.datamodel.SequenceI;
  39 import jalview.util.DBRefUtils;
  40 import jalview.util.MapList;
  41 import jalview.ws.SequenceFetcher;
  42 import jalview.ws.SequenceFetcherFactory;
  43
  44 import java.util.ArrayList;
  45 import java.util.List;
  46
  47 import org.testng.annotations.AfterClass;
  48 import org.testng.annotations.Test;
  49
  50 public class CrossRefTest
  51 {
  52   @Test(groups = { "Functional" })
  53   public void testFindXDbRefs()
  54   {
  55     DBRefEntry ref1 = new DBRefEntry("UNIPROT", "1", "A123");
  56     DBRefEntry ref2 = new DBRefEntry("UNIPROTKB/TREMBL", "1", "A123");
  57     DBRefEntry ref3 = new DBRefEntry("pdb", "1", "A123");
  58     DBRefEntry ref4 = new DBRefEntry("EMBLCDSPROTEIN", "1", "A123");
  59     DBRefEntry ref5 = new DBRefEntry("embl", "1", "A123");
  60     DBRefEntry ref6 = new DBRefEntry("emblCDS", "1", "A123");
  61     DBRefEntry ref7 = new DBRefEntry("GeneDB", "1", "A123");
  62     DBRefEntry ref8 = new DBRefEntry("PFAM", "1", "A123");
  63     // ENSEMBL is a source of either dna or protein sequence data
  64     DBRefEntry ref9 = new DBRefEntry("ENSEMBL", "1", "A123");
  65     DBRefEntry[] refs = new DBRefEntry[] { ref1, ref2, ref3, ref4, ref5,
  66         ref6, ref7, ref8, ref9 };
  67
  68     /*
  69      * Just the DNA refs:
  70      */
  71     DBRefEntry[] found = DBRefUtils.selectDbRefs(true, refs);
  72     assertEquals(4, found.length);
  73     assertSame(ref5, found[0]);
  74     assertSame(ref6, found[1]);
  75     assertSame(ref7, found[2]);
  76     assertSame(ref9, found[3]);
  77
  78     /*
  79      * Just the protein refs:
  80      */
  81     found = DBRefUtils.selectDbRefs(false, refs);
  82     assertEquals(5, found.length);
  83     assertSame(ref1, found[0]);
  84     assertSame(ref2, found[1]);
  85     assertSame(ref3, found[2]);
  86     assertSame(ref4, found[3]);
  87     assertSame(ref9, found[4]);
  88   }
  89
  90   /**
  91    * Test the method that finds a sequence's "product" xref source databases,
  92    * which may be direct (dbrefs on the sequence), or indirect (dbrefs on
  93    * sequences which share a dbref with the sequence
  94    */
  95   @Test(groups = { "Functional" }, enabled = true)
  96   public void testFindXrefSourcesForSequence_proteinToDna()
  97   {
  98     SequenceI seq = new Sequence("Seq1", "MGKYQARLSS");
  99     List<String> sources = new ArrayList<String>();
 100     AlignmentI al = new Alignment(new SequenceI[] {});
 101
 102     /*
 103      * first with no dbrefs to search
 104      */
 105     sources = new CrossRef(new SequenceI[] { seq }, al)
 106             .findXrefSourcesForSequences(false);
 107     assertTrue(sources.isEmpty());
 108
 109     /*
 110      * add some dbrefs to sequence
 111      */
 112     // protein db is not a candidate for findXrefSources
 113     seq.addDBRef(new DBRefEntry("UNIPROT", "0", "A1234"));
 114     // dna coding databatases are
 115     seq.addDBRef(new DBRefEntry("EMBL", "0", "E2345"));
 116     // a second EMBL xref should not result in a duplicate
 117     seq.addDBRef(new DBRefEntry("EMBL", "0", "E2346"));
 118     seq.addDBRef(new DBRefEntry("EMBLCDS", "0", "E2347"));
 119     seq.addDBRef(new DBRefEntry("GENEDB", "0", "E2348"));
 120     seq.addDBRef(new DBRefEntry("ENSEMBL", "0", "E2349"));
 121     seq.addDBRef(new DBRefEntry("ENSEMBLGENOMES", "0", "E2350"));
 122     sources = new CrossRef(new SequenceI[] { seq }, al)
 123             .findXrefSourcesForSequences(false);
 124     assertEquals(4, sources.size());
 125     assertEquals("[EMBL, EMBLCDS, GENEDB, ENSEMBL]", sources.toString());
 126
 127     /*
 128      * add a sequence to the alignment which has a dbref to UNIPROT|A1234
 129      * and others to dna coding databases
 130      */
 131     sources.clear();
 132     seq.setDBRefs(null);
 133     seq.addDBRef(new DBRefEntry("UNIPROT", "0", "A1234"));
 134     seq.addDBRef(new DBRefEntry("EMBLCDS", "0", "E2347"));
 135     SequenceI seq2 = new Sequence("Seq2", "MGKYQARLSS");
 136     seq2.addDBRef(new DBRefEntry("UNIPROT", "0", "A1234"));
 137     seq2.addDBRef(new DBRefEntry("EMBL", "0", "E2345"));
 138     seq2.addDBRef(new DBRefEntry("GENEDB", "0", "E2348"));
 139     // TODO include ENSEMBLGENOMES in DBRefSource.DNACODINGDBS ?
 140     al.addSequence(seq2);
 141     sources = new CrossRef(new SequenceI[] { seq, seq2 }, al)
 142             .findXrefSourcesForSequences(false);
 143     assertEquals(3, sources.size());
 144     assertEquals("[EMBLCDS, EMBL, GENEDB]", sources.toString());
 145   }
 146
 147   /**
 148    * Test for finding 'product' sequences for the case where only an indirect
 149    * xref is found - not on the nucleotide sequence but on a peptide sequence in
 150    * the alignment which which it shares a nucleotide dbref
 151    */
 152   @Test(groups = { "Functional" }, enabled = false)
 153   public void testFindXrefSequences_indirectDbrefToProtein()
 154   {
 155     /*
 156      * Alignment setup:
 157      *   - nucleotide dbref  EMBL|AF039662
 158      *   - peptide    dbrefs EMBL|AF039662, UNIPROT|Q9ZTS2
 159      */
 160     SequenceI emblSeq = new Sequence("AF039662", "GGGGCAGCACAAGAAC");
 161     emblSeq.addDBRef(new DBRefEntry("EMBL", "0", "AF039662"));
 162     SequenceI uniprotSeq = new Sequence("Q9ZTS2", "MASVSATMISTS");
 163     uniprotSeq.addDBRef(new DBRefEntry("EMBL", "0", "AF039662"));
 164     uniprotSeq.addDBRef(new DBRefEntry("UNIPROT", "0", "Q9ZTS2"));
 165
 166     /*
 167      * Find UNIPROT xrefs for nucleotide
 168      * - it has no UNIPROT dbref of its own
 169      * - but peptide with matching nucleotide dbref does, so is returned
 170      */
 171     AlignmentI al = new Alignment(new SequenceI[] { emblSeq, uniprotSeq });
 172     Alignment xrefs = new CrossRef(new SequenceI[] { emblSeq }, al)
 173             .findXrefSequences("UNIPROT", true);
 174     assertEquals(1, xrefs.getHeight());
 175     assertSame(uniprotSeq, xrefs.getSequenceAt(0));
 176   }
 177
 178   /**
 179    * Test for finding 'product' sequences for the case where only an indirect
 180    * xref is found - not on the peptide sequence but on a nucleotide sequence in
 181    * the alignment which which it shares a protein dbref
 182    */
 183   @Test(groups = { "Functional" }, enabled = false)
 184   public void testFindXrefSequences_indirectDbrefToNucleotide()
 185   {
 186     /*
 187      * Alignment setup:
 188      *   - peptide    dbref  UNIPROT|Q9ZTS2
 189      *   - nucleotide dbref  EMBL|AF039662, UNIPROT|Q9ZTS2
 190      */
 191     SequenceI uniprotSeq = new Sequence("Q9ZTS2", "MASVSATMISTS");
 192     uniprotSeq.addDBRef(new DBRefEntry("UNIPROT", "0", "Q9ZTS2"));
 193     SequenceI emblSeq = new Sequence("AF039662", "GGGGCAGCACAAGAAC");
 194     emblSeq.addDBRef(new DBRefEntry("EMBL", "0", "AF039662"));
 195     emblSeq.addDBRef(new DBRefEntry("UNIPROT", "0", "Q9ZTS2"));
 196
 197     /*
 198      * find EMBL xrefs for peptide sequence - it has no direct
 199      * dbrefs, but the 'corresponding' nucleotide sequence does, so is returned
 200      */
 201     /*
 202      * Find EMBL xrefs for peptide
 203      * - it has no EMBL dbref of its own
 204      * - but nucleotide with matching peptide dbref does, so is returned
 205      */
 206     AlignmentI al = new Alignment(new SequenceI[] { emblSeq, uniprotSeq });
 207     Alignment xrefs = new CrossRef(new SequenceI[] { uniprotSeq },
 208  al)
 209             .findXrefSequences("EMBL", true);
 210     assertEquals(1, xrefs.getHeight());
 211     assertSame(emblSeq, xrefs.getSequenceAt(0));
 212   }
 213
 214   /**
 215    * Test for finding 'product' sequences for the case where the selected
 216    * sequence has no dbref to the desired source, and there are no indirect
 217    * references via another sequence in the alignment
 218    */
 219   @Test(groups = { "Functional" })
 220   public void testFindXrefSequences_noDbrefs()
 221   {
 222     /*
 223      * two nucleotide sequences, one with UNIPROT dbref
 224      */
 225     SequenceI dna1 = new Sequence("AF039662", "GGGGCAGCACAAGAAC");
 226     dna1.addDBRef(new DBRefEntry("UNIPROT", "0", "Q9ZTS2"));
 227     SequenceI dna2 = new Sequence("AJ307031", "AAACCCTTT");
 228
 229     /*
 230      * find UNIPROT xrefs for peptide sequence - it has no direct
 231      * dbrefs, and the other sequence (which has a UNIPROT dbref) is not
 232      * equatable to it, so no results found
 233      */
 234     AlignmentI al = new Alignment(new SequenceI[] { dna1, dna2 });
 235     Alignment xrefs = new CrossRef(new SequenceI[] { dna2 }, al)
 236             .findXrefSequences("UNIPROT", true);
 237     assertNull(xrefs);
 238   }
 239
 240   /**
 241    * Tests for the method that searches an alignment (with one sequence
 242    * excluded) for protein/nucleotide sequences with a given cross-reference
 243    */
 244   @Test(groups = { "Functional" }, enabled = false)
 245   public void testSearchDataset()
 246   {
 247     /*
 248      * nucleotide sequence with UNIPROT AND EMBL dbref
 249      * peptide sequence with UNIPROT dbref
 250      */
 251     SequenceI dna1 = new Sequence("AF039662", "GGGGCAGCACAAGAAC");
 252     dna1.addDBRef(new DBRefEntry("UNIPROT", "0", "Q9ZTS2"));
 253     dna1.addDBRef(new DBRefEntry("EMBL", "0", "AF039662"));
 254     SequenceI pep1 = new Sequence("Q9ZTS2", "MLAVSRGQ");
 255     pep1.addDBRef(new DBRefEntry("UNIPROT", "0", "Q9ZTS2"));
 256     AlignmentI al = new Alignment(new SequenceI[] { dna1, pep1 });
 257
 258     List<SequenceI> result = new ArrayList<SequenceI>();
 259
 260     /*
 261      * first search for a dbref nowhere on the alignment:
 262      */
 263     DBRefEntry dbref = new DBRefEntry("UNIPROT", "0", "P30419");
 264     CrossRef testee = new CrossRef(al.getSequencesArray(), al);
 265     boolean found = testee.searchDataset(true, dna1, dbref, result, null,
 266             true);
 267     assertFalse(found);
 268     assertTrue(result.isEmpty());
 269
 270     // TODO we are setting direct=true here but it is set to
 271     // false in Jalview code...
 272
 273     /*
 274      * search for a protein sequence with dbref UNIPROT:Q9ZTS2
 275      */
 276     dbref = new DBRefEntry("UNIPROT", "0", "Q9ZTS2");
 277     found = testee.searchDataset(true, dna1, dbref, result, null, true);
 278     assertTrue(found);
 279     assertEquals(1, result.size());
 280     assertSame(pep1, result.get(0));
 281
 282     /*
 283      * search for a nucleotide sequence with dbref UNIPROT:Q9ZTS2
 284      */
 285     result.clear();
 286     dbref = new DBRefEntry("UNIPROT", "0", "Q9ZTS2");
 287     found = testee.searchDataset(false, pep1, dbref, result, null, false);
 288     assertTrue(found);
 289     assertEquals(1, result.size());
 290     assertSame(dna1, result.get(0));
 291   }
 292
 293   /**
 294    * Test for finding 'product' sequences for the case where the selected
 295    * sequence has a dbref with a mapping to a sequence
 296    */
 297   @Test(groups = { "Functional" })
 298   public void testFindXrefSequences_fromDbRefMap()
 299   {
 300     /*
 301      * two peptide sequences each with a DBRef and SequenceFeature
 302      */
 303     SequenceI pep1 = new Sequence("Q9ZTS2", "MALFQRSV");
 304     pep1.addDBRef(new DBRefEntry("Pfam", "0", "PF00111"));
 305     pep1.addSequenceFeature(new SequenceFeature("type", "desc", 12, 14, 1f,
 306             "group"));
 307     SequenceI pep2 = new Sequence("P30419", "MTRRSQIF");
 308     pep2.addDBRef(new DBRefEntry("PDB", "0", "3JTK"));
 309     pep2.addSequenceFeature(new SequenceFeature("type2", "desc2", 13, 15,
 310             12f, "group2"));
 311
 312     /*
 313      * nucleotide sequence (to go in the alignment)
 314      */
 315     SequenceI dna1 = new Sequence("AF039662", "GGGGCAGCACAAGAAC");
 316
 317     /*
 318      * add DBRefEntry's to dna1 with mappings from dna to both peptides
 319      */
 320     MapList mapList = new MapList(new int[] { 1, 24 }, new int[] { 1, 3 },
 321             3, 1);
 322     Mapping map = new Mapping(pep1, mapList);
 323     DBRefEntry dbRef1 = new DBRefEntry("UNIPROT", "0", "Q9ZTS2", map);
 324     dna1.addDBRef(dbRef1);
 325     mapList = new MapList(new int[] { 1, 24 }, new int[] { 1, 3 }, 3, 1);
 326     map = new Mapping(pep2, mapList);
 327     DBRefEntry dbRef2 = new DBRefEntry("UNIPROT", "0", "P30419", map);
 328     dna1.addDBRef(dbRef2);
 329
 330     /*
 331      * find UNIPROT xrefs for nucleotide sequence - it should pick up
 332      * mapped sequences
 333      */
 334     AlignmentI al = new Alignment(new SequenceI[] { dna1 });
 335     Alignment xrefs = new CrossRef(new SequenceI[] { dna1 }, al)
 336             .findXrefSequences("UNIPROT", true);
 337     assertEquals(2, xrefs.getHeight());
 338
 339     /*
 340      * cross-refs alignment holds copies of the mapped sequences
 341      * including copies of their dbrefs and features
 342      */
 343     checkCopySequence(pep1, xrefs.getSequenceAt(0));
 344     checkCopySequence(pep2, xrefs.getSequenceAt(1));
 345   }
 346
 347   /**
 348    * Helper method to assert seq1 looks like a copy of seq2
 349    *
 350    * @param seq1
 351    * @param seq2
 352    */
 353   private void checkCopySequence(SequenceI seq1, SequenceI seq2)
 354   {
 355     assertNotSame(seq1, seq2);
 356     assertEquals(seq1.getName(), seq2.getName());
 357     assertEquals(seq1.getStart(), seq2.getStart());
 358     assertEquals(seq1.getEnd(), seq2.getEnd());
 359     assertEquals(seq1.getSequenceAsString(), seq2.getSequenceAsString());
 360
 361     /*
 362      * compare dbrefs
 363      */
 364     assertArrayEquals(seq1.getDBRefs(), seq2.getDBRefs());
 365     // check one to verify a copy, not the same object
 366     if (seq1.getDBRefs().length > 0)
 367     {
 368       assertNotSame(seq1.getDBRefs()[0], seq2.getDBRefs()[0]);
 369     }
 370
 371     /*
 372      * compare features
 373      */
 374     assertArrayEquals(seq1.getSequenceFeatures(),
 375             seq2.getSequenceFeatures());
 376     if (seq1.getSequenceFeatures().length > 0)
 377     {
 378       assertNotSame(seq1.getSequenceFeatures()[0],
 379               seq2.getSequenceFeatures()[0]);
 380     }
 381   }
 382
 383   /**
 384    * Test for finding 'product' sequences for the case where the selected
 385    * sequence has a dbref with no mapping, triggering a fetch from database
 386    */
 387   @Test(groups = { "Functional" })
 388   public void testFindXrefSequences_withFetch()
 389   {
 390     SequenceI dna1 = new Sequence("AF039662", "GGGGCAGCACAAGAAC");
 391     dna1.addDBRef(new DBRefEntry("UNIPROT", "0", "Q9ZTS2"));
 392     dna1.addDBRef(new DBRefEntry("UNIPROT", "0", "P30419"));
 393     dna1.addDBRef(new DBRefEntry("UNIPROT", "0", "P00314"));
 394     final SequenceI pep1 = new Sequence("Q9ZTS2", "MYQLIRSSW");
 395     final SequenceI pep2 = new Sequence("P00314", "MRKLLAASG");
 396
 397     /*
 398      * argument false suppresses adding DAS sources
 399      * todo: define an interface type SequenceFetcherI and mock that
 400      */
 401     SequenceFetcher mockFetcher = new SequenceFetcher(false)
 402     {
 403       @Override
 404       public boolean isFetchable(String source)
 405       {
 406         return true;
 407       }
 408
 409       @Override
 410       public SequenceI[] getSequences(List<DBRefEntry> refs, boolean dna)
 411       {
 412         return new SequenceI[] { pep1, pep2 };
 413       }
 414     };
 415     SequenceFetcherFactory.setSequenceFetcher(mockFetcher);
 416
 417     /*
 418      * find UNIPROT xrefs for nucleotide sequence
 419      */
 420     AlignmentI al = new Alignment(new SequenceI[] { dna1 });
 421     Alignment xrefs = new CrossRef(new SequenceI[] { dna1 }, al)
 422             .findXrefSequences("UNIPROT", true);
 423     assertEquals(2, xrefs.getHeight());
 424     assertSame(pep1, xrefs.getSequenceAt(0));
 425     assertSame(pep2, xrefs.getSequenceAt(1));
 426   }
 427
 428   @AfterClass
 429   public void tearDown()
 430   {
 431     SequenceFetcherFactory.setSequenceFetcher(null);
 432   }
 433
 434   /**
 435    * Test for finding 'product' sequences for the case where both gene and
 436    * transcript sequences have dbrefs to Uniprot.
 437    */
 438   @Test(groups = { "Functional" })
 439   public void testFindXrefSequences_forGeneAndTranscripts()
 440   {
 441     /*
 442      * 'gene' sequence
 443      */
 444     SequenceI gene = new Sequence("ENSG00000157764", "CGCCTCCCTTCCCC");
 445     gene.addDBRef(new DBRefEntry("UNIPROT", "0", "P15056"));
 446     gene.addDBRef(new DBRefEntry("UNIPROT", "0", "H7C5K3"));
 447
 448     /*
 449      * 'transcript' with CDS feature (supports mapping to protein)
 450      */
 451     SequenceI braf001 = new Sequence("ENST00000288602", "taagATGGCGGCGCTGa");
 452     braf001.addDBRef(new DBRefEntry("UNIPROT", "0", "P15056"));
 453     braf001.addSequenceFeature(new SequenceFeature("CDS", "", 5, 16, 0f,
 454             null));
 455
 456     /*
 457      * 'spliced transcript' with CDS ranges
 458      */
 459     SequenceI braf002 = new Sequence("ENST00000497784", "gCAGGCtaTCTGTTCaa");
 460     braf002.addDBRef(new DBRefEntry("UNIPROT", "0", "H7C5K3"));
 461     braf002.addSequenceFeature(new SequenceFeature("CDS", "", 2, 6, 0f,
 462             null));
 463     braf002.addSequenceFeature(new SequenceFeature("CDS", "", 9, 15, 0f,
 464             null));
 465
 466     /*
 467      * TODO code is fragile - use of SequenceIdMatcher depends on fetched
 468      * sequences having a name starting Source|Accession
 469      * which happens to be true for Uniprot,PDB,EMBL but not Pfam,Rfam,Ensembl
 470      */
 471     final SequenceI pep1 = new Sequence("UNIPROT|P15056", "MAAL");
 472     final SequenceI pep2 = new Sequence("UNIPROT|H7C5K3", "QALF");
 473
 474     /*
 475      * argument false suppresses adding DAS sources
 476      * todo: define an interface type SequenceFetcherI and mock that
 477      */
 478     SequenceFetcher mockFetcher = new SequenceFetcher(false)
 479     {
 480       @Override
 481       public boolean isFetchable(String source)
 482       {
 483         return true;
 484       }
 485
 486       @Override
 487       public SequenceI[] getSequences(List<DBRefEntry> refs, boolean dna)
 488       {
 489         return new SequenceI[] { pep1, pep2 };
 490       }
 491     };
 492     SequenceFetcherFactory.setSequenceFetcher(mockFetcher);
 493
 494     /*
 495      * find UNIPROT xrefs for gene and transcripts
 496      * verify that
 497      * - the two proteins are retrieved but not duplicated
 498      * - mappings are built from transcript (CDS) to proteins
 499      * - no mappings from gene to proteins
 500      */
 501     SequenceI[] seqs = new SequenceI[] { gene, braf001, braf002 };
 502     AlignmentI al = new Alignment(seqs);
 503     Alignment xrefs = new CrossRef(seqs, al)
 504 .findXrefSequences("UNIPROT",
 505             true);
 506     assertEquals(2, xrefs.getHeight());
 507     assertSame(pep1, xrefs.getSequenceAt(0));
 508     assertSame(pep2, xrefs.getSequenceAt(1));
 509   }
 510
 511   /**
 512    * <pre>
 513    * Test that emulates this (real but simplified) case:
 514    * Alignment:          DBrefs
 515    *     UNIPROT|P0CE19  EMBL|J03321, EMBL|X06707, EMBL|M19487
 516    *     UNIPROT|P0CE20  EMBL|J03321, EMBL|X06707, EMBL|X07547
 517    * Find cross-references for EMBL. These are mocked here as
 518    *     EMBL|J03321     with mappings to P0CE18, P0CE19, P0CE20
 519    *     EMBL|X06707     with mappings to P0CE17, P0CE19, P0CE20
 520    *     EMBL|M19487     with mappings to P0CE19, Q46432
 521    *     EMBL|X07547     with mappings to P0CE20, B0BCM4
 522    * EMBL sequences are first 'fetched' (mocked here) for P0CE19.
 523    * The 3 EMBL sequences are added to the alignment dataset.
 524    * Their dbrefs to Uniprot products P0CE19 and P0CE20 should be matched in the
 525    * alignment dataset and updated to reference the original Uniprot sequences.
 526    * For the second Uniprot sequence, the J03321 and X06707 xrefs should be
 527    * resolved from the dataset, and only the X07547 dbref fetched.
 528    * So the end state to verify is:
 529    * - 4 cross-ref sequences returned: J03321, X06707,  M19487, X07547
 530    * - P0CE19/20 dbrefs to EMBL sequences now have mappings
 531    * - J03321 dbrefs to P0CE19/20 mapped to original Uniprot sequences
 532    * - X06707 dbrefs to P0CE19/20 mapped to original Uniprot sequences
 533    * </pre>
 534    */
 535   @Test(groups = { "Functional" })
 536   public void testFindXrefSequences_uniprotEmblManyToMany()
 537   {
 538     /*
 539      * Uniprot sequences, both with xrefs to EMBL|J03321
 540      * and EMBL|X07547
 541      */
 542     SequenceI p0ce19 = new Sequence("UNIPROT|P0CE19", "KPFG");
 543     p0ce19.addDBRef(new DBRefEntry("EMBL", "0", "J03321"));
 544     p0ce19.addDBRef(new DBRefEntry("EMBL", "0", "X06707"));
 545     p0ce19.addDBRef(new DBRefEntry("EMBL", "0", "M19487"));
 546     SequenceI p0ce20 = new Sequence("UNIPROT|P0CE20", "PFGK");
 547     p0ce20.addDBRef(new DBRefEntry("EMBL", "0", "J03321"));
 548     p0ce20.addDBRef(new DBRefEntry("EMBL", "0", "X06707"));
 549     p0ce20.addDBRef(new DBRefEntry("EMBL", "0", "X07547"));
 550
 551     /*
 552      * EMBL sequences to be 'fetched', complete with dbrefs and mappings
 553      * to their protein products (CDS location  and translations  are provided
 554      * in  EMBL XML); these should be matched to, and replaced with,
 555      * the corresponding uniprot sequences after fetching
 556      */
 557
 558     /*
 559      * J03321 with mappings to P0CE19 and P0CE20
 560      */
 561     final SequenceI j03321 = new Sequence("EMBL|J03321", "AAACCCTTTGGGAAAA");
 562     DBRefEntry dbref1 = new DBRefEntry("UNIPROT", "0", "P0CE19");
 563     MapList mapList = new MapList(new int[] { 1, 12 }, new int[] { 1, 4 },
 564             3, 1);
 565     Mapping map = new Mapping(new Sequence("UNIPROT|P0CE19", "KPFG"), mapList);
 566     // add a dbref to the mapped to sequence - should get copied to p0ce19
 567     map.getTo().addDBRef(new DBRefEntry("PIR", "0", "S01875"));
 568     dbref1.setMap(map);
 569     j03321.addDBRef(dbref1);
 570     DBRefEntry dbref2 = new DBRefEntry("UNIPROT", "0", "P0CE20");
 571     mapList = new MapList(new int[] { 4, 15 }, new int[] { 2, 5 }, 3, 1);
 572     dbref2.setMap(new Mapping(new Sequence("UNIPROT|P0CE20", "PFGK"),
 573             new MapList(mapList)));
 574     j03321.addDBRef(dbref2);
 575
 576     /*
 577      * X06707 with mappings to P0CE19 and P0CE20
 578      */
 579     final SequenceI x06707 = new Sequence("EMBL|X06707", "atgAAACCCTTTGGG");
 580     DBRefEntry dbref3 = new DBRefEntry("UNIPROT", "0", "P0CE19");
 581     MapList map2 = new MapList(new int[] { 4, 15 }, new int[] { 1, 4 }, 3,
 582             1);
 583     dbref3.setMap(new Mapping(new Sequence("UNIPROT|P0CE19", "KPFG"), map2));
 584     x06707.addDBRef(dbref3);
 585     DBRefEntry dbref4 = new DBRefEntry("UNIPROT", "0", "P0CE20");
 586     MapList map3 = new MapList(new int[] { 4, 15 }, new int[] { 1, 4 }, 3,
 587             1);
 588     dbref4.setMap(new Mapping(new Sequence("UNIPROT|P0CE20", "PFGK"), map3));
 589     x06707.addDBRef(dbref4);
 590
 591     /*
 592      * M19487 with mapping to P0CE19 and Q46432
 593      */
 594     final SequenceI m19487 = new Sequence("EMBL|M19487", "AAACCCTTTGGG");
 595     DBRefEntry dbref5 = new DBRefEntry("UNIPROT", "0", "P0CE19");
 596     dbref5.setMap(new Mapping(new Sequence("UNIPROT|P0CE19", "KPFG"),
 597             new MapList(mapList)));
 598     m19487.addDBRef(dbref5);
 599     DBRefEntry dbref6 = new DBRefEntry("UNIPROT", "0", "Q46432");
 600     dbref6.setMap(new Mapping(new Sequence("UNIPROT|Q46432", "KPFG"),
 601             new MapList(mapList)));
 602     m19487.addDBRef(dbref6);
 603
 604     /*
 605      * X07547 with mapping to P0CE20 and B0BCM4
 606      */
 607     final SequenceI x07547 = new Sequence("EMBL|X07547", "cccAAACCCTTTGGG");
 608     DBRefEntry dbref7 = new DBRefEntry("UNIPROT", "0", "P0CE20");
 609     dbref7.setMap(new Mapping(new Sequence("UNIPROT|P0CE19", "KPFG"),
 610             new MapList(map2)));
 611     x07547.addDBRef(dbref7);
 612     DBRefEntry dbref8 = new DBRefEntry("UNIPROT", "0", "B0BCM4");
 613     dbref8.setMap(new Mapping(new Sequence("UNIPROT|B0BCM4", "KPFG"),
 614             new MapList(map2)));
 615     x07547.addDBRef(dbref8);
 616
 617     /*
 618      * mock sequence fetcher to 'return' the EMBL sequences
 619      * TODO: Mockito would allow .thenReturn().thenReturn() here,
 620      * and also capture and verification of the parameters
 621      * passed in calls to getSequences() - important to verify that
 622      * duplicate sequence fetches are not requested
 623      */
 624     SequenceFetcher mockFetcher = new SequenceFetcher(false)
 625     {
 626       int call  = 0;
 627       @Override
 628       public boolean isFetchable(String source)
 629       {
 630         return true;
 631       }
 632       @Override
 633       public SequenceI[] getSequences(List<DBRefEntry> refs, boolean dna)
 634       {
 635         call++;
 636         if (call == 1) {
 637           assertEquals("Expected 3 embl seqs in first fetch", 3, refs.size());
 638         return new SequenceI[] { j03321, x06707, m19487 };
 639         } else {
 640           assertEquals("Expected 1 embl seq in second fetch", 1, refs.size());
 641                 return new SequenceI[] { x07547 };
 642         }
 643       }
 644     };
 645     SequenceFetcherFactory.setSequenceFetcher(mockFetcher);
 646
 647     /*
 648      * find EMBL xrefs for Uniprot seqs and verify that
 649      * - the EMBL xref'd sequences are retrieved without duplicates
 650      * - mappings are added to the Uniprot dbrefs
 651      * - mappings in the EMBL-to-Uniprot dbrefs are updated to the
 652      *   alignment sequences
 653      * - dbrefs on the EMBL sequences are added to the original dbrefs
 654      */
 655     SequenceI[] seqs = new SequenceI[] { p0ce19, p0ce20 };
 656     AlignmentI al = new Alignment(seqs);
 657     Alignment xrefs = new CrossRef(seqs, al).findXrefSequences("EMBL",
 658             false);
 659
 660     /*
 661      * verify retrieved sequences
 662      */
 663     assertNotNull(xrefs);
 664     assertEquals(4, xrefs.getHeight());
 665     assertSame(j03321, xrefs.getSequenceAt(0));
 666     assertSame(x06707, xrefs.getSequenceAt(1));
 667     assertSame(m19487, xrefs.getSequenceAt(2));
 668     assertSame(x07547, xrefs.getSequenceAt(3));
 669
 670     /*
 671      * verify mappings added to Uniprot-to-EMBL dbrefs
 672      */
 673     Mapping mapping = p0ce19.getDBRefs()[0].getMap();
 674     assertSame(j03321, mapping.getTo());
 675     mapping = p0ce19.getDBRefs()[1].getMap();
 676     assertSame(x06707, mapping.getTo());
 677     mapping = p0ce20.getDBRefs()[0].getMap();
 678     assertSame(j03321, mapping.getTo());
 679     mapping = p0ce20.getDBRefs()[1].getMap();
 680     assertSame(x06707, mapping.getTo());
 681
 682     /*
 683      * verify dbrefs on EMBL are mapped to alignment seqs
 684      */
 685     assertSame(p0ce19, j03321.getDBRefs()[0].getMap().getTo());
 686     assertSame(p0ce20, j03321.getDBRefs()[1].getMap().getTo());
 687     assertSame(p0ce19, x06707.getDBRefs()[0].getMap().getTo());
 688     assertSame(p0ce20, x06707.getDBRefs()[1].getMap().getTo());
 689
 690     /*
 691      * verify new dbref on EMBL dbref mapping is copied to the
 692      * original Uniprot sequence
 693      */
 694     assertEquals(4, p0ce19.getDBRefs().length);
 695     assertEquals("PIR", p0ce19.getDBRefs()[3].getSource());
 696     assertEquals("S01875", p0ce19.getDBRefs()[3].getAccessionId());
 697   }
 698
 699   @Test(groups = "Functional")
 700   public void testSameSequence()
 701   {
 702     assertTrue(CrossRef.sameSequence(null, null));
 703     SequenceI seq1 = new Sequence("seq1", "ABCDEF");
 704     assertFalse(CrossRef.sameSequence(seq1, null));
 705     assertFalse(CrossRef.sameSequence(null, seq1));
 706     assertTrue(CrossRef.sameSequence(seq1, new Sequence("seq2", "ABCDEF")));
 707     assertTrue(CrossRef.sameSequence(seq1, new Sequence("seq2", "abcdef")));
 708     assertFalse(CrossRef
 709             .sameSequence(seq1, new Sequence("seq2", "ABCDE-F")));
 710     assertFalse(CrossRef.sameSequence(seq1, new Sequence("seq2", "BCDEF")));
 711   }
 712 }