test/jalview/datamodel/SequenceTest.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.datamodel;
  22
  23 import 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 import static org.testng.internal.junit.ArrayAsserts.assertArrayEquals;
  30
  31 import jalview.datamodel.PDBEntry.Type;
  32 import jalview.util.MapList;
  33
  34 import java.util.ArrayList;
  35 import java.util.Arrays;
  36 import java.util.List;
  37 import java.util.Vector;
  38
  39 import org.testng.Assert;
  40 import org.testng.annotations.BeforeMethod;
  41 import org.testng.annotations.Test;
  42
  43 public class SequenceTest
  44 {
  45   Sequence seq;
  46
  47   @BeforeMethod(alwaysRun = true)
  48   public void setUp()
  49   {
  50     seq = new Sequence("FER1", "AKPNGVL");
  51   }
  52
  53   @Test(groups = { "Functional" })
  54   public void testInsertGapsAndGapmaps()
  55   {
  56     SequenceI aseq = seq.deriveSequence();
  57     aseq.insertCharAt(2, 3, '-');
  58     aseq.insertCharAt(6, 3, '-');
  59     assertEquals("Gap insertions not correct", "AK---P---NGVL",
  60             aseq.getSequenceAsString());
  61     List<int[]> gapInt = aseq.getInsertions();
  62     assertEquals("Gap interval 1 start wrong", 2, gapInt.get(0)[0]);
  63     assertEquals("Gap interval 1 end wrong", 4, gapInt.get(0)[1]);
  64     assertEquals("Gap interval 2 start wrong", 6, gapInt.get(1)[0]);
  65     assertEquals("Gap interval 2 end wrong", 8, gapInt.get(1)[1]);
  66   }
  67
  68   @Test(groups = ("Functional"))
  69   public void testIsProtein()
  70   {
  71     // test Protein
  72     assertTrue(new Sequence("prot","ASDFASDFASDF").isProtein());
  73     // test DNA
  74     assertFalse(new Sequence("prot","ACGTACGTACGT").isProtein());
  75     // test RNA
  76     SequenceI sq = new Sequence("prot","ACGUACGUACGU");
  77     assertFalse(sq.isProtein());
  78     // change sequence, should trigger an update of cached result
  79     sq.setSequence("ASDFASDFADSF");
  80     assertTrue(sq.isProtein());
  81     /*
  82      * in situ change of sequence doesn't change hashcode :-O
  83      * (sequence should not expose internal implementation)
  84      */
  85     for (int i = 0; i < sq.getSequence().length; i++)
  86     {
  87       sq.getSequence()[i] = "acgtu".charAt(i % 5);
  88     }
  89     assertTrue(sq.isProtein()); // but it isn't
  90   }
  91
  92   @Test(groups = { "Functional" })
  93   public void testGetAnnotation()
  94   {
  95     // initial state returns null not an empty array
  96     assertNull(seq.getAnnotation());
  97     AlignmentAnnotation ann = addAnnotation("label1", "desc1", "calcId1",
  98             1f);
  99     AlignmentAnnotation[] anns = seq.getAnnotation();
 100     assertEquals(1, anns.length);
 101     assertSame(ann, anns[0]);
 102
 103     // removing all annotations reverts array to null
 104     seq.removeAlignmentAnnotation(ann);
 105     assertNull(seq.getAnnotation());
 106   }
 107
 108   @Test(groups = { "Functional" })
 109   public void testGetAnnotation_forLabel()
 110   {
 111     AlignmentAnnotation ann1 = addAnnotation("label1", "desc1", "calcId1",
 112             1f);
 113     addAnnotation("label2", "desc2", "calcId2", 1f);
 114     AlignmentAnnotation ann3 = addAnnotation("label1", "desc3", "calcId3",
 115             1f);
 116     AlignmentAnnotation[] anns = seq.getAnnotation("label1");
 117     assertEquals(2, anns.length);
 118     assertSame(ann1, anns[0]);
 119     assertSame(ann3, anns[1]);
 120   }
 121
 122   private AlignmentAnnotation addAnnotation(String label,
 123           String description, String calcId, float value)
 124   {
 125     final AlignmentAnnotation annotation = new AlignmentAnnotation(label,
 126             description, value);
 127     annotation.setCalcId(calcId);
 128     seq.addAlignmentAnnotation(annotation);
 129     return annotation;
 130   }
 131
 132   @Test(groups = { "Functional" })
 133   public void testGetAlignmentAnnotations_forCalcIdAndLabel()
 134   {
 135     addAnnotation("label1", "desc1", "calcId1", 1f);
 136     AlignmentAnnotation ann2 = addAnnotation("label2", "desc2", "calcId2",
 137             1f);
 138     addAnnotation("label2", "desc3", "calcId3", 1f);
 139     AlignmentAnnotation ann4 = addAnnotation("label2", "desc3", "calcId2",
 140             1f);
 141     addAnnotation("label5", "desc3", null, 1f);
 142     addAnnotation(null, "desc3", "calcId3", 1f);
 143
 144     List<AlignmentAnnotation> anns = seq.getAlignmentAnnotations("calcId2",
 145             "label2");
 146     assertEquals(2, anns.size());
 147     assertSame(ann2, anns.get(0));
 148     assertSame(ann4, anns.get(1));
 149
 150     assertTrue(seq.getAlignmentAnnotations("calcId2", "label3").isEmpty());
 151     assertTrue(seq.getAlignmentAnnotations("calcId3", "label5").isEmpty());
 152     assertTrue(seq.getAlignmentAnnotations("calcId2", null).isEmpty());
 153     assertTrue(seq.getAlignmentAnnotations(null, "label3").isEmpty());
 154     assertTrue(seq.getAlignmentAnnotations(null, null).isEmpty());
 155   }
 156
 157   /**
 158    * Tests for addAlignmentAnnotation. Note this method has the side-effect of
 159    * setting the sequenceRef on the annotation. Adding the same annotation twice
 160    * should be ignored.
 161    */
 162   @Test(groups = { "Functional" })
 163   public void testAddAlignmentAnnotation()
 164   {
 165     assertNull(seq.getAnnotation());
 166     final AlignmentAnnotation annotation = new AlignmentAnnotation("a",
 167             "b", 2d);
 168     assertNull(annotation.sequenceRef);
 169     seq.addAlignmentAnnotation(annotation);
 170     assertSame(seq, annotation.sequenceRef);
 171     AlignmentAnnotation[] anns = seq.getAnnotation();
 172     assertEquals(1, anns.length);
 173     assertSame(annotation, anns[0]);
 174
 175     // re-adding does nothing
 176     seq.addAlignmentAnnotation(annotation);
 177     anns = seq.getAnnotation();
 178     assertEquals(1, anns.length);
 179     assertSame(annotation, anns[0]);
 180
 181     // an identical but different annotation can be added
 182     final AlignmentAnnotation annotation2 = new AlignmentAnnotation("a",
 183             "b", 2d);
 184     seq.addAlignmentAnnotation(annotation2);
 185     anns = seq.getAnnotation();
 186     assertEquals(2, anns.length);
 187     assertSame(annotation, anns[0]);
 188     assertSame(annotation2, anns[1]);
 189   }
 190
 191   @Test(groups = { "Functional" })
 192   public void testGetStartGetEnd()
 193   {
 194     SequenceI sq = new Sequence("test", "ABCDEF");
 195     assertEquals(1, sq.getStart());
 196     assertEquals(6, sq.getEnd());
 197
 198     sq = new Sequence("test", "--AB-C-DEF--");
 199     assertEquals(1, sq.getStart());
 200     assertEquals(6, sq.getEnd());
 201
 202     sq = new Sequence("test", "----");
 203     assertEquals(1, sq.getStart());
 204     assertEquals(0, sq.getEnd()); // ??
 205   }
 206
 207   /**
 208    * Tests for the method that returns an alignment column position (base 1) for
 209    * a given sequence position (base 1).
 210    */
 211   @Test(groups = { "Functional" })
 212   public void testFindIndex()
 213   {
 214     SequenceI sq = new Sequence("test", "ABCDEF");
 215     assertEquals(0, sq.findIndex(0));
 216     assertEquals(1, sq.findIndex(1));
 217     assertEquals(5, sq.findIndex(5));
 218     assertEquals(6, sq.findIndex(6));
 219     assertEquals(6, sq.findIndex(9));
 220
 221     sq = new Sequence("test", "-A--B-C-D-E-F--");
 222     assertEquals(2, sq.findIndex(1));
 223     assertEquals(5, sq.findIndex(2));
 224     assertEquals(7, sq.findIndex(3));
 225
 226     // before start returns 0
 227     assertEquals(0, sq.findIndex(0));
 228     assertEquals(0, sq.findIndex(-1));
 229
 230     // beyond end returns last residue column
 231     assertEquals(13, sq.findIndex(99));
 232
 233   }
 234
 235   /**
 236    * Tests for the method that returns a dataset sequence position (base 1) for
 237    * an aligned column position (base 0).
 238    */
 239   @Test(groups = { "Functional" })
 240   public void testFindPosition()
 241   {
 242     SequenceI sq = new Sequence("test", "ABCDEF");
 243     assertEquals(1, sq.findPosition(0));
 244     assertEquals(6, sq.findPosition(5));
 245     // assertEquals(-1, seq.findPosition(6)); // fails
 246
 247     sq = new Sequence("test", "AB-C-D--");
 248     assertEquals(1, sq.findPosition(0));
 249     assertEquals(2, sq.findPosition(1));
 250     // gap position 'finds' residue to the right (not the left as per javadoc)
 251     assertEquals(3, sq.findPosition(2));
 252     assertEquals(3, sq.findPosition(3));
 253     assertEquals(4, sq.findPosition(4));
 254     assertEquals(4, sq.findPosition(5));
 255     // returns 1 more than sequence length if off the end ?!?
 256     assertEquals(5, sq.findPosition(6));
 257     assertEquals(5, sq.findPosition(7));
 258
 259     sq = new Sequence("test", "--AB-C-DEF--");
 260     assertEquals(1, sq.findPosition(0));
 261     assertEquals(1, sq.findPosition(1));
 262     assertEquals(1, sq.findPosition(2));
 263     assertEquals(2, sq.findPosition(3));
 264     assertEquals(3, sq.findPosition(4));
 265     assertEquals(3, sq.findPosition(5));
 266     assertEquals(4, sq.findPosition(6));
 267     assertEquals(4, sq.findPosition(7));
 268     assertEquals(5, sq.findPosition(8));
 269     assertEquals(6, sq.findPosition(9));
 270     assertEquals(7, sq.findPosition(10));
 271     assertEquals(7, sq.findPosition(11));
 272   }
 273
 274   @Test(groups = { "Functional" })
 275   public void testDeleteChars()
 276   {
 277     SequenceI sq = new Sequence("test", "ABCDEF");
 278     assertEquals(1, sq.getStart());
 279     assertEquals(6, sq.getEnd());
 280     sq.deleteChars(2, 3);
 281     assertEquals("ABDEF", sq.getSequenceAsString());
 282     assertEquals(1, sq.getStart());
 283     assertEquals(5, sq.getEnd());
 284
 285     sq = new Sequence("test", "ABCDEF");
 286     sq.deleteChars(0, 2);
 287     assertEquals("CDEF", sq.getSequenceAsString());
 288     assertEquals(3, sq.getStart());
 289     assertEquals(6, sq.getEnd());
 290   }
 291
 292   @Test(groups = { "Functional" })
 293   public void testInsertCharAt()
 294   {
 295     // non-static methods:
 296     SequenceI sq = new Sequence("test", "ABCDEF");
 297     sq.insertCharAt(0, 'z');
 298     assertEquals("zABCDEF", sq.getSequenceAsString());
 299     sq.insertCharAt(2, 2, 'x');
 300     assertEquals("zAxxBCDEF", sq.getSequenceAsString());
 301
 302     // for static method see StringUtilsTest
 303   }
 304
 305   /**
 306    * Test the method that returns an array of aligned sequence positions where
 307    * the array index is the data sequence position (both base 0).
 308    */
 309   @Test(groups = { "Functional" })
 310   public void testGapMap()
 311   {
 312     SequenceI sq = new Sequence("test", "-A--B-CD-E--F-");
 313     sq.createDatasetSequence();
 314     assertEquals("[1, 4, 6, 7, 9, 12]", Arrays.toString(sq.gapMap()));
 315   }
 316
 317   /**
 318    * Test the method that gets sequence features, either from the sequence or
 319    * its dataset.
 320    */
 321   @Test(groups = { "Functional" })
 322   public void testGetSequenceFeatures()
 323   {
 324     SequenceI sq = new Sequence("test", "GATCAT");
 325     sq.createDatasetSequence();
 326
 327     assertNull(sq.getSequenceFeatures());
 328
 329     /*
 330      * SequenceFeature on sequence
 331      */
 332     SequenceFeature sf = new SequenceFeature();
 333     sq.addSequenceFeature(sf);
 334     SequenceFeature[] sfs = sq.getSequenceFeatures();
 335     assertEquals(1, sfs.length);
 336     assertSame(sf, sfs[0]);
 337
 338
 339     /*
 340      * SequenceFeature on sequence and dataset sequence; returns that on
 341      * sequence
 342      *
 343      * Note JAL-2046: spurious: we have no use case for this at the moment.
 344      * This test also buggy - as sf2.equals(sf), no new feature is added
 345      */
 346     SequenceFeature sf2 = new SequenceFeature();
 347     sq.getDatasetSequence().addSequenceFeature(sf2);
 348     sfs = sq.getSequenceFeatures();
 349     assertEquals(1, sfs.length);
 350     assertSame(sf, sfs[0]);
 351
 352     /*
 353      * SequenceFeature on dataset sequence only
 354      * Note JAL-2046: spurious: we have no use case for setting a non-dataset sequence's feature array to null at the moment.
 355      */
 356     sq.setSequenceFeatures(null);
 357     assertNull(sq.getDatasetSequence().getSequenceFeatures());
 358
 359     /*
 360      * Corrupt case - no SequenceFeature, dataset's dataset is the original
 361      * sequence. Test shows no infinite loop results.
 362      */
 363     sq.getDatasetSequence().setSequenceFeatures(null);
 364     /**
 365      * is there a usecase for this ? setDatasetSequence should throw an error if
 366      * this actually occurs.
 367      */
 368     sq.getDatasetSequence().setDatasetSequence(sq); // loop!
 369     assertNull(sq.getSequenceFeatures());
 370   }
 371
 372   /**
 373    * Test the method that returns an array, indexed by sequence position, whose
 374    * entries are the residue positions at the sequence position (or to the right
 375    * if a gap)
 376    */
 377   @Test(groups = { "Functional" })
 378   public void testFindPositionMap()
 379   {
 380     /*
 381      * Note: Javadoc for findPosition says it returns the residue position to
 382      * the left of a gapped position; in fact it returns the position to the
 383      * right. Also it returns a non-existent residue position for a gap beyond
 384      * the sequence.
 385      */
 386     Sequence sq = new Sequence("TestSeq", "AB.C-D E.");
 387     int[] map = sq.findPositionMap();
 388     assertEquals(Arrays.toString(new int[] { 1, 2, 3, 3, 4, 4, 5, 5, 6 }),
 389             Arrays.toString(map));
 390   }
 391
 392   /**
 393    * Test for getSubsequence
 394    */
 395   @Test(groups = { "Functional" })
 396   public void testGetSubsequence()
 397   {
 398     SequenceI sq = new Sequence("TestSeq", "ABCDEFG");
 399     sq.createDatasetSequence();
 400
 401     // positions are base 0, end position is exclusive
 402     SequenceI subseq = sq.getSubSequence(2, 4);
 403
 404     assertEquals("CD", subseq.getSequenceAsString());
 405     // start/end are base 1 positions
 406     assertEquals(3, subseq.getStart());
 407     assertEquals(4, subseq.getEnd());
 408     // subsequence shares the full dataset sequence
 409     assertSame(sq.getDatasetSequence(), subseq.getDatasetSequence());
 410   }
 411
 412   /**
 413    * test createDatasetSequence behaves to doc
 414    */
 415   @Test(groups = { "Functional" })
 416   public void testCreateDatasetSequence()
 417   {
 418     SequenceI sq = new Sequence("my","ASDASD");
 419     assertNull(sq.getDatasetSequence());
 420     SequenceI rds = sq.createDatasetSequence();
 421     assertNotNull(rds);
 422     assertNull(rds.getDatasetSequence());
 423     assertEquals(sq.getDatasetSequence(), rds);
 424   }
 425
 426   /**
 427    * Test for deriveSequence applied to a sequence with a dataset
 428    */
 429   @Test(groups = { "Functional" })
 430   public void testDeriveSequence_existingDataset()
 431   {
 432     Sequence sq = new Sequence("Seq1", "CD");
 433     sq.setDatasetSequence(new Sequence("Seq1", "ABCDEF"));
 434     sq.getDatasetSequence().addSequenceFeature(
 435             new SequenceFeature("", "", 1, 2, 0f, null));
 436     sq.setStart(3);
 437     sq.setEnd(4);
 438
 439     sq.setDescription("Test sequence description..");
 440     sq.setVamsasId("TestVamsasId");
 441     sq.addDBRef(new DBRefEntry("PDB", "version0", "1TST"));
 442
 443     sq.addDBRef(new DBRefEntry("PDB", "version1", "1PDB"));
 444     sq.addDBRef(new DBRefEntry("PDB", "version2", "2PDB"));
 445     sq.addDBRef(new DBRefEntry("PDB", "version3", "3PDB"));
 446     sq.addDBRef(new DBRefEntry("PDB", "version4", "4PDB"));
 447
 448     sq.addPDBId(new PDBEntry("1PDB", "A", Type.PDB, "filePath/test1"));
 449     sq.addPDBId(new PDBEntry("1PDB", "B", Type.PDB, "filePath/test1"));
 450     sq.addPDBId(new PDBEntry("2PDB", "A", Type.MMCIF, "filePath/test2"));
 451     sq.addPDBId(new PDBEntry("2PDB", "B", Type.MMCIF, "filePath/test2"));
 452
 453     DBRefEntry pdb1pdb = new DBRefEntry("PDB", "version1", "1PDB");
 454     DBRefEntry pdb2pdb = new DBRefEntry("PDB", "version1", "2PDB");
 455     List<DBRefEntry> primRefs = Arrays.asList(new DBRefEntry[] { pdb1pdb,
 456         pdb2pdb });
 457
 458     sq.getDatasetSequence().addDBRef(pdb1pdb);
 459     sq.getDatasetSequence().addDBRef(pdb2pdb);
 460     sq.getDatasetSequence().addDBRef(
 461             new DBRefEntry("PDB", "version3", "3PDB"));
 462     sq.getDatasetSequence().addDBRef(
 463             new DBRefEntry("PDB", "version4", "4PDB"));
 464
 465     PDBEntry pdbe1a=new PDBEntry("1PDB", "A", Type.PDB, "filePath/test1");
 466     PDBEntry pdbe1b = new PDBEntry("1PDB", "B", Type.PDB, "filePath/test1");
 467     PDBEntry pdbe2a=new PDBEntry("2PDB", "A", Type.MMCIF, "filePath/test2");
 468     PDBEntry pdbe2b = new PDBEntry("2PDB", "B", Type.MMCIF, "filePath/test2");
 469     sq.getDatasetSequence().addPDBId(
 470             pdbe1a);
 471     sq.getDatasetSequence().addPDBId(
 472             pdbe1b);
 473     sq.getDatasetSequence().addPDBId(pdbe2a);
 474     sq.getDatasetSequence().addPDBId(pdbe2b);
 475
 476     /*
 477      * test we added pdb entries to the dataset sequence
 478      */
 479     Assert.assertEquals(sq.getDatasetSequence().getAllPDBEntries(), Arrays
 480             .asList(new PDBEntry[] { pdbe1a, pdbe1b, pdbe2a, pdbe2b }),
 481             "PDB Entries were not found on dataset sequence.");
 482
 483     /*
 484      * we should recover a pdb entry that is on the dataset sequence via PDBEntry
 485      */
 486     Assert.assertEquals(pdbe1a,
 487             sq.getDatasetSequence().getPDBEntry("1PDB"),
 488             "PDB Entry '1PDB' not found on dataset sequence via getPDBEntry.");
 489     ArrayList<Annotation> annotsList = new ArrayList<Annotation>();
 490     System.out.println(">>>>>> " + sq.getSequenceAsString().length());
 491     annotsList.add(new Annotation("A", "A", 'X', 0.1f));
 492     annotsList.add(new Annotation("A", "A", 'X', 0.1f));
 493     Annotation[] annots = annotsList.toArray(new Annotation[0]);
 494     sq.addAlignmentAnnotation(new AlignmentAnnotation("Test annot",
 495             "Test annot description", annots));
 496     sq.getDatasetSequence().addAlignmentAnnotation(
 497             new AlignmentAnnotation("Test annot", "Test annot description",
 498                     annots));
 499     Assert.assertEquals(sq.getDescription(), "Test sequence description..");
 500     Assert.assertEquals(sq.getDBRefs().length, 5);
 501     Assert.assertEquals(sq.getAllPDBEntries().size(), 4);
 502     Assert.assertNotNull(sq.getAnnotation());
 503     Assert.assertEquals(sq.getAnnotation()[0].annotations.length, 2);
 504     Assert.assertEquals(sq.getDatasetSequence().getDBRefs().length, 4);
 505     Assert.assertEquals(sq.getDatasetSequence().getAllPDBEntries().size(),
 506             4);
 507     Assert.assertNotNull(sq.getDatasetSequence().getAnnotation());
 508
 509     Sequence derived = (Sequence) sq.deriveSequence();
 510
 511     Assert.assertEquals(derived.getDescription(),
 512             "Test sequence description..");
 513     Assert.assertEquals(derived.getDBRefs().length, 4); // come from dataset
 514     Assert.assertEquals(derived.getAllPDBEntries().size(), 4);
 515     Assert.assertNotNull(derived.getAnnotation());
 516     Assert.assertEquals(derived.getAnnotation()[0].annotations.length, 2);
 517     Assert.assertEquals(derived.getDatasetSequence().getDBRefs().length, 4);
 518     Assert.assertEquals(derived.getDatasetSequence().getAllPDBEntries()
 519             .size(), 4);
 520     Assert.assertNotNull(derived.getDatasetSequence().getAnnotation());
 521
 522     assertEquals("CD", derived.getSequenceAsString());
 523     assertSame(sq.getDatasetSequence(), derived.getDatasetSequence());
 524
 525     assertNull(sq.sequenceFeatures);
 526     assertNull(derived.sequenceFeatures);
 527     // derived sequence should access dataset sequence features
 528     assertNotNull(sq.getSequenceFeatures());
 529     assertArrayEquals(sq.getSequenceFeatures(),
 530             derived.getSequenceFeatures());
 531
 532     /*
 533      *  verify we have primary db refs *just* for PDB IDs with associated
 534      *  PDBEntry objects
 535      */
 536
 537     assertEquals(primRefs, sq.getPrimaryDBRefs());
 538     assertEquals(primRefs, sq.getDatasetSequence().getPrimaryDBRefs());
 539
 540     assertEquals(sq.getPrimaryDBRefs(), derived.getPrimaryDBRefs());
 541
 542   }
 543
 544   /**
 545    * Test for deriveSequence applied to an ungapped sequence with no dataset
 546    */
 547   @Test(groups = { "Functional" })
 548   public void testDeriveSequence_noDatasetUngapped()
 549   {
 550     SequenceI sq = new Sequence("Seq1", "ABCDEF");
 551     assertEquals(1, sq.getStart());
 552     assertEquals(6, sq.getEnd());
 553     SequenceI derived = sq.deriveSequence();
 554     assertEquals("ABCDEF", derived.getSequenceAsString());
 555     assertEquals("ABCDEF", derived.getDatasetSequence()
 556             .getSequenceAsString());
 557   }
 558
 559   /**
 560    * Test for deriveSequence applied to a gapped sequence with no dataset
 561    */
 562   @Test(groups = { "Functional" })
 563   public void testDeriveSequence_noDatasetGapped()
 564   {
 565     SequenceI sq = new Sequence("Seq1", "AB-C.D EF");
 566     assertEquals(1, sq.getStart());
 567     assertEquals(6, sq.getEnd());
 568     assertNull(sq.getDatasetSequence());
 569     SequenceI derived = sq.deriveSequence();
 570     assertEquals("AB-C.D EF", derived.getSequenceAsString());
 571     assertEquals("ABCDEF", derived.getDatasetSequence()
 572             .getSequenceAsString());
 573   }
 574
 575   @Test(groups = { "Functional" })
 576   public void testCopyConstructor_noDataset()
 577   {
 578     SequenceI seq1 = new Sequence("Seq1", "AB-C.D EF");
 579     seq1.setDescription("description");
 580     seq1.addAlignmentAnnotation(new AlignmentAnnotation("label", "desc",
 581             1.3d));
 582     seq1.addSequenceFeature(new SequenceFeature("type", "desc", 22, 33,
 583             12.4f, "group"));
 584     seq1.addPDBId(new PDBEntry("1A70", "B", Type.PDB, "File"));
 585     seq1.addDBRef(new DBRefEntry("EMBL", "1.2", "AZ12345"));
 586
 587     SequenceI copy = new Sequence(seq1);
 588
 589     assertNull(copy.getDatasetSequence());
 590
 591     verifyCopiedSequence(seq1, copy);
 592
 593     // copy has a copy of the DBRefEntry
 594     // this is murky - DBrefs are only copied for dataset sequences
 595     // where the test for 'dataset sequence' is 'dataset is null'
 596     // but that doesn't distinguish it from an aligned sequence
 597     // which has not yet generated a dataset sequence
 598     // NB getDBRef looks inside dataset sequence if not null
 599     DBRefEntry[] dbrefs = copy.getDBRefs();
 600     assertEquals(1, dbrefs.length);
 601     assertFalse(dbrefs[0] == seq1.getDBRefs()[0]);
 602     assertTrue(dbrefs[0].equals(seq1.getDBRefs()[0]));
 603   }
 604
 605   @Test(groups = { "Functional" })
 606   public void testCopyConstructor_withDataset()
 607   {
 608     SequenceI seq1 = new Sequence("Seq1", "AB-C.D EF");
 609     seq1.createDatasetSequence();
 610     seq1.setDescription("description");
 611     seq1.addAlignmentAnnotation(new AlignmentAnnotation("label", "desc",
 612             1.3d));
 613     // JAL-2046 - what is the contract for using a derived sequence's
 614     // addSequenceFeature ?
 615     seq1.addSequenceFeature(new SequenceFeature("type", "desc", 22, 33,
 616             12.4f, "group"));
 617     seq1.addPDBId(new PDBEntry("1A70", "B", Type.PDB, "File"));
 618     // here we add DBRef to the dataset sequence:
 619     seq1.getDatasetSequence().addDBRef(
 620             new DBRefEntry("EMBL", "1.2", "AZ12345"));
 621
 622     SequenceI copy = new Sequence(seq1);
 623
 624     assertNotNull(copy.getDatasetSequence());
 625     assertSame(copy.getDatasetSequence(), seq1.getDatasetSequence());
 626
 627     verifyCopiedSequence(seq1, copy);
 628
 629     // getDBRef looks inside dataset sequence and this is shared,
 630     // so holds the same dbref objects
 631     DBRefEntry[] dbrefs = copy.getDBRefs();
 632     assertEquals(1, dbrefs.length);
 633     assertSame(dbrefs[0], seq1.getDBRefs()[0]);
 634   }
 635
 636   /**
 637    * Helper to make assertions about a copied sequence
 638    *
 639    * @param seq1
 640    * @param copy
 641    */
 642   protected void verifyCopiedSequence(SequenceI seq1, SequenceI copy)
 643   {
 644     // verify basic properties:
 645     assertEquals(copy.getName(), seq1.getName());
 646     assertEquals(copy.getDescription(), seq1.getDescription());
 647     assertEquals(copy.getStart(), seq1.getStart());
 648     assertEquals(copy.getEnd(), seq1.getEnd());
 649     assertEquals(copy.getSequenceAsString(), seq1.getSequenceAsString());
 650
 651     // copy has a copy of the annotation:
 652     AlignmentAnnotation[] anns = copy.getAnnotation();
 653     assertEquals(1, anns.length);
 654     assertFalse(anns[0] == seq1.getAnnotation()[0]);
 655     assertEquals(anns[0].label, seq1.getAnnotation()[0].label);
 656     assertEquals(anns[0].description, seq1.getAnnotation()[0].description);
 657     assertEquals(anns[0].score, seq1.getAnnotation()[0].score);
 658
 659     // copy has a copy of the sequence feature:
 660     SequenceFeature[] sfs = copy.getSequenceFeatures();
 661     assertEquals(1, sfs.length);
 662     if (seq1.getDatasetSequence()!=null && copy.getDatasetSequence()==seq1.getDatasetSequence()) {
 663       assertTrue(sfs[0] == seq1.getSequenceFeatures()[0]);
 664     } else {
 665       assertFalse(sfs[0] == seq1.getSequenceFeatures()[0]);
 666     }
 667     assertTrue(sfs[0].equals(seq1.getSequenceFeatures()[0]));
 668
 669     // copy has a copy of the PDB entry
 670     Vector<PDBEntry> pdbs = copy.getAllPDBEntries();
 671     assertEquals(1, pdbs.size());
 672     assertFalse(pdbs.get(0) == seq1.getAllPDBEntries().get(0));
 673     assertTrue(pdbs.get(0).equals(seq1.getAllPDBEntries().get(0)));
 674   }
 675
 676   @Test(groups = "Functional")
 677   public void testGetCharAt()
 678   {
 679     SequenceI sq = new Sequence("", "abcde");
 680     assertEquals('a', sq.getCharAt(0));
 681     assertEquals('e', sq.getCharAt(4));
 682     assertEquals(' ', sq.getCharAt(5));
 683     assertEquals(' ', sq.getCharAt(-1));
 684   }
 685
 686   /**
 687    * Tests for adding (or updating) dbrefs
 688    *
 689    * @see DBRefEntry#updateFrom(DBRefEntry)
 690    */
 691   @Test(groups = { "Functional" })
 692   public void testAddDBRef()
 693   {
 694     SequenceI sq = new Sequence("", "abcde");
 695     assertNull(sq.getDBRefs());
 696     DBRefEntry dbref = new DBRefEntry("Uniprot", "1", "P00340");
 697     sq.addDBRef(dbref);
 698     assertEquals(1, sq.getDBRefs().length);
 699     assertSame(dbref, sq.getDBRefs()[0]);
 700
 701     /*
 702      * change of version - new entry
 703      */
 704     DBRefEntry dbref2 = new DBRefEntry("Uniprot", "2", "P00340");
 705     sq.addDBRef(dbref2);
 706     assertEquals(2, sq.getDBRefs().length);
 707     assertSame(dbref, sq.getDBRefs()[0]);
 708     assertSame(dbref2, sq.getDBRefs()[1]);
 709
 710     /*
 711      * matches existing entry - not added
 712      */
 713     sq.addDBRef(new DBRefEntry("UNIPROT", "1", "p00340"));
 714     assertEquals(2, sq.getDBRefs().length);
 715
 716     /*
 717      * different source = new entry
 718      */
 719     DBRefEntry dbref3 = new DBRefEntry("UniRef", "1", "p00340");
 720     sq.addDBRef(dbref3);
 721     assertEquals(3, sq.getDBRefs().length);
 722     assertSame(dbref3, sq.getDBRefs()[2]);
 723
 724     /*
 725      * different ref = new entry
 726      */
 727     DBRefEntry dbref4 = new DBRefEntry("UniRef", "1", "p00341");
 728     sq.addDBRef(dbref4);
 729     assertEquals(4, sq.getDBRefs().length);
 730     assertSame(dbref4, sq.getDBRefs()[3]);
 731
 732     /*
 733      * matching ref with a mapping - map updated
 734      */
 735     DBRefEntry dbref5 = new DBRefEntry("UniRef", "1", "p00341");
 736     Mapping map = new Mapping(new MapList(new int[] { 1, 3 }, new int[] {
 737         1, 1 }, 3, 1));
 738     dbref5.setMap(map);
 739     sq.addDBRef(dbref5);
 740     assertEquals(4, sq.getDBRefs().length);
 741     assertSame(dbref4, sq.getDBRefs()[3]);
 742     assertSame(map, dbref4.getMap());
 743
 744     /*
 745      * 'real' version replaces "0" version
 746      */
 747     dbref2.setVersion("0");
 748     DBRefEntry dbref6 = new DBRefEntry(dbref2.getSource(), "3",
 749             dbref2.getAccessionId());
 750     sq.addDBRef(dbref6);
 751     assertEquals(4, sq.getDBRefs().length);
 752     assertSame(dbref2, sq.getDBRefs()[1]);
 753     assertEquals("3", dbref2.getVersion());
 754
 755     /*
 756      * 'real' version replaces "source:0" version
 757      */
 758     dbref3.setVersion("Uniprot:0");
 759     DBRefEntry dbref7 = new DBRefEntry(dbref3.getSource(), "3",
 760             dbref3.getAccessionId());
 761     sq.addDBRef(dbref7);
 762     assertEquals(4, sq.getDBRefs().length);
 763     assertSame(dbref3, sq.getDBRefs()[2]);
 764     assertEquals("3", dbref2.getVersion());
 765   }
 766 }