2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
3 * Copyright (C) 2014 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;
25 import java.util.ArrayList;
26 import java.util.Enumeration;
27 import java.util.List;
28 import java.util.Vector;
30 import fr.orsay.lri.varna.models.rna.RNA;
34 * Implements the SequenceI interface for a char[] based sequence object.
39 public class Sequence implements SequenceI
41 SequenceI datasetSequence;
45 private char[] sequence;
62 * This annotation is displayed below the alignment but the positions are tied
63 * to the residues of this sequence
65 * TODO: change to List<>
67 Vector<AlignmentAnnotation> annotation;
70 * The index of the sequence in a MSA
74 /** array of sequence features - may not be null for a valid sequence object */
75 public SequenceFeature[] sequenceFeatures;
78 * Creates a new Sequence object.
83 * string to form a possibly gapped sequence out of
85 * first position of non-gap residue in the sequence
87 * last position of ungapped residues (nearly always only used for
90 public Sequence(String name, String sequence, int start, int end)
93 this.sequence = sequence.toCharArray();
100 public Sequence(String name, char[] sequence, int start, int end)
103 this.sequence = sequence;
110 com.stevesoft.pat.Regex limitrx = new com.stevesoft.pat.Regex(
111 "[/][0-9]{1,}[-][0-9]{1,}$");
113 com.stevesoft.pat.Regex endrx = new com.stevesoft.pat.Regex("[0-9]{1,}$");
120 .println("POSSIBLE IMPLEMENTATION ERROR: null sequence name passed to constructor.");
123 // Does sequence have the /start-end signiature?
124 if (limitrx.search(name))
126 name = limitrx.left();
127 endrx.search(limitrx.stringMatched());
128 setStart(Integer.parseInt(limitrx.stringMatched().substring(1,
129 endrx.matchedFrom() - 1)));
130 setEnd(Integer.parseInt(endrx.stringMatched()));
134 void checkValidRange()
137 // http://issues.jalview.org/browse/JAL-774?focusedCommentId=11239&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-11239
140 for (int j = 0; j < sequence.length; j++)
142 if (!jalview.util.Comparison.isGap(sequence[j]))
161 * Creates a new Sequence object.
168 public Sequence(String name, String sequence)
170 this(name, sequence, 1, -1);
174 * Creates a new Sequence object with new features, DBRefEntries,
175 * AlignmentAnnotations, and PDBIds but inherits any existing dataset sequence
181 public Sequence(SequenceI seq)
183 this(seq, seq.getAnnotation());
187 * Create a new sequence object with new features, DBRefEntries, and PDBIds
188 * but inherits any existing dataset sequence reference, and duplicate of any
189 * annotation that is present in the given annotation array.
192 * the sequence to be copied
193 * @param alAnnotation
194 * an array of annotation including some associated with seq
196 public Sequence(SequenceI seq, AlignmentAnnotation[] alAnnotation)
198 this(seq.getName(), seq.getSequence(), seq.getStart(), seq.getEnd());
199 description = seq.getDescription();
200 if (seq.getSequenceFeatures() != null)
202 SequenceFeature[] sf = seq.getSequenceFeatures();
203 for (int i = 0; i < sf.length; i++)
205 addSequenceFeature(new SequenceFeature(sf[i]));
208 setDatasetSequence(seq.getDatasetSequence());
209 if (datasetSequence == null && seq.getDBRef() != null)
211 // only copy DBRefs if we really are a dataset sequence
212 DBRefEntry[] dbr = seq.getDBRef();
213 for (int i = 0; i < dbr.length; i++)
215 addDBRef(new DBRefEntry(dbr[i]));
218 if (seq.getAnnotation() != null)
220 AlignmentAnnotation[] sqann = seq.getAnnotation();
221 for (int i = 0; i < sqann.length; i++)
223 if (sqann[i] == null)
227 boolean found = (alAnnotation == null);
230 for (int apos = 0; !found && apos < alAnnotation.length; apos++)
232 found = (alAnnotation[apos] == sqann[i]);
237 // only copy the given annotation
238 AlignmentAnnotation newann = new AlignmentAnnotation(sqann[i]);
239 addAlignmentAnnotation(newann);
243 if (seq.getPDBId() != null)
245 Vector ids = seq.getPDBId();
246 Enumeration e = ids.elements();
247 while (e.hasMoreElements())
249 this.addPDBId(new PDBEntry((PDBEntry) e.nextElement()));
260 public void setSequenceFeatures(SequenceFeature[] features)
262 sequenceFeatures = features;
265 public synchronized void addSequenceFeature(SequenceFeature sf)
267 if (sequenceFeatures == null)
269 sequenceFeatures = new SequenceFeature[0];
272 for (int i = 0; i < sequenceFeatures.length; i++)
274 if (sequenceFeatures[i].equals(sf))
280 SequenceFeature[] temp = new SequenceFeature[sequenceFeatures.length + 1];
281 System.arraycopy(sequenceFeatures, 0, temp, 0, sequenceFeatures.length);
282 temp[sequenceFeatures.length] = sf;
284 sequenceFeatures = temp;
287 public void deleteFeature(SequenceFeature sf)
289 if (sequenceFeatures == null)
295 for (index = 0; index < sequenceFeatures.length; index++)
297 if (sequenceFeatures[index].equals(sf))
303 if (index == sequenceFeatures.length)
308 int sfLength = sequenceFeatures.length;
311 sequenceFeatures = null;
315 SequenceFeature[] temp = new SequenceFeature[sfLength - 1];
316 System.arraycopy(sequenceFeatures, 0, temp, 0, index);
318 if (index < sfLength)
320 System.arraycopy(sequenceFeatures, index + 1, temp, index,
321 sequenceFeatures.length - index - 1);
324 sequenceFeatures = temp;
331 * @return DOCUMENT ME!
333 public SequenceFeature[] getSequenceFeatures()
335 return sequenceFeatures;
338 public void addPDBId(PDBEntry entry)
342 pdbIds = new Vector();
344 if (!pdbIds.contains(entry))
346 pdbIds.addElement(entry);
356 public void setPDBId(Vector id)
364 * @return DOCUMENT ME!
366 public Vector getPDBId()
374 * @return DOCUMENT ME!
376 public String getDisplayId(boolean jvsuffix)
378 StringBuffer result = new StringBuffer(name);
381 result.append("/" + start + "-" + end);
384 return result.toString();
393 public void setName(String name)
402 * @return DOCUMENT ME!
404 public String getName()
415 public void setStart(int start)
423 * @return DOCUMENT ME!
425 public int getStart()
436 public void setEnd(int end)
444 * @return DOCUMENT ME!
454 * @return DOCUMENT ME!
456 public int getLength()
458 return this.sequence.length;
467 public void setSequence(String seq)
469 this.sequence = seq.toCharArray();
473 public String getSequenceAsString()
475 return new String(sequence);
478 public String getSequenceAsString(int start, int end)
480 return new String(getSequence(start, end));
483 public char[] getSequence()
491 * @see jalview.datamodel.SequenceI#getSequence(int, int)
493 public char[] getSequence(int start, int end)
499 // JBPNote - left to user to pad the result here (TODO:Decide on this
501 if (start >= sequence.length)
506 if (end >= sequence.length)
508 end = sequence.length;
511 char[] reply = new char[end - start];
512 System.arraycopy(sequence, start, reply, 0, end - start);
518 public SequenceI getSubSequence(int start, int end)
524 char[] seq = getSequence(start, end);
529 int nstart = findPosition(start);
530 int nend = findPosition(end) - 1;
531 // JBPNote - this is an incomplete copy.
532 SequenceI nseq = new Sequence(this.getName(), seq, nstart, nend);
533 nseq.setDescription(description);
534 if (datasetSequence != null)
536 nseq.setDatasetSequence(datasetSequence);
540 nseq.setDatasetSequence(this);
551 * @return DOCUMENT ME!
553 public char getCharAt(int i)
555 if (i < sequence.length)
571 public void setDescription(String desc)
573 this.description = desc;
579 * @return DOCUMENT ME!
581 public String getDescription()
583 return this.description;
589 * @see jalview.datamodel.SequenceI#findIndex(int)
591 public int findIndex(int pos)
593 // returns the alignment position for a residue
596 // Rely on end being at least as long as the length of the sequence.
597 while ((i < sequence.length) && (j <= end) && (j <= pos))
599 if (!jalview.util.Comparison.isGap(sequence[i]))
607 if ((j == end) && (j < pos))
618 public int findPosition(int i)
622 int seqlen = sequence.length;
623 while ((j < i) && (j < seqlen))
625 if (!jalview.util.Comparison.isGap(sequence[j]))
637 * Returns an int array where indices correspond to each residue in the
638 * sequence and the element value gives its position in the alignment
640 * @return int[SequenceI.getEnd()-SequenceI.getStart()+1] or null if no
641 * residues in SequenceI object
643 public int[] gapMap()
645 String seq = jalview.analysis.AlignSeq.extractGaps(
646 jalview.util.Comparison.GapChars, new String(sequence));
647 int[] map = new int[seq.length()];
651 while (j < sequence.length)
653 if (!jalview.util.Comparison.isGap(sequence[j]))
667 * @see jalview.datamodel.SequenceI#findPositionMap()
669 public int[] findPositionMap()
671 int map[] = new int[sequence.length];
674 int seqlen = sequence.length;
678 if (!jalview.util.Comparison.isGap(sequence[j]))
691 * @see jalview.datamodel.SequenceI#deleteChars(int, int)
693 public void deleteChars(int i, int j)
695 int newstart = start, newend = end;
696 if (i >= sequence.length)
703 if (j >= sequence.length)
706 System.arraycopy(sequence, 0, tmp, 0, i);
711 tmp = new char[sequence.length - j + i];
712 System.arraycopy(sequence, 0, tmp, 0, i);
713 System.arraycopy(sequence, j, tmp, i, sequence.length - j);
715 boolean createNewDs = false;
716 // TODO: take a look at the new dataset creation validation method below -
717 // this could become time comsuming for large sequences - consider making it
719 for (int s = i; s < j; s++)
721 if (jalview.schemes.ResidueProperties.aaIndex[sequence[s]] != 23)
729 int sindex = findIndex(start) - 1;
732 // delete characters including start of sequence
733 newstart = findPosition(j);
734 break; // don't need to search for any more residue characters.
738 // delete characters after start.
739 int eindex = findIndex(end) - 1;
742 // delete characters at end of sequence
743 newend = findPosition(i - 1);
744 break; // don't need to search for any more residue characters.
749 newend--; // decrease end position by one for the deleted residue
750 // and search further
756 // deletion occured in the middle of the sequence
757 if (createNewDs && this.datasetSequence != null)
759 // construct a new sequence
760 Sequence ds = new Sequence(datasetSequence);
761 // TODO: remove any non-inheritable properties ?
762 // TODO: create a sequence mapping (since there is a relation here ?)
763 ds.deleteChars(i, j);
764 datasetSequence = ds;
781 public void insertCharAt(int i, int length, char c)
783 char[] tmp = new char[sequence.length + length];
785 if (i >= sequence.length)
787 System.arraycopy(sequence, 0, tmp, 0, sequence.length);
792 System.arraycopy(sequence, 0, tmp, 0, i);
802 if (i < sequence.length)
804 System.arraycopy(sequence, i, tmp, index, sequence.length - i);
810 public void insertCharAt(int i, char c)
812 insertCharAt(i, 1, c);
815 public String getVamsasId()
820 public void setVamsasId(String id)
825 public void setDBRef(DBRefEntry[] dbref)
830 public DBRefEntry[] getDBRef()
832 if (dbrefs == null && datasetSequence != null
833 && this != datasetSequence)
835 return datasetSequence.getDBRef();
840 public void addDBRef(DBRefEntry entry)
844 dbrefs = new DBRefEntry[0];
847 int i, iSize = dbrefs.length;
849 for (i = 0; i < iSize; i++)
851 if (dbrefs[i].equalRef(entry))
853 if (entry.getMap() != null)
855 if (dbrefs[i].getMap() == null)
857 // overwrite with 'superior' entry that contains a mapping.
865 DBRefEntry[] temp = new DBRefEntry[iSize + 1];
866 System.arraycopy(dbrefs, 0, temp, 0, iSize);
867 temp[temp.length - 1] = entry;
872 public void setDatasetSequence(SequenceI seq)
874 datasetSequence = seq;
877 public SequenceI getDatasetSequence()
879 return datasetSequence;
883 * Returns a new array containing this sequence's annotations, or null.
885 public AlignmentAnnotation[] getAnnotation()
887 return annotation == null ? null : annotation
888 .toArray(new AlignmentAnnotation[annotation.size()]);
892 * Returns true if this sequence has the given annotation (by object
896 public boolean hasAnnotation(AlignmentAnnotation ann)
898 return annotation == null ? false : annotation.contains(ann);
902 * Add the given annotation, if not already added, and set its sequence ref to
903 * be this sequence. Does nothing if this sequence's annotations already
904 * include this annotation (by identical object reference).
906 public void addAlignmentAnnotation(AlignmentAnnotation annotation)
908 if (this.annotation == null)
910 this.annotation = new Vector();
912 if (!this.annotation.contains(annotation))
914 this.annotation.addElement(annotation);
916 annotation.setSequenceRef(this);
919 public void removeAlignmentAnnotation(AlignmentAnnotation annotation)
921 if (this.annotation != null)
923 this.annotation.removeElement(annotation);
924 if (this.annotation.size() == 0)
926 this.annotation = null;
932 * test if this is a valid candidate for another sequence's dataset sequence.
935 private boolean isValidDatasetSequence()
937 if (datasetSequence != null)
941 for (int i = 0; i < sequence.length; i++)
943 if (jalview.util.Comparison.isGap(sequence[i]))
954 * @see jalview.datamodel.SequenceI#deriveSequence()
956 public SequenceI deriveSequence()
958 SequenceI seq = new Sequence(this);
959 if (datasetSequence != null)
961 // duplicate current sequence with same dataset
962 seq.setDatasetSequence(datasetSequence);
966 if (isValidDatasetSequence())
968 // Use this as dataset sequence
969 seq.setDatasetSequence(this);
973 // Create a new, valid dataset sequence
975 ds.setSequence(AlignSeq.extractGaps(
976 jalview.util.Comparison.GapChars, new String(sequence)));
977 setDatasetSequence(ds);
978 ds.setSequenceFeatures(getSequenceFeatures());
979 seq = this; // and return this sequence as the derived sequence.
988 * @see jalview.datamodel.SequenceI#createDatasetSequence()
990 public SequenceI createDatasetSequence()
992 if (datasetSequence == null)
994 datasetSequence = new Sequence(getName(), AlignSeq.extractGaps(
995 jalview.util.Comparison.GapChars, getSequenceAsString()),
996 getStart(), getEnd());
997 datasetSequence.setSequenceFeatures(getSequenceFeatures());
998 datasetSequence.setDescription(getDescription());
999 setSequenceFeatures(null);
1000 // move database references onto dataset sequence
1001 datasetSequence.setDBRef(getDBRef());
1003 datasetSequence.setPDBId(getPDBId());
1005 datasetSequence.updatePDBIds();
1006 if (annotation != null)
1008 for (AlignmentAnnotation aa : annotation)
1010 AlignmentAnnotation _aa = new AlignmentAnnotation(aa);
1011 _aa.sequenceRef = datasetSequence;
1012 _aa.adjustForAlignment(); // uses annotation's own record of
1013 // sequence-column mapping
1014 datasetSequence.addAlignmentAnnotation(_aa);
1018 return datasetSequence;
1025 * jalview.datamodel.SequenceI#setAlignmentAnnotation(AlignmmentAnnotation[]
1028 public void setAlignmentAnnotation(AlignmentAnnotation[] annotations)
1030 if (annotation != null)
1032 annotation.removeAllElements();
1034 if (annotations != null)
1036 for (int i = 0; i < annotations.length; i++)
1038 if (annotations[i] != null)
1040 addAlignmentAnnotation(annotations[i]);
1049 * @see jalview.datamodel.SequenceI#getAnnotation(java.lang.String)
1051 public AlignmentAnnotation[] getAnnotation(String label)
1053 if (annotation == null || annotation.size() == 0)
1058 Vector subset = new Vector();
1059 Enumeration e = annotation.elements();
1060 while (e.hasMoreElements())
1062 AlignmentAnnotation ann = (AlignmentAnnotation) e.nextElement();
1063 if (ann.label != null && ann.label.equals(label))
1065 subset.addElement(ann);
1068 if (subset.size() == 0)
1072 AlignmentAnnotation[] anns = new AlignmentAnnotation[subset.size()];
1074 e = subset.elements();
1075 while (e.hasMoreElements())
1077 anns[i++] = (AlignmentAnnotation) e.nextElement();
1079 subset.removeAllElements();
1083 public boolean updatePDBIds()
1085 if (datasetSequence != null)
1087 // TODO: could merge DBRefs
1088 return datasetSequence.updatePDBIds();
1090 if (dbrefs == null || dbrefs.length == 0)
1094 Vector newpdb = new Vector();
1095 for (int i = 0; i < dbrefs.length; i++)
1097 if (DBRefSource.PDB.equals(dbrefs[i].getSource()))
1099 PDBEntry pdbe = new PDBEntry();
1100 pdbe.setId(dbrefs[i].getAccessionId());
1101 if (pdbIds == null || pdbIds.size() == 0)
1103 newpdb.addElement(pdbe);
1107 Enumeration en = pdbIds.elements();
1108 boolean matched = false;
1109 while (!matched && en.hasMoreElements())
1111 PDBEntry anentry = (PDBEntry) en.nextElement();
1112 if (anentry.getId().equals(pdbe.getId()))
1119 newpdb.addElement(pdbe);
1124 if (newpdb.size() > 0)
1126 Enumeration en = newpdb.elements();
1127 while (en.hasMoreElements())
1129 addPDBId((PDBEntry) en.nextElement());
1140 * jalview.datamodel.SequenceI#transferAnnotation(jalview.datamodel.SequenceI,
1141 * jalview.datamodel.Mapping)
1143 public void transferAnnotation(SequenceI entry, Mapping mp)
1145 if (datasetSequence != null)
1147 datasetSequence.transferAnnotation(entry, mp);
1150 if (entry.getDatasetSequence() != null)
1152 transferAnnotation(entry.getDatasetSequence(), mp);
1155 // transfer any new features from entry onto sequence
1156 if (entry.getSequenceFeatures() != null)
1159 SequenceFeature[] sfs = entry.getSequenceFeatures();
1160 for (int si = 0; si < sfs.length; si++)
1162 SequenceFeature sf[] = (mp != null) ? mp.locateFeature(sfs[si])
1163 : new SequenceFeature[]
1164 { new SequenceFeature(sfs[si]) };
1165 if (sf != null && sf.length > 0)
1167 for (int sfi = 0; sfi < sf.length; sfi++)
1169 addSequenceFeature(sf[sfi]);
1175 // transfer PDB entries
1176 if (entry.getPDBId() != null)
1178 Enumeration e = entry.getPDBId().elements();
1179 while (e.hasMoreElements())
1181 PDBEntry pdb = (PDBEntry) e.nextElement();
1185 // transfer database references
1186 DBRefEntry[] entryRefs = entry.getDBRef();
1187 if (entryRefs != null)
1189 for (int r = 0; r < entryRefs.length; r++)
1191 DBRefEntry newref = new DBRefEntry(entryRefs[r]);
1192 if (newref.getMap() != null && mp != null)
1194 // remap ref using our local mapping
1196 // we also assume all version string setting is done by dbSourceProxy
1198 * if (!newref.getSource().equalsIgnoreCase(dbSource)) {
1199 * newref.setSource(dbSource); }
1207 * @return The index (zero-based) on this sequence in the MSA. It returns
1208 * {@code -1} if this information is not available.
1210 public int getIndex()
1216 * Defines the position of this sequence in the MSA. Use the value {@code -1}
1217 * if this information is undefined.
1220 * position for this sequence. This value is zero-based (zero for
1221 * this first sequence)
1223 public void setIndex(int value)
1228 public void setRNA(RNA r)
1239 * Returns a (possibly empty) list of any annotations that match on given
1240 * calcId (source) and label (type). Null values do not match.
1246 public List<AlignmentAnnotation> getAlignmentAnnotations(String calcId,
1249 List<AlignmentAnnotation> result = new ArrayList<AlignmentAnnotation>();
1250 if (this.annotation != null) {
1251 for (AlignmentAnnotation ann : annotation) {
1252 if (ann.calcId != null && ann.calcId.equals(calcId)
1253 && ann.label != null && ann.label.equals(label))