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.assertNotSame;
  27 import static org.testng.AssertJUnit.assertNull;
  28 import static org.testng.AssertJUnit.assertSame;
  29 import static org.testng.AssertJUnit.assertTrue;
  30
  31 import jalview.analysis.AlignmentGenerator;
  32 import jalview.commands.EditCommand;
  33 import jalview.commands.EditCommand.Action;
  34 import jalview.datamodel.PDBEntry.Type;
  35 import jalview.gui.JvOptionPane;
  36 import jalview.util.MapList;
  37
  38 import java.io.File;
  39 import java.util.ArrayList;
  40 import java.util.Arrays;
  41 import java.util.BitSet;
  42 import java.util.Iterator;
  43 import java.util.List;
  44 import java.util.Vector;
  45
  46 import org.testng.Assert;
  47 import org.testng.annotations.BeforeClass;
  48 import org.testng.annotations.BeforeMethod;
  49 import org.testng.annotations.Test;
  50
  51 import junit.extensions.PA;
  52
  53 public class SequenceTest
  54 {
  55   @BeforeClass(alwaysRun = true)
  56   public void setUpJvOptionPane()
  57   {
  58     JvOptionPane.setInteractiveMode(false);
  59     JvOptionPane.setMockResponse(JvOptionPane.CANCEL_OPTION);
  60   }
  61
  62   Sequence seq;
  63
  64   @BeforeMethod(alwaysRun = true)
  65   public void setUp()
  66   {
  67     seq = new Sequence("FER1", "AKPNGVL");
  68   }
  69
  70   @Test(groups = { "Functional" })
  71   public void testInsertGapsAndGapmaps()
  72   {
  73     SequenceI aseq = seq.deriveSequence();
  74     aseq.insertCharAt(2, 3, '-');
  75     aseq.insertCharAt(6, 3, '-');
  76     assertEquals("Gap insertions not correct", "AK---P---NGVL",
  77             aseq.getSequenceAsString());
  78     List<int[]> gapInt = aseq.getInsertions();
  79     assertEquals("Gap interval 1 start wrong", 2, gapInt.get(0)[0]);
  80     assertEquals("Gap interval 1 end wrong", 4, gapInt.get(0)[1]);
  81     assertEquals("Gap interval 2 start wrong", 6, gapInt.get(1)[0]);
  82     assertEquals("Gap interval 2 end wrong", 8, gapInt.get(1)[1]);
  83
  84     BitSet gapfield = aseq.getInsertionsAsBits();
  85     BitSet expectedgaps = new BitSet();
  86     expectedgaps.set(2, 5);
  87     expectedgaps.set(6, 9);
  88
  89     assertEquals(6, expectedgaps.cardinality());
  90
  91     assertEquals("getInsertionsAsBits didn't mark expected number of gaps",
  92             6, gapfield.cardinality());
  93
  94     assertEquals("getInsertionsAsBits not correct.", expectedgaps, gapfield);
  95   }
  96
  97   @Test(groups = ("Functional"))
  98   public void testIsProtein()
  99   {
 100     // test Protein
 101     assertTrue(new Sequence("prot", "ASDFASDFASDF").isProtein());
 102     // test DNA
 103     assertFalse(new Sequence("prot", "ACGTACGTACGT").isProtein());
 104     // test RNA
 105     SequenceI sq = new Sequence("prot", "ACGUACGUACGU");
 106     assertFalse(sq.isProtein());
 107     // change sequence, should trigger an update of cached result
 108     sq.setSequence("ASDFASDFADSF");
 109     assertTrue(sq.isProtein());
 110   }
 111
 112   @Test(groups = { "Functional" })
 113   public void testGetAnnotation()
 114   {
 115     // initial state returns null not an empty array
 116     assertNull(seq.getAnnotation());
 117     AlignmentAnnotation ann = addAnnotation("label1", "desc1", "calcId1",
 118             1f);
 119     AlignmentAnnotation[] anns = seq.getAnnotation();
 120     assertEquals(1, anns.length);
 121     assertSame(ann, anns[0]);
 122
 123     // removing all annotations reverts array to null
 124     seq.removeAlignmentAnnotation(ann);
 125     assertNull(seq.getAnnotation());
 126   }
 127
 128   @Test(groups = { "Functional" })
 129   public void testGetAnnotation_forLabel()
 130   {
 131     AlignmentAnnotation ann1 = addAnnotation("label1", "desc1", "calcId1",
 132             1f);
 133     addAnnotation("label2", "desc2", "calcId2", 1f);
 134     AlignmentAnnotation ann3 = addAnnotation("label1", "desc3", "calcId3",
 135             1f);
 136     AlignmentAnnotation[] anns = seq.getAnnotation("label1");
 137     assertEquals(2, anns.length);
 138     assertSame(ann1, anns[0]);
 139     assertSame(ann3, anns[1]);
 140   }
 141
 142   private AlignmentAnnotation addAnnotation(String label,
 143           String description, String calcId, float value)
 144   {
 145     final AlignmentAnnotation annotation = new AlignmentAnnotation(label,
 146             description, value);
 147     annotation.setCalcId(calcId);
 148     seq.addAlignmentAnnotation(annotation);
 149     return annotation;
 150   }
 151
 152   @Test(groups = { "Functional" })
 153   public void testGetAlignmentAnnotations_forCalcIdAndLabel()
 154   {
 155     addAnnotation("label1", "desc1", "calcId1", 1f);
 156     AlignmentAnnotation ann2 = addAnnotation("label2", "desc2", "calcId2",
 157             1f);
 158     addAnnotation("label2", "desc3", "calcId3", 1f);
 159     AlignmentAnnotation ann4 = addAnnotation("label2", "desc3", "calcId2",
 160             1f);
 161     addAnnotation("label5", "desc3", null, 1f);
 162     addAnnotation(null, "desc3", "calcId3", 1f);
 163
 164     List<AlignmentAnnotation> anns = seq.getAlignmentAnnotations("calcId2",
 165             "label2");
 166     assertEquals(2, anns.size());
 167     assertSame(ann2, anns.get(0));
 168     assertSame(ann4, anns.get(1));
 169
 170     assertTrue(seq.getAlignmentAnnotations("calcId2", "label3").isEmpty());
 171     assertTrue(seq.getAlignmentAnnotations("calcId3", "label5").isEmpty());
 172     assertTrue(seq.getAlignmentAnnotations("calcId2", null).isEmpty());
 173     assertTrue(seq.getAlignmentAnnotations(null, "label3").isEmpty());
 174     assertTrue(seq.getAlignmentAnnotations(null, null).isEmpty());
 175   }
 176
 177   /**
 178    * Tests for addAlignmentAnnotation. Note this method has the side-effect of
 179    * setting the sequenceRef on the annotation. Adding the same annotation twice
 180    * should be ignored.
 181    */
 182   @Test(groups = { "Functional" })
 183   public void testAddAlignmentAnnotation()
 184   {
 185     assertNull(seq.getAnnotation());
 186     final AlignmentAnnotation annotation = new AlignmentAnnotation("a",
 187             "b", 2d);
 188     assertNull(annotation.sequenceRef);
 189     seq.addAlignmentAnnotation(annotation);
 190     assertSame(seq, annotation.sequenceRef);
 191     AlignmentAnnotation[] anns = seq.getAnnotation();
 192     assertEquals(1, anns.length);
 193     assertSame(annotation, anns[0]);
 194
 195     // re-adding does nothing
 196     seq.addAlignmentAnnotation(annotation);
 197     anns = seq.getAnnotation();
 198     assertEquals(1, anns.length);
 199     assertSame(annotation, anns[0]);
 200
 201     // an identical but different annotation can be added
 202     final AlignmentAnnotation annotation2 = new AlignmentAnnotation("a",
 203             "b", 2d);
 204     seq.addAlignmentAnnotation(annotation2);
 205     anns = seq.getAnnotation();
 206     assertEquals(2, anns.length);
 207     assertSame(annotation, anns[0]);
 208     assertSame(annotation2, anns[1]);
 209   }
 210
 211   @Test(groups = { "Functional" })
 212   public void testGetStartGetEnd()
 213   {
 214     SequenceI sq = new Sequence("test", "ABCDEF");
 215     assertEquals(1, sq.getStart());
 216     assertEquals(6, sq.getEnd());
 217
 218     sq = new Sequence("test", "--AB-C-DEF--");
 219     assertEquals(1, sq.getStart());
 220     assertEquals(6, sq.getEnd());
 221
 222     sq = new Sequence("test", "----");
 223     assertEquals(1, sq.getStart());
 224     assertEquals(0, sq.getEnd()); // ??
 225   }
 226
 227   /**
 228    * Tests for the method that returns an alignment column position (base 1) for
 229    * a given sequence position (base 1).
 230    */
 231   @Test(groups = { "Functional" })
 232   public void testFindIndex()
 233   {
 234     /*
 235      * call sequenceChanged() after each test to invalidate any cursor,
 236      * forcing the 1-arg findIndex to be executed
 237      */
 238     SequenceI sq = new Sequence("test", "ABCDEF");
 239     assertEquals(0, sq.findIndex(0));
 240     sq.sequenceChanged();
 241     assertEquals(1, sq.findIndex(1));
 242     sq.sequenceChanged();
 243     assertEquals(5, sq.findIndex(5));
 244     sq.sequenceChanged();
 245     assertEquals(6, sq.findIndex(6));
 246     sq.sequenceChanged();
 247     assertEquals(6, sq.findIndex(9));
 248
 249     final String aligned = "-A--B-C-D-E-F--";
 250     assertEquals(15, aligned.length());
 251     sq = new Sequence("test/8-13", aligned);
 252     assertEquals(2, sq.findIndex(8));
 253     sq.sequenceChanged();
 254     assertEquals(5, sq.findIndex(9));
 255     sq.sequenceChanged();
 256     assertEquals(7, sq.findIndex(10));
 257
 258     // before start returns 0
 259     sq.sequenceChanged();
 260     assertEquals(0, sq.findIndex(0));
 261     sq.sequenceChanged();
 262     assertEquals(0, sq.findIndex(-1));
 263
 264     // beyond end returns last residue column
 265     sq.sequenceChanged();
 266     assertEquals(13, sq.findIndex(99));
 267
 268     /*
 269      * residue before sequence 'end' but beyond end of sequence returns
 270      * length of sequence (last column) (rightly or wrongly!)
 271      */
 272     sq = new Sequence("test/8-15", "A-B-C-"); // trailing gap case
 273     assertEquals(6, sq.getLength());
 274     sq.sequenceChanged();
 275     assertEquals(sq.getLength(), sq.findIndex(14));
 276     sq = new Sequence("test/8-99", "-A--B-C-D"); // trailing residue case
 277     sq.sequenceChanged();
 278     assertEquals(sq.getLength(), sq.findIndex(65));
 279
 280     /*
 281      * residue after sequence 'start' but before first residue returns
 282      * zero (before first column) (rightly or wrongly!)
 283      */
 284     sq = new Sequence("test/8-15", "-A-B-C-"); // leading gap case
 285     sq.sequenceChanged();
 286     assertEquals(0, sq.findIndex(3));
 287     sq = new Sequence("test/8-15", "A-B-C-"); // leading residue case
 288     sq.sequenceChanged();
 289     assertEquals(0, sq.findIndex(2));
 290   }
 291
 292   /**
 293    * Tests for the method that returns a dataset sequence position (start..) for
 294    * an aligned column position (base 0).
 295    */
 296   @Test(groups = { "Functional" })
 297   public void testFindPosition()
 298   {
 299     /*
 300      * call sequenceChanged() after each test to invalidate any cursor,
 301      * forcing the 1-arg findPosition to be executed
 302      */
 303     SequenceI sq = new Sequence("test/8-13", "ABCDEF");
 304     assertEquals(8, sq.findPosition(0));
 305     // Sequence should now hold a cursor at [8, 0]
 306     assertEquals("test:Pos8:Col1:startCol1:endCol0:tok0",
 307             PA.getValue(sq, "cursor").toString());
 308     SequenceCursor cursor = (SequenceCursor) PA.getValue(sq, "cursor");
 309     int token = (int) PA.getValue(sq, "changeCount");
 310     assertEquals(new SequenceCursor(sq, 8, 1, token), cursor);
 311
 312     sq.sequenceChanged();
 313
 314     /*
 315      * find F13 at column offset 5, cursor should update to [13, 6]
 316      * endColumn is found and saved in cursor
 317      */
 318     assertEquals(13, sq.findPosition(5));
 319     cursor = (SequenceCursor) PA.getValue(sq, "cursor");
 320     assertEquals(++token, (int) PA.getValue(sq, "changeCount"));
 321     assertEquals(new SequenceCursor(sq, 13, 6, token), cursor);
 322     assertEquals("test:Pos13:Col6:startCol1:endCol6:tok1",
 323             PA.getValue(sq, "cursor").toString());
 324
 325     // assertEquals(-1, seq.findPosition(6)); // fails
 326
 327     sq = new Sequence("test/8-11", "AB-C-D--");
 328     token = (int) PA.getValue(sq, "changeCount"); // 0
 329     assertEquals(8, sq.findPosition(0));
 330     cursor = (SequenceCursor) PA.getValue(sq, "cursor");
 331     assertEquals(new SequenceCursor(sq, 8, 1, token), cursor);
 332     assertEquals("test:Pos8:Col1:startCol1:endCol0:tok0",
 333             PA.getValue(sq, "cursor").toString());
 334
 335     sq.sequenceChanged();
 336     assertEquals(9, sq.findPosition(1));
 337     cursor = (SequenceCursor) PA.getValue(sq, "cursor");
 338     assertEquals(new SequenceCursor(sq, 9, 2, ++token), cursor);
 339     assertEquals("test:Pos9:Col2:startCol1:endCol0:tok1",
 340             PA.getValue(sq, "cursor").toString());
 341
 342     sq.sequenceChanged();
 343     // gap position 'finds' residue to the right (not the left as per javadoc)
 344     // cursor is set to the last residue position found [B 2]
 345     assertEquals(10, sq.findPosition(2));
 346     cursor = (SequenceCursor) PA.getValue(sq, "cursor");
 347     assertEquals(new SequenceCursor(sq, 9, 2, ++token), cursor);
 348     assertEquals("test:Pos9:Col2:startCol1:endCol0:tok2",
 349             PA.getValue(sq, "cursor").toString());
 350
 351     sq.sequenceChanged();
 352     assertEquals(10, sq.findPosition(3));
 353     cursor = (SequenceCursor) PA.getValue(sq, "cursor");
 354     assertEquals(new SequenceCursor(sq, 10, 4, ++token), cursor);
 355     assertEquals("test:Pos10:Col4:startCol1:endCol0:tok3",
 356             PA.getValue(sq, "cursor").toString());
 357
 358     sq.sequenceChanged();
 359     // column[4] is the gap after C - returns D11
 360     // cursor is set to [C 4]
 361     assertEquals(11, sq.findPosition(4));
 362     cursor = (SequenceCursor) PA.getValue(sq, "cursor");
 363     assertEquals(new SequenceCursor(sq, 10, 4, ++token), cursor);
 364     assertEquals("test:Pos10:Col4:startCol1:endCol0:tok4",
 365             PA.getValue(sq, "cursor").toString());
 366
 367     sq.sequenceChanged();
 368     assertEquals(11, sq.findPosition(5)); // D
 369     cursor = (SequenceCursor) PA.getValue(sq, "cursor");
 370     assertEquals(new SequenceCursor(sq, 11, 6, ++token), cursor);
 371     // lastCol has been found and saved in the cursor
 372     assertEquals("test:Pos11:Col6:startCol1:endCol6:tok5",
 373             PA.getValue(sq, "cursor").toString());
 374
 375     sq.sequenceChanged();
 376     // returns 1 more than sequence length if off the end ?!?
 377     assertEquals(12, sq.findPosition(6));
 378
 379     sq.sequenceChanged();
 380     assertEquals(12, sq.findPosition(7));
 381
 382     /*
 383      * first findPosition should also set firstResCol in cursor
 384      */
 385     sq = new Sequence("test/8-13", "--AB-C-DEF--");
 386     assertEquals(8, sq.findPosition(0));
 387     assertNull(PA.getValue(sq, "cursor"));
 388
 389     sq.sequenceChanged();
 390     assertEquals(8, sq.findPosition(1));
 391     assertNull(PA.getValue(sq, "cursor"));
 392
 393     sq.sequenceChanged();
 394     assertEquals(8, sq.findPosition(2));
 395     assertEquals("test:Pos8:Col3:startCol3:endCol0:tok2",
 396             PA.getValue(sq, "cursor").toString());
 397
 398     sq.sequenceChanged();
 399     assertEquals(9, sq.findPosition(3));
 400     assertEquals("test:Pos9:Col4:startCol3:endCol0:tok3",
 401             PA.getValue(sq, "cursor").toString());
 402
 403     sq.sequenceChanged();
 404     // column[4] is a gap, returns next residue pos (C10)
 405     // cursor is set to last residue found [B]
 406     assertEquals(10, sq.findPosition(4));
 407     assertEquals("test:Pos9:Col4:startCol3:endCol0:tok4",
 408             PA.getValue(sq, "cursor").toString());
 409
 410     sq.sequenceChanged();
 411     assertEquals(10, sq.findPosition(5));
 412     assertEquals("test:Pos10:Col6:startCol3:endCol0:tok5",
 413             PA.getValue(sq, "cursor").toString());
 414
 415     sq.sequenceChanged();
 416     // column[6] is a gap, returns next residue pos (D11)
 417     // cursor is set to last residue found [C]
 418     assertEquals(11, sq.findPosition(6));
 419     assertEquals("test:Pos10:Col6:startCol3:endCol0:tok6",
 420             PA.getValue(sq, "cursor").toString());
 421
 422     sq.sequenceChanged();
 423     assertEquals(11, sq.findPosition(7));
 424     assertEquals("test:Pos11:Col8:startCol3:endCol0:tok7",
 425             PA.getValue(sq, "cursor").toString());
 426
 427     sq.sequenceChanged();
 428     assertEquals(12, sq.findPosition(8));
 429     assertEquals("test:Pos12:Col9:startCol3:endCol0:tok8",
 430             PA.getValue(sq, "cursor").toString());
 431
 432     /*
 433      * when the last residue column is found, it is set in the cursor
 434      */
 435     sq.sequenceChanged();
 436     assertEquals(13, sq.findPosition(9));
 437     assertEquals("test:Pos13:Col10:startCol3:endCol10:tok9",
 438             PA.getValue(sq, "cursor").toString());
 439
 440     sq.sequenceChanged();
 441     assertEquals(14, sq.findPosition(10));
 442     assertEquals("test:Pos13:Col10:startCol3:endCol10:tok10",
 443             PA.getValue(sq, "cursor").toString());
 444
 445     /*
 446      * findPosition for column beyond sequence length
 447      * returns 1 more than last residue position
 448      */
 449     sq.sequenceChanged();
 450     assertEquals(14, sq.findPosition(11));
 451     assertEquals("test:Pos13:Col10:startCol3:endCol10:tok11",
 452             PA.getValue(sq, "cursor").toString());
 453
 454     sq.sequenceChanged();
 455     assertEquals(14, sq.findPosition(99));
 456     assertEquals("test:Pos13:Col10:startCol3:endCol10:tok12",
 457             PA.getValue(sq, "cursor").toString());
 458
 459     /*
 460      * gapped sequence ending in non-gap
 461      */
 462     sq = new Sequence("test/8-13", "--AB-C-DEF");
 463     assertEquals(13, sq.findPosition(9));
 464     assertEquals("test:Pos13:Col10:startCol3:endCol10:tok0",
 465             PA.getValue(sq, "cursor").toString());
 466     sq.sequenceChanged();
 467     assertEquals(12, sq.findPosition(8));
 468     cursor = (SequenceCursor) PA.getValue(sq, "cursor");
 469     // sequenceChanged() invalidates cursor.lastResidueColumn
 470     cursor = (SequenceCursor) PA.getValue(sq, "cursor");
 471     assertEquals("test:Pos12:Col9:startCol3:endCol0:tok1",
 472             cursor.toString());
 473     // findPosition with cursor accepts base 1 column values
 474     assertEquals(13, ((Sequence) sq).findPosition(10, cursor));
 475     assertEquals(13, sq.findPosition(9)); // F13
 476     // lastResidueColumn has now been found and saved in cursor
 477     assertEquals("test:Pos13:Col10:startCol3:endCol10:tok1",
 478             PA.getValue(sq, "cursor").toString());
 479   }
 480
 481   @Test(groups = { "Functional" })
 482   public void testDeleteChars()
 483   {
 484     /*
 485      * internal delete
 486      */
 487     SequenceI sq = new Sequence("test", "ABCDEF");
 488     assertNull(PA.getValue(sq, "datasetSequence"));
 489     assertEquals(1, sq.getStart());
 490     assertEquals(6, sq.getEnd());
 491     sq.deleteChars(2, 3);
 492     assertEquals("ABDEF", sq.getSequenceAsString());
 493     assertEquals(1, sq.getStart());
 494     assertEquals(5, sq.getEnd());
 495     assertNull(PA.getValue(sq, "datasetSequence"));
 496
 497     /*
 498      * delete at start
 499      */
 500     sq = new Sequence("test", "ABCDEF");
 501     sq.deleteChars(0, 2);
 502     assertEquals("CDEF", sq.getSequenceAsString());
 503     assertEquals(3, sq.getStart());
 504     assertEquals(6, sq.getEnd());
 505     assertNull(PA.getValue(sq, "datasetSequence"));
 506
 507     /*
 508      * delete at end
 509      */
 510     sq = new Sequence("test", "ABCDEF");
 511     sq.deleteChars(4, 6);
 512     assertEquals("ABCD", sq.getSequenceAsString());
 513     assertEquals(1, sq.getStart());
 514     assertEquals(4, sq.getEnd());
 515     assertNull(PA.getValue(sq, "datasetSequence"));
 516   }
 517
 518   @Test(groups = { "Functional" })
 519   public void testDeleteChars_withDbRefsAndFeatures()
 520   {
 521     /*
 522      * internal delete - new dataset sequence created
 523      * gets a copy of any dbrefs
 524      */
 525     SequenceI sq = new Sequence("test", "ABCDEF");
 526     sq.createDatasetSequence();
 527     DBRefEntry dbr1 = new DBRefEntry("Uniprot", "0", "a123");
 528     sq.addDBRef(dbr1);
 529     Object ds = PA.getValue(sq, "datasetSequence");
 530     assertNotNull(ds);
 531     assertEquals(1, sq.getStart());
 532     assertEquals(6, sq.getEnd());
 533     sq.deleteChars(2, 3);
 534     assertEquals("ABDEF", sq.getSequenceAsString());
 535     assertEquals(1, sq.getStart());
 536     assertEquals(5, sq.getEnd());
 537     Object newDs = PA.getValue(sq, "datasetSequence");
 538     assertNotNull(newDs);
 539     assertNotSame(ds, newDs);
 540     assertNotNull(sq.getDBRefs());
 541     assertEquals(1, sq.getDBRefs().length);
 542     assertNotSame(dbr1, sq.getDBRefs()[0]);
 543     assertEquals(dbr1, sq.getDBRefs()[0]);
 544
 545     /*
 546      * internal delete with sequence features
 547      * (failure case for JAL-2541)
 548      */
 549     sq = new Sequence("test", "ABCDEF");
 550     sq.createDatasetSequence();
 551     SequenceFeature sf1 = new SequenceFeature("Cath", "desc", 2, 4, 2f,
 552             "CathGroup");
 553     sq.addSequenceFeature(sf1);
 554     ds = PA.getValue(sq, "datasetSequence");
 555     assertNotNull(ds);
 556     assertEquals(1, sq.getStart());
 557     assertEquals(6, sq.getEnd());
 558     sq.deleteChars(2, 4);
 559     assertEquals("ABEF", sq.getSequenceAsString());
 560     assertEquals(1, sq.getStart());
 561     assertEquals(4, sq.getEnd());
 562     newDs = PA.getValue(sq, "datasetSequence");
 563     assertNotNull(newDs);
 564     assertNotSame(ds, newDs);
 565     List<SequenceFeature> sfs = sq.getSequenceFeatures();
 566     assertEquals(1, sfs.size());
 567     assertNotSame(sf1, sfs.get(0));
 568     assertEquals(sf1, sfs.get(0));
 569
 570     /*
 571      * delete at start - no new dataset sequence created
 572      * any sequence features remain as before
 573      */
 574     sq = new Sequence("test", "ABCDEF");
 575     sq.createDatasetSequence();
 576     ds = PA.getValue(sq, "datasetSequence");
 577     sf1 = new SequenceFeature("Cath", "desc", 2, 4, 2f, "CathGroup");
 578     sq.addSequenceFeature(sf1);
 579     sq.deleteChars(0, 2);
 580     assertEquals("CDEF", sq.getSequenceAsString());
 581     assertEquals(3, sq.getStart());
 582     assertEquals(6, sq.getEnd());
 583     assertSame(ds, PA.getValue(sq, "datasetSequence"));
 584     sfs = sq.getSequenceFeatures();
 585     assertNotNull(sfs);
 586     assertEquals(1, sfs.size());
 587     assertSame(sf1, sfs.get(0));
 588
 589     /*
 590      * delete at end - no new dataset sequence created
 591      * any dbrefs remain as before
 592      */
 593     sq = new Sequence("test", "ABCDEF");
 594     sq.createDatasetSequence();
 595     ds = PA.getValue(sq, "datasetSequence");
 596     dbr1 = new DBRefEntry("Uniprot", "0", "a123");
 597     sq.addDBRef(dbr1);
 598     sq.deleteChars(4, 6);
 599     assertEquals("ABCD", sq.getSequenceAsString());
 600     assertEquals(1, sq.getStart());
 601     assertEquals(4, sq.getEnd());
 602     assertSame(ds, PA.getValue(sq, "datasetSequence"));
 603     assertNotNull(sq.getDBRefs());
 604     assertEquals(1, sq.getDBRefs().length);
 605     assertSame(dbr1, sq.getDBRefs()[0]);
 606   }
 607
 608   @Test(groups = { "Functional" })
 609   public void testInsertCharAt()
 610   {
 611     // non-static methods:
 612     SequenceI sq = new Sequence("test", "ABCDEF");
 613     sq.insertCharAt(0, 'z');
 614     assertEquals("zABCDEF", sq.getSequenceAsString());
 615     sq.insertCharAt(2, 2, 'x');
 616     assertEquals("zAxxBCDEF", sq.getSequenceAsString());
 617
 618     // for static method see StringUtilsTest
 619   }
 620
 621   /**
 622    * Test the method that returns an array of aligned sequence positions where
 623    * the array index is the data sequence position (both base 0).
 624    */
 625   @Test(groups = { "Functional" })
 626   public void testGapMap()
 627   {
 628     SequenceI sq = new Sequence("test", "-A--B-CD-E--F-");
 629     sq.createDatasetSequence();
 630     assertEquals("[1, 4, 6, 7, 9, 12]", Arrays.toString(sq.gapMap()));
 631   }
 632
 633   /**
 634    * Test the method that gets sequence features, either from the sequence or
 635    * its dataset.
 636    */
 637   @Test(groups = { "Functional" })
 638   public void testGetSequenceFeatures()
 639   {
 640     SequenceI sq = new Sequence("test", "GATCAT");
 641     sq.createDatasetSequence();
 642
 643     assertTrue(sq.getSequenceFeatures().isEmpty());
 644
 645     /*
 646      * SequenceFeature on sequence
 647      */
 648     SequenceFeature sf = new SequenceFeature("Cath", "desc", 2, 4, 2f, null);
 649     sq.addSequenceFeature(sf);
 650     List<SequenceFeature> sfs = sq.getSequenceFeatures();
 651     assertEquals(1, sfs.size());
 652     assertSame(sf, sfs.get(0));
 653
 654     /*
 655      * SequenceFeature on sequence and dataset sequence; returns that on
 656      * sequence
 657      *
 658      * Note JAL-2046: spurious: we have no use case for this at the moment.
 659      * This test also buggy - as sf2.equals(sf), no new feature is added
 660      */
 661     SequenceFeature sf2 = new SequenceFeature("Cath", "desc", 2, 4, 2f,
 662             null);
 663     sq.getDatasetSequence().addSequenceFeature(sf2);
 664     sfs = sq.getSequenceFeatures();
 665     assertEquals(1, sfs.size());
 666     assertSame(sf, sfs.get(0));
 667
 668     /*
 669      * SequenceFeature on dataset sequence only
 670      * Note JAL-2046: spurious: we have no use case for setting a non-dataset sequence's feature array to null at the moment.
 671      */
 672     sq.setSequenceFeatures(null);
 673     assertTrue(sq.getDatasetSequence().getSequenceFeatures().isEmpty());
 674
 675     /*
 676      * Corrupt case - no SequenceFeature, dataset's dataset is the original
 677      * sequence. Test shows no infinite loop results.
 678      */
 679     sq.getDatasetSequence().setSequenceFeatures(null);
 680     /**
 681      * is there a usecase for this ? setDatasetSequence should throw an error if
 682      * this actually occurs.
 683      */
 684     try
 685     {
 686       sq.getDatasetSequence().setDatasetSequence(sq); // loop!
 687       Assert.fail("Expected Error to be raised when calling setDatasetSequence with self reference");
 688     } catch (IllegalArgumentException e)
 689     {
 690       // TODO Jalview error/exception class for raising implementation errors
 691       assertTrue(e.getMessage().toLowerCase()
 692               .contains("implementation error"));
 693     }
 694     assertTrue(sq.getSequenceFeatures().isEmpty());
 695   }
 696
 697   /**
 698    * Test the method that returns an array, indexed by sequence position, whose
 699    * entries are the residue positions at the sequence position (or to the right
 700    * if a gap)
 701    */
 702   @Test(groups = { "Functional" })
 703   public void testFindPositionMap()
 704   {
 705     /*
 706      * Note: Javadoc for findPosition says it returns the residue position to
 707      * the left of a gapped position; in fact it returns the position to the
 708      * right. Also it returns a non-existent residue position for a gap beyond
 709      * the sequence.
 710      */
 711     Sequence sq = new Sequence("TestSeq", "AB.C-D E.");
 712     int[] map = sq.findPositionMap();
 713     assertEquals(Arrays.toString(new int[] { 1, 2, 3, 3, 4, 4, 5, 5, 6 }),
 714             Arrays.toString(map));
 715   }
 716
 717   /**
 718    * Test for getSubsequence
 719    */
 720   @Test(groups = { "Functional" })
 721   public void testGetSubsequence()
 722   {
 723     SequenceI sq = new Sequence("TestSeq", "ABCDEFG");
 724     sq.createDatasetSequence();
 725
 726     // positions are base 0, end position is exclusive
 727     SequenceI subseq = sq.getSubSequence(2, 4);
 728
 729     assertEquals("CD", subseq.getSequenceAsString());
 730     // start/end are base 1 positions
 731     assertEquals(3, subseq.getStart());
 732     assertEquals(4, subseq.getEnd());
 733     // subsequence shares the full dataset sequence
 734     assertSame(sq.getDatasetSequence(), subseq.getDatasetSequence());
 735   }
 736
 737   /**
 738    * test createDatasetSequence behaves to doc
 739    */
 740   @Test(groups = { "Functional" })
 741   public void testCreateDatasetSequence()
 742   {
 743     SequenceI sq = new Sequence("my", "ASDASD");
 744     sq.addSequenceFeature(new SequenceFeature("type", "desc", 1, 10, 1f,
 745             "group"));
 746     sq.addDBRef(new DBRefEntry("source", "version", "accession"));
 747     assertNull(sq.getDatasetSequence());
 748     assertNotNull(PA.getValue(sq, "sequenceFeatureStore"));
 749     assertNotNull(PA.getValue(sq, "dbrefs"));
 750
 751     SequenceI rds = sq.createDatasetSequence();
 752     assertNotNull(rds);
 753     assertNull(rds.getDatasetSequence());
 754     assertSame(sq.getDatasetSequence(), rds);
 755
 756     // sequence features and dbrefs transferred to dataset sequence
 757     assertNull(PA.getValue(sq, "sequenceFeatureStore"));
 758     assertNull(PA.getValue(sq, "dbrefs"));
 759     assertNotNull(PA.getValue(rds, "sequenceFeatureStore"));
 760     assertNotNull(PA.getValue(rds, "dbrefs"));
 761   }
 762
 763   /**
 764    * Test for deriveSequence applied to a sequence with a dataset
 765    */
 766   @Test(groups = { "Functional" })
 767   public void testDeriveSequence_existingDataset()
 768   {
 769     Sequence sq = new Sequence("Seq1", "CD");
 770     sq.setDatasetSequence(new Sequence("Seq1", "ABCDEF"));
 771     sq.getDatasetSequence().addSequenceFeature(
 772             new SequenceFeature("", "", 1, 2, 0f, null));
 773     sq.setStart(3);
 774     sq.setEnd(4);
 775
 776     sq.setDescription("Test sequence description..");
 777     sq.setVamsasId("TestVamsasId");
 778     sq.addDBRef(new DBRefEntry("PDB", "version0", "1TST"));
 779
 780     sq.addDBRef(new DBRefEntry("PDB", "version1", "1PDB"));
 781     sq.addDBRef(new DBRefEntry("PDB", "version2", "2PDB"));
 782     sq.addDBRef(new DBRefEntry("PDB", "version3", "3PDB"));
 783     sq.addDBRef(new DBRefEntry("PDB", "version4", "4PDB"));
 784
 785     sq.addPDBId(new PDBEntry("1PDB", "A", Type.PDB, "filePath/test1"));
 786     sq.addPDBId(new PDBEntry("1PDB", "B", Type.PDB, "filePath/test1"));
 787     sq.addPDBId(new PDBEntry("2PDB", "A", Type.MMCIF, "filePath/test2"));
 788     sq.addPDBId(new PDBEntry("2PDB", "B", Type.MMCIF, "filePath/test2"));
 789
 790     // these are the same as ones already added
 791     DBRefEntry pdb1pdb = new DBRefEntry("PDB", "version1", "1PDB");
 792     DBRefEntry pdb2pdb = new DBRefEntry("PDB", "version2", "2PDB");
 793
 794     List<DBRefEntry> primRefs = Arrays.asList(new DBRefEntry[] { pdb1pdb,
 795         pdb2pdb });
 796
 797     sq.getDatasetSequence().addDBRef(pdb1pdb); // should do nothing
 798     sq.getDatasetSequence().addDBRef(pdb2pdb); // should do nothing
 799     sq.getDatasetSequence().addDBRef(
 800             new DBRefEntry("PDB", "version3", "3PDB")); // should do nothing
 801     sq.getDatasetSequence().addDBRef(
 802             new DBRefEntry("PDB", "version4", "4PDB")); // should do nothing
 803
 804     PDBEntry pdbe1a = new PDBEntry("1PDB", "A", Type.PDB, "filePath/test1");
 805     PDBEntry pdbe1b = new PDBEntry("1PDB", "B", Type.PDB, "filePath/test1");
 806     PDBEntry pdbe2a = new PDBEntry("2PDB", "A", Type.MMCIF,
 807             "filePath/test2");
 808     PDBEntry pdbe2b = new PDBEntry("2PDB", "B", Type.MMCIF,
 809             "filePath/test2");
 810     sq.getDatasetSequence().addPDBId(pdbe1a);
 811     sq.getDatasetSequence().addPDBId(pdbe1b);
 812     sq.getDatasetSequence().addPDBId(pdbe2a);
 813     sq.getDatasetSequence().addPDBId(pdbe2b);
 814
 815     /*
 816      * test we added pdb entries to the dataset sequence
 817      */
 818     Assert.assertEquals(sq.getDatasetSequence().getAllPDBEntries(), Arrays
 819             .asList(new PDBEntry[] { pdbe1a, pdbe1b, pdbe2a, pdbe2b }),
 820             "PDB Entries were not found on dataset sequence.");
 821
 822     /*
 823      * we should recover a pdb entry that is on the dataset sequence via PDBEntry
 824      */
 825     Assert.assertEquals(pdbe1a,
 826             sq.getDatasetSequence().getPDBEntry("1PDB"),
 827             "PDB Entry '1PDB' not found on dataset sequence via getPDBEntry.");
 828     ArrayList<Annotation> annotsList = new ArrayList<>();
 829     System.out.println(">>>>>> " + sq.getSequenceAsString().length());
 830     annotsList.add(new Annotation("A", "A", 'X', 0.1f));
 831     annotsList.add(new Annotation("A", "A", 'X', 0.1f));
 832     Annotation[] annots = annotsList.toArray(new Annotation[0]);
 833     sq.addAlignmentAnnotation(new AlignmentAnnotation("Test annot",
 834             "Test annot description", annots));
 835     sq.getDatasetSequence().addAlignmentAnnotation(
 836             new AlignmentAnnotation("Test annot", "Test annot description",
 837                     annots));
 838     Assert.assertEquals(sq.getDescription(), "Test sequence description..");
 839     Assert.assertEquals(sq.getDBRefs().length, 5); // DBRefs are on dataset
 840                                                    // sequence
 841     Assert.assertEquals(sq.getAllPDBEntries().size(), 4);
 842     Assert.assertNotNull(sq.getAnnotation());
 843     Assert.assertEquals(sq.getAnnotation()[0].annotations.length, 2);
 844     Assert.assertEquals(sq.getDatasetSequence().getDBRefs().length, 5); // same
 845                                                                         // as
 846                                                                         // sq.getDBRefs()
 847     Assert.assertEquals(sq.getDatasetSequence().getAllPDBEntries().size(),
 848             4);
 849     Assert.assertNotNull(sq.getDatasetSequence().getAnnotation());
 850
 851     Sequence derived = (Sequence) sq.deriveSequence();
 852
 853     Assert.assertEquals(derived.getDescription(),
 854             "Test sequence description..");
 855     Assert.assertEquals(derived.getDBRefs().length, 5); // come from dataset
 856     Assert.assertEquals(derived.getAllPDBEntries().size(), 4);
 857     Assert.assertNotNull(derived.getAnnotation());
 858     Assert.assertEquals(derived.getAnnotation()[0].annotations.length, 2);
 859     Assert.assertEquals(derived.getDatasetSequence().getDBRefs().length, 5);
 860     Assert.assertEquals(derived.getDatasetSequence().getAllPDBEntries()
 861             .size(), 4);
 862     Assert.assertNotNull(derived.getDatasetSequence().getAnnotation());
 863
 864     assertEquals("CD", derived.getSequenceAsString());
 865     assertSame(sq.getDatasetSequence(), derived.getDatasetSequence());
 866
 867     // derived sequence should access dataset sequence features
 868     assertNotNull(sq.getSequenceFeatures());
 869     assertEquals(sq.getSequenceFeatures(), derived.getSequenceFeatures());
 870
 871     /*
 872      *  verify we have primary db refs *just* for PDB IDs with associated
 873      *  PDBEntry objects
 874      */
 875
 876     assertEquals(primRefs, sq.getPrimaryDBRefs());
 877     assertEquals(primRefs, sq.getDatasetSequence().getPrimaryDBRefs());
 878
 879     assertEquals(sq.getPrimaryDBRefs(), derived.getPrimaryDBRefs());
 880
 881   }
 882
 883   /**
 884    * Test for deriveSequence applied to an ungapped sequence with no dataset
 885    */
 886   @Test(groups = { "Functional" })
 887   public void testDeriveSequence_noDatasetUngapped()
 888   {
 889     SequenceI sq = new Sequence("Seq1", "ABCDEF");
 890     assertEquals(1, sq.getStart());
 891     assertEquals(6, sq.getEnd());
 892     SequenceI derived = sq.deriveSequence();
 893     assertEquals("ABCDEF", derived.getSequenceAsString());
 894     assertEquals("ABCDEF", derived.getDatasetSequence()
 895             .getSequenceAsString());
 896   }
 897
 898   /**
 899    * Test for deriveSequence applied to a gapped sequence with no dataset
 900    */
 901   @Test(groups = { "Functional" })
 902   public void testDeriveSequence_noDatasetGapped()
 903   {
 904     SequenceI sq = new Sequence("Seq1", "AB-C.D EF");
 905     assertEquals(1, sq.getStart());
 906     assertEquals(6, sq.getEnd());
 907     assertNull(sq.getDatasetSequence());
 908     SequenceI derived = sq.deriveSequence();
 909     assertEquals("AB-C.D EF", derived.getSequenceAsString());
 910     assertEquals("ABCDEF", derived.getDatasetSequence()
 911             .getSequenceAsString());
 912   }
 913
 914   @Test(groups = { "Functional" })
 915   public void testCopyConstructor_noDataset()
 916   {
 917     SequenceI seq1 = new Sequence("Seq1", "AB-C.D EF");
 918     seq1.setDescription("description");
 919     seq1.addAlignmentAnnotation(new AlignmentAnnotation("label", "desc",
 920             1.3d));
 921     seq1.addSequenceFeature(new SequenceFeature("type", "desc", 22, 33,
 922             12.4f, "group"));
 923     seq1.addPDBId(new PDBEntry("1A70", "B", Type.PDB, "File"));
 924     seq1.addDBRef(new DBRefEntry("EMBL", "1.2", "AZ12345"));
 925
 926     SequenceI copy = new Sequence(seq1);
 927
 928     assertNull(copy.getDatasetSequence());
 929
 930     verifyCopiedSequence(seq1, copy);
 931
 932     // copy has a copy of the DBRefEntry
 933     // this is murky - DBrefs are only copied for dataset sequences
 934     // where the test for 'dataset sequence' is 'dataset is null'
 935     // but that doesn't distinguish it from an aligned sequence
 936     // which has not yet generated a dataset sequence
 937     // NB getDBRef looks inside dataset sequence if not null
 938     DBRefEntry[] dbrefs = copy.getDBRefs();
 939     assertEquals(1, dbrefs.length);
 940     assertFalse(dbrefs[0] == seq1.getDBRefs()[0]);
 941     assertTrue(dbrefs[0].equals(seq1.getDBRefs()[0]));
 942   }
 943
 944   @Test(groups = { "Functional" })
 945   public void testCopyConstructor_withDataset()
 946   {
 947     SequenceI seq1 = new Sequence("Seq1", "AB-C.D EF");
 948     seq1.createDatasetSequence();
 949     seq1.setDescription("description");
 950     seq1.addAlignmentAnnotation(new AlignmentAnnotation("label", "desc",
 951             1.3d));
 952     // JAL-2046 - what is the contract for using a derived sequence's
 953     // addSequenceFeature ?
 954     seq1.addSequenceFeature(new SequenceFeature("type", "desc", 22, 33,
 955             12.4f, "group"));
 956     seq1.addPDBId(new PDBEntry("1A70", "B", Type.PDB, "File"));
 957     // here we add DBRef to the dataset sequence:
 958     seq1.getDatasetSequence().addDBRef(
 959             new DBRefEntry("EMBL", "1.2", "AZ12345"));
 960
 961     SequenceI copy = new Sequence(seq1);
 962
 963     assertNotNull(copy.getDatasetSequence());
 964     assertSame(copy.getDatasetSequence(), seq1.getDatasetSequence());
 965
 966     verifyCopiedSequence(seq1, copy);
 967
 968     // getDBRef looks inside dataset sequence and this is shared,
 969     // so holds the same dbref objects
 970     DBRefEntry[] dbrefs = copy.getDBRefs();
 971     assertEquals(1, dbrefs.length);
 972     assertSame(dbrefs[0], seq1.getDBRefs()[0]);
 973   }
 974
 975   /**
 976    * Helper to make assertions about a copied sequence
 977    *
 978    * @param seq1
 979    * @param copy
 980    */
 981   protected void verifyCopiedSequence(SequenceI seq1, SequenceI copy)
 982   {
 983     // verify basic properties:
 984     assertEquals(copy.getName(), seq1.getName());
 985     assertEquals(copy.getDescription(), seq1.getDescription());
 986     assertEquals(copy.getStart(), seq1.getStart());
 987     assertEquals(copy.getEnd(), seq1.getEnd());
 988     assertEquals(copy.getSequenceAsString(), seq1.getSequenceAsString());
 989
 990     // copy has a copy of the annotation:
 991     AlignmentAnnotation[] anns = copy.getAnnotation();
 992     assertEquals(1, anns.length);
 993     assertFalse(anns[0] == seq1.getAnnotation()[0]);
 994     assertEquals(anns[0].label, seq1.getAnnotation()[0].label);
 995     assertEquals(anns[0].description, seq1.getAnnotation()[0].description);
 996     assertEquals(anns[0].score, seq1.getAnnotation()[0].score);
 997
 998     // copy has a copy of the sequence feature:
 999     List<SequenceFeature> sfs = copy.getSequenceFeatures();
1000     assertEquals(1, sfs.size());
1001     if (seq1.getDatasetSequence() != null
1002             && copy.getDatasetSequence() == seq1.getDatasetSequence())
1003     {
1004       assertSame(sfs.get(0), seq1.getSequenceFeatures().get(0));
1005     }
1006     else
1007     {
1008       assertNotSame(sfs.get(0), seq1.getSequenceFeatures().get(0));
1009     }
1010     assertEquals(sfs.get(0), seq1.getSequenceFeatures().get(0));
1011
1012     // copy has a copy of the PDB entry
1013     Vector<PDBEntry> pdbs = copy.getAllPDBEntries();
1014     assertEquals(1, pdbs.size());
1015     assertFalse(pdbs.get(0) == seq1.getAllPDBEntries().get(0));
1016     assertTrue(pdbs.get(0).equals(seq1.getAllPDBEntries().get(0)));
1017   }
1018
1019   @Test(groups = "Functional")
1020   public void testGetCharAt()
1021   {
1022     SequenceI sq = new Sequence("", "abcde");
1023     assertEquals('a', sq.getCharAt(0));
1024     assertEquals('e', sq.getCharAt(4));
1025     assertEquals(' ', sq.getCharAt(5));
1026     assertEquals(' ', sq.getCharAt(-1));
1027   }
1028
1029   @Test(groups = { "Functional" })
1030   public void testAddSequenceFeatures()
1031   {
1032     SequenceI sq = new Sequence("", "abcde");
1033     // type may not be null
1034     assertFalse(sq.addSequenceFeature(new SequenceFeature(null, "desc", 4,
1035             8, 0f, null)));
1036     assertTrue(sq.addSequenceFeature(new SequenceFeature("Cath", "desc", 4,
1037             8, 0f, null)));
1038     // can't add a duplicate feature
1039     assertFalse(sq.addSequenceFeature(new SequenceFeature("Cath", "desc",
1040             4, 8, 0f, null)));
1041     // can add a different feature
1042     assertTrue(sq.addSequenceFeature(new SequenceFeature("Scop", "desc", 4,
1043             8, 0f, null))); // different type
1044     assertTrue(sq.addSequenceFeature(new SequenceFeature("Cath",
1045             "description", 4, 8, 0f, null)));// different description
1046     assertTrue(sq.addSequenceFeature(new SequenceFeature("Cath", "desc", 3,
1047             8, 0f, null))); // different start position
1048     assertTrue(sq.addSequenceFeature(new SequenceFeature("Cath", "desc", 4,
1049             9, 0f, null))); // different end position
1050     assertTrue(sq.addSequenceFeature(new SequenceFeature("Cath", "desc", 4,
1051             8, 1f, null))); // different score
1052     assertTrue(sq.addSequenceFeature(new SequenceFeature("Cath", "desc", 4,
1053             8, Float.NaN, null))); // score NaN
1054     assertTrue(sq.addSequenceFeature(new SequenceFeature("Cath", "desc", 4,
1055             8, 0f, "Metal"))); // different group
1056     assertEquals(8, sq.getFeatures().getAllFeatures().size());
1057   }
1058
1059   /**
1060    * Tests for adding (or updating) dbrefs
1061    *
1062    * @see DBRefEntry#updateFrom(DBRefEntry)
1063    */
1064   @Test(groups = { "Functional" })
1065   public void testAddDBRef()
1066   {
1067     SequenceI sq = new Sequence("", "abcde");
1068     assertNull(sq.getDBRefs());
1069     DBRefEntry dbref = new DBRefEntry("Uniprot", "1", "P00340");
1070     sq.addDBRef(dbref);
1071     assertEquals(1, sq.getDBRefs().length);
1072     assertSame(dbref, sq.getDBRefs()[0]);
1073
1074     /*
1075      * change of version - new entry
1076      */
1077     DBRefEntry dbref2 = new DBRefEntry("Uniprot", "2", "P00340");
1078     sq.addDBRef(dbref2);
1079     assertEquals(2, sq.getDBRefs().length);
1080     assertSame(dbref, sq.getDBRefs()[0]);
1081     assertSame(dbref2, sq.getDBRefs()[1]);
1082
1083     /*
1084      * matches existing entry - not added
1085      */
1086     sq.addDBRef(new DBRefEntry("UNIPROT", "1", "p00340"));
1087     assertEquals(2, sq.getDBRefs().length);
1088
1089     /*
1090      * different source = new entry
1091      */
1092     DBRefEntry dbref3 = new DBRefEntry("UniRef", "1", "p00340");
1093     sq.addDBRef(dbref3);
1094     assertEquals(3, sq.getDBRefs().length);
1095     assertSame(dbref3, sq.getDBRefs()[2]);
1096
1097     /*
1098      * different ref = new entry
1099      */
1100     DBRefEntry dbref4 = new DBRefEntry("UniRef", "1", "p00341");
1101     sq.addDBRef(dbref4);
1102     assertEquals(4, sq.getDBRefs().length);
1103     assertSame(dbref4, sq.getDBRefs()[3]);
1104
1105     /*
1106      * matching ref with a mapping - map updated
1107      */
1108     DBRefEntry dbref5 = new DBRefEntry("UniRef", "1", "p00341");
1109     Mapping map = new Mapping(new MapList(new int[] { 1, 3 }, new int[] {
1110         1, 1 }, 3, 1));
1111     dbref5.setMap(map);
1112     sq.addDBRef(dbref5);
1113     assertEquals(4, sq.getDBRefs().length);
1114     assertSame(dbref4, sq.getDBRefs()[3]);
1115     assertSame(map, dbref4.getMap());
1116
1117     /*
1118      * 'real' version replaces "0" version
1119      */
1120     dbref2.setVersion("0");
1121     DBRefEntry dbref6 = new DBRefEntry(dbref2.getSource(), "3",
1122             dbref2.getAccessionId());
1123     sq.addDBRef(dbref6);
1124     assertEquals(4, sq.getDBRefs().length);
1125     assertSame(dbref2, sq.getDBRefs()[1]);
1126     assertEquals("3", dbref2.getVersion());
1127
1128     /*
1129      * 'real' version replaces "source:0" version
1130      */
1131     dbref3.setVersion("Uniprot:0");
1132     DBRefEntry dbref7 = new DBRefEntry(dbref3.getSource(), "3",
1133             dbref3.getAccessionId());
1134     sq.addDBRef(dbref7);
1135     assertEquals(4, sq.getDBRefs().length);
1136     assertSame(dbref3, sq.getDBRefs()[2]);
1137     assertEquals("3", dbref2.getVersion());
1138   }
1139
1140   @Test(groups = { "Functional" })
1141   public void testGetPrimaryDBRefs_peptide()
1142   {
1143     SequenceI sq = new Sequence("aseq", "ASDFKYLMQPRST", 10, 22);
1144
1145     // no dbrefs
1146     List<DBRefEntry> primaryDBRefs = sq.getPrimaryDBRefs();
1147     assertTrue(primaryDBRefs.isEmpty());
1148
1149     // empty dbrefs
1150     sq.setDBRefs(new DBRefEntry[] {});
1151     primaryDBRefs = sq.getPrimaryDBRefs();
1152     assertTrue(primaryDBRefs.isEmpty());
1153
1154     // primary - uniprot
1155     DBRefEntry upentry1 = new DBRefEntry("UNIPROT", "0", "Q04760");
1156     sq.addDBRef(upentry1);
1157
1158     // primary - uniprot with congruent map
1159     DBRefEntry upentry2 = new DBRefEntry("UNIPROT", "0", "Q04762");
1160     upentry2.setMap(new Mapping(null, new MapList(new int[] { 10, 22 },
1161             new int[] { 10, 22 }, 1, 1)));
1162     sq.addDBRef(upentry2);
1163
1164     // primary - uniprot with map of enclosing sequence
1165     DBRefEntry upentry3 = new DBRefEntry("UNIPROT", "0", "Q04763");
1166     upentry3.setMap(new Mapping(null, new MapList(new int[] { 8, 24 },
1167             new int[] { 8, 24 }, 1, 1)));
1168     sq.addDBRef(upentry3);
1169
1170     // not primary - uniprot with map of sub-sequence (5')
1171     DBRefEntry upentry4 = new DBRefEntry("UNIPROT", "0", "Q04764");
1172     upentry4.setMap(new Mapping(null, new MapList(new int[] { 10, 18 },
1173             new int[] { 10, 18 }, 1, 1)));
1174     sq.addDBRef(upentry4);
1175
1176     // not primary - uniprot with map that overlaps 3'
1177     DBRefEntry upentry5 = new DBRefEntry("UNIPROT", "0", "Q04765");
1178     upentry5.setMap(new Mapping(null, new MapList(new int[] { 12, 22 },
1179             new int[] { 12, 22 }, 1, 1)));
1180     sq.addDBRef(upentry5);
1181
1182     // not primary - uniprot with map to different coordinates frame
1183     DBRefEntry upentry6 = new DBRefEntry("UNIPROT", "0", "Q04766");
1184     upentry6.setMap(new Mapping(null, new MapList(new int[] { 12, 18 },
1185             new int[] { 112, 118 }, 1, 1)));
1186     sq.addDBRef(upentry6);
1187
1188     // not primary - dbref to 'non-core' database
1189     DBRefEntry upentry7 = new DBRefEntry("Pfam", "0", "PF00903");
1190     sq.addDBRef(upentry7);
1191
1192     // primary - type is PDB
1193     DBRefEntry pdbentry = new DBRefEntry("PDB", "0", "1qip");
1194     sq.addDBRef(pdbentry);
1195
1196     // not primary - PDBEntry has no file
1197     sq.addDBRef(new DBRefEntry("PDB", "0", "1AAA"));
1198
1199     // not primary - no PDBEntry
1200     sq.addDBRef(new DBRefEntry("PDB", "0", "1DDD"));
1201
1202     // add corroborating PDB entry for primary DBref -
1203     // needs to have a file as well as matching ID
1204     // note PDB ID is not treated as case sensitive
1205     sq.addPDBId(new PDBEntry("1QIP", null, Type.PDB, new File("/blah")
1206             .toString()));
1207
1208     // not valid DBRef - no file..
1209     sq.addPDBId(new PDBEntry("1AAA", null, null, null));
1210
1211     primaryDBRefs = sq.getPrimaryDBRefs();
1212     assertEquals(4, primaryDBRefs.size());
1213     assertTrue("Couldn't find simple primary reference (UNIPROT)",
1214             primaryDBRefs.contains(upentry1));
1215     assertTrue("Couldn't find mapped primary reference (UNIPROT)",
1216             primaryDBRefs.contains(upentry2));
1217     assertTrue("Couldn't find mapped context reference (UNIPROT)",
1218             primaryDBRefs.contains(upentry3));
1219     assertTrue("Couldn't find expected PDB primary reference",
1220             primaryDBRefs.contains(pdbentry));
1221   }
1222
1223   @Test(groups = { "Functional" })
1224   public void testGetPrimaryDBRefs_nucleotide()
1225   {
1226     SequenceI sq = new Sequence("aseq", "TGATCACTCGACTAGCATCAGCATA", 10, 34);
1227
1228     // primary - Ensembl
1229     DBRefEntry dbr1 = new DBRefEntry("ENSEMBL", "0", "ENSG1234");
1230     sq.addDBRef(dbr1);
1231
1232     // not primary - Ensembl 'transcript' mapping of sub-sequence
1233     DBRefEntry dbr2 = new DBRefEntry("ENSEMBL", "0", "ENST1234");
1234     dbr2.setMap(new Mapping(null, new MapList(new int[] { 15, 25 },
1235             new int[] { 1, 11 }, 1, 1)));
1236     sq.addDBRef(dbr2);
1237
1238     // primary - EMBL with congruent map
1239     DBRefEntry dbr3 = new DBRefEntry("EMBL", "0", "J1234");
1240     dbr3.setMap(new Mapping(null, new MapList(new int[] { 10, 34 },
1241             new int[] { 10, 34 }, 1, 1)));
1242     sq.addDBRef(dbr3);
1243
1244     // not primary - to non-core database
1245     DBRefEntry dbr4 = new DBRefEntry("CCDS", "0", "J1234");
1246     sq.addDBRef(dbr4);
1247
1248     // not primary - to protein
1249     DBRefEntry dbr5 = new DBRefEntry("UNIPROT", "0", "Q87654");
1250     sq.addDBRef(dbr5);
1251
1252     List<DBRefEntry> primaryDBRefs = sq.getPrimaryDBRefs();
1253     assertEquals(2, primaryDBRefs.size());
1254     assertTrue(primaryDBRefs.contains(dbr1));
1255     assertTrue(primaryDBRefs.contains(dbr3));
1256   }
1257
1258   /**
1259    * Test the method that updates the list of PDBEntry from any new DBRefEntry
1260    * for PDB
1261    */
1262   @Test(groups = { "Functional" })
1263   public void testUpdatePDBIds()
1264   {
1265     PDBEntry pdbe1 = new PDBEntry("3A6S", null, null, null);
1266     seq.addPDBId(pdbe1);
1267     seq.addDBRef(new DBRefEntry("Ensembl", "8", "ENST1234"));
1268     seq.addDBRef(new DBRefEntry("PDB", "0", "1A70"));
1269     seq.addDBRef(new DBRefEntry("PDB", "0", "4BQGa"));
1270     seq.addDBRef(new DBRefEntry("PDB", "0", "3a6sB"));
1271     // 7 is not a valid chain code:
1272     seq.addDBRef(new DBRefEntry("PDB", "0", "2GIS7"));
1273
1274     seq.updatePDBIds();
1275     List<PDBEntry> pdbIds = seq.getAllPDBEntries();
1276     assertEquals(4, pdbIds.size());
1277     assertSame(pdbe1, pdbIds.get(0));
1278     // chain code got added to 3A6S:
1279     assertEquals("B", pdbe1.getChainCode());
1280     assertEquals("1A70", pdbIds.get(1).getId());
1281     // 4BQGA is parsed into id + chain
1282     assertEquals("4BQG", pdbIds.get(2).getId());
1283     assertEquals("a", pdbIds.get(2).getChainCode());
1284     assertEquals("2GIS7", pdbIds.get(3).getId());
1285     assertNull(pdbIds.get(3).getChainCode());
1286   }
1287
1288   /**
1289    * Test the method that either adds a pdbid or updates an existing one
1290    */
1291   @Test(groups = { "Functional" })
1292   public void testAddPDBId()
1293   {
1294     PDBEntry pdbe = new PDBEntry("3A6S", null, null, null);
1295     seq.addPDBId(pdbe);
1296     assertEquals(1, seq.getAllPDBEntries().size());
1297     assertSame(pdbe, seq.getPDBEntry("3A6S"));
1298     assertSame(pdbe, seq.getPDBEntry("3a6s")); // case-insensitive
1299
1300     // add the same entry
1301     seq.addPDBId(pdbe);
1302     assertEquals(1, seq.getAllPDBEntries().size());
1303     assertSame(pdbe, seq.getPDBEntry("3A6S"));
1304
1305     // add an identical entry
1306     seq.addPDBId(new PDBEntry("3A6S", null, null, null));
1307     assertEquals(1, seq.getAllPDBEntries().size());
1308     assertSame(pdbe, seq.getPDBEntry("3A6S"));
1309
1310     // add a different entry
1311     PDBEntry pdbe2 = new PDBEntry("1A70", null, null, null);
1312     seq.addPDBId(pdbe2);
1313     assertEquals(2, seq.getAllPDBEntries().size());
1314     assertSame(pdbe, seq.getAllPDBEntries().get(0));
1315     assertSame(pdbe2, seq.getAllPDBEntries().get(1));
1316
1317     // update pdbe with chain code, file, type
1318     PDBEntry pdbe3 = new PDBEntry("3a6s", "A", Type.PDB, "filepath");
1319     seq.addPDBId(pdbe3);
1320     assertEquals(2, seq.getAllPDBEntries().size());
1321     assertSame(pdbe, seq.getAllPDBEntries().get(0)); // updated in situ
1322     assertEquals("3A6S", pdbe.getId()); // unchanged
1323     assertEquals("A", pdbe.getChainCode()); // updated
1324     assertEquals(Type.PDB.toString(), pdbe.getType()); // updated
1325     assertEquals("filepath", pdbe.getFile()); // updated
1326     assertSame(pdbe2, seq.getAllPDBEntries().get(1));
1327
1328     // add with a different file path
1329     PDBEntry pdbe4 = new PDBEntry("3a6s", "A", Type.PDB, "filepath2");
1330     seq.addPDBId(pdbe4);
1331     assertEquals(3, seq.getAllPDBEntries().size());
1332     assertSame(pdbe4, seq.getAllPDBEntries().get(2));
1333
1334     // add with a different chain code
1335     PDBEntry pdbe5 = new PDBEntry("3a6s", "B", Type.PDB, "filepath");
1336     seq.addPDBId(pdbe5);
1337     assertEquals(4, seq.getAllPDBEntries().size());
1338     assertSame(pdbe5, seq.getAllPDBEntries().get(3));
1339   }
1340
1341   @Test(
1342     groups = { "Functional" },
1343     expectedExceptions = { IllegalArgumentException.class })
1344   public void testSetDatasetSequence_toSelf()
1345   {
1346     seq.setDatasetSequence(seq);
1347   }
1348
1349   @Test(
1350     groups = { "Functional" },
1351     expectedExceptions = { IllegalArgumentException.class })
1352   public void testSetDatasetSequence_cascading()
1353   {
1354     SequenceI seq2 = new Sequence("Seq2", "xyz");
1355     seq2.createDatasetSequence();
1356     seq.setDatasetSequence(seq2);
1357   }
1358
1359   @Test(groups = { "Functional" })
1360   public void testFindFeatures()
1361   {
1362     SequenceI sq = new Sequence("test/8-16", "-ABC--DEF--GHI--");
1363     sq.createDatasetSequence();
1364
1365     assertTrue(sq.findFeatures(1, 99).isEmpty());
1366
1367     // add non-positional feature
1368     SequenceFeature sf0 = new SequenceFeature("Cath", "desc", 0, 0, 2f,
1369             null);
1370     sq.addSequenceFeature(sf0);
1371     // add feature on BCD
1372     SequenceFeature sfBCD = new SequenceFeature("Cath", "desc", 9, 11, 2f,
1373             null);
1374     sq.addSequenceFeature(sfBCD);
1375     // add feature on DE
1376     SequenceFeature sfDE = new SequenceFeature("Cath", "desc", 11, 12, 2f,
1377             null);
1378     sq.addSequenceFeature(sfDE);
1379     // add contact feature at [B, H]
1380     SequenceFeature sfContactBH = new SequenceFeature("Disulphide bond",
1381             "desc", 9, 15, 2f, null);
1382     sq.addSequenceFeature(sfContactBH);
1383     // add contact feature at [F, G]
1384     SequenceFeature sfContactFG = new SequenceFeature("Disulfide Bond",
1385             "desc", 13, 14, 2f, null);
1386     sq.addSequenceFeature(sfContactFG);
1387     // add single position feature at [I]
1388     SequenceFeature sfI = new SequenceFeature("Disulfide Bond",
1389             "desc", 16, 16, null);
1390     sq.addSequenceFeature(sfI);
1391
1392     // no features in columns 1-2 (-A)
1393     List<SequenceFeature> found = sq.findFeatures(1, 2);
1394     assertTrue(found.isEmpty());
1395
1396     // columns 1-6 (-ABC--) includes BCD and B/H feature but not DE
1397     found = sq.findFeatures(1, 6);
1398     assertEquals(2, found.size());
1399     assertTrue(found.contains(sfBCD));
1400     assertTrue(found.contains(sfContactBH));
1401
1402     // columns 5-6 (--) includes (enclosing) BCD but not (contact) B/H feature
1403     found = sq.findFeatures(5, 6);
1404     assertEquals(1, found.size());
1405     assertTrue(found.contains(sfBCD));
1406
1407     // columns 7-10 (DEF-) includes BCD, DE, F/G but not B/H feature
1408     found = sq.findFeatures(7, 10);
1409     assertEquals(3, found.size());
1410     assertTrue(found.contains(sfBCD));
1411     assertTrue(found.contains(sfDE));
1412     assertTrue(found.contains(sfContactFG));
1413
1414     // columns 10-11 (--) should find nothing
1415     found = sq.findFeatures(10, 11);
1416     assertEquals(0, found.size());
1417
1418     // columns 14-14 (I) should find variant feature
1419     found = sq.findFeatures(14, 14);
1420     assertEquals(1, found.size());
1421     assertTrue(found.contains(sfI));
1422   }
1423
1424   @Test(groups = { "Functional" })
1425   public void testFindIndex_withCursor()
1426   {
1427     Sequence sq = new Sequence("test/8-13", "-A--BCD-EF--");
1428
1429     // find F given A, check cursor is now at the found position
1430     assertEquals(10, sq.findIndex(13, new SequenceCursor(sq, 8, 2, 0)));
1431     SequenceCursor cursor = (SequenceCursor) PA.getValue(sq, "cursor");
1432     assertEquals(13, cursor.residuePosition);
1433     assertEquals(10, cursor.columnPosition);
1434
1435     // find A given F
1436     assertEquals(2, sq.findIndex(8, new SequenceCursor(sq, 13, 10, 0)));
1437     cursor = (SequenceCursor) PA.getValue(sq, "cursor");
1438     assertEquals(8, cursor.residuePosition);
1439     assertEquals(2, cursor.columnPosition);
1440
1441     // find C given C (no cursor update is done for this case)
1442     assertEquals(6, sq.findIndex(10, new SequenceCursor(sq, 10, 6, 0)));
1443     SequenceCursor cursor2 = (SequenceCursor) PA.getValue(sq, "cursor");
1444     assertSame(cursor2, cursor);
1445
1446     /*
1447      * sequence 'end' beyond end of sequence returns length of sequence
1448      *  (for compatibility with pre-cursor code)
1449      *  - also verify the cursor is left in a valid state
1450      */
1451     sq = new Sequence("test/8-99", "-A--B-C-D-E-F--"); // trailing gap case
1452     assertEquals(7, sq.findIndex(10)); // establishes a cursor
1453     cursor = (SequenceCursor) PA.getValue(sq, "cursor");
1454     assertEquals(10, cursor.residuePosition);
1455     assertEquals(7, cursor.columnPosition);
1456     assertEquals(sq.getLength(), sq.findIndex(65));
1457     cursor2 = (SequenceCursor) PA.getValue(sq, "cursor");
1458     assertSame(cursor, cursor2); // not updated for this case!
1459
1460     sq = new Sequence("test/8-99", "-A--B-C-D-E-F"); // trailing residue case
1461     sq.findIndex(10); // establishes a cursor
1462     cursor = (SequenceCursor) PA.getValue(sq, "cursor");
1463     assertEquals(sq.getLength(), sq.findIndex(65));
1464     cursor2 = (SequenceCursor) PA.getValue(sq, "cursor");
1465     assertSame(cursor, cursor2); // not updated for this case!
1466
1467     /*
1468      * residue after sequence 'start' but before first residue should return
1469      * zero (for compatibility with pre-cursor code)
1470      */
1471     sq = new Sequence("test/8-15", "-A-B-C-"); // leading gap case
1472     sq.findIndex(10); // establishes a cursor
1473     cursor = (SequenceCursor) PA.getValue(sq, "cursor");
1474     assertEquals(0, sq.findIndex(3));
1475     cursor2 = (SequenceCursor) PA.getValue(sq, "cursor");
1476     assertSame(cursor, cursor2); // not updated for this case!
1477
1478     sq = new Sequence("test/8-15", "A-B-C-"); // leading residue case
1479     sq.findIndex(10); // establishes a cursor
1480     cursor = (SequenceCursor) PA.getValue(sq, "cursor");
1481     assertEquals(0, sq.findIndex(2));
1482     cursor2 = (SequenceCursor) PA.getValue(sq, "cursor");
1483     assertSame(cursor, cursor2); // not updated for this case!
1484   }
1485
1486   @Test(groups = { "Functional" })
1487   public void testFindPosition_withCursor()
1488   {
1489     Sequence sq = new Sequence("test/8-13", "-A--BCD-EF--");
1490
1491     // find F pos given A - lastCol gets set in cursor
1492     assertEquals(13, sq.findPosition(10, new SequenceCursor(sq, 8, 2, 0)));
1493     assertEquals("test:Pos13:Col10:startCol0:endCol10:tok0",
1494             PA.getValue(sq, "cursor").toString());
1495
1496     // find A pos given F - first residue column is saved in cursor
1497     assertEquals(8, sq.findPosition(2, new SequenceCursor(sq, 13, 10, 0)));
1498     assertEquals("test:Pos8:Col2:startCol2:endCol10:tok0",
1499             PA.getValue(sq, "cursor").toString());
1500
1501     // find C pos given C (neither startCol nor endCol is set)
1502     assertEquals(10, sq.findPosition(6, new SequenceCursor(sq, 10, 6, 0)));
1503     assertEquals("test:Pos10:Col6:startCol0:endCol0:tok0",
1504             PA.getValue(sq, "cursor").toString());
1505
1506     // now the grey area - what residue position for a gapped column? JAL-2562
1507
1508     // find 'residue' for column 3 given cursor for D (so working left)
1509     // returns B9; cursor is updated to [B 5]
1510     assertEquals(9, sq.findPosition(3, new SequenceCursor(sq, 11, 7, 0)));
1511     assertEquals("test:Pos9:Col5:startCol0:endCol0:tok0",
1512             PA.getValue(sq, "cursor").toString());
1513
1514     // find 'residue' for column 8 given cursor for D (so working right)
1515     // returns E12; cursor is updated to [D 7]
1516     assertEquals(12, sq.findPosition(8, new SequenceCursor(sq, 11, 7, 0)));
1517     assertEquals("test:Pos11:Col7:startCol0:endCol0:tok0",
1518             PA.getValue(sq, "cursor").toString());
1519
1520     // find 'residue' for column 12 given cursor for B
1521     // returns 1 more than last residue position; cursor is updated to [F 10]
1522     // lastCol position is saved in cursor
1523     assertEquals(14, sq.findPosition(12, new SequenceCursor(sq, 9, 5, 0)));
1524     assertEquals("test:Pos13:Col10:startCol0:endCol10:tok0",
1525             PA.getValue(sq, "cursor").toString());
1526
1527     /*
1528      * findPosition for column beyond length of sequence
1529      * returns 1 more than the last residue position
1530      * cursor is set to last real residue position [F 10]
1531      */
1532     assertEquals(14, sq.findPosition(99, new SequenceCursor(sq, 8, 2, 0)));
1533     assertEquals("test:Pos13:Col10:startCol0:endCol10:tok0",
1534             PA.getValue(sq, "cursor").toString());
1535
1536     /*
1537      * and the case without a trailing gap
1538      */
1539     sq = new Sequence("test/8-13", "-A--BCD-EF");
1540     // first find C from A
1541     assertEquals(10, sq.findPosition(6, new SequenceCursor(sq, 8, 2, 0)));
1542     SequenceCursor cursor = (SequenceCursor) PA.getValue(sq, "cursor");
1543     assertEquals("test:Pos10:Col6:startCol0:endCol0:tok0",
1544             cursor.toString());
1545     // now 'find' 99 from C
1546     // cursor is set to [F 10] and saved lastCol
1547     assertEquals(14, sq.findPosition(99, cursor));
1548     assertEquals("test:Pos13:Col10:startCol0:endCol10:tok0",
1549             PA.getValue(sq, "cursor").toString());
1550   }
1551
1552   @Test
1553   public void testIsValidCursor()
1554   {
1555     Sequence sq = new Sequence("Seq", "ABC--DE-F", 8, 13);
1556     assertFalse(sq.isValidCursor(null));
1557
1558     /*
1559      * cursor is valid if it has valid sequence ref and changeCount token
1560      * and positions within the range of the sequence
1561      */
1562     int changeCount = (int) PA.getValue(sq, "changeCount");
1563     SequenceCursor cursor = new SequenceCursor(sq, 13, 1, changeCount);
1564     assertTrue(sq.isValidCursor(cursor));
1565
1566     /*
1567      * column position outside [0 - length] is rejected
1568      */
1569     cursor = new SequenceCursor(sq, 13, -1, changeCount);
1570     assertFalse(sq.isValidCursor(cursor));
1571     cursor = new SequenceCursor(sq, 13, 10, changeCount);
1572     assertFalse(sq.isValidCursor(cursor));
1573     cursor = new SequenceCursor(sq, 7, 8, changeCount);
1574     assertFalse(sq.isValidCursor(cursor));
1575     cursor = new SequenceCursor(sq, 14, 2, changeCount);
1576     assertFalse(sq.isValidCursor(cursor));
1577
1578     /*
1579      * wrong sequence is rejected
1580      */
1581     cursor = new SequenceCursor(null, 13, 1, changeCount);
1582     assertFalse(sq.isValidCursor(cursor));
1583     cursor = new SequenceCursor(new Sequence("Seq", "abc"), 13, 1,
1584             changeCount);
1585     assertFalse(sq.isValidCursor(cursor));
1586
1587     /*
1588      * wrong token value is rejected
1589      */
1590     cursor = new SequenceCursor(sq, 13, 1, changeCount + 1);
1591     assertFalse(sq.isValidCursor(cursor));
1592     cursor = new SequenceCursor(sq, 13, 1, changeCount - 1);
1593     assertFalse(sq.isValidCursor(cursor));
1594   }
1595
1596   @Test(groups = { "Functional" })
1597   public void testFindPosition_withCursorAndEdits()
1598   {
1599     Sequence sq = new Sequence("test/8-13", "-A--BCD-EF--");
1600
1601     // find F pos given A
1602     assertEquals(13, sq.findPosition(10, new SequenceCursor(sq, 8, 2, 0)));
1603     int token = (int) PA.getValue(sq, "changeCount"); // 0
1604     SequenceCursor cursor = (SequenceCursor) PA.getValue(sq, "cursor");
1605     assertEquals(new SequenceCursor(sq, 13, 10, token), cursor);
1606
1607     /*
1608      * setSequence should invalidate the cursor cached by the sequence
1609      */
1610     sq.setSequence("-A-BCD-EF---"); // one gap removed
1611     assertEquals(8, sq.getStart()); // sanity check
1612     assertEquals(11, sq.findPosition(5)); // D11
1613     // cursor should now be at [D 6]
1614     cursor = (SequenceCursor) PA.getValue(sq, "cursor");
1615     assertEquals(new SequenceCursor(sq, 11, 6, ++token), cursor);
1616
1617     /*
1618      * deleteChars should invalidate the cached cursor
1619      */
1620     sq.deleteChars(2, 5); // delete -BC
1621     assertEquals("-AD-EF---", sq.getSequenceAsString());
1622     assertEquals(8, sq.getStart()); // sanity check
1623     assertEquals(10, sq.findPosition(4)); // E10
1624     // cursor should now be at [E 5]
1625     cursor = (SequenceCursor) PA.getValue(sq, "cursor");
1626     assertEquals(new SequenceCursor(sq, 10, 5, ++token), cursor);
1627
1628     /*
1629      * Edit to insert gaps should invalidate the cached cursor
1630      * insert 2 gaps at column[3] to make -AD---EF---
1631      */
1632     SequenceI[] seqs = new SequenceI[] { sq };
1633     AlignmentI al = new Alignment(seqs);
1634     new EditCommand().appendEdit(Action.INSERT_GAP, seqs, 3, 2, al, true);
1635     assertEquals("-AD---EF---", sq.getSequenceAsString());
1636     assertEquals(10, sq.findPosition(4)); // E10
1637     // cursor should now be at [D 3]
1638     cursor = (SequenceCursor) PA.getValue(sq, "cursor");
1639     assertEquals(new SequenceCursor(sq, 9, 3, ++token), cursor);
1640
1641     /*
1642      * insertCharAt should invalidate the cached cursor
1643      * insert CC at column[4] to make -AD-CC--EF---
1644      */
1645     sq.insertCharAt(4, 2, 'C');
1646     assertEquals("-AD-CC--EF---", sq.getSequenceAsString());
1647     assertEquals(13, sq.findPosition(9)); // F13
1648     // cursor should now be at [F 10]
1649     cursor = (SequenceCursor) PA.getValue(sq, "cursor");
1650     assertEquals(new SequenceCursor(sq, 13, 10, ++token), cursor);
1651   }
1652
1653   @Test(groups = { "Functional" })
1654   public void testGetSequence()
1655   {
1656     String seqstring = "-A--BCD-EF--";
1657     Sequence sq = new Sequence("test/8-13", seqstring);
1658     sq.createDatasetSequence();
1659     assertTrue(Arrays.equals(sq.getSequence(), seqstring.toCharArray()));
1660     assertTrue(Arrays.equals(sq.getDatasetSequence().getSequence(),
1661             "ABCDEF".toCharArray()));
1662
1663     // verify a copy of the sequence array is returned
1664     char[] theSeq = (char[]) PA.getValue(sq, "sequence");
1665     assertNotSame(theSeq, sq.getSequence());
1666     theSeq = (char[]) PA.getValue(sq.getDatasetSequence(), "sequence");
1667     assertNotSame(theSeq, sq.getDatasetSequence().getSequence());
1668   }
1669
1670   @Test(groups = { "Functional" })
1671   public void testReplace()
1672   {
1673     String seqstring = "-A--BCD-EF--";
1674     SequenceI sq = new Sequence("test/8-13", seqstring);
1675     assertEquals(0, PA.getValue(sq, "changeCount"));
1676
1677     assertEquals(0, sq.replace('A', 'A')); // same char
1678     assertEquals(seqstring, sq.getSequenceAsString());
1679     assertEquals(0, PA.getValue(sq, "changeCount"));
1680
1681     assertEquals(0, sq.replace('X', 'Y')); // not there
1682     assertEquals(seqstring, sq.getSequenceAsString());
1683     assertEquals(0, PA.getValue(sq, "changeCount"));
1684
1685     assertEquals(1, sq.replace('A', 'K'));
1686     assertEquals("-K--BCD-EF--", sq.getSequenceAsString());
1687     assertEquals(1, PA.getValue(sq, "changeCount"));
1688
1689     assertEquals(6, sq.replace('-', '.'));
1690     assertEquals(".K..BCD.EF..", sq.getSequenceAsString());
1691     assertEquals(2, PA.getValue(sq, "changeCount"));
1692   }
1693
1694   @Test(groups = { "Functional" })
1695   public void testFindPositions()
1696   {
1697     SequenceI sq = new Sequence("test/8-13", "-ABC---DE-F--");
1698
1699     /*
1700      * invalid inputs
1701      */
1702     assertNull(sq.findPositions(6, 5));
1703     assertNull(sq.findPositions(0, 5));
1704     assertNull(sq.findPositions(-1, 5));
1705
1706     /*
1707      * all gapped ranges
1708      */
1709     assertNull(sq.findPositions(1, 1)); // 1-based columns
1710     assertNull(sq.findPositions(5, 5));
1711     assertNull(sq.findPositions(5, 6));
1712     assertNull(sq.findPositions(5, 7));
1713
1714     /*
1715      * all ungapped ranges
1716      */
1717     assertEquals(new Range(8, 8), sq.findPositions(2, 2)); // A
1718     assertEquals(new Range(8, 9), sq.findPositions(2, 3)); // AB
1719     assertEquals(new Range(8, 10), sq.findPositions(2, 4)); // ABC
1720     assertEquals(new Range(9, 10), sq.findPositions(3, 4)); // BC
1721
1722     /*
1723      * gap to ungapped range
1724      */
1725     assertEquals(new Range(8, 10), sq.findPositions(1, 4)); // ABC
1726     assertEquals(new Range(11, 12), sq.findPositions(6, 9)); // DE
1727
1728     /*
1729      * ungapped to gapped range
1730      */
1731     assertEquals(new Range(10, 10), sq.findPositions(4, 5)); // C
1732     assertEquals(new Range(9, 13), sq.findPositions(3, 11)); // BCDEF
1733
1734     /*
1735      * ungapped to ungapped enclosing gaps
1736      */
1737     assertEquals(new Range(10, 11), sq.findPositions(4, 8)); // CD
1738     assertEquals(new Range(8, 13), sq.findPositions(2, 11)); // ABCDEF
1739
1740     /*
1741      * gapped to gapped enclosing ungapped
1742      */
1743     assertEquals(new Range(8, 10), sq.findPositions(1, 5)); // ABC
1744     assertEquals(new Range(11, 12), sq.findPositions(5, 10)); // DE
1745     assertEquals(new Range(8, 13), sq.findPositions(1, 13)); // the lot
1746     assertEquals(new Range(8, 13), sq.findPositions(1, 99));
1747   }
1748
1749   @Test(groups = { "Functional" })
1750   public void testGapBitset()
1751   {
1752     SequenceI sq = new Sequence("test/8-13", "-ABC---DE-F--");
1753     BitSet bs = sq.gapBitset();
1754     BitSet expected = new BitSet();
1755     expected.set(0);
1756     expected.set(4, 7);
1757     expected.set(9);
1758     expected.set(11, 13);
1759
1760     assertTrue(bs.equals(expected));
1761
1762   }
1763
1764   public void testFindFeatures_largeEndPos()
1765   {
1766     /*
1767      * imitate a PDB sequence where end is larger than end position
1768      */
1769     SequenceI sq = new Sequence("test", "-ABC--DEF--", 1, 20);
1770     sq.createDatasetSequence();
1771
1772     assertTrue(sq.findFeatures(1, 9).isEmpty());
1773     // should be no array bounds exception - JAL-2772
1774     assertTrue(sq.findFeatures(1, 15).isEmpty());
1775
1776     // add feature on BCD
1777     SequenceFeature sfBCD = new SequenceFeature("Cath", "desc", 2, 4, 2f,
1778             null);
1779     sq.addSequenceFeature(sfBCD);
1780
1781     // no features in columns 1-2 (-A)
1782     List<SequenceFeature> found = sq.findFeatures(1, 2);
1783     assertTrue(found.isEmpty());
1784
1785     // columns 1-6 (-ABC--) includes BCD
1786     found = sq.findFeatures(1, 6);
1787     assertEquals(1, found.size());
1788     assertTrue(found.contains(sfBCD));
1789
1790     // columns 10-11 (--) should find nothing
1791     found = sq.findFeatures(10, 11);
1792     assertEquals(0, found.size());
1793   }
1794
1795   @Test(groups = { "Functional" })
1796   public void testSetName()
1797   {
1798     SequenceI sq = new Sequence("test", "-ABC---DE-F--");
1799     assertEquals("test", sq.getName());
1800     assertEquals(1, sq.getStart());
1801     assertEquals(6, sq.getEnd());
1802
1803     sq.setName("testing");
1804     assertEquals("testing", sq.getName());
1805
1806     sq.setName("test/8-10");
1807     assertEquals("test", sq.getName());
1808     assertEquals(8, sq.getStart());
1809     assertEquals(13, sq.getEnd()); // note end is recomputed
1810
1811     sq.setName("testing/7-99");
1812     assertEquals("testing", sq.getName());
1813     assertEquals(7, sq.getStart());
1814     assertEquals(99, sq.getEnd()); // end may be beyond physical end
1815
1816     sq.setName("/2-3");
1817     assertEquals("", sq.getName());
1818     assertEquals(2, sq.getStart());
1819     assertEquals(7, sq.getEnd());
1820
1821     sq.setName("test/"); // invalid
1822     assertEquals("test/", sq.getName());
1823     assertEquals(2, sq.getStart());
1824     assertEquals(7, sq.getEnd());
1825
1826     sq.setName("test/6-13/7-99");
1827     assertEquals("test/6-13", sq.getName());
1828     assertEquals(7, sq.getStart());
1829     assertEquals(99, sq.getEnd());
1830
1831     sq.setName("test/0-5"); // 0 is invalid - ignored
1832     assertEquals("test/0-5", sq.getName());
1833     assertEquals(7, sq.getStart());
1834     assertEquals(99, sq.getEnd());
1835
1836     sq.setName("test/a-5"); // a is invalid - ignored
1837     assertEquals("test/a-5", sq.getName());
1838     assertEquals(7, sq.getStart());
1839     assertEquals(99, sq.getEnd());
1840
1841     sq.setName("test/6-5"); // start > end is invalid - ignored
1842     assertEquals("test/6-5", sq.getName());
1843     assertEquals(7, sq.getStart());
1844     assertEquals(99, sq.getEnd());
1845
1846     sq.setName("test/5"); // invalid - ignored
1847     assertEquals("test/5", sq.getName());
1848     assertEquals(7, sq.getStart());
1849     assertEquals(99, sq.getEnd());
1850
1851     sq.setName("test/-5"); // invalid - ignored
1852     assertEquals("test/-5", sq.getName());
1853     assertEquals(7, sq.getStart());
1854     assertEquals(99, sq.getEnd());
1855
1856     sq.setName("test/5-"); // invalid - ignored
1857     assertEquals("test/5-", sq.getName());
1858     assertEquals(7, sq.getStart());
1859     assertEquals(99, sq.getEnd());
1860
1861     sq.setName("test/5-6-7"); // invalid - ignored
1862     assertEquals("test/5-6-7", sq.getName());
1863     assertEquals(7, sq.getStart());
1864     assertEquals(99, sq.getEnd());
1865
1866     sq.setName(null); // invalid, gets converted to space
1867     assertEquals("", sq.getName());
1868     assertEquals(7, sq.getStart());
1869     assertEquals(99, sq.getEnd());
1870   }
1871
1872   @Test(groups = { "Functional" })
1873   public void testCheckValidRange()
1874   {
1875     Sequence sq = new Sequence("test/7-12", "-ABC---DE-F--");
1876     assertEquals(7, sq.getStart());
1877     assertEquals(12, sq.getEnd());
1878
1879     /*
1880      * checkValidRange ensures end is at least the last residue position
1881      */
1882     PA.setValue(sq, "end", 2);
1883     sq.checkValidRange();
1884     assertEquals(12, sq.getEnd());
1885
1886     /*
1887      * end may be beyond the last residue position
1888      */
1889     PA.setValue(sq, "end", 22);
1890     sq.checkValidRange();
1891     assertEquals(22, sq.getEnd());
1892   }
1893
1894   @Test(groups = { "Functional" })
1895   public void testDeleteChars_withGaps()
1896   {
1897     /*
1898      * delete gaps only
1899      */
1900     SequenceI sq = new Sequence("test/8-10", "A-B-C");
1901     sq.createDatasetSequence();
1902     assertEquals("ABC", sq.getDatasetSequence().getSequenceAsString());
1903     sq.deleteChars(1, 2); // delete first gap
1904     assertEquals("AB-C", sq.getSequenceAsString());
1905     assertEquals(8, sq.getStart());
1906     assertEquals(10, sq.getEnd());
1907     assertEquals("ABC", sq.getDatasetSequence().getSequenceAsString());
1908
1909     /*
1910      * delete gaps and residues at start (no new dataset sequence)
1911      */
1912     sq = new Sequence("test/8-10", "A-B-C");
1913     sq.createDatasetSequence();
1914     sq.deleteChars(0, 3); // delete A-B
1915     assertEquals("-C", sq.getSequenceAsString());
1916     assertEquals(10, sq.getStart());
1917     assertEquals(10, sq.getEnd());
1918     assertEquals("ABC", sq.getDatasetSequence().getSequenceAsString());
1919
1920     /*
1921      * delete gaps and residues at end (no new dataset sequence)
1922      */
1923     sq = new Sequence("test/8-10", "A-B-C");
1924     sq.createDatasetSequence();
1925     sq.deleteChars(2, 5); // delete B-C
1926     assertEquals("A-", sq.getSequenceAsString());
1927     assertEquals(8, sq.getStart());
1928     assertEquals(8, sq.getEnd());
1929     assertEquals("ABC", sq.getDatasetSequence().getSequenceAsString());
1930
1931     /*
1932      * delete gaps and residues internally (new dataset sequence)
1933      * first delete from gap to residue
1934      */
1935     sq = new Sequence("test/8-10", "A-B-C");
1936     sq.createDatasetSequence();
1937     sq.deleteChars(1, 3); // delete -B
1938     assertEquals("A-C", sq.getSequenceAsString());
1939     assertEquals(8, sq.getStart());
1940     assertEquals(9, sq.getEnd());
1941     assertEquals("AC", sq.getDatasetSequence().getSequenceAsString());
1942     assertEquals(8, sq.getDatasetSequence().getStart());
1943     assertEquals(9, sq.getDatasetSequence().getEnd());
1944
1945     /*
1946      * internal delete from gap to gap
1947      */
1948     sq = new Sequence("test/8-10", "A-B-C");
1949     sq.createDatasetSequence();
1950     sq.deleteChars(1, 4); // delete -B-
1951     assertEquals("AC", sq.getSequenceAsString());
1952     assertEquals(8, sq.getStart());
1953     assertEquals(9, sq.getEnd());
1954     assertEquals("AC", sq.getDatasetSequence().getSequenceAsString());
1955     assertEquals(8, sq.getDatasetSequence().getStart());
1956     assertEquals(9, sq.getDatasetSequence().getEnd());
1957
1958     /*
1959      * internal delete from residue to residue
1960      */
1961     sq = new Sequence("test/8-10", "A-B-C");
1962     sq.createDatasetSequence();
1963     sq.deleteChars(2, 3); // delete B
1964     assertEquals("A--C", sq.getSequenceAsString());
1965     assertEquals(8, sq.getStart());
1966     assertEquals(9, sq.getEnd());
1967     assertEquals("AC", sq.getDatasetSequence().getSequenceAsString());
1968     assertEquals(8, sq.getDatasetSequence().getStart());
1969     assertEquals(9, sq.getDatasetSequence().getEnd());
1970   }
1971
1972   /**
1973    * Test the code used to locate the reference sequence ruler origin
1974    */
1975   @Test(groups = { "Functional" })
1976   public void testLocateVisibleStartofSequence()
1977   {
1978     // create random alignment
1979     AlignmentGenerator gen = new AlignmentGenerator(false);
1980     AlignmentI al = gen.generate(50, 20, 123, 5, 5);
1981
1982     HiddenColumns cs = al.getHiddenColumns();
1983     ColumnSelection colsel = new ColumnSelection();
1984
1985     SequenceI seq = new Sequence("RefSeq", "-A-SD-ASD--E---");
1986     assertEquals(2, seq.findIndex(seq.getStart()));
1987
1988     // no hidden columns
1989     assertEquals(seq.findIndex(seq.getStart()) - 1,
1990             seq.firstResidueOutsideIterator(cs.iterator()));
1991
1992     // hidden column on gap after end of sequence - should not affect bounds
1993     colsel.hideSelectedColumns(13, al.getHiddenColumns());
1994     assertEquals(seq.findIndex(seq.getStart()) - 1,
1995             seq.firstResidueOutsideIterator(cs.iterator()));
1996
1997     cs.revealAllHiddenColumns(colsel);
1998     // hidden column on gap before beginning of sequence - should vis bounds by
1999     // one
2000     colsel.hideSelectedColumns(0, al.getHiddenColumns());
2001     assertEquals(seq.findIndex(seq.getStart()) - 2,
2002             cs.absoluteToVisibleColumn(
2003                     seq.firstResidueOutsideIterator(cs.iterator())));
2004
2005     cs.revealAllHiddenColumns(colsel);
2006     // hide columns around most of sequence - leave one residue remaining
2007     cs.hideColumns(1, 3);
2008     cs.hideColumns(6, 11);
2009
2010     Iterator<int[]> it = cs.getVisContigsIterator(0, 6, false);
2011
2012     assertEquals("-D", seq.getSequenceStringFromIterator(it));
2013     // cs.getVisibleSequenceStrings(0, 5, new SequenceI[]
2014     // { seq })[0]);
2015
2016     assertEquals(4, seq.firstResidueOutsideIterator(cs.iterator()));
2017     cs.revealAllHiddenColumns(colsel);
2018
2019     // hide whole sequence - should just get location of hidden region
2020     // containing sequence
2021     cs.hideColumns(1, 11);
2022     assertEquals(0, seq.firstResidueOutsideIterator(cs.iterator()));
2023
2024     cs.revealAllHiddenColumns(colsel);
2025     cs.hideColumns(0, 15);
2026     assertEquals(0, seq.firstResidueOutsideIterator(cs.iterator()));
2027
2028     SequenceI seq2 = new Sequence("RefSeq2", "-------A-SD-ASD--E---");
2029
2030     cs.revealAllHiddenColumns(colsel);
2031     cs.hideColumns(7, 17);
2032     assertEquals(0, seq2.firstResidueOutsideIterator(cs.iterator()));
2033
2034     cs.revealAllHiddenColumns(colsel);
2035     cs.hideColumns(3, 17);
2036     assertEquals(0, seq2.firstResidueOutsideIterator(cs.iterator()));
2037
2038     cs.revealAllHiddenColumns(colsel);
2039     cs.hideColumns(3, 19);
2040     assertEquals(0, seq2.firstResidueOutsideIterator(cs.iterator()));
2041
2042     cs.revealAllHiddenColumns(colsel);
2043     cs.hideColumns(0, 0);
2044     assertEquals(1, seq.firstResidueOutsideIterator(cs.iterator()));
2045
2046     cs.revealAllHiddenColumns(colsel);
2047     cs.hideColumns(0, 1);
2048     assertEquals(3, seq.firstResidueOutsideIterator(cs.iterator()));
2049
2050     cs.revealAllHiddenColumns(colsel);
2051     cs.hideColumns(0, 2);
2052     assertEquals(3, seq.firstResidueOutsideIterator(cs.iterator()));
2053
2054     cs.revealAllHiddenColumns(colsel);
2055     cs.hideColumns(1, 1);
2056     assertEquals(3, seq.firstResidueOutsideIterator(cs.iterator()));
2057
2058     cs.revealAllHiddenColumns(colsel);
2059     cs.hideColumns(1, 2);
2060     assertEquals(3, seq.firstResidueOutsideIterator(cs.iterator()));
2061
2062     cs.revealAllHiddenColumns(colsel);
2063     cs.hideColumns(1, 3);
2064     assertEquals(4, seq.firstResidueOutsideIterator(cs.iterator()));
2065
2066     cs.revealAllHiddenColumns(colsel);
2067     cs.hideColumns(0, 2);
2068     cs.hideColumns(5, 6);
2069     assertEquals(3, seq.firstResidueOutsideIterator(cs.iterator()));
2070
2071     cs.revealAllHiddenColumns(colsel);
2072     cs.hideColumns(0, 2);
2073     cs.hideColumns(5, 6);
2074     cs.hideColumns(9, 10);
2075     assertEquals(3, seq.firstResidueOutsideIterator(cs.iterator()));
2076
2077     cs.revealAllHiddenColumns(colsel);
2078     cs.hideColumns(0, 2);
2079     cs.hideColumns(7, 11);
2080     assertEquals(3, seq.firstResidueOutsideIterator(cs.iterator()));
2081
2082     cs.revealAllHiddenColumns(colsel);
2083     cs.hideColumns(2, 4);
2084     cs.hideColumns(7, 11);
2085     assertEquals(1, seq.firstResidueOutsideIterator(cs.iterator()));
2086
2087     cs.revealAllHiddenColumns(colsel);
2088     cs.hideColumns(2, 4);
2089     cs.hideColumns(7, 12);
2090     assertEquals(1, seq.firstResidueOutsideIterator(cs.iterator()));
2091
2092     cs.revealAllHiddenColumns(colsel);
2093     cs.hideColumns(1, 11);
2094     assertEquals(0, seq.firstResidueOutsideIterator(cs.iterator()));
2095
2096     cs.revealAllHiddenColumns(colsel);
2097     cs.hideColumns(0, 12);
2098     assertEquals(0, seq.firstResidueOutsideIterator(cs.iterator()));
2099
2100     cs.revealAllHiddenColumns(colsel);
2101     cs.hideColumns(0, 4);
2102     cs.hideColumns(6, 12);
2103     assertEquals(0, seq.firstResidueOutsideIterator(cs.iterator()));
2104
2105     cs.revealAllHiddenColumns(colsel);
2106     cs.hideColumns(0, 1);
2107     cs.hideColumns(3, 12);
2108     assertEquals(0, seq.firstResidueOutsideIterator(cs.iterator()));
2109
2110     cs.revealAllHiddenColumns(colsel);
2111     cs.hideColumns(3, 14);
2112     cs.hideColumns(17, 19);
2113     assertEquals(0, seq2.firstResidueOutsideIterator(cs.iterator()));
2114
2115     cs.revealAllHiddenColumns(colsel);
2116     cs.hideColumns(3, 7);
2117     cs.hideColumns(9, 14);
2118     cs.hideColumns(17, 19);
2119     assertEquals(0, seq2.firstResidueOutsideIterator(cs.iterator()));
2120
2121     cs.revealAllHiddenColumns(colsel);
2122     cs.hideColumns(0, 1);
2123     cs.hideColumns(3, 4);
2124     cs.hideColumns(6, 8);
2125     cs.hideColumns(10, 12);
2126     assertEquals(0, seq.firstResidueOutsideIterator(cs.iterator()));
2127
2128   }
2129 }