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