2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
21 package jalview.datamodel;
23 import static org.testng.AssertJUnit.assertEquals;
24 import static org.testng.AssertJUnit.assertFalse;
25 import static org.testng.AssertJUnit.assertNotNull;
26 import static org.testng.AssertJUnit.assertNotSame;
27 import static org.testng.AssertJUnit.assertNull;
28 import static org.testng.AssertJUnit.assertSame;
29 import static org.testng.AssertJUnit.assertTrue;
31 import jalview.analysis.AlignmentGenerator;
32 import jalview.commands.EditCommand;
33 import jalview.commands.EditCommand.Action;
34 import jalview.datamodel.PDBEntry.Type;
35 import jalview.gui.JvOptionPane;
36 import jalview.util.MapList;
39 import java.util.ArrayList;
40 import java.util.Arrays;
41 import java.util.BitSet;
42 import java.util.Iterator;
43 import java.util.List;
44 import java.util.Vector;
46 import org.testng.Assert;
47 import org.testng.annotations.BeforeClass;
48 import org.testng.annotations.BeforeMethod;
49 import org.testng.annotations.Test;
51 import junit.extensions.PA;
53 public class SequenceTest
55 @BeforeClass(alwaysRun = true)
56 public void setUpJvOptionPane()
58 JvOptionPane.setInteractiveMode(false);
59 JvOptionPane.setMockResponse(JvOptionPane.CANCEL_OPTION);
64 @BeforeMethod(alwaysRun = true)
67 seq = new Sequence("FER1", "AKPNGVL");
70 @Test(groups = { "Functional" })
71 public void testInsertGapsAndGapmaps()
73 SequenceI aseq = seq.deriveSequence();
74 aseq.insertCharAt(2, 3, '-');
75 aseq.insertCharAt(6, 3, '-');
76 assertEquals("Gap insertions not correct", "AK---P---NGVL",
77 aseq.getSequenceAsString());
78 List<int[]> gapInt = aseq.getInsertions();
79 assertEquals("Gap interval 1 start wrong", 2, gapInt.get(0)[0]);
80 assertEquals("Gap interval 1 end wrong", 4, gapInt.get(0)[1]);
81 assertEquals("Gap interval 2 start wrong", 6, gapInt.get(1)[0]);
82 assertEquals("Gap interval 2 end wrong", 8, gapInt.get(1)[1]);
84 BitSet gapfield = aseq.getInsertionsAsBits();
85 BitSet expectedgaps = new BitSet();
86 expectedgaps.set(2, 5);
87 expectedgaps.set(6, 9);
89 assertEquals(6, expectedgaps.cardinality());
91 assertEquals("getInsertionsAsBits didn't mark expected number of gaps",
92 6, gapfield.cardinality());
94 assertEquals("getInsertionsAsBits not correct.", expectedgaps, gapfield);
97 @Test(groups = ("Functional"))
98 public void testIsProtein()
101 assertTrue(new Sequence("prot", "ASDFASDFASDF").isProtein());
103 assertFalse(new Sequence("prot", "ACGTACGTACGT").isProtein());
105 SequenceI sq = new Sequence("prot", "ACGUACGUACGU");
106 assertFalse(sq.isProtein());
107 // change sequence, should trigger an update of cached result
108 sq.setSequence("ASDFASDFADSF");
109 assertTrue(sq.isProtein());
112 @Test(groups = { "Functional" })
113 public void testGetAnnotation()
115 // initial state returns null not an empty array
116 assertNull(seq.getAnnotation());
117 AlignmentAnnotation ann = addAnnotation("label1", "desc1", "calcId1",
119 AlignmentAnnotation[] anns = seq.getAnnotation();
120 assertEquals(1, anns.length);
121 assertSame(ann, anns[0]);
123 // removing all annotations reverts array to null
124 seq.removeAlignmentAnnotation(ann);
125 assertNull(seq.getAnnotation());
128 @Test(groups = { "Functional" })
129 public void testGetAnnotation_forLabel()
131 AlignmentAnnotation ann1 = addAnnotation("label1", "desc1", "calcId1",
133 addAnnotation("label2", "desc2", "calcId2", 1f);
134 AlignmentAnnotation ann3 = addAnnotation("label1", "desc3", "calcId3",
136 AlignmentAnnotation[] anns = seq.getAnnotation("label1");
137 assertEquals(2, anns.length);
138 assertSame(ann1, anns[0]);
139 assertSame(ann3, anns[1]);
142 private AlignmentAnnotation addAnnotation(String label,
143 String description, String calcId, float value)
145 final AlignmentAnnotation annotation = new AlignmentAnnotation(label,
147 annotation.setCalcId(calcId);
148 seq.addAlignmentAnnotation(annotation);
152 @Test(groups = { "Functional" })
153 public void testGetAlignmentAnnotations_forCalcIdAndLabel()
155 addAnnotation("label1", "desc1", "calcId1", 1f);
156 AlignmentAnnotation ann2 = addAnnotation("label2", "desc2", "calcId2",
158 addAnnotation("label2", "desc3", "calcId3", 1f);
159 AlignmentAnnotation ann4 = addAnnotation("label2", "desc3", "calcId2",
161 addAnnotation("label5", "desc3", null, 1f);
162 addAnnotation(null, "desc3", "calcId3", 1f);
164 List<AlignmentAnnotation> anns = seq.getAlignmentAnnotations("calcId2",
166 assertEquals(2, anns.size());
167 assertSame(ann2, anns.get(0));
168 assertSame(ann4, anns.get(1));
170 assertTrue(seq.getAlignmentAnnotations("calcId2", "label3").isEmpty());
171 assertTrue(seq.getAlignmentAnnotations("calcId3", "label5").isEmpty());
172 assertTrue(seq.getAlignmentAnnotations("calcId2", null).isEmpty());
173 assertTrue(seq.getAlignmentAnnotations(null, "label3").isEmpty());
174 assertTrue(seq.getAlignmentAnnotations(null, null).isEmpty());
178 * Tests for addAlignmentAnnotation. Note this method has the side-effect of
179 * setting the sequenceRef on the annotation. Adding the same annotation twice
182 @Test(groups = { "Functional" })
183 public void testAddAlignmentAnnotation()
185 assertNull(seq.getAnnotation());
186 final AlignmentAnnotation annotation = new AlignmentAnnotation("a",
188 assertNull(annotation.sequenceRef);
189 seq.addAlignmentAnnotation(annotation);
190 assertSame(seq, annotation.sequenceRef);
191 AlignmentAnnotation[] anns = seq.getAnnotation();
192 assertEquals(1, anns.length);
193 assertSame(annotation, anns[0]);
195 // re-adding does nothing
196 seq.addAlignmentAnnotation(annotation);
197 anns = seq.getAnnotation();
198 assertEquals(1, anns.length);
199 assertSame(annotation, anns[0]);
201 // an identical but different annotation can be added
202 final AlignmentAnnotation annotation2 = new AlignmentAnnotation("a",
204 seq.addAlignmentAnnotation(annotation2);
205 anns = seq.getAnnotation();
206 assertEquals(2, anns.length);
207 assertSame(annotation, anns[0]);
208 assertSame(annotation2, anns[1]);
211 @Test(groups = { "Functional" })
212 public void testGetStartGetEnd()
214 SequenceI sq = new Sequence("test", "ABCDEF");
215 assertEquals(1, sq.getStart());
216 assertEquals(6, sq.getEnd());
218 sq = new Sequence("test", "--AB-C-DEF--");
219 assertEquals(1, sq.getStart());
220 assertEquals(6, sq.getEnd());
222 sq = new Sequence("test", "----");
223 assertEquals(1, sq.getStart());
224 assertEquals(0, sq.getEnd()); // ??
228 * Tests for the method that returns an alignment column position (base 1) for
229 * a given sequence position (base 1).
231 @Test(groups = { "Functional" })
232 public void testFindIndex()
235 * call sequenceChanged() after each test to invalidate any cursor,
236 * forcing the 1-arg findIndex to be executed
238 SequenceI sq = new Sequence("test", "ABCDEF");
239 assertEquals(0, sq.findIndex(0));
240 sq.sequenceChanged();
241 assertEquals(1, sq.findIndex(1));
242 sq.sequenceChanged();
243 assertEquals(5, sq.findIndex(5));
244 sq.sequenceChanged();
245 assertEquals(6, sq.findIndex(6));
246 sq.sequenceChanged();
247 assertEquals(6, sq.findIndex(9));
249 final String aligned = "-A--B-C-D-E-F--";
250 assertEquals(15, aligned.length());
251 sq = new Sequence("test/8-13", aligned);
252 assertEquals(2, sq.findIndex(8));
253 sq.sequenceChanged();
254 assertEquals(5, sq.findIndex(9));
255 sq.sequenceChanged();
256 assertEquals(7, sq.findIndex(10));
258 // before start returns 0
259 sq.sequenceChanged();
260 assertEquals(0, sq.findIndex(0));
261 sq.sequenceChanged();
262 assertEquals(0, sq.findIndex(-1));
264 // beyond end returns last residue column
265 sq.sequenceChanged();
266 assertEquals(13, sq.findIndex(99));
269 * residue before sequence 'end' but beyond end of sequence returns
270 * length of sequence (last column) (rightly or wrongly!)
272 sq = new Sequence("test/8-15", "A-B-C-"); // trailing gap case
273 assertEquals(6, sq.getLength());
274 sq.sequenceChanged();
275 assertEquals(sq.getLength(), sq.findIndex(14));
276 sq = new Sequence("test/8-99", "-A--B-C-D"); // trailing residue case
277 sq.sequenceChanged();
278 assertEquals(sq.getLength(), sq.findIndex(65));
281 * residue after sequence 'start' but before first residue returns
282 * zero (before first column) (rightly or wrongly!)
284 sq = new Sequence("test/8-15", "-A-B-C-"); // leading gap case
285 sq.sequenceChanged();
286 assertEquals(0, sq.findIndex(3));
287 sq = new Sequence("test/8-15", "A-B-C-"); // leading residue case
288 sq.sequenceChanged();
289 assertEquals(0, sq.findIndex(2));
292 @Test(groups = { "Functional" })
293 public void testFindPositions()
295 SequenceI sq = new Sequence("test/8-13", "-ABC---DE-F--");
300 assertNull(sq.findPositions(6, 5));
301 assertNull(sq.findPositions(0, 5));
302 assertNull(sq.findPositions(-1, 5));
307 assertNull(sq.findPositions(1, 1)); // 1-based columns
308 assertNull(sq.findPositions(5, 5));
309 assertNull(sq.findPositions(5, 6));
310 assertNull(sq.findPositions(5, 7));
313 * all ungapped ranges
315 assertEquals(new Range(8, 8), sq.findPositions(2, 2)); // A
316 assertEquals(new Range(8, 9), sq.findPositions(2, 3)); // AB
317 assertEquals(new Range(8, 10), sq.findPositions(2, 4)); // ABC
318 assertEquals(new Range(9, 10), sq.findPositions(3, 4)); // BC
321 * gap to ungapped range
323 assertEquals(new Range(8, 10), sq.findPositions(1, 4)); // ABC
324 assertEquals(new Range(11, 12), sq.findPositions(6, 9)); // DE
327 * ungapped to gapped range
329 assertEquals(new Range(10, 10), sq.findPositions(4, 5)); // C
330 assertEquals(new Range(9, 13), sq.findPositions(3, 11)); // BCDEF
333 * ungapped to ungapped enclosing gaps
335 assertEquals(new Range(10, 11), sq.findPositions(4, 8)); // CD
336 assertEquals(new Range(8, 13), sq.findPositions(2, 11)); // ABCDEF
339 * gapped to gapped enclosing ungapped
341 assertEquals(new Range(8, 10), sq.findPositions(1, 5)); // ABC
342 assertEquals(new Range(11, 12), sq.findPositions(5, 10)); // DE
343 assertEquals(new Range(8, 13), sq.findPositions(1, 13)); // the lot
344 assertEquals(new Range(8, 13), sq.findPositions(1, 99));
348 * Tests for the method that returns a dataset sequence position (start..) for
349 * an aligned column position (base 0).
351 @Test(groups = { "Functional" })
352 public void testFindPosition()
355 * call sequenceChanged() after each test to invalidate any cursor,
356 * forcing the 1-arg findPosition to be executed
358 SequenceI sq = new Sequence("test/8-13", "ABCDEF");
359 assertEquals(8, sq.findPosition(0));
360 // Sequence should now hold a cursor at [8, 0]
361 assertEquals("test:Pos8:Col1:startCol1:endCol0:tok0",
362 PA.getValue(sq, "cursor").toString());
363 SequenceCursor cursor = (SequenceCursor) PA.getValue(sq, "cursor");
364 int token = (int) PA.getValue(sq, "changeCount");
365 assertEquals(new SequenceCursor(sq, 8, 1, token), cursor);
367 sq.sequenceChanged();
370 * find F13 at column offset 5, cursor should update to [13, 6]
371 * endColumn is found and saved in cursor
373 assertEquals(13, sq.findPosition(5));
374 cursor = (SequenceCursor) PA.getValue(sq, "cursor");
375 assertEquals(++token, (int) PA.getValue(sq, "changeCount"));
376 assertEquals(new SequenceCursor(sq, 13, 6, token), cursor);
377 assertEquals("test:Pos13:Col6:startCol1:endCol6:tok1",
378 PA.getValue(sq, "cursor").toString());
380 // assertEquals(-1, seq.findPosition(6)); // fails
382 sq = new Sequence("test/8-11", "AB-C-D--");
383 token = (int) PA.getValue(sq, "changeCount"); // 0
384 assertEquals(8, sq.findPosition(0));
385 cursor = (SequenceCursor) PA.getValue(sq, "cursor");
386 assertEquals(new SequenceCursor(sq, 8, 1, token), cursor);
387 assertEquals("test:Pos8:Col1:startCol1:endCol0:tok0",
388 PA.getValue(sq, "cursor").toString());
390 sq.sequenceChanged();
391 assertEquals(9, sq.findPosition(1));
392 cursor = (SequenceCursor) PA.getValue(sq, "cursor");
393 assertEquals(new SequenceCursor(sq, 9, 2, ++token), cursor);
394 assertEquals("test:Pos9:Col2:startCol1:endCol0:tok1",
395 PA.getValue(sq, "cursor").toString());
397 sq.sequenceChanged();
398 // gap position 'finds' residue to the right (not the left as per javadoc)
399 // cursor is set to the last residue position found [B 2]
400 assertEquals(10, sq.findPosition(2));
401 cursor = (SequenceCursor) PA.getValue(sq, "cursor");
402 assertEquals(new SequenceCursor(sq, 9, 2, ++token), cursor);
403 assertEquals("test:Pos9:Col2:startCol1:endCol0:tok2",
404 PA.getValue(sq, "cursor").toString());
406 sq.sequenceChanged();
407 assertEquals(10, sq.findPosition(3));
408 cursor = (SequenceCursor) PA.getValue(sq, "cursor");
409 assertEquals(new SequenceCursor(sq, 10, 4, ++token), cursor);
410 assertEquals("test:Pos10:Col4:startCol1:endCol0:tok3",
411 PA.getValue(sq, "cursor").toString());
413 sq.sequenceChanged();
414 // column[4] is the gap after C - returns D11
415 // cursor is set to [C 4]
416 assertEquals(11, sq.findPosition(4));
417 cursor = (SequenceCursor) PA.getValue(sq, "cursor");
418 assertEquals(new SequenceCursor(sq, 10, 4, ++token), cursor);
419 assertEquals("test:Pos10:Col4:startCol1:endCol0:tok4",
420 PA.getValue(sq, "cursor").toString());
422 sq.sequenceChanged();
423 assertEquals(11, sq.findPosition(5)); // D
424 cursor = (SequenceCursor) PA.getValue(sq, "cursor");
425 assertEquals(new SequenceCursor(sq, 11, 6, ++token), cursor);
426 // lastCol has been found and saved in the cursor
427 assertEquals("test:Pos11:Col6:startCol1:endCol6:tok5",
428 PA.getValue(sq, "cursor").toString());
430 sq.sequenceChanged();
431 // returns 1 more than sequence length if off the end ?!?
432 assertEquals(12, sq.findPosition(6));
434 sq.sequenceChanged();
435 assertEquals(12, sq.findPosition(7));
438 * first findPosition should also set firstResCol in cursor
440 sq = new Sequence("test/8-13", "--AB-C-DEF--");
441 assertEquals(8, sq.findPosition(0));
442 assertNull(PA.getValue(sq, "cursor"));
444 sq.sequenceChanged();
445 assertEquals(8, sq.findPosition(1));
446 assertNull(PA.getValue(sq, "cursor"));
448 sq.sequenceChanged();
449 assertEquals(8, sq.findPosition(2));
450 assertEquals("test:Pos8:Col3:startCol3:endCol0:tok2",
451 PA.getValue(sq, "cursor").toString());
453 sq.sequenceChanged();
454 assertEquals(9, sq.findPosition(3));
455 assertEquals("test:Pos9:Col4:startCol3:endCol0:tok3",
456 PA.getValue(sq, "cursor").toString());
458 sq.sequenceChanged();
459 // column[4] is a gap, returns next residue pos (C10)
460 // cursor is set to last residue found [B]
461 assertEquals(10, sq.findPosition(4));
462 assertEquals("test:Pos9:Col4:startCol3:endCol0:tok4",
463 PA.getValue(sq, "cursor").toString());
465 sq.sequenceChanged();
466 assertEquals(10, sq.findPosition(5));
467 assertEquals("test:Pos10:Col6:startCol3:endCol0:tok5",
468 PA.getValue(sq, "cursor").toString());
470 sq.sequenceChanged();
471 // column[6] is a gap, returns next residue pos (D11)
472 // cursor is set to last residue found [C]
473 assertEquals(11, sq.findPosition(6));
474 assertEquals("test:Pos10:Col6:startCol3:endCol0:tok6",
475 PA.getValue(sq, "cursor").toString());
477 sq.sequenceChanged();
478 assertEquals(11, sq.findPosition(7));
479 assertEquals("test:Pos11:Col8:startCol3:endCol0:tok7",
480 PA.getValue(sq, "cursor").toString());
482 sq.sequenceChanged();
483 assertEquals(12, sq.findPosition(8));
484 assertEquals("test:Pos12:Col9:startCol3:endCol0:tok8",
485 PA.getValue(sq, "cursor").toString());
488 * when the last residue column is found, it is set in the cursor
490 sq.sequenceChanged();
491 assertEquals(13, sq.findPosition(9));
492 assertEquals("test:Pos13:Col10:startCol3:endCol10:tok9",
493 PA.getValue(sq, "cursor").toString());
495 sq.sequenceChanged();
496 assertEquals(14, sq.findPosition(10));
497 assertEquals("test:Pos13:Col10:startCol3:endCol10:tok10",
498 PA.getValue(sq, "cursor").toString());
501 * findPosition for column beyond sequence length
502 * returns 1 more than last residue position
504 sq.sequenceChanged();
505 assertEquals(14, sq.findPosition(11));
506 assertEquals("test:Pos13:Col10:startCol3:endCol10:tok11",
507 PA.getValue(sq, "cursor").toString());
509 sq.sequenceChanged();
510 assertEquals(14, sq.findPosition(99));
511 assertEquals("test:Pos13:Col10:startCol3:endCol10:tok12",
512 PA.getValue(sq, "cursor").toString());
515 * gapped sequence ending in non-gap
517 sq = new Sequence("test/8-13", "--AB-C-DEF");
518 assertEquals(13, sq.findPosition(9));
519 assertEquals("test:Pos13:Col10:startCol3:endCol10:tok0",
520 PA.getValue(sq, "cursor").toString());
521 sq.sequenceChanged();
522 assertEquals(12, sq.findPosition(8)); // E12
523 // sequenceChanged() invalidates cursor.lastResidueColumn
524 cursor = (SequenceCursor) PA.getValue(sq, "cursor");
525 assertEquals("test:Pos12:Col9:startCol3:endCol0:tok1",
527 // findPosition with cursor accepts base 1 column values
528 assertEquals(13, ((Sequence) sq).findPosition(10, cursor));
529 assertEquals(13, sq.findPosition(9)); // F13
530 // lastResidueColumn has now been found and saved in cursor
531 assertEquals("test:Pos13:Col10:startCol3:endCol10:tok1",
532 PA.getValue(sq, "cursor").toString());
535 @Test(groups = { "Functional" })
536 public void testDeleteChars()
541 SequenceI sq = new Sequence("test", "ABCDEF");
542 assertNull(PA.getValue(sq, "datasetSequence"));
543 assertEquals(1, sq.getStart());
544 assertEquals(6, sq.getEnd());
545 sq.deleteChars(2, 3);
546 assertEquals("ABDEF", sq.getSequenceAsString());
547 assertEquals(1, sq.getStart());
548 assertEquals(5, sq.getEnd());
549 assertNull(PA.getValue(sq, "datasetSequence"));
554 sq = new Sequence("test", "ABCDEF");
555 sq.deleteChars(0, 2);
556 assertEquals("CDEF", sq.getSequenceAsString());
557 assertEquals(3, sq.getStart());
558 assertEquals(6, sq.getEnd());
559 assertNull(PA.getValue(sq, "datasetSequence"));
561 sq = new Sequence("test", "ABCDE");
562 sq.deleteChars(0, 3);
563 assertEquals("DE", sq.getSequenceAsString());
564 assertEquals(4, sq.getStart());
565 assertEquals(5, sq.getEnd());
566 assertNull(PA.getValue(sq, "datasetSequence"));
571 sq = new Sequence("test", "ABCDEF");
572 sq.deleteChars(4, 6);
573 assertEquals("ABCD", sq.getSequenceAsString());
574 assertEquals(1, sq.getStart());
575 assertEquals(4, sq.getEnd());
576 assertNull(PA.getValue(sq, "datasetSequence"));
579 * delete more positions than there are
581 sq = new Sequence("test/8-11", "ABCD");
582 sq.deleteChars(0, 99);
583 assertEquals("", sq.getSequenceAsString());
584 assertEquals(12, sq.getStart()); // = findPosition(99) ?!?
585 assertEquals(11, sq.getEnd());
587 sq = new Sequence("test/8-11", "----");
588 sq.deleteChars(0, 99); // ArrayIndexOutOfBoundsException <= 2.10.2
589 assertEquals("", sq.getSequenceAsString());
590 assertEquals(8, sq.getStart());
591 assertEquals(11, sq.getEnd());
594 @Test(groups = { "Functional" })
595 public void testDeleteChars_withDbRefsAndFeatures()
598 * internal delete - new dataset sequence created
599 * gets a copy of any dbrefs
601 SequenceI sq = new Sequence("test", "ABCDEF");
602 sq.createDatasetSequence();
603 DBRefEntry dbr1 = new DBRefEntry("Uniprot", "0", "a123");
605 Object ds = PA.getValue(sq, "datasetSequence");
607 assertEquals(1, sq.getStart());
608 assertEquals(6, sq.getEnd());
609 sq.deleteChars(2, 3);
610 assertEquals("ABDEF", sq.getSequenceAsString());
611 assertEquals(1, sq.getStart());
612 assertEquals(5, sq.getEnd());
613 Object newDs = PA.getValue(sq, "datasetSequence");
614 assertNotNull(newDs);
615 assertNotSame(ds, newDs);
616 assertNotNull(sq.getDBRefs());
617 assertEquals(1, sq.getDBRefs().length);
618 assertNotSame(dbr1, sq.getDBRefs()[0]);
619 assertEquals(dbr1, sq.getDBRefs()[0]);
622 * internal delete with sequence features
623 * (failure case for JAL-2541)
625 sq = new Sequence("test", "ABCDEF");
626 sq.createDatasetSequence();
627 SequenceFeature sf1 = new SequenceFeature("Cath", "desc", 2, 4, 2f,
629 sq.addSequenceFeature(sf1);
630 ds = PA.getValue(sq, "datasetSequence");
632 assertEquals(1, sq.getStart());
633 assertEquals(6, sq.getEnd());
634 sq.deleteChars(2, 4);
635 assertEquals("ABEF", sq.getSequenceAsString());
636 assertEquals(1, sq.getStart());
637 assertEquals(4, sq.getEnd());
638 newDs = PA.getValue(sq, "datasetSequence");
639 assertNotNull(newDs);
640 assertNotSame(ds, newDs);
641 List<SequenceFeature> sfs = sq.getSequenceFeatures();
642 assertEquals(1, sfs.size());
643 assertNotSame(sf1, sfs.get(0));
644 assertEquals(sf1, sfs.get(0));
647 * delete at start - no new dataset sequence created
648 * any sequence features remain as before
650 sq = new Sequence("test", "ABCDEF");
651 sq.createDatasetSequence();
652 ds = PA.getValue(sq, "datasetSequence");
653 sf1 = new SequenceFeature("Cath", "desc", 2, 4, 2f, "CathGroup");
654 sq.addSequenceFeature(sf1);
655 sq.deleteChars(0, 2);
656 assertEquals("CDEF", sq.getSequenceAsString());
657 assertEquals(3, sq.getStart());
658 assertEquals(6, sq.getEnd());
659 assertSame(ds, PA.getValue(sq, "datasetSequence"));
660 sfs = sq.getSequenceFeatures();
662 assertEquals(1, sfs.size());
663 assertSame(sf1, sfs.get(0));
666 * delete at end - no new dataset sequence created
667 * any dbrefs remain as before
669 sq = new Sequence("test", "ABCDEF");
670 sq.createDatasetSequence();
671 ds = PA.getValue(sq, "datasetSequence");
672 dbr1 = new DBRefEntry("Uniprot", "0", "a123");
674 sq.deleteChars(4, 6);
675 assertEquals("ABCD", sq.getSequenceAsString());
676 assertEquals(1, sq.getStart());
677 assertEquals(4, sq.getEnd());
678 assertSame(ds, PA.getValue(sq, "datasetSequence"));
679 assertNotNull(sq.getDBRefs());
680 assertEquals(1, sq.getDBRefs().length);
681 assertSame(dbr1, sq.getDBRefs()[0]);
684 @Test(groups = { "Functional" })
685 public void testInsertCharAt()
687 // non-static methods:
688 SequenceI sq = new Sequence("test", "ABCDEF");
689 sq.insertCharAt(0, 'z');
690 assertEquals("zABCDEF", sq.getSequenceAsString());
691 sq.insertCharAt(2, 2, 'x');
692 assertEquals("zAxxBCDEF", sq.getSequenceAsString());
694 // for static method see StringUtilsTest
698 * Test the method that returns an array of aligned sequence positions where
699 * the array index is the data sequence position (both base 0).
701 @Test(groups = { "Functional" })
702 public void testGapMap()
704 SequenceI sq = new Sequence("test", "-A--B-CD-E--F-");
705 sq.createDatasetSequence();
706 assertEquals("[1, 4, 6, 7, 9, 12]", Arrays.toString(sq.gapMap()));
710 * Test the method that gets sequence features, either from the sequence or
713 @Test(groups = { "Functional" })
714 public void testGetSequenceFeatures()
716 SequenceI sq = new Sequence("test", "GATCAT");
717 sq.createDatasetSequence();
719 assertTrue(sq.getSequenceFeatures().isEmpty());
722 * SequenceFeature on sequence
724 SequenceFeature sf = new SequenceFeature("Cath", "desc", 2, 4, 2f, null);
725 sq.addSequenceFeature(sf);
726 List<SequenceFeature> sfs = sq.getSequenceFeatures();
727 assertEquals(1, sfs.size());
728 assertSame(sf, sfs.get(0));
731 * SequenceFeature on sequence and dataset sequence; returns that on
734 * Note JAL-2046: spurious: we have no use case for this at the moment.
735 * This test also buggy - as sf2.equals(sf), no new feature is added
737 SequenceFeature sf2 = new SequenceFeature("Cath", "desc", 2, 4, 2f,
739 sq.getDatasetSequence().addSequenceFeature(sf2);
740 sfs = sq.getSequenceFeatures();
741 assertEquals(1, sfs.size());
742 assertSame(sf, sfs.get(0));
745 * SequenceFeature on dataset sequence only
746 * Note JAL-2046: spurious: we have no use case for setting a non-dataset sequence's feature array to null at the moment.
748 sq.setSequenceFeatures(null);
749 assertTrue(sq.getDatasetSequence().getSequenceFeatures().isEmpty());
752 * Corrupt case - no SequenceFeature, dataset's dataset is the original
753 * sequence. Test shows no infinite loop results.
755 sq.getDatasetSequence().setSequenceFeatures(null);
757 * is there a usecase for this ? setDatasetSequence should throw an error if
758 * this actually occurs.
762 sq.getDatasetSequence().setDatasetSequence(sq); // loop!
763 Assert.fail("Expected Error to be raised when calling setDatasetSequence with self reference");
764 } catch (IllegalArgumentException e)
766 // TODO Jalview error/exception class for raising implementation errors
767 assertTrue(e.getMessage().toLowerCase()
768 .contains("implementation error"));
770 assertTrue(sq.getSequenceFeatures().isEmpty());
774 * Test the method that returns an array, indexed by sequence position, whose
775 * entries are the residue positions at the sequence position (or to the right
778 @Test(groups = { "Functional" })
779 public void testFindPositionMap()
782 * Note: Javadoc for findPosition says it returns the residue position to
783 * the left of a gapped position; in fact it returns the position to the
784 * right. Also it returns a non-existent residue position for a gap beyond
787 Sequence sq = new Sequence("TestSeq", "AB.C-D E.");
788 int[] map = sq.findPositionMap();
789 assertEquals(Arrays.toString(new int[] { 1, 2, 3, 3, 4, 4, 5, 5, 6 }),
790 Arrays.toString(map));
794 * Test for getSubsequence
796 @Test(groups = { "Functional" })
797 public void testGetSubsequence()
799 SequenceI sq = new Sequence("TestSeq", "ABCDEFG");
800 sq.createDatasetSequence();
802 // positions are base 0, end position is exclusive
803 SequenceI subseq = sq.getSubSequence(2, 4);
805 assertEquals("CD", subseq.getSequenceAsString());
806 // start/end are base 1 positions
807 assertEquals(3, subseq.getStart());
808 assertEquals(4, subseq.getEnd());
809 // subsequence shares the full dataset sequence
810 assertSame(sq.getDatasetSequence(), subseq.getDatasetSequence());
814 * test createDatasetSequence behaves to doc
816 @Test(groups = { "Functional" })
817 public void testCreateDatasetSequence()
819 SequenceI sq = new Sequence("my", "ASDASD");
820 sq.addSequenceFeature(new SequenceFeature("type", "desc", 1, 10, 1f,
822 sq.addDBRef(new DBRefEntry("source", "version", "accession"));
823 assertNull(sq.getDatasetSequence());
824 assertNotNull(PA.getValue(sq, "sequenceFeatureStore"));
825 assertNotNull(PA.getValue(sq, "dbrefs"));
827 SequenceI rds = sq.createDatasetSequence();
829 assertNull(rds.getDatasetSequence());
830 assertSame(sq.getDatasetSequence(), rds);
832 // sequence features and dbrefs transferred to dataset sequence
833 assertNull(PA.getValue(sq, "sequenceFeatureStore"));
834 assertNull(PA.getValue(sq, "dbrefs"));
835 assertNotNull(PA.getValue(rds, "sequenceFeatureStore"));
836 assertNotNull(PA.getValue(rds, "dbrefs"));
840 * Test for deriveSequence applied to a sequence with a dataset
842 @Test(groups = { "Functional" })
843 public void testDeriveSequence_existingDataset()
845 Sequence sq = new Sequence("Seq1", "CD");
846 sq.setDatasetSequence(new Sequence("Seq1", "ABCDEF"));
847 sq.getDatasetSequence().addSequenceFeature(
848 new SequenceFeature("", "", 1, 2, 0f, null));
852 sq.setDescription("Test sequence description..");
853 sq.setVamsasId("TestVamsasId");
854 sq.addDBRef(new DBRefEntry("PDB", "version0", "1TST"));
856 sq.addDBRef(new DBRefEntry("PDB", "version1", "1PDB"));
857 sq.addDBRef(new DBRefEntry("PDB", "version2", "2PDB"));
858 sq.addDBRef(new DBRefEntry("PDB", "version3", "3PDB"));
859 sq.addDBRef(new DBRefEntry("PDB", "version4", "4PDB"));
861 sq.addPDBId(new PDBEntry("1PDB", "A", Type.PDB, "filePath/test1"));
862 sq.addPDBId(new PDBEntry("1PDB", "B", Type.PDB, "filePath/test1"));
863 sq.addPDBId(new PDBEntry("2PDB", "A", Type.MMCIF, "filePath/test2"));
864 sq.addPDBId(new PDBEntry("2PDB", "B", Type.MMCIF, "filePath/test2"));
866 // these are the same as ones already added
867 DBRefEntry pdb1pdb = new DBRefEntry("PDB", "version1", "1PDB");
868 DBRefEntry pdb2pdb = new DBRefEntry("PDB", "version2", "2PDB");
870 List<DBRefEntry> primRefs = Arrays.asList(new DBRefEntry[] { pdb1pdb,
873 sq.getDatasetSequence().addDBRef(pdb1pdb); // should do nothing
874 sq.getDatasetSequence().addDBRef(pdb2pdb); // should do nothing
875 sq.getDatasetSequence().addDBRef(
876 new DBRefEntry("PDB", "version3", "3PDB")); // should do nothing
877 sq.getDatasetSequence().addDBRef(
878 new DBRefEntry("PDB", "version4", "4PDB")); // should do nothing
880 PDBEntry pdbe1a = new PDBEntry("1PDB", "A", Type.PDB, "filePath/test1");
881 PDBEntry pdbe1b = new PDBEntry("1PDB", "B", Type.PDB, "filePath/test1");
882 PDBEntry pdbe2a = new PDBEntry("2PDB", "A", Type.MMCIF,
884 PDBEntry pdbe2b = new PDBEntry("2PDB", "B", Type.MMCIF,
886 sq.getDatasetSequence().addPDBId(pdbe1a);
887 sq.getDatasetSequence().addPDBId(pdbe1b);
888 sq.getDatasetSequence().addPDBId(pdbe2a);
889 sq.getDatasetSequence().addPDBId(pdbe2b);
892 * test we added pdb entries to the dataset sequence
894 Assert.assertEquals(sq.getDatasetSequence().getAllPDBEntries(), Arrays
895 .asList(new PDBEntry[] { pdbe1a, pdbe1b, pdbe2a, pdbe2b }),
896 "PDB Entries were not found on dataset sequence.");
899 * we should recover a pdb entry that is on the dataset sequence via PDBEntry
901 Assert.assertEquals(pdbe1a,
902 sq.getDatasetSequence().getPDBEntry("1PDB"),
903 "PDB Entry '1PDB' not found on dataset sequence via getPDBEntry.");
904 ArrayList<Annotation> annotsList = new ArrayList<>();
905 System.out.println(">>>>>> " + sq.getSequenceAsString().length());
906 annotsList.add(new Annotation("A", "A", 'X', 0.1f));
907 annotsList.add(new Annotation("A", "A", 'X', 0.1f));
908 Annotation[] annots = annotsList.toArray(new Annotation[0]);
909 sq.addAlignmentAnnotation(new AlignmentAnnotation("Test annot",
910 "Test annot description", annots));
911 sq.getDatasetSequence().addAlignmentAnnotation(
912 new AlignmentAnnotation("Test annot", "Test annot description",
914 Assert.assertEquals(sq.getDescription(), "Test sequence description..");
915 Assert.assertEquals(sq.getDBRefs().length, 5); // DBRefs are on dataset
917 Assert.assertEquals(sq.getAllPDBEntries().size(), 4);
918 Assert.assertNotNull(sq.getAnnotation());
919 Assert.assertEquals(sq.getAnnotation()[0].annotations.length, 2);
920 Assert.assertEquals(sq.getDatasetSequence().getDBRefs().length, 5); // same
923 Assert.assertEquals(sq.getDatasetSequence().getAllPDBEntries().size(),
925 Assert.assertNotNull(sq.getDatasetSequence().getAnnotation());
927 Sequence derived = (Sequence) sq.deriveSequence();
929 Assert.assertEquals(derived.getDescription(),
930 "Test sequence description..");
931 Assert.assertEquals(derived.getDBRefs().length, 5); // come from dataset
932 Assert.assertEquals(derived.getAllPDBEntries().size(), 4);
933 Assert.assertNotNull(derived.getAnnotation());
934 Assert.assertEquals(derived.getAnnotation()[0].annotations.length, 2);
935 Assert.assertEquals(derived.getDatasetSequence().getDBRefs().length, 5);
936 Assert.assertEquals(derived.getDatasetSequence().getAllPDBEntries()
938 Assert.assertNotNull(derived.getDatasetSequence().getAnnotation());
940 assertEquals("CD", derived.getSequenceAsString());
941 assertSame(sq.getDatasetSequence(), derived.getDatasetSequence());
943 // derived sequence should access dataset sequence features
944 assertNotNull(sq.getSequenceFeatures());
945 assertEquals(sq.getSequenceFeatures(), derived.getSequenceFeatures());
948 * verify we have primary db refs *just* for PDB IDs with associated
952 assertEquals(primRefs, sq.getPrimaryDBRefs());
953 assertEquals(primRefs, sq.getDatasetSequence().getPrimaryDBRefs());
955 assertEquals(sq.getPrimaryDBRefs(), derived.getPrimaryDBRefs());
960 * Test for deriveSequence applied to an ungapped sequence with no dataset
962 @Test(groups = { "Functional" })
963 public void testDeriveSequence_noDatasetUngapped()
965 SequenceI sq = new Sequence("Seq1", "ABCDEF");
966 assertEquals(1, sq.getStart());
967 assertEquals(6, sq.getEnd());
968 SequenceI derived = sq.deriveSequence();
969 assertEquals("ABCDEF", derived.getSequenceAsString());
970 assertEquals("ABCDEF", derived.getDatasetSequence()
971 .getSequenceAsString());
975 * Test for deriveSequence applied to a gapped sequence with no dataset
977 @Test(groups = { "Functional" })
978 public void testDeriveSequence_noDatasetGapped()
980 SequenceI sq = new Sequence("Seq1", "AB-C.D EF");
981 assertEquals(1, sq.getStart());
982 assertEquals(6, sq.getEnd());
983 assertNull(sq.getDatasetSequence());
984 SequenceI derived = sq.deriveSequence();
985 assertEquals("AB-C.D EF", derived.getSequenceAsString());
986 assertEquals("ABCDEF", derived.getDatasetSequence()
987 .getSequenceAsString());
990 @Test(groups = { "Functional" })
991 public void testCopyConstructor_noDataset()
993 SequenceI seq1 = new Sequence("Seq1", "AB-C.D EF");
994 seq1.setDescription("description");
995 seq1.addAlignmentAnnotation(new AlignmentAnnotation("label", "desc",
997 seq1.addSequenceFeature(new SequenceFeature("type", "desc", 22, 33,
999 seq1.addPDBId(new PDBEntry("1A70", "B", Type.PDB, "File"));
1000 seq1.addDBRef(new DBRefEntry("EMBL", "1.2", "AZ12345"));
1002 SequenceI copy = new Sequence(seq1);
1004 assertNull(copy.getDatasetSequence());
1006 verifyCopiedSequence(seq1, copy);
1008 // copy has a copy of the DBRefEntry
1009 // this is murky - DBrefs are only copied for dataset sequences
1010 // where the test for 'dataset sequence' is 'dataset is null'
1011 // but that doesn't distinguish it from an aligned sequence
1012 // which has not yet generated a dataset sequence
1013 // NB getDBRef looks inside dataset sequence if not null
1014 DBRefEntry[] dbrefs = copy.getDBRefs();
1015 assertEquals(1, dbrefs.length);
1016 assertFalse(dbrefs[0] == seq1.getDBRefs()[0]);
1017 assertTrue(dbrefs[0].equals(seq1.getDBRefs()[0]));
1020 @Test(groups = { "Functional" })
1021 public void testCopyConstructor_withDataset()
1023 SequenceI seq1 = new Sequence("Seq1", "AB-C.D EF");
1024 seq1.createDatasetSequence();
1025 seq1.setDescription("description");
1026 seq1.addAlignmentAnnotation(new AlignmentAnnotation("label", "desc",
1028 // JAL-2046 - what is the contract for using a derived sequence's
1029 // addSequenceFeature ?
1030 seq1.addSequenceFeature(new SequenceFeature("type", "desc", 22, 33,
1032 seq1.addPDBId(new PDBEntry("1A70", "B", Type.PDB, "File"));
1033 // here we add DBRef to the dataset sequence:
1034 seq1.getDatasetSequence().addDBRef(
1035 new DBRefEntry("EMBL", "1.2", "AZ12345"));
1037 SequenceI copy = new Sequence(seq1);
1039 assertNotNull(copy.getDatasetSequence());
1040 assertSame(copy.getDatasetSequence(), seq1.getDatasetSequence());
1042 verifyCopiedSequence(seq1, copy);
1044 // getDBRef looks inside dataset sequence and this is shared,
1045 // so holds the same dbref objects
1046 DBRefEntry[] dbrefs = copy.getDBRefs();
1047 assertEquals(1, dbrefs.length);
1048 assertSame(dbrefs[0], seq1.getDBRefs()[0]);
1052 * Helper to make assertions about a copied sequence
1057 protected void verifyCopiedSequence(SequenceI seq1, SequenceI copy)
1059 // verify basic properties:
1060 assertEquals(copy.getName(), seq1.getName());
1061 assertEquals(copy.getDescription(), seq1.getDescription());
1062 assertEquals(copy.getStart(), seq1.getStart());
1063 assertEquals(copy.getEnd(), seq1.getEnd());
1064 assertEquals(copy.getSequenceAsString(), seq1.getSequenceAsString());
1066 // copy has a copy of the annotation:
1067 AlignmentAnnotation[] anns = copy.getAnnotation();
1068 assertEquals(1, anns.length);
1069 assertFalse(anns[0] == seq1.getAnnotation()[0]);
1070 assertEquals(anns[0].label, seq1.getAnnotation()[0].label);
1071 assertEquals(anns[0].description, seq1.getAnnotation()[0].description);
1072 assertEquals(anns[0].score, seq1.getAnnotation()[0].score);
1074 // copy has a copy of the sequence feature:
1075 List<SequenceFeature> sfs = copy.getSequenceFeatures();
1076 assertEquals(1, sfs.size());
1077 if (seq1.getDatasetSequence() != null
1078 && copy.getDatasetSequence() == seq1.getDatasetSequence())
1080 assertSame(sfs.get(0), seq1.getSequenceFeatures().get(0));
1084 assertNotSame(sfs.get(0), seq1.getSequenceFeatures().get(0));
1086 assertEquals(sfs.get(0), seq1.getSequenceFeatures().get(0));
1088 // copy has a copy of the PDB entry
1089 Vector<PDBEntry> pdbs = copy.getAllPDBEntries();
1090 assertEquals(1, pdbs.size());
1091 assertFalse(pdbs.get(0) == seq1.getAllPDBEntries().get(0));
1092 assertTrue(pdbs.get(0).equals(seq1.getAllPDBEntries().get(0)));
1095 @Test(groups = "Functional")
1096 public void testGetCharAt()
1098 SequenceI sq = new Sequence("", "abcde");
1099 assertEquals('a', sq.getCharAt(0));
1100 assertEquals('e', sq.getCharAt(4));
1101 assertEquals(' ', sq.getCharAt(5));
1102 assertEquals(' ', sq.getCharAt(-1));
1105 @Test(groups = { "Functional" })
1106 public void testAddSequenceFeatures()
1108 SequenceI sq = new Sequence("", "abcde");
1109 // type may not be null
1110 assertFalse(sq.addSequenceFeature(new SequenceFeature(null, "desc", 4,
1112 assertTrue(sq.addSequenceFeature(new SequenceFeature("Cath", "desc", 4,
1114 // can't add a duplicate feature
1115 assertFalse(sq.addSequenceFeature(new SequenceFeature("Cath", "desc",
1117 // can add a different feature
1118 assertTrue(sq.addSequenceFeature(new SequenceFeature("Scop", "desc", 4,
1119 8, 0f, null))); // different type
1120 assertTrue(sq.addSequenceFeature(new SequenceFeature("Cath",
1121 "description", 4, 8, 0f, null)));// different description
1122 assertTrue(sq.addSequenceFeature(new SequenceFeature("Cath", "desc", 3,
1123 8, 0f, null))); // different start position
1124 assertTrue(sq.addSequenceFeature(new SequenceFeature("Cath", "desc", 4,
1125 9, 0f, null))); // different end position
1126 assertTrue(sq.addSequenceFeature(new SequenceFeature("Cath", "desc", 4,
1127 8, 1f, null))); // different score
1128 assertTrue(sq.addSequenceFeature(new SequenceFeature("Cath", "desc", 4,
1129 8, Float.NaN, null))); // score NaN
1130 assertTrue(sq.addSequenceFeature(new SequenceFeature("Cath", "desc", 4,
1131 8, 0f, "Metal"))); // different group
1132 assertEquals(8, sq.getFeatures().getAllFeatures().size());
1136 * Tests for adding (or updating) dbrefs
1138 * @see DBRefEntry#updateFrom(DBRefEntry)
1140 @Test(groups = { "Functional" })
1141 public void testAddDBRef()
1143 SequenceI sq = new Sequence("", "abcde");
1144 assertNull(sq.getDBRefs());
1145 DBRefEntry dbref = new DBRefEntry("Uniprot", "1", "P00340");
1147 assertEquals(1, sq.getDBRefs().length);
1148 assertSame(dbref, sq.getDBRefs()[0]);
1151 * change of version - new entry
1153 DBRefEntry dbref2 = new DBRefEntry("Uniprot", "2", "P00340");
1154 sq.addDBRef(dbref2);
1155 assertEquals(2, sq.getDBRefs().length);
1156 assertSame(dbref, sq.getDBRefs()[0]);
1157 assertSame(dbref2, sq.getDBRefs()[1]);
1160 * matches existing entry - not added
1162 sq.addDBRef(new DBRefEntry("UNIPROT", "1", "p00340"));
1163 assertEquals(2, sq.getDBRefs().length);
1166 * different source = new entry
1168 DBRefEntry dbref3 = new DBRefEntry("UniRef", "1", "p00340");
1169 sq.addDBRef(dbref3);
1170 assertEquals(3, sq.getDBRefs().length);
1171 assertSame(dbref3, sq.getDBRefs()[2]);
1174 * different ref = new entry
1176 DBRefEntry dbref4 = new DBRefEntry("UniRef", "1", "p00341");
1177 sq.addDBRef(dbref4);
1178 assertEquals(4, sq.getDBRefs().length);
1179 assertSame(dbref4, sq.getDBRefs()[3]);
1182 * matching ref with a mapping - map updated
1184 DBRefEntry dbref5 = new DBRefEntry("UniRef", "1", "p00341");
1185 Mapping map = new Mapping(new MapList(new int[] { 1, 3 }, new int[] {
1188 sq.addDBRef(dbref5);
1189 assertEquals(4, sq.getDBRefs().length);
1190 assertSame(dbref4, sq.getDBRefs()[3]);
1191 assertSame(map, dbref4.getMap());
1194 * 'real' version replaces "0" version
1196 dbref2.setVersion("0");
1197 DBRefEntry dbref6 = new DBRefEntry(dbref2.getSource(), "3",
1198 dbref2.getAccessionId());
1199 sq.addDBRef(dbref6);
1200 assertEquals(4, sq.getDBRefs().length);
1201 assertSame(dbref2, sq.getDBRefs()[1]);
1202 assertEquals("3", dbref2.getVersion());
1205 * 'real' version replaces "source:0" version
1207 dbref3.setVersion("Uniprot:0");
1208 DBRefEntry dbref7 = new DBRefEntry(dbref3.getSource(), "3",
1209 dbref3.getAccessionId());
1210 sq.addDBRef(dbref7);
1211 assertEquals(4, sq.getDBRefs().length);
1212 assertSame(dbref3, sq.getDBRefs()[2]);
1213 assertEquals("3", dbref2.getVersion());
1216 @Test(groups = { "Functional" })
1217 public void testGetPrimaryDBRefs_peptide()
1219 SequenceI sq = new Sequence("aseq", "ASDFKYLMQPRST", 10, 22);
1222 List<DBRefEntry> primaryDBRefs = sq.getPrimaryDBRefs();
1223 assertTrue(primaryDBRefs.isEmpty());
1226 sq.setDBRefs(new DBRefEntry[] {});
1227 primaryDBRefs = sq.getPrimaryDBRefs();
1228 assertTrue(primaryDBRefs.isEmpty());
1230 // primary - uniprot
1231 DBRefEntry upentry1 = new DBRefEntry("UNIPROT", "0", "Q04760");
1232 sq.addDBRef(upentry1);
1234 // primary - uniprot with congruent map
1235 DBRefEntry upentry2 = new DBRefEntry("UNIPROT", "0", "Q04762");
1236 upentry2.setMap(new Mapping(null, new MapList(new int[] { 10, 22 },
1237 new int[] { 10, 22 }, 1, 1)));
1238 sq.addDBRef(upentry2);
1240 // primary - uniprot with map of enclosing sequence
1241 DBRefEntry upentry3 = new DBRefEntry("UNIPROT", "0", "Q04763");
1242 upentry3.setMap(new Mapping(null, new MapList(new int[] { 8, 24 },
1243 new int[] { 8, 24 }, 1, 1)));
1244 sq.addDBRef(upentry3);
1246 // not primary - uniprot with map of sub-sequence (5')
1247 DBRefEntry upentry4 = new DBRefEntry("UNIPROT", "0", "Q04764");
1248 upentry4.setMap(new Mapping(null, new MapList(new int[] { 10, 18 },
1249 new int[] { 10, 18 }, 1, 1)));
1250 sq.addDBRef(upentry4);
1252 // not primary - uniprot with map that overlaps 3'
1253 DBRefEntry upentry5 = new DBRefEntry("UNIPROT", "0", "Q04765");
1254 upentry5.setMap(new Mapping(null, new MapList(new int[] { 12, 22 },
1255 new int[] { 12, 22 }, 1, 1)));
1256 sq.addDBRef(upentry5);
1258 // not primary - uniprot with map to different coordinates frame
1259 DBRefEntry upentry6 = new DBRefEntry("UNIPROT", "0", "Q04766");
1260 upentry6.setMap(new Mapping(null, new MapList(new int[] { 12, 18 },
1261 new int[] { 112, 118 }, 1, 1)));
1262 sq.addDBRef(upentry6);
1264 // not primary - dbref to 'non-core' database
1265 DBRefEntry upentry7 = new DBRefEntry("Pfam", "0", "PF00903");
1266 sq.addDBRef(upentry7);
1268 // primary - type is PDB
1269 DBRefEntry pdbentry = new DBRefEntry("PDB", "0", "1qip");
1270 sq.addDBRef(pdbentry);
1272 // not primary - PDBEntry has no file
1273 sq.addDBRef(new DBRefEntry("PDB", "0", "1AAA"));
1275 // not primary - no PDBEntry
1276 sq.addDBRef(new DBRefEntry("PDB", "0", "1DDD"));
1278 // add corroborating PDB entry for primary DBref -
1279 // needs to have a file as well as matching ID
1280 // note PDB ID is not treated as case sensitive
1281 sq.addPDBId(new PDBEntry("1QIP", null, Type.PDB, new File("/blah")
1284 // not valid DBRef - no file..
1285 sq.addPDBId(new PDBEntry("1AAA", null, null, null));
1287 primaryDBRefs = sq.getPrimaryDBRefs();
1288 assertEquals(4, primaryDBRefs.size());
1289 assertTrue("Couldn't find simple primary reference (UNIPROT)",
1290 primaryDBRefs.contains(upentry1));
1291 assertTrue("Couldn't find mapped primary reference (UNIPROT)",
1292 primaryDBRefs.contains(upentry2));
1293 assertTrue("Couldn't find mapped context reference (UNIPROT)",
1294 primaryDBRefs.contains(upentry3));
1295 assertTrue("Couldn't find expected PDB primary reference",
1296 primaryDBRefs.contains(pdbentry));
1299 @Test(groups = { "Functional" })
1300 public void testGetPrimaryDBRefs_nucleotide()
1302 SequenceI sq = new Sequence("aseq", "TGATCACTCGACTAGCATCAGCATA", 10, 34);
1304 // primary - Ensembl
1305 DBRefEntry dbr1 = new DBRefEntry("ENSEMBL", "0", "ENSG1234");
1308 // not primary - Ensembl 'transcript' mapping of sub-sequence
1309 DBRefEntry dbr2 = new DBRefEntry("ENSEMBL", "0", "ENST1234");
1310 dbr2.setMap(new Mapping(null, new MapList(new int[] { 15, 25 },
1311 new int[] { 1, 11 }, 1, 1)));
1314 // primary - EMBL with congruent map
1315 DBRefEntry dbr3 = new DBRefEntry("EMBL", "0", "J1234");
1316 dbr3.setMap(new Mapping(null, new MapList(new int[] { 10, 34 },
1317 new int[] { 10, 34 }, 1, 1)));
1320 // not primary - to non-core database
1321 DBRefEntry dbr4 = new DBRefEntry("CCDS", "0", "J1234");
1324 // not primary - to protein
1325 DBRefEntry dbr5 = new DBRefEntry("UNIPROT", "0", "Q87654");
1328 List<DBRefEntry> primaryDBRefs = sq.getPrimaryDBRefs();
1329 assertEquals(2, primaryDBRefs.size());
1330 assertTrue(primaryDBRefs.contains(dbr1));
1331 assertTrue(primaryDBRefs.contains(dbr3));
1335 * Test the method that updates the list of PDBEntry from any new DBRefEntry
1338 @Test(groups = { "Functional" })
1339 public void testUpdatePDBIds()
1341 PDBEntry pdbe1 = new PDBEntry("3A6S", null, null, null);
1342 seq.addPDBId(pdbe1);
1343 seq.addDBRef(new DBRefEntry("Ensembl", "8", "ENST1234"));
1344 seq.addDBRef(new DBRefEntry("PDB", "0", "1A70"));
1345 seq.addDBRef(new DBRefEntry("PDB", "0", "4BQGa"));
1346 seq.addDBRef(new DBRefEntry("PDB", "0", "3a6sB"));
1347 // 7 is not a valid chain code:
1348 seq.addDBRef(new DBRefEntry("PDB", "0", "2GIS7"));
1351 List<PDBEntry> pdbIds = seq.getAllPDBEntries();
1352 assertEquals(4, pdbIds.size());
1353 assertSame(pdbe1, pdbIds.get(0));
1354 // chain code got added to 3A6S:
1355 assertEquals("B", pdbe1.getChainCode());
1356 assertEquals("1A70", pdbIds.get(1).getId());
1357 // 4BQGA is parsed into id + chain
1358 assertEquals("4BQG", pdbIds.get(2).getId());
1359 assertEquals("a", pdbIds.get(2).getChainCode());
1360 assertEquals("2GIS7", pdbIds.get(3).getId());
1361 assertNull(pdbIds.get(3).getChainCode());
1365 * Test the method that either adds a pdbid or updates an existing one
1367 @Test(groups = { "Functional" })
1368 public void testAddPDBId()
1370 PDBEntry pdbe = new PDBEntry("3A6S", null, null, null);
1372 assertEquals(1, seq.getAllPDBEntries().size());
1373 assertSame(pdbe, seq.getPDBEntry("3A6S"));
1374 assertSame(pdbe, seq.getPDBEntry("3a6s")); // case-insensitive
1376 // add the same entry
1378 assertEquals(1, seq.getAllPDBEntries().size());
1379 assertSame(pdbe, seq.getPDBEntry("3A6S"));
1381 // add an identical entry
1382 seq.addPDBId(new PDBEntry("3A6S", null, null, null));
1383 assertEquals(1, seq.getAllPDBEntries().size());
1384 assertSame(pdbe, seq.getPDBEntry("3A6S"));
1386 // add a different entry
1387 PDBEntry pdbe2 = new PDBEntry("1A70", null, null, null);
1388 seq.addPDBId(pdbe2);
1389 assertEquals(2, seq.getAllPDBEntries().size());
1390 assertSame(pdbe, seq.getAllPDBEntries().get(0));
1391 assertSame(pdbe2, seq.getAllPDBEntries().get(1));
1393 // update pdbe with chain code, file, type
1394 PDBEntry pdbe3 = new PDBEntry("3a6s", "A", Type.PDB, "filepath");
1395 seq.addPDBId(pdbe3);
1396 assertEquals(2, seq.getAllPDBEntries().size());
1397 assertSame(pdbe, seq.getAllPDBEntries().get(0)); // updated in situ
1398 assertEquals("3A6S", pdbe.getId()); // unchanged
1399 assertEquals("A", pdbe.getChainCode()); // updated
1400 assertEquals(Type.PDB.toString(), pdbe.getType()); // updated
1401 assertEquals("filepath", pdbe.getFile()); // updated
1402 assertSame(pdbe2, seq.getAllPDBEntries().get(1));
1404 // add with a different file path
1405 PDBEntry pdbe4 = new PDBEntry("3a6s", "A", Type.PDB, "filepath2");
1406 seq.addPDBId(pdbe4);
1407 assertEquals(3, seq.getAllPDBEntries().size());
1408 assertSame(pdbe4, seq.getAllPDBEntries().get(2));
1410 // add with a different chain code
1411 PDBEntry pdbe5 = new PDBEntry("3a6s", "B", Type.PDB, "filepath");
1412 seq.addPDBId(pdbe5);
1413 assertEquals(4, seq.getAllPDBEntries().size());
1414 assertSame(pdbe5, seq.getAllPDBEntries().get(3));
1418 groups = { "Functional" },
1419 expectedExceptions = { IllegalArgumentException.class })
1420 public void testSetDatasetSequence_toSelf()
1422 seq.setDatasetSequence(seq);
1426 groups = { "Functional" },
1427 expectedExceptions = { IllegalArgumentException.class })
1428 public void testSetDatasetSequence_cascading()
1430 SequenceI seq2 = new Sequence("Seq2", "xyz");
1431 seq2.createDatasetSequence();
1432 seq.setDatasetSequence(seq2);
1435 @Test(groups = { "Functional" })
1436 public void testFindFeatures()
1438 SequenceI sq = new Sequence("test/8-16", "-ABC--DEF--GHI--");
1439 sq.createDatasetSequence();
1441 assertTrue(sq.findFeatures(1, 99).isEmpty());
1443 // add non-positional feature
1444 SequenceFeature sf0 = new SequenceFeature("Cath", "desc", 0, 0, 2f,
1446 sq.addSequenceFeature(sf0);
1447 // add feature on BCD
1448 SequenceFeature sfBCD = new SequenceFeature("Cath", "desc", 9, 11, 2f,
1450 sq.addSequenceFeature(sfBCD);
1451 // add feature on DE
1452 SequenceFeature sfDE = new SequenceFeature("Cath", "desc", 11, 12, 2f,
1454 sq.addSequenceFeature(sfDE);
1455 // add contact feature at [B, H]
1456 SequenceFeature sfContactBH = new SequenceFeature("Disulphide bond",
1457 "desc", 9, 15, 2f, null);
1458 sq.addSequenceFeature(sfContactBH);
1459 // add contact feature at [F, G]
1460 SequenceFeature sfContactFG = new SequenceFeature("Disulfide Bond",
1461 "desc", 13, 14, 2f, null);
1462 sq.addSequenceFeature(sfContactFG);
1463 // add single position feature at [I]
1464 SequenceFeature sfI = new SequenceFeature("Disulfide Bond",
1465 "desc", 16, 16, null);
1466 sq.addSequenceFeature(sfI);
1468 // no features in columns 1-2 (-A)
1469 List<SequenceFeature> found = sq.findFeatures(1, 2);
1470 assertTrue(found.isEmpty());
1472 // columns 1-6 (-ABC--) includes BCD and B/H feature but not DE
1473 found = sq.findFeatures(1, 6);
1474 assertEquals(2, found.size());
1475 assertTrue(found.contains(sfBCD));
1476 assertTrue(found.contains(sfContactBH));
1478 // columns 5-6 (--) includes (enclosing) BCD but not (contact) B/H feature
1479 found = sq.findFeatures(5, 6);
1480 assertEquals(1, found.size());
1481 assertTrue(found.contains(sfBCD));
1483 // columns 7-10 (DEF-) includes BCD, DE, F/G but not B/H feature
1484 found = sq.findFeatures(7, 10);
1485 assertEquals(3, found.size());
1486 assertTrue(found.contains(sfBCD));
1487 assertTrue(found.contains(sfDE));
1488 assertTrue(found.contains(sfContactFG));
1490 // columns 10-11 (--) should find nothing
1491 found = sq.findFeatures(10, 11);
1492 assertEquals(0, found.size());
1494 // columns 14-14 (I) should find variant feature
1495 found = sq.findFeatures(14, 14);
1496 assertEquals(1, found.size());
1497 assertTrue(found.contains(sfI));
1500 @Test(groups = { "Functional" })
1501 public void testFindIndex_withCursor()
1503 Sequence sq = new Sequence("test/8-13", "-A--BCD-EF--");
1505 // find F given A, check cursor is now at the found position
1506 assertEquals(10, sq.findIndex(13, new SequenceCursor(sq, 8, 2, 0)));
1507 SequenceCursor cursor = (SequenceCursor) PA.getValue(sq, "cursor");
1508 assertEquals(13, cursor.residuePosition);
1509 assertEquals(10, cursor.columnPosition);
1512 assertEquals(2, sq.findIndex(8, new SequenceCursor(sq, 13, 10, 0)));
1513 cursor = (SequenceCursor) PA.getValue(sq, "cursor");
1514 assertEquals(8, cursor.residuePosition);
1515 assertEquals(2, cursor.columnPosition);
1517 // find C given C (no cursor update is done for this case)
1518 assertEquals(6, sq.findIndex(10, new SequenceCursor(sq, 10, 6, 0)));
1519 SequenceCursor cursor2 = (SequenceCursor) PA.getValue(sq, "cursor");
1520 assertSame(cursor2, cursor);
1523 * sequence 'end' beyond end of sequence returns length of sequence
1524 * (for compatibility with pre-cursor code)
1525 * - also verify the cursor is left in a valid state
1527 sq = new Sequence("test/8-99", "-A--B-C-D-E-F--"); // trailing gap case
1528 assertEquals(7, sq.findIndex(10)); // establishes a cursor
1529 cursor = (SequenceCursor) PA.getValue(sq, "cursor");
1530 assertEquals(10, cursor.residuePosition);
1531 assertEquals(7, cursor.columnPosition);
1532 assertEquals(sq.getLength(), sq.findIndex(65));
1533 cursor2 = (SequenceCursor) PA.getValue(sq, "cursor");
1534 assertSame(cursor, cursor2); // not updated for this case!
1536 sq = new Sequence("test/8-99", "-A--B-C-D-E-F"); // trailing residue case
1537 sq.findIndex(10); // establishes a cursor
1538 cursor = (SequenceCursor) PA.getValue(sq, "cursor");
1539 assertEquals(sq.getLength(), sq.findIndex(65));
1540 cursor2 = (SequenceCursor) PA.getValue(sq, "cursor");
1541 assertSame(cursor, cursor2); // not updated for this case!
1544 * residue after sequence 'start' but before first residue should return
1545 * zero (for compatibility with pre-cursor code)
1547 sq = new Sequence("test/8-15", "-A-B-C-"); // leading gap case
1548 sq.findIndex(10); // establishes a cursor
1549 cursor = (SequenceCursor) PA.getValue(sq, "cursor");
1550 assertEquals(0, sq.findIndex(3));
1551 cursor2 = (SequenceCursor) PA.getValue(sq, "cursor");
1552 assertSame(cursor, cursor2); // not updated for this case!
1554 sq = new Sequence("test/8-15", "A-B-C-"); // leading residue case
1555 sq.findIndex(10); // establishes a cursor
1556 cursor = (SequenceCursor) PA.getValue(sq, "cursor");
1557 assertEquals(0, sq.findIndex(2));
1558 cursor2 = (SequenceCursor) PA.getValue(sq, "cursor");
1559 assertSame(cursor, cursor2); // not updated for this case!
1562 @Test(groups = { "Functional" })
1563 public void testFindPosition_withCursor()
1565 Sequence sq = new Sequence("test/8-13", "-A--BCD-EF--");
1567 // find F pos given A - lastCol gets set in cursor
1568 assertEquals(13, sq.findPosition(10, new SequenceCursor(sq, 8, 2, 0)));
1569 assertEquals("test:Pos13:Col10:startCol0:endCol10:tok0",
1570 PA.getValue(sq, "cursor").toString());
1572 // find A pos given F - first residue column is saved in cursor
1573 assertEquals(8, sq.findPosition(2, new SequenceCursor(sq, 13, 10, 0)));
1574 assertEquals("test:Pos8:Col2:startCol2:endCol10:tok0",
1575 PA.getValue(sq, "cursor").toString());
1577 // find C pos given C (neither startCol nor endCol is set)
1578 assertEquals(10, sq.findPosition(6, new SequenceCursor(sq, 10, 6, 0)));
1579 assertEquals("test:Pos10:Col6:startCol0:endCol0:tok0",
1580 PA.getValue(sq, "cursor").toString());
1582 // now the grey area - what residue position for a gapped column? JAL-2562
1584 // find 'residue' for column 3 given cursor for D (so working left)
1585 // returns B9; cursor is updated to [B 5]
1586 assertEquals(9, sq.findPosition(3, new SequenceCursor(sq, 11, 7, 0)));
1587 assertEquals("test:Pos9:Col5:startCol0:endCol0:tok0",
1588 PA.getValue(sq, "cursor").toString());
1590 // find 'residue' for column 8 given cursor for D (so working right)
1591 // returns E12; cursor is updated to [D 7]
1592 assertEquals(12, sq.findPosition(8, new SequenceCursor(sq, 11, 7, 0)));
1593 assertEquals("test:Pos11:Col7:startCol0:endCol0:tok0",
1594 PA.getValue(sq, "cursor").toString());
1596 // find 'residue' for column 12 given cursor for B
1597 // returns 1 more than last residue position; cursor is updated to [F 10]
1598 // lastCol position is saved in cursor
1599 assertEquals(14, sq.findPosition(12, new SequenceCursor(sq, 9, 5, 0)));
1600 assertEquals("test:Pos13:Col10:startCol0:endCol10:tok0",
1601 PA.getValue(sq, "cursor").toString());
1604 * findPosition for column beyond length of sequence
1605 * returns 1 more than the last residue position
1606 * cursor is set to last real residue position [F 10]
1608 assertEquals(14, sq.findPosition(99, new SequenceCursor(sq, 8, 2, 0)));
1609 assertEquals("test:Pos13:Col10:startCol0:endCol10:tok0",
1610 PA.getValue(sq, "cursor").toString());
1613 * and the case without a trailing gap
1615 sq = new Sequence("test/8-13", "-A--BCD-EF");
1616 // first find C from A
1617 assertEquals(10, sq.findPosition(6, new SequenceCursor(sq, 8, 2, 0)));
1618 SequenceCursor cursor = (SequenceCursor) PA.getValue(sq, "cursor");
1619 assertEquals("test:Pos10:Col6:startCol0:endCol0:tok0",
1621 // now 'find' 99 from C
1622 // cursor is set to [F 10] and saved lastCol
1623 assertEquals(14, sq.findPosition(99, cursor));
1624 assertEquals("test:Pos13:Col10:startCol0:endCol10:tok0",
1625 PA.getValue(sq, "cursor").toString());
1629 public void testIsValidCursor()
1631 Sequence sq = new Sequence("Seq", "ABC--DE-F", 8, 13);
1632 assertFalse(sq.isValidCursor(null));
1635 * cursor is valid if it has valid sequence ref and changeCount token
1636 * and positions within the range of the sequence
1638 int changeCount = (int) PA.getValue(sq, "changeCount");
1639 SequenceCursor cursor = new SequenceCursor(sq, 13, 1, changeCount);
1640 assertTrue(sq.isValidCursor(cursor));
1643 * column position outside [0 - length] is rejected
1645 cursor = new SequenceCursor(sq, 13, -1, changeCount);
1646 assertFalse(sq.isValidCursor(cursor));
1647 cursor = new SequenceCursor(sq, 13, 10, changeCount);
1648 assertFalse(sq.isValidCursor(cursor));
1649 cursor = new SequenceCursor(sq, 7, 8, changeCount);
1650 assertFalse(sq.isValidCursor(cursor));
1651 cursor = new SequenceCursor(sq, 14, 2, changeCount);
1652 assertFalse(sq.isValidCursor(cursor));
1655 * wrong sequence is rejected
1657 cursor = new SequenceCursor(null, 13, 1, changeCount);
1658 assertFalse(sq.isValidCursor(cursor));
1659 cursor = new SequenceCursor(new Sequence("Seq", "abc"), 13, 1,
1661 assertFalse(sq.isValidCursor(cursor));
1664 * wrong token value is rejected
1666 cursor = new SequenceCursor(sq, 13, 1, changeCount + 1);
1667 assertFalse(sq.isValidCursor(cursor));
1668 cursor = new SequenceCursor(sq, 13, 1, changeCount - 1);
1669 assertFalse(sq.isValidCursor(cursor));
1672 @Test(groups = { "Functional" })
1673 public void testFindPosition_withCursorAndEdits()
1675 Sequence sq = new Sequence("test/8-13", "-A--BCD-EF--");
1677 // find F pos given A
1678 assertEquals(13, sq.findPosition(10, new SequenceCursor(sq, 8, 2, 0)));
1679 int token = (int) PA.getValue(sq, "changeCount"); // 0
1680 SequenceCursor cursor = (SequenceCursor) PA.getValue(sq, "cursor");
1681 assertEquals(new SequenceCursor(sq, 13, 10, token), cursor);
1684 * setSequence should invalidate the cursor cached by the sequence
1686 sq.setSequence("-A-BCD-EF---"); // one gap removed
1687 assertEquals(8, sq.getStart()); // sanity check
1688 assertEquals(11, sq.findPosition(5)); // D11
1689 // cursor should now be at [D 6]
1690 cursor = (SequenceCursor) PA.getValue(sq, "cursor");
1691 assertEquals(new SequenceCursor(sq, 11, 6, ++token), cursor);
1692 assertEquals(0, cursor.lastColumnPosition); // not yet found
1693 assertEquals(13, sq.findPosition(8)); // E13
1694 cursor = (SequenceCursor) PA.getValue(sq, "cursor");
1695 assertEquals(9, cursor.lastColumnPosition); // found
1698 * deleteChars should invalidate the cached cursor
1700 sq.deleteChars(2, 5); // delete -BC
1701 assertEquals("-AD-EF---", sq.getSequenceAsString());
1702 assertEquals(8, sq.getStart()); // sanity check
1703 assertEquals(10, sq.findPosition(4)); // E10
1704 // cursor should now be at [E 5]
1705 cursor = (SequenceCursor) PA.getValue(sq, "cursor");
1706 assertEquals(new SequenceCursor(sq, 10, 5, ++token), cursor);
1709 * Edit to insert gaps should invalidate the cached cursor
1710 * insert 2 gaps at column[3] to make -AD---EF---
1712 SequenceI[] seqs = new SequenceI[] { sq };
1713 AlignmentI al = new Alignment(seqs);
1714 new EditCommand().appendEdit(Action.INSERT_GAP, seqs, 3, 2, al, true);
1715 assertEquals("-AD---EF---", sq.getSequenceAsString());
1716 assertEquals(10, sq.findPosition(4)); // E10
1717 // cursor should now be at [D 3]
1718 cursor = (SequenceCursor) PA.getValue(sq, "cursor");
1719 assertEquals(new SequenceCursor(sq, 9, 3, ++token), cursor);
1722 * insertCharAt should invalidate the cached cursor
1723 * insert CC at column[4] to make -AD-CC--EF---
1725 sq.insertCharAt(4, 2, 'C');
1726 assertEquals("-AD-CC--EF---", sq.getSequenceAsString());
1727 assertEquals(13, sq.findPosition(9)); // F13
1728 // cursor should now be at [F 10]
1729 cursor = (SequenceCursor) PA.getValue(sq, "cursor");
1730 assertEquals(new SequenceCursor(sq, 13, 10, ++token), cursor);
1733 @Test(groups = { "Functional" })
1734 public void testGetSequence()
1736 String seqstring = "-A--BCD-EF--";
1737 Sequence sq = new Sequence("test/8-13", seqstring);
1738 sq.createDatasetSequence();
1739 assertTrue(Arrays.equals(sq.getSequence(), seqstring.toCharArray()));
1740 assertTrue(Arrays.equals(sq.getDatasetSequence().getSequence(),
1741 "ABCDEF".toCharArray()));
1743 // verify a copy of the sequence array is returned
1744 char[] theSeq = (char[]) PA.getValue(sq, "sequence");
1745 assertNotSame(theSeq, sq.getSequence());
1746 theSeq = (char[]) PA.getValue(sq.getDatasetSequence(), "sequence");
1747 assertNotSame(theSeq, sq.getDatasetSequence().getSequence());
1750 @Test(groups = { "Functional" })
1751 public void testReplace()
1753 String seqstring = "-A--BCD-EF--";
1754 SequenceI sq = new Sequence("test/8-13", seqstring);
1755 assertEquals(0, PA.getValue(sq, "changeCount"));
1757 assertEquals(0, sq.replace('A', 'A')); // same char
1758 assertEquals(seqstring, sq.getSequenceAsString());
1759 assertEquals(0, PA.getValue(sq, "changeCount"));
1761 assertEquals(0, sq.replace('X', 'Y')); // not there
1762 assertEquals(seqstring, sq.getSequenceAsString());
1763 assertEquals(0, PA.getValue(sq, "changeCount"));
1765 assertEquals(1, sq.replace('A', 'K'));
1766 assertEquals("-K--BCD-EF--", sq.getSequenceAsString());
1767 assertEquals(1, PA.getValue(sq, "changeCount"));
1769 assertEquals(6, sq.replace('-', '.'));
1770 assertEquals(".K..BCD.EF..", sq.getSequenceAsString());
1771 assertEquals(2, PA.getValue(sq, "changeCount"));
1774 @Test(groups = { "Functional" })
1775 public void testGapBitset()
1777 SequenceI sq = new Sequence("test/8-13", "-ABC---DE-F--");
1778 BitSet bs = sq.gapBitset();
1779 BitSet expected = new BitSet();
1783 expected.set(11, 13);
1785 assertTrue(bs.equals(expected));
1789 public void testFindFeatures_largeEndPos()
1792 * imitate a PDB sequence where end is larger than end position
1794 SequenceI sq = new Sequence("test", "-ABC--DEF--", 1, 20);
1795 sq.createDatasetSequence();
1797 assertTrue(sq.findFeatures(1, 9).isEmpty());
1798 // should be no array bounds exception - JAL-2772
1799 assertTrue(sq.findFeatures(1, 15).isEmpty());
1801 // add feature on BCD
1802 SequenceFeature sfBCD = new SequenceFeature("Cath", "desc", 2, 4, 2f,
1804 sq.addSequenceFeature(sfBCD);
1806 // no features in columns 1-2 (-A)
1807 List<SequenceFeature> found = sq.findFeatures(1, 2);
1808 assertTrue(found.isEmpty());
1810 // columns 1-6 (-ABC--) includes BCD
1811 found = sq.findFeatures(1, 6);
1812 assertEquals(1, found.size());
1813 assertTrue(found.contains(sfBCD));
1815 // columns 10-11 (--) should find nothing
1816 found = sq.findFeatures(10, 11);
1817 assertEquals(0, found.size());
1820 @Test(groups = { "Functional" })
1821 public void testSetName()
1823 SequenceI sq = new Sequence("test", "-ABC---DE-F--");
1824 assertEquals("test", sq.getName());
1825 assertEquals(1, sq.getStart());
1826 assertEquals(6, sq.getEnd());
1828 sq.setName("testing");
1829 assertEquals("testing", sq.getName());
1831 sq.setName("test/8-10");
1832 assertEquals("test", sq.getName());
1833 assertEquals(8, sq.getStart());
1834 assertEquals(13, sq.getEnd()); // note end is recomputed
1836 sq.setName("testing/7-99");
1837 assertEquals("testing", sq.getName());
1838 assertEquals(7, sq.getStart());
1839 assertEquals(99, sq.getEnd()); // end may be beyond physical end
1842 assertEquals("", sq.getName());
1843 assertEquals(2, sq.getStart());
1844 assertEquals(7, sq.getEnd());
1846 sq.setName("test/"); // invalid
1847 assertEquals("test/", sq.getName());
1848 assertEquals(2, sq.getStart());
1849 assertEquals(7, sq.getEnd());
1851 sq.setName("test/6-13/7-99");
1852 assertEquals("test/6-13", sq.getName());
1853 assertEquals(7, sq.getStart());
1854 assertEquals(99, sq.getEnd());
1856 sq.setName("test/0-5"); // 0 is invalid - ignored
1857 assertEquals("test/0-5", sq.getName());
1858 assertEquals(7, sq.getStart());
1859 assertEquals(99, sq.getEnd());
1861 sq.setName("test/a-5"); // a is invalid - ignored
1862 assertEquals("test/a-5", sq.getName());
1863 assertEquals(7, sq.getStart());
1864 assertEquals(99, sq.getEnd());
1866 sq.setName("test/6-5"); // start > end is invalid - ignored
1867 assertEquals("test/6-5", sq.getName());
1868 assertEquals(7, sq.getStart());
1869 assertEquals(99, sq.getEnd());
1871 sq.setName("test/5"); // invalid - ignored
1872 assertEquals("test/5", sq.getName());
1873 assertEquals(7, sq.getStart());
1874 assertEquals(99, sq.getEnd());
1876 sq.setName("test/-5"); // invalid - ignored
1877 assertEquals("test/-5", sq.getName());
1878 assertEquals(7, sq.getStart());
1879 assertEquals(99, sq.getEnd());
1881 sq.setName("test/5-"); // invalid - ignored
1882 assertEquals("test/5-", sq.getName());
1883 assertEquals(7, sq.getStart());
1884 assertEquals(99, sq.getEnd());
1886 sq.setName("test/5-6-7"); // invalid - ignored
1887 assertEquals("test/5-6-7", sq.getName());
1888 assertEquals(7, sq.getStart());
1889 assertEquals(99, sq.getEnd());
1891 sq.setName(null); // invalid, gets converted to space
1892 assertEquals("", sq.getName());
1893 assertEquals(7, sq.getStart());
1894 assertEquals(99, sq.getEnd());
1897 @Test(groups = { "Functional" })
1898 public void testCheckValidRange()
1900 Sequence sq = new Sequence("test/7-12", "-ABC---DE-F--");
1901 assertEquals(7, sq.getStart());
1902 assertEquals(12, sq.getEnd());
1905 * checkValidRange ensures end is at least the last residue position
1907 PA.setValue(sq, "end", 2);
1908 sq.checkValidRange();
1909 assertEquals(12, sq.getEnd());
1912 * end may be beyond the last residue position
1914 PA.setValue(sq, "end", 22);
1915 sq.checkValidRange();
1916 assertEquals(22, sq.getEnd());
1919 @Test(groups = { "Functional" })
1920 public void testDeleteChars_withGaps()
1925 SequenceI sq = new Sequence("test/8-10", "A-B-C");
1926 sq.createDatasetSequence();
1927 assertEquals("ABC", sq.getDatasetSequence().getSequenceAsString());
1928 sq.deleteChars(1, 2); // delete first gap
1929 assertEquals("AB-C", sq.getSequenceAsString());
1930 assertEquals(8, sq.getStart());
1931 assertEquals(10, sq.getEnd());
1932 assertEquals("ABC", sq.getDatasetSequence().getSequenceAsString());
1935 * delete gaps and residues at start (no new dataset sequence)
1937 sq = new Sequence("test/8-10", "A-B-C");
1938 sq.createDatasetSequence();
1939 sq.deleteChars(0, 3); // delete A-B
1940 assertEquals("-C", sq.getSequenceAsString());
1941 assertEquals(10, sq.getStart());
1942 assertEquals(10, sq.getEnd());
1943 assertEquals("ABC", sq.getDatasetSequence().getSequenceAsString());
1946 * delete gaps and residues at end (no new dataset sequence)
1948 sq = new Sequence("test/8-10", "A-B-C");
1949 sq.createDatasetSequence();
1950 sq.deleteChars(2, 5); // delete B-C
1951 assertEquals("A-", sq.getSequenceAsString());
1952 assertEquals(8, sq.getStart());
1953 assertEquals(8, sq.getEnd());
1954 assertEquals("ABC", sq.getDatasetSequence().getSequenceAsString());
1957 * delete gaps and residues internally (new dataset sequence)
1958 * first delete from gap to residue
1960 sq = new Sequence("test/8-10", "A-B-C");
1961 sq.createDatasetSequence();
1962 sq.deleteChars(1, 3); // delete -B
1963 assertEquals("A-C", sq.getSequenceAsString());
1964 assertEquals(8, sq.getStart());
1965 assertEquals(9, sq.getEnd());
1966 assertEquals("AC", sq.getDatasetSequence().getSequenceAsString());
1967 assertEquals(8, sq.getDatasetSequence().getStart());
1968 assertEquals(9, sq.getDatasetSequence().getEnd());
1971 * internal delete from gap to gap
1973 sq = new Sequence("test/8-10", "A-B-C");
1974 sq.createDatasetSequence();
1975 sq.deleteChars(1, 4); // delete -B-
1976 assertEquals("AC", sq.getSequenceAsString());
1977 assertEquals(8, sq.getStart());
1978 assertEquals(9, sq.getEnd());
1979 assertEquals("AC", sq.getDatasetSequence().getSequenceAsString());
1980 assertEquals(8, sq.getDatasetSequence().getStart());
1981 assertEquals(9, sq.getDatasetSequence().getEnd());
1984 * internal delete from residue to residue
1986 sq = new Sequence("test/8-10", "A-B-C");
1987 sq.createDatasetSequence();
1988 sq.deleteChars(2, 3); // delete B
1989 assertEquals("A--C", sq.getSequenceAsString());
1990 assertEquals(8, sq.getStart());
1991 assertEquals(9, sq.getEnd());
1992 assertEquals("AC", sq.getDatasetSequence().getSequenceAsString());
1993 assertEquals(8, sq.getDatasetSequence().getStart());
1994 assertEquals(9, sq.getDatasetSequence().getEnd());
1998 * Test the code used to locate the reference sequence ruler origin
2000 @Test(groups = { "Functional" })
2001 public void testLocateVisibleStartofSequence()
2003 // create random alignment
2004 AlignmentGenerator gen = new AlignmentGenerator(false);
2005 AlignmentI al = gen.generate(50, 20, 123, 5, 5);
2007 HiddenColumns cs = al.getHiddenColumns();
2008 ColumnSelection colsel = new ColumnSelection();
2010 SequenceI seq = new Sequence("RefSeq", "-A-SD-ASD--E---");
2011 assertEquals(2, seq.findIndex(seq.getStart()));
2013 // no hidden columns
2014 assertEquals(seq.findIndex(seq.getStart()) - 1,
2015 seq.firstResidueOutsideIterator(cs.iterator()));
2017 // hidden column on gap after end of sequence - should not affect bounds
2018 colsel.hideSelectedColumns(13, al.getHiddenColumns());
2019 assertEquals(seq.findIndex(seq.getStart()) - 1,
2020 seq.firstResidueOutsideIterator(cs.iterator()));
2022 cs.revealAllHiddenColumns(colsel);
2023 // hidden column on gap before beginning of sequence - should vis bounds by
2025 colsel.hideSelectedColumns(0, al.getHiddenColumns());
2026 assertEquals(seq.findIndex(seq.getStart()) - 2,
2027 cs.absoluteToVisibleColumn(
2028 seq.firstResidueOutsideIterator(cs.iterator())));
2030 cs.revealAllHiddenColumns(colsel);
2031 // hide columns around most of sequence - leave one residue remaining
2032 cs.hideColumns(1, 3);
2033 cs.hideColumns(6, 11);
2035 Iterator<int[]> it = cs.getVisContigsIterator(0, 6, false);
2037 assertEquals("-D", seq.getSequenceStringFromIterator(it));
2038 // cs.getVisibleSequenceStrings(0, 5, new SequenceI[]
2041 assertEquals(4, seq.firstResidueOutsideIterator(cs.iterator()));
2042 cs.revealAllHiddenColumns(colsel);
2044 // hide whole sequence - should just get location of hidden region
2045 // containing sequence
2046 cs.hideColumns(1, 11);
2047 assertEquals(0, seq.firstResidueOutsideIterator(cs.iterator()));
2049 cs.revealAllHiddenColumns(colsel);
2050 cs.hideColumns(0, 15);
2051 assertEquals(0, seq.firstResidueOutsideIterator(cs.iterator()));
2053 SequenceI seq2 = new Sequence("RefSeq2", "-------A-SD-ASD--E---");
2055 cs.revealAllHiddenColumns(colsel);
2056 cs.hideColumns(7, 17);
2057 assertEquals(0, seq2.firstResidueOutsideIterator(cs.iterator()));
2059 cs.revealAllHiddenColumns(colsel);
2060 cs.hideColumns(3, 17);
2061 assertEquals(0, seq2.firstResidueOutsideIterator(cs.iterator()));
2063 cs.revealAllHiddenColumns(colsel);
2064 cs.hideColumns(3, 19);
2065 assertEquals(0, seq2.firstResidueOutsideIterator(cs.iterator()));
2067 cs.revealAllHiddenColumns(colsel);
2068 cs.hideColumns(0, 0);
2069 assertEquals(1, seq.firstResidueOutsideIterator(cs.iterator()));
2071 cs.revealAllHiddenColumns(colsel);
2072 cs.hideColumns(0, 1);
2073 assertEquals(3, seq.firstResidueOutsideIterator(cs.iterator()));
2075 cs.revealAllHiddenColumns(colsel);
2076 cs.hideColumns(0, 2);
2077 assertEquals(3, seq.firstResidueOutsideIterator(cs.iterator()));
2079 cs.revealAllHiddenColumns(colsel);
2080 cs.hideColumns(1, 1);
2081 assertEquals(3, seq.firstResidueOutsideIterator(cs.iterator()));
2083 cs.revealAllHiddenColumns(colsel);
2084 cs.hideColumns(1, 2);
2085 assertEquals(3, seq.firstResidueOutsideIterator(cs.iterator()));
2087 cs.revealAllHiddenColumns(colsel);
2088 cs.hideColumns(1, 3);
2089 assertEquals(4, seq.firstResidueOutsideIterator(cs.iterator()));
2091 cs.revealAllHiddenColumns(colsel);
2092 cs.hideColumns(0, 2);
2093 cs.hideColumns(5, 6);
2094 assertEquals(3, seq.firstResidueOutsideIterator(cs.iterator()));
2096 cs.revealAllHiddenColumns(colsel);
2097 cs.hideColumns(0, 2);
2098 cs.hideColumns(5, 6);
2099 cs.hideColumns(9, 10);
2100 assertEquals(3, seq.firstResidueOutsideIterator(cs.iterator()));
2102 cs.revealAllHiddenColumns(colsel);
2103 cs.hideColumns(0, 2);
2104 cs.hideColumns(7, 11);
2105 assertEquals(3, seq.firstResidueOutsideIterator(cs.iterator()));
2107 cs.revealAllHiddenColumns(colsel);
2108 cs.hideColumns(2, 4);
2109 cs.hideColumns(7, 11);
2110 assertEquals(1, seq.firstResidueOutsideIterator(cs.iterator()));
2112 cs.revealAllHiddenColumns(colsel);
2113 cs.hideColumns(2, 4);
2114 cs.hideColumns(7, 12);
2115 assertEquals(1, seq.firstResidueOutsideIterator(cs.iterator()));
2117 cs.revealAllHiddenColumns(colsel);
2118 cs.hideColumns(1, 11);
2119 assertEquals(0, seq.firstResidueOutsideIterator(cs.iterator()));
2121 cs.revealAllHiddenColumns(colsel);
2122 cs.hideColumns(0, 12);
2123 assertEquals(0, seq.firstResidueOutsideIterator(cs.iterator()));
2125 cs.revealAllHiddenColumns(colsel);
2126 cs.hideColumns(0, 4);
2127 cs.hideColumns(6, 12);
2128 assertEquals(0, seq.firstResidueOutsideIterator(cs.iterator()));
2130 cs.revealAllHiddenColumns(colsel);
2131 cs.hideColumns(0, 1);
2132 cs.hideColumns(3, 12);
2133 assertEquals(0, seq.firstResidueOutsideIterator(cs.iterator()));
2135 cs.revealAllHiddenColumns(colsel);
2136 cs.hideColumns(3, 14);
2137 cs.hideColumns(17, 19);
2138 assertEquals(0, seq2.firstResidueOutsideIterator(cs.iterator()));
2140 cs.revealAllHiddenColumns(colsel);
2141 cs.hideColumns(3, 7);
2142 cs.hideColumns(9, 14);
2143 cs.hideColumns(17, 19);
2144 assertEquals(0, seq2.firstResidueOutsideIterator(cs.iterator()));
2146 cs.revealAllHiddenColumns(colsel);
2147 cs.hideColumns(0, 1);
2148 cs.hideColumns(3, 4);
2149 cs.hideColumns(6, 8);
2150 cs.hideColumns(10, 12);
2151 assertEquals(0, seq.firstResidueOutsideIterator(cs.iterator()));