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