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 jalview.analysis.AlignSeq;
24 import jalview.api.DBRefEntryI;
25 import jalview.datamodel.features.SequenceFeatures;
26 import jalview.datamodel.features.SequenceFeaturesI;
27 import jalview.util.Comparison;
28 import jalview.util.DBRefUtils;
29 import jalview.util.MapList;
30 import jalview.util.StringUtils;
31 import jalview.workers.InformationThread;
33 import java.util.ArrayList;
34 import java.util.Arrays;
35 import java.util.BitSet;
36 import java.util.Collections;
37 import java.util.Enumeration;
38 import java.util.Iterator;
39 import java.util.List;
40 import java.util.ListIterator;
41 import java.util.Vector;
43 import fr.orsay.lri.varna.models.rna.RNA;
47 * Implements the SequenceI interface for a char[] based sequence object
49 public class Sequence extends ASequence implements SequenceI
51 SequenceI datasetSequence;
55 private char[] sequence;
63 HiddenMarkovModel hmm;
65 boolean isHMMConsensusSequence = false;
67 Vector<PDBEntry> pdbIds;
76 * This annotation is displayed below the alignment but the positions are tied
77 * to the residues of this sequence
79 * TODO: change to List<>
81 Vector<AlignmentAnnotation> annotation;
83 private SequenceFeaturesI sequenceFeatureStore;
86 * A cursor holding the approximate current view position to the sequence,
87 * as determined by findIndex or findPosition or findPositions.
88 * Using a cursor as a hint allows these methods to be more performant for
91 private SequenceCursor cursor;
94 * A number that should be incremented whenever the sequence is edited.
95 * If the value matches the cursor token, then we can trust the cursor,
96 * if not then it should be recomputed.
98 private int changeCount;
101 * Creates a new Sequence object.
104 * display name string
106 * string to form a possibly gapped sequence out of
108 * first position of non-gap residue in the sequence
110 * last position of ungapped residues (nearly always only used for
113 public Sequence(String name, String sequence, int start, int end)
116 initSeqAndName(name, sequence.toCharArray(), start, end);
119 public Sequence(String name, char[] sequence, int start, int end)
122 initSeqAndName(name, sequence, start, end);
126 * Stage 1 constructor - assign name, sequence, and set start and end fields.
127 * start and end are updated values from name2 if it ends with /start-end
134 protected void initSeqAndName(String name2, char[] sequence2, int start2,
138 this.sequence = sequence2;
146 * If 'name' ends in /i-j, where i >= j > 0 are integers, extracts i and j as
147 * start and end respectively and removes the suffix from the name
154 "POSSIBLE IMPLEMENTATION ERROR: null sequence name passed to constructor.");
157 int slashPos = name.lastIndexOf('/');
158 if (slashPos > -1 && slashPos < name.length() - 1)
160 String suffix = name.substring(slashPos + 1);
161 String[] range = suffix.split("-");
162 if (range.length == 2)
166 int from = Integer.valueOf(range[0]);
167 int to = Integer.valueOf(range[1]);
168 if (from > 0 && to >= from)
170 name = name.substring(0, slashPos);
175 } catch (NumberFormatException e)
177 // leave name unchanged if suffix is invalid
184 * Ensures that 'end' is not before the end of the sequence, that is,
185 * (end-start+1) is at least as long as the count of ungapped positions. Note
186 * that end is permitted to be beyond the end of the sequence data.
188 void checkValidRange()
191 // http://issues.jalview.org/browse/JAL-774?focusedCommentId=11239&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-11239
194 for (int j = 0; j < sequence.length; j++)
196 if (!Comparison.isGap(sequence[j]))
215 * default constructor
219 sequenceFeatureStore = new SequenceFeatures();
223 * Creates a new Sequence object.
230 public Sequence(String name, String sequence)
232 this(name, sequence, 1, -1);
236 * Creates a new Sequence object with new AlignmentAnnotations but inherits
237 * any existing dataset sequence reference. If non exists, everything is
241 * if seq is a dataset sequence, behaves like a plain old copy
244 public Sequence(SequenceI seq)
246 this(seq, seq.getAnnotation());
250 * Create a new sequence object with new features, DBRefEntries, and PDBIds
251 * but inherits any existing dataset sequence reference, and duplicate of any
252 * annotation that is present in the given annotation array.
255 * the sequence to be copied
256 * @param alAnnotation
257 * an array of annotation including some associated with seq
259 public Sequence(SequenceI seq, AlignmentAnnotation[] alAnnotation)
262 initSeqFrom(seq, alAnnotation);
266 * does the heavy lifting when cloning a dataset sequence, or coping data from
267 * dataset to a new derived sequence.
270 * - source of attributes.
271 * @param alAnnotation
272 * - alignment annotation present on seq that should be copied onto
275 protected void initSeqFrom(SequenceI seq,
276 AlignmentAnnotation[] alAnnotation)
278 char[] oseq = seq.getSequence(); // returns a copy of the array
279 initSeqAndName(seq.getName(), oseq, seq.getStart(), seq.getEnd());
281 description = seq.getDescription();
282 if (seq != datasetSequence)
284 setDatasetSequence(seq.getDatasetSequence());
288 * only copy DBRefs and seqfeatures if we really are a dataset sequence
290 if (datasetSequence == null)
292 if (seq.getDBRefs() != null)
294 DBRefEntry[] dbr = seq.getDBRefs();
295 for (int i = 0; i < dbr.length; i++)
297 addDBRef(new DBRefEntry(dbr[i]));
302 * make copies of any sequence features
304 for (SequenceFeature sf : seq.getSequenceFeatures())
306 addSequenceFeature(new SequenceFeature(sf));
310 if (seq.getAnnotation() != null)
312 AlignmentAnnotation[] sqann = seq.getAnnotation();
313 for (int i = 0; i < sqann.length; i++)
315 if (sqann[i] == null)
319 boolean found = (alAnnotation == null);
322 for (int apos = 0; !found && apos < alAnnotation.length; apos++)
324 found = (alAnnotation[apos] == sqann[i]);
329 // only copy the given annotation
330 AlignmentAnnotation newann = new AlignmentAnnotation(sqann[i]);
331 addAlignmentAnnotation(newann);
335 if (seq.getAllPDBEntries() != null)
337 Vector<PDBEntry> ids = seq.getAllPDBEntries();
338 for (PDBEntry pdb : ids)
340 this.addPDBId(new PDBEntry(pdb));
343 if (seq.getHMM() != null)
345 this.hmm = new HiddenMarkovModel(seq.getHMM(), this);
351 public void setSequenceFeatures(List<SequenceFeature> features)
353 if (datasetSequence != null)
355 datasetSequence.setSequenceFeatures(features);
358 sequenceFeatureStore = new SequenceFeatures(features);
362 public synchronized boolean addSequenceFeature(SequenceFeature sf)
364 if (sf.getType() == null)
366 System.err.println("SequenceFeature type may not be null: "
371 if (datasetSequence != null)
373 return datasetSequence.addSequenceFeature(sf);
376 return sequenceFeatureStore.add(sf);
380 public void deleteFeature(SequenceFeature sf)
382 if (datasetSequence != null)
384 datasetSequence.deleteFeature(sf);
388 sequenceFeatureStore.delete(sf);
398 public List<SequenceFeature> getSequenceFeatures()
400 if (datasetSequence != null)
402 return datasetSequence.getSequenceFeatures();
404 return sequenceFeatureStore.getAllFeatures();
408 public SequenceFeaturesI getFeatures()
410 return datasetSequence != null ? datasetSequence.getFeatures()
411 : sequenceFeatureStore;
415 public boolean addPDBId(PDBEntry entry)
419 pdbIds = new Vector<>();
424 for (PDBEntry pdbe : pdbIds)
426 if (pdbe.updateFrom(entry))
431 pdbIds.addElement(entry);
442 public void setPDBId(Vector<PDBEntry> id)
450 * @return DOCUMENT ME!
453 public Vector<PDBEntry> getAllPDBEntries()
455 return pdbIds == null ? new Vector<>() : pdbIds;
459 * Answers the sequence name, with '/start-end' appended if jvsuffix is true
464 public String getDisplayId(boolean jvsuffix)
470 StringBuilder result = new StringBuilder(name);
471 result.append("/").append(start).append("-").append(end);
473 return result.toString();
477 * Sets the sequence name. If the name ends in /start-end, then the start-end
478 * values are parsed out and set, and the suffix is removed from the name.
483 public void setName(String theName)
492 * @return DOCUMENT ME!
495 public String getName()
507 public void setStart(int start)
515 * @return DOCUMENT ME!
518 public int getStart()
530 public void setEnd(int end)
538 * @return DOCUMENT ME!
549 * @return DOCUMENT ME!
552 public int getLength()
554 return this.sequence.length;
564 public void setSequence(String seq)
566 this.sequence = seq.toCharArray();
572 public String getSequenceAsString()
574 return new String(sequence);
578 public String getSequenceAsString(int start, int end)
580 return new String(getSequence(start, end));
584 public char[] getSequence()
587 return sequence == null ? null : Arrays.copyOf(sequence,
594 * @see jalview.datamodel.SequenceI#getSequence(int, int)
597 public char[] getSequence(int start, int end)
603 // JBPNote - left to user to pad the result here (TODO:Decide on this
605 if (start >= sequence.length)
610 if (end >= sequence.length)
612 end = sequence.length;
615 char[] reply = new char[end - start];
616 System.arraycopy(sequence, start, reply, 0, end - start);
622 public SequenceI getSubSequence(int start, int end)
628 char[] seq = getSequence(start, end);
633 int nstart = findPosition(start);
634 int nend = findPosition(end) - 1;
635 // JBPNote - this is an incomplete copy.
636 SequenceI nseq = new Sequence(this.getName(), seq, nstart, nend);
637 nseq.setDescription(description);
638 if (datasetSequence != null)
640 nseq.setDatasetSequence(datasetSequence);
644 nseq.setDatasetSequence(this);
650 * Returns the character of the aligned sequence at the given position (base
651 * zero), or space if the position is not within the sequence's bounds
656 public char getCharAt(int i)
658 if (i >= 0 && i < sequence.length)
669 * Sets the sequence description, and also parses out any special formats of
675 public void setDescription(String desc)
677 this.description = desc;
681 public void setGeneLoci(String speciesId, String assemblyId,
682 String chromosomeId, MapList map)
684 addDBRef(new GeneLocus(speciesId, assemblyId, chromosomeId,
689 * Returns the gene loci mapping for the sequence (may be null)
694 public GeneLociI getGeneLoci()
696 DBRefEntry[] refs = getDBRefs();
699 for (final DBRefEntry ref : refs)
701 if (ref instanceof GeneLociI)
703 return (GeneLociI) ref;
711 * Answers the description
716 public String getDescription()
718 return this.description;
725 public int findIndex(int pos)
728 * use a valid, hopefully nearby, cursor if available
730 if (isValidCursor(cursor))
732 return findIndex(pos, cursor);
740 * traverse sequence from the start counting gaps; make a note of
741 * the column of the first residue to save in the cursor
743 while ((i < sequence.length) && (j <= end) && (j <= pos))
745 if (!Comparison.isGap(sequence[i]))
756 if (j == end && j < pos)
761 updateCursor(pos, i, startColumn);
766 * Updates the cursor to the latest found residue and column position
773 * column position of the first sequence residue
775 protected void updateCursor(int residuePos, int column, int startColumn)
778 * preserve end residue column provided cursor was valid
780 int endColumn = isValidCursor(cursor) ? cursor.lastColumnPosition : 0;
782 if (residuePos == this.end)
787 cursor = new SequenceCursor(this, residuePos, column, startColumn,
788 endColumn, this.changeCount);
792 * Answers the aligned column position (1..) for the given residue position
793 * (start..) given a 'hint' of a residue/column location in the neighbourhood.
794 * The hint may be left of, at, or to the right of the required position.
800 protected int findIndex(final int pos, SequenceCursor curs)
802 if (!isValidCursor(curs))
805 * wrong or invalidated cursor, compute de novo
807 return findIndex(pos);
810 if (curs.residuePosition == pos)
812 return curs.columnPosition;
816 * move left or right to find pos from hint.position
818 int col = curs.columnPosition - 1; // convert from base 1 to base 0
819 int newPos = curs.residuePosition;
820 int delta = newPos > pos ? -1 : 1;
822 while (newPos != pos)
824 col += delta; // shift one column left or right
829 if (col == sequence.length)
831 col--; // return last column if we failed to reach pos
834 if (!Comparison.isGap(sequence[col]))
840 col++; // convert back to base 1
843 * only update cursor if we found the target position
847 updateCursor(pos, col, curs.firstColumnPosition);
857 public int findPosition(final int column)
860 * use a valid, hopefully nearby, cursor if available
862 if (isValidCursor(cursor))
864 return findPosition(column + 1, cursor);
867 // TODO recode this more naturally i.e. count residues only
868 // as they are found, not 'in anticipation'
871 * traverse the sequence counting gaps; note the column position
872 * of the first residue, to save in the cursor
874 int firstResidueColumn = 0;
875 int lastPosFound = 0;
876 int lastPosFoundColumn = 0;
877 int seqlen = sequence.length;
879 if (seqlen > 0 && !Comparison.isGap(sequence[0]))
881 lastPosFound = start;
882 lastPosFoundColumn = 0;
888 while (j < column && j < seqlen)
890 if (!Comparison.isGap(sequence[j]))
893 lastPosFoundColumn = j;
894 if (pos == this.start)
896 firstResidueColumn = j;
902 if (j < seqlen && !Comparison.isGap(sequence[j]))
905 lastPosFoundColumn = j;
906 if (pos == this.start)
908 firstResidueColumn = j;
913 * update the cursor to the last residue position found (if any)
914 * (converting column position to base 1)
916 if (lastPosFound != 0)
918 updateCursor(lastPosFound, lastPosFoundColumn + 1,
919 firstResidueColumn + 1);
926 * Answers true if the given cursor is not null, is for this sequence object,
927 * and has a token value that matches this object's changeCount, else false.
928 * This allows us to ignore a cursor as 'stale' if the sequence has been
929 * modified since the cursor was created.
934 protected boolean isValidCursor(SequenceCursor curs)
936 if (curs == null || curs.sequence != this || curs.token != changeCount)
941 * sanity check against range
943 if (curs.columnPosition < 0 || curs.columnPosition > sequence.length)
947 if (curs.residuePosition < start || curs.residuePosition > end)
955 * Answers the sequence position (start..) for the given aligned column
956 * position (1..), given a hint of a cursor in the neighbourhood. The cursor
957 * may lie left of, at, or to the right of the column position.
963 protected int findPosition(final int col, SequenceCursor curs)
965 if (!isValidCursor(curs))
968 * wrong or invalidated cursor, compute de novo
970 return findPosition(col - 1);// ugh back to base 0
973 if (curs.columnPosition == col)
975 cursor = curs; // in case this method becomes public
976 return curs.residuePosition; // easy case :-)
979 if (curs.lastColumnPosition > 0 && curs.lastColumnPosition < col)
982 * sequence lies entirely to the left of col
983 * - return last residue + 1
988 if (curs.firstColumnPosition > 0 && curs.firstColumnPosition > col)
991 * sequence lies entirely to the right of col
992 * - return first residue
997 // todo could choose closest to col out of column,
998 // firstColumnPosition, lastColumnPosition as a start point
1001 * move left or right to find pos from cursor position
1003 int firstResidueColumn = curs.firstColumnPosition;
1004 int column = curs.columnPosition - 1; // to base 0
1005 int newPos = curs.residuePosition;
1006 int delta = curs.columnPosition > col ? -1 : 1;
1007 boolean gapped = false;
1008 int lastFoundPosition = curs.residuePosition;
1009 int lastFoundPositionColumn = curs.columnPosition;
1011 while (column != col - 1)
1013 column += delta; // shift one column left or right
1014 if (column < 0 || column == sequence.length)
1018 gapped = Comparison.isGap(sequence[column]);
1022 lastFoundPosition = newPos;
1023 lastFoundPositionColumn = column + 1;
1024 if (lastFoundPosition == this.start)
1026 firstResidueColumn = column + 1;
1031 if (cursor == null || lastFoundPosition != cursor.residuePosition)
1033 updateCursor(lastFoundPosition, lastFoundPositionColumn,
1034 firstResidueColumn);
1038 * hack to give position to the right if on a gap
1039 * or beyond the length of the sequence (see JAL-2562)
1041 if (delta > 0 && (gapped || column >= sequence.length))
1053 public ContiguousI findPositions(int fromColumn, int toColumn)
1055 fromColumn = Math.max(fromColumn, 1);
1056 if (toColumn < fromColumn)
1062 * find the first non-gapped position, if any
1064 int firstPosition = 0;
1065 int col = fromColumn - 1;
1066 int length = sequence.length;
1067 while (col < length && col < toColumn)
1069 if (!Comparison.isGap(sequence[col]))
1071 firstPosition = findPosition(col++);
1077 if (firstPosition == 0)
1083 * find the last non-gapped position
1085 int lastPosition = firstPosition;
1086 while (col < length && col < toColumn)
1088 if (!Comparison.isGap(sequence[col++]))
1094 return new Range(firstPosition, lastPosition);
1098 * Returns an int array where indices correspond to each residue in the
1099 * sequence and the element value gives its position in the alignment
1101 * @return int[SequenceI.getEnd()-SequenceI.getStart()+1] or null if no
1102 * residues in SequenceI object
1105 public int[] gapMap()
1107 String seq = jalview.analysis.AlignSeq.extractGaps(
1108 jalview.util.Comparison.GapChars, new String(sequence));
1109 int[] map = new int[seq.length()];
1113 while (j < sequence.length)
1115 if (!jalview.util.Comparison.isGap(sequence[j]))
1127 * Build a bitset corresponding to sequence gaps
1129 * @return a BitSet where set values correspond to gaps in the sequence
1132 public BitSet gapBitset()
1134 BitSet gaps = new BitSet(sequence.length);
1136 while (j < sequence.length)
1138 if (jalview.util.Comparison.isGap(sequence[j]))
1148 public int[] findPositionMap()
1150 int map[] = new int[sequence.length];
1153 int seqlen = sequence.length;
1154 while ((j < seqlen))
1157 if (!jalview.util.Comparison.isGap(sequence[j]))
1168 public List<int[]> getInsertions()
1170 ArrayList<int[]> map = new ArrayList<>();
1171 int lastj = -1, j = 0;
1173 int seqlen = sequence.length;
1174 while ((j < seqlen))
1176 if (jalview.util.Comparison.isGap(sequence[j]))
1187 map.add(new int[] { lastj, j - 1 });
1195 map.add(new int[] { lastj, j - 1 });
1202 public BitSet getInsertionsAsBits()
1204 BitSet map = new BitSet();
1205 int lastj = -1, j = 0;
1207 int seqlen = sequence.length;
1208 while ((j < seqlen))
1210 if (jalview.util.Comparison.isGap(sequence[j]))
1236 public void deleteChars(final int i, final int j)
1238 int newstart = start, newend = end;
1239 if (i >= sequence.length || i < 0)
1244 char[] tmp = StringUtils.deleteChars(sequence, i, j);
1245 boolean createNewDs = false;
1246 // TODO: take a (second look) at the dataset creation validation method for
1247 // the very large sequence case
1249 int startIndex = findIndex(start) - 1;
1250 int endIndex = findIndex(end) - 1;
1251 int startDeleteColumn = -1; // for dataset sequence deletions
1252 int deleteCount = 0;
1254 for (int s = i; s < j && s < sequence.length; s++)
1256 if (Comparison.isGap(sequence[s]))
1261 if (startDeleteColumn == -1)
1263 startDeleteColumn = findPosition(s) - start;
1271 if (startIndex == s)
1274 * deleting characters from start of sequence; new start is the
1275 * sequence position of the next column (position to the right
1276 * if the column position is gapped)
1278 newstart = findPosition(j);
1286 * deleting characters at end of sequence; new end is the sequence
1287 * position of the column before the deletion; subtract 1 if this is
1288 * gapped since findPosition returns the next sequence position
1290 newend = findPosition(i - 1);
1291 if (Comparison.isGap(sequence[i - 1]))
1306 if (createNewDs && this.datasetSequence != null)
1309 * if deletion occured in the middle of the sequence,
1310 * construct a new dataset sequence and delete the residues
1311 * that were deleted from the aligned sequence
1313 Sequence ds = new Sequence(datasetSequence);
1314 ds.deleteChars(startDeleteColumn, startDeleteColumn + deleteCount);
1315 datasetSequence = ds;
1316 // TODO: remove any non-inheritable properties ?
1317 // TODO: create a sequence mapping (since there is a relation here ?)
1326 public void insertCharAt(int i, int length, char c)
1328 char[] tmp = new char[sequence.length + length];
1330 if (i >= sequence.length)
1332 System.arraycopy(sequence, 0, tmp, 0, sequence.length);
1333 i = sequence.length;
1337 System.arraycopy(sequence, 0, tmp, 0, i);
1347 if (i < sequence.length)
1349 System.arraycopy(sequence, i, tmp, index, sequence.length - i);
1357 public void insertCharAt(int i, char c)
1359 insertCharAt(i, 1, c);
1363 public String getVamsasId()
1369 public void setVamsasId(String id)
1375 public void setDBRefs(DBRefEntry[] dbref)
1377 if (dbrefs == null && datasetSequence != null
1378 && this != datasetSequence)
1380 datasetSequence.setDBRefs(dbref);
1386 DBRefUtils.ensurePrimaries(this);
1391 public DBRefEntry[] getDBRefs()
1393 if (dbrefs == null && datasetSequence != null
1394 && this != datasetSequence)
1396 return datasetSequence.getDBRefs();
1402 public void addDBRef(DBRefEntry entry)
1404 if (datasetSequence != null)
1406 datasetSequence.addDBRef(entry);
1412 dbrefs = new DBRefEntry[0];
1415 for (DBRefEntryI dbr : dbrefs)
1417 if (dbr.updateFrom(entry))
1420 * found a dbref that either matched, or could be
1421 * updated from, the new entry - no need to add it
1428 * extend the array to make room for one more
1430 // TODO use an ArrayList instead
1431 int j = dbrefs.length;
1432 DBRefEntry[] temp = new DBRefEntry[j + 1];
1433 System.arraycopy(dbrefs, 0, temp, 0, j);
1434 temp[temp.length - 1] = entry;
1438 DBRefUtils.ensurePrimaries(this);
1442 public void setDatasetSequence(SequenceI seq)
1446 throw new IllegalArgumentException(
1447 "Implementation Error: self reference passed to SequenceI.setDatasetSequence");
1449 if (seq != null && seq.getDatasetSequence() != null)
1451 throw new IllegalArgumentException(
1452 "Implementation error: cascading dataset sequences are not allowed.");
1454 datasetSequence = seq;
1458 public SequenceI getDatasetSequence()
1460 return datasetSequence;
1464 public AlignmentAnnotation[] getAnnotation()
1466 return annotation == null ? null
1468 .toArray(new AlignmentAnnotation[annotation.size()]);
1472 public boolean hasAnnotation(AlignmentAnnotation ann)
1474 return annotation == null ? false : annotation.contains(ann);
1478 public void addAlignmentAnnotation(AlignmentAnnotation annotation)
1480 if (this.annotation == null)
1482 this.annotation = new Vector<>();
1484 if (!this.annotation.contains(annotation))
1486 this.annotation.addElement(annotation);
1488 annotation.setSequenceRef(this);
1492 public void removeAlignmentAnnotation(AlignmentAnnotation annotation)
1494 if (this.annotation != null)
1496 this.annotation.removeElement(annotation);
1497 if (this.annotation.size() == 0)
1499 this.annotation = null;
1505 * test if this is a valid candidate for another sequence's dataset sequence.
1508 private boolean isValidDatasetSequence()
1510 if (datasetSequence != null)
1514 for (int i = 0; i < sequence.length; i++)
1516 if (jalview.util.Comparison.isGap(sequence[i]))
1525 public SequenceI deriveSequence()
1527 Sequence seq = null;
1528 if (datasetSequence == null)
1530 if (isValidDatasetSequence())
1532 // Use this as dataset sequence
1533 seq = new Sequence(getName(), "", 1, -1);
1534 seq.setDatasetSequence(this);
1535 seq.initSeqFrom(this, getAnnotation());
1540 // Create a new, valid dataset sequence
1541 createDatasetSequence();
1544 return new Sequence(this);
1547 private boolean _isNa;
1549 private int _seqhash = 0;
1552 * Answers false if the sequence is more than 85% nucleotide (ACGTU), else
1556 public boolean isProtein()
1558 if (datasetSequence != null)
1560 return datasetSequence.isProtein();
1562 if (_seqhash != sequence.hashCode())
1564 _seqhash = sequence.hashCode();
1565 _isNa = Comparison.isNucleotide(this);
1573 * @see jalview.datamodel.SequenceI#createDatasetSequence()
1576 public SequenceI createDatasetSequence()
1578 if (datasetSequence == null)
1580 Sequence dsseq = new Sequence(getName(),
1581 AlignSeq.extractGaps(jalview.util.Comparison.GapChars,
1582 getSequenceAsString()),
1583 getStart(), getEnd());
1585 datasetSequence = dsseq;
1587 dsseq.setDescription(description);
1588 // move features and database references onto dataset sequence
1589 dsseq.sequenceFeatureStore = sequenceFeatureStore;
1590 sequenceFeatureStore = null;
1591 dsseq.dbrefs = dbrefs;
1593 // TODO: search and replace any references to this sequence with
1594 // references to the dataset sequence in Mappings on dbref
1595 dsseq.pdbIds = pdbIds;
1597 datasetSequence.updatePDBIds();
1598 if (annotation != null)
1600 // annotation is cloned rather than moved, to preserve what's currently
1602 for (AlignmentAnnotation aa : annotation)
1604 AlignmentAnnotation _aa = new AlignmentAnnotation(aa);
1605 _aa.sequenceRef = datasetSequence;
1606 _aa.adjustForAlignment(); // uses annotation's own record of
1607 // sequence-column mapping
1608 datasetSequence.addAlignmentAnnotation(_aa);
1612 return datasetSequence;
1619 * jalview.datamodel.SequenceI#setAlignmentAnnotation(AlignmmentAnnotation[]
1623 public void setAlignmentAnnotation(AlignmentAnnotation[] annotations)
1625 if (annotation != null)
1627 annotation.removeAllElements();
1629 if (annotations != null)
1631 for (int i = 0; i < annotations.length; i++)
1633 if (annotations[i] != null)
1635 addAlignmentAnnotation(annotations[i]);
1642 public AlignmentAnnotation[] getAnnotation(String label)
1644 if (annotation == null || annotation.size() == 0)
1649 Vector<AlignmentAnnotation> subset = new Vector<>();
1650 Enumeration<AlignmentAnnotation> e = annotation.elements();
1651 while (e.hasMoreElements())
1653 AlignmentAnnotation ann = e.nextElement();
1654 if (ann.label != null && ann.label.equals(label))
1656 subset.addElement(ann);
1659 if (subset.size() == 0)
1663 AlignmentAnnotation[] anns = new AlignmentAnnotation[subset.size()];
1665 e = subset.elements();
1666 while (e.hasMoreElements())
1668 anns[i++] = e.nextElement();
1670 subset.removeAllElements();
1675 public boolean updatePDBIds()
1677 if (datasetSequence != null)
1679 // TODO: could merge DBRefs
1680 return datasetSequence.updatePDBIds();
1682 if (dbrefs == null || dbrefs.length == 0)
1686 boolean added = false;
1687 for (DBRefEntry dbr : dbrefs)
1689 if (DBRefSource.PDB.equals(dbr.getSource()))
1692 * 'Add' any PDB dbrefs as a PDBEntry - add is only performed if the
1693 * PDB id is not already present in a 'matching' PDBEntry
1694 * Constructor parses out a chain code if appended to the accession id
1695 * (a fudge used to 'store' the chain code in the DBRef)
1697 PDBEntry pdbe = new PDBEntry(dbr);
1698 added |= addPDBId(pdbe);
1705 public void transferAnnotation(SequenceI entry, Mapping mp)
1707 if (datasetSequence != null)
1709 datasetSequence.transferAnnotation(entry, mp);
1712 if (entry.getDatasetSequence() != null)
1714 transferAnnotation(entry.getDatasetSequence(), mp);
1717 // transfer any new features from entry onto sequence
1718 if (entry.getSequenceFeatures() != null)
1721 List<SequenceFeature> sfs = entry.getSequenceFeatures();
1722 for (SequenceFeature feature : sfs)
1724 SequenceFeature sf[] = (mp != null) ? mp.locateFeature(feature)
1725 : new SequenceFeature[] { new SequenceFeature(feature) };
1728 for (int sfi = 0; sfi < sf.length; sfi++)
1730 addSequenceFeature(sf[sfi]);
1736 // transfer PDB entries
1737 if (entry.getAllPDBEntries() != null)
1739 Enumeration<PDBEntry> e = entry.getAllPDBEntries().elements();
1740 while (e.hasMoreElements())
1742 PDBEntry pdb = e.nextElement();
1746 // transfer database references
1747 DBRefEntry[] entryRefs = entry.getDBRefs();
1748 if (entryRefs != null)
1750 for (int r = 0; r < entryRefs.length; r++)
1752 DBRefEntry newref = new DBRefEntry(entryRefs[r]);
1753 if (newref.getMap() != null && mp != null)
1755 // remap ref using our local mapping
1757 // we also assume all version string setting is done by dbSourceProxy
1759 * if (!newref.getSource().equalsIgnoreCase(dbSource)) {
1760 * newref.setSource(dbSource); }
1768 public void setRNA(RNA r)
1780 public List<AlignmentAnnotation> getAlignmentAnnotations(String calcId,
1783 List<AlignmentAnnotation> result = new ArrayList<>();
1784 if (this.annotation != null)
1786 for (AlignmentAnnotation ann : annotation)
1788 String id = ann.getCalcId();
1789 if (id != null && id.equals(calcId)
1790 && ann.label != null && ann.label.equals(label))
1800 public String toString()
1802 return getDisplayId(false);
1806 public PDBEntry getPDBEntry(String pdbIdStr)
1808 if (getDatasetSequence() != null)
1810 return getDatasetSequence().getPDBEntry(pdbIdStr);
1816 List<PDBEntry> entries = getAllPDBEntries();
1817 for (PDBEntry entry : entries)
1819 if (entry.getId().equalsIgnoreCase(pdbIdStr))
1828 public List<DBRefEntry> getPrimaryDBRefs()
1830 if (datasetSequence != null)
1832 return datasetSequence.getPrimaryDBRefs();
1834 if (dbrefs == null || dbrefs.length == 0)
1836 return Collections.emptyList();
1838 synchronized (dbrefs)
1840 List<DBRefEntry> primaries = new ArrayList<>();
1841 DBRefEntry[] tmp = new DBRefEntry[1];
1842 for (DBRefEntry ref : dbrefs)
1844 if (!ref.isPrimaryCandidate())
1850 MapList mp = ref.getMap().getMap();
1851 if (mp.getFromLowest() > start || mp.getFromHighest() < end)
1853 // map only involves a subsequence, so cannot be primary
1857 // whilst it looks like it is a primary ref, we also sanity check type
1858 if (DBRefUtils.getCanonicalName(DBRefSource.PDB)
1859 .equals(DBRefUtils.getCanonicalName(ref.getSource())))
1861 // PDB dbrefs imply there should be a PDBEntry associated
1862 // TODO: tighten PDB dbrefs
1863 // formally imply Jalview has actually downloaded and
1864 // parsed the pdb file. That means there should be a cached file
1865 // handle on the PDBEntry, and a real mapping between sequence and
1866 // extracted sequence from PDB file
1867 PDBEntry pdbentry = getPDBEntry(ref.getAccessionId());
1868 if (pdbentry != null && pdbentry.getFile() != null)
1874 // check standard protein or dna sources
1876 DBRefEntry[] res = DBRefUtils.selectDbRefs(!isProtein(), tmp);
1877 if (res != null && res[0] == tmp[0])
1888 public HiddenMarkovModel getHMM()
1894 public void setHMM(HiddenMarkovModel hmm)
1900 public boolean hasHMMAnnotation()
1902 if (this.annotation == null) {
1905 for (AlignmentAnnotation ann : annotation)
1907 if (InformationThread.HMM_CALC_ID.equals(ann.getCalcId()))
1919 public List<SequenceFeature> findFeatures(int fromColumn, int toColumn,
1922 int startPos = findPosition(fromColumn - 1); // convert base 1 to base 0
1923 int endPos = fromColumn == toColumn ? startPos
1924 : findPosition(toColumn - 1);
1926 List<SequenceFeature> result = getFeatures().findFeatures(startPos,
1928 if (datasetSequence != null)
1930 result = datasetSequence.getFeatures().findFeatures(startPos, endPos,
1935 result = sequenceFeatureStore.findFeatures(startPos, endPos, types);
1939 * if end column is gapped, endPos may be to the right,
1940 * and we may have included adjacent or enclosing features;
1941 * remove any that are not enclosing, non-contact features
1943 boolean endColumnIsGapped = toColumn > 0 && toColumn <= sequence.length
1944 && Comparison.isGap(sequence[toColumn - 1]);
1945 if (endPos > this.end || endColumnIsGapped)
1947 ListIterator<SequenceFeature> it = result.listIterator();
1948 while (it.hasNext())
1950 SequenceFeature sf = it.next();
1951 int sfBegin = sf.getBegin();
1952 int sfEnd = sf.getEnd();
1953 int featureStartColumn = findIndex(sfBegin);
1954 if (featureStartColumn > toColumn)
1958 else if (featureStartColumn < fromColumn)
1960 int featureEndColumn = sfEnd == sfBegin ? featureStartColumn
1962 if (featureEndColumn < fromColumn)
1966 else if (featureEndColumn > toColumn && sf.isContactFeature())
1969 * remove an enclosing feature if it is a contact feature
1981 * Invalidates any stale cursors (forcing recalculation) by incrementing the
1982 * token that has to match the one presented by the cursor
1985 public void sequenceChanged()
1994 public int replace(char c1, char c2)
2001 synchronized (sequence)
2003 for (int c = 0; c < sequence.length; c++)
2005 if (sequence[c] == c1)
2021 public String getSequenceStringFromIterator(Iterator<int[]> it)
2023 StringBuilder newSequence = new StringBuilder();
2024 while (it.hasNext())
2026 int[] block = it.next();
2029 newSequence.append(getSequence(block[0], block[1] + 1));
2033 newSequence.append(getSequence(block[0], block[1]));
2037 return newSequence.toString();
2041 public int firstResidueOutsideIterator(Iterator<int[]> regions)
2045 if (!regions.hasNext())
2047 return findIndex(getStart()) - 1;
2050 // Simply walk along the sequence whilst watching for region
2052 int hideStart = getLength();
2054 boolean foundStart = false;
2056 // step through the non-gapped positions of the sequence
2057 for (int i = getStart(); i <= getEnd() && (!foundStart); i++)
2059 // get alignment position of this residue in the sequence
2060 int p = findIndex(i) - 1;
2062 // update region start/end
2063 while (hideEnd < p && regions.hasNext())
2065 int[] region = regions.next();
2066 hideStart = region[0];
2067 hideEnd = region[1];
2071 hideStart = getLength();
2073 // update boundary for sequence
2085 // otherwise, sequence was completely hidden
2090 public boolean hasHMMProfile()