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