test/jalview/datamodel/SequenceTest.java

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