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