Merge branch 'develop' into features/mchmmer
[jalview.git] / src / jalview / datamodel / SequenceI.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
4  * 
5  * This file is part of Jalview.
6  * 
7  * Jalview is free software: you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License 
9  * as published by the Free Software Foundation, either version 3
10  * of the License, or (at your option) any later version.
11  *  
12  * Jalview is distributed in the hope that it will be useful, but 
13  * WITHOUT ANY WARRANTY; without even the implied warranty 
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
15  * PURPOSE.  See the GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License
18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
19  * The Jalview Authors are detailed in the 'AUTHORS' file.
20  */
21 package jalview.datamodel;
22
23 import jalview.datamodel.features.SequenceFeaturesI;
24 import jalview.util.MapList;
25
26 import java.util.BitSet;
27 import java.util.List;
28 import java.util.Vector;
29
30 import fr.orsay.lri.varna.models.rna.RNA;
31
32 /**
33  * Methods for manipulating a sequence, its metadata and related annotation in
34  * an alignment or dataset.
35  * 
36  * @author $author$
37  * @version $Revision$
38  */
39 public interface SequenceI extends ASequenceI
40 {
41   /**
42    * Set the display name for the sequence
43    * 
44    * @param name
45    */
46   public void setName(String name);
47
48   public HiddenMarkovModel getHMM();
49
50   public void setHMM(HiddenMarkovModel hmm);
51
52   /**
53    * Get the display name
54    */
55   public String getName();
56
57   /**
58    * Set start position of first non-gapped symbol in sequence
59    * 
60    * @param start
61    *          new start position
62    */
63   public void setStart(int start);
64
65   /**
66    * get start position of first non-gapped residue in sequence
67    * 
68    * @return
69    */
70   public int getStart();
71
72   /**
73    * get the displayed id of the sequence
74    * 
75    * @return true means the id will be returned in the form
76    *         DisplayName/Start-End
77    */
78   public String getDisplayId(boolean jvsuffix);
79
80   /**
81    * set end position for last residue in sequence
82    * 
83    * @param end
84    */
85   public void setEnd(int end);
86
87   /**
88    * get end position for last residue in sequence getEnd()>getStart() unless
89    * sequence only consists of gap characters
90    * 
91    * @return
92    */
93   public int getEnd();
94
95   /**
96    * @return length of sequence including gaps
97    * 
98    */
99   public int getLength();
100
101   /**
102    * Replace the sequence with the given string
103    * 
104    * @param sequence
105    *          new sequence string
106    */
107   public void setSequence(String sequence);
108
109   /**
110    * @return sequence as string
111    */
112   public String getSequenceAsString();
113
114   /**
115    * get a range on the sequence as a string
116    * 
117    * @param start
118    *          position relative to start of sequence including gaps (from 0)
119    * @param end
120    *          position relative to start of sequence including gaps (from 0)
121    * 
122    * @return String containing all gap and symbols in specified range
123    */
124   public String getSequenceAsString(int start, int end);
125
126   /**
127    * Answers a copy of the sequence as a character array
128    * 
129    * @return
130    */
131   public char[] getSequence();
132
133   /**
134    * get stretch of sequence characters in an array
135    * 
136    * @param start
137    *          absolute index into getSequence()
138    * @param end
139    *          exclusive index of last position in segment to be returned.
140    * 
141    * @return char[max(0,end-start)];
142    */
143   public char[] getSequence(int start, int end);
144
145   /**
146    * create a new sequence object with a subsequence of this one but sharing the
147    * same dataset sequence
148    * 
149    * @param start
150    *          int index for start position (base 0, inclusive)
151    * @param end
152    *          int index for end position (base 0, exclusive)
153    * 
154    * @return SequenceI
155    * @note implementations may use getSequence to get the sequence data
156    */
157   public SequenceI getSubSequence(int start, int end);
158
159   /**
160    * get the i'th character in this sequence's local reference frame (ie from
161    * 0-number of characters lying from start-end)
162    * 
163    * @param i
164    *          index
165    * @return character or ' '
166    */
167   public char getCharAt(int i);
168
169   /**
170    * DOCUMENT ME!
171    * 
172    * @param desc
173    *          DOCUMENT ME!
174    */
175   public void setDescription(String desc);
176
177   /**
178    * DOCUMENT ME!
179    * 
180    * @return DOCUMENT ME!
181    */
182   public String getDescription();
183
184   /**
185    * Return the alignment column (from 1..) for a sequence position
186    * 
187    * @param pos
188    *          lying from start to end
189    * 
190    * @return aligned column for residue (0 if residue is upstream from
191    *         alignment, -1 if residue is downstream from alignment) note.
192    *         Sequence object returns sequence.getEnd() for positions upstream
193    *         currently. TODO: change sequence for
194    *         assert(findIndex(seq.getEnd()+1)==-1) and fix incremental bugs
195    * 
196    */
197   public int findIndex(int pos);
198
199   /**
200    * Returns the sequence position for an alignment (column) position. If at a
201    * gap, returns the position of the next residue to the right. If beyond the
202    * end of the sequence, returns 1 more than the last residue position.
203    * 
204    * @param i
205    *          column index in alignment (from 0..<length)
206    * 
207    * @return
208    */
209   public int findPosition(int i);
210
211   /**
212    * Returns the from-to sequence positions (start..) for the given column
213    * positions (1..), or null if no residues are included in the range
214    * 
215    * @param fromColum
216    * @param toColumn
217    * @return
218    */
219   public Range findPositions(int fromColum, int toColumn);
220
221   /**
222    * Returns an int array where indices correspond to each residue in the
223    * sequence and the element value gives its position in the alignment
224    * 
225    * @return int[SequenceI.getEnd()-SequenceI.getStart()+1] or null if no
226    *         residues in SequenceI object
227    */
228   public int[] gapMap();
229
230   /**
231    * Returns an int array where indices correspond to each position in sequence
232    * char array and the element value gives the result of findPosition for that
233    * index in the sequence.
234    * 
235    * @return int[SequenceI.getLength()]
236    */
237   public int[] findPositionMap();
238
239   /**
240    * Answers true if the sequence is composed of amino acid characters. Note
241    * that implementations may use heuristic methods which are not guaranteed to
242    * give the biologically 'right' answer.
243    * 
244    * @return
245    */
246   public boolean isProtein();
247
248   /**
249    * Delete a range of aligned sequence columns, creating a new dataset sequence
250    * if necessary and adjusting start and end positions accordingly.
251    * 
252    * @param i
253    *          first column in range to delete (inclusive)
254    * @param j
255    *          last column in range to delete (exclusive)
256    */
257   public void deleteChars(int i, int j);
258
259   /**
260    * DOCUMENT ME!
261    * 
262    * @param i
263    *          alignment column number
264    * @param c
265    *          character to insert
266    */
267   public void insertCharAt(int i, char c);
268
269   /**
270    * insert given character at alignment column position
271    * 
272    * @param position
273    *          alignment column number
274    * @param count
275    *          length of insert
276    * @param ch
277    *          character to insert
278    */
279   public void insertCharAt(int position, int count, char ch);
280
281   /**
282    * Answers a list of all sequence features associated with this sequence. The
283    * list may be held by the sequence's dataset sequence if that is defined.
284    * 
285    * @return
286    */
287   public List<SequenceFeature> getSequenceFeatures();
288
289   /**
290    * Answers the object holding features for the sequence
291    * 
292    * @return
293    */
294   SequenceFeaturesI getFeatures();
295
296   /**
297    * Replaces the sequence features associated with this sequence with the given
298    * features. If this sequence has a dataset sequence, then this method will
299    * update the dataset sequence's features instead.
300    * 
301    * @param features
302    */
303   public void setSequenceFeatures(List<SequenceFeature> features);
304
305   /**
306    * DOCUMENT ME!
307    * 
308    * @param id
309    *          DOCUMENT ME!
310    */
311   public void setPDBId(Vector<PDBEntry> ids);
312
313   /**
314    * Returns a list
315    * 
316    * @return DOCUMENT ME!
317    */
318   public Vector<PDBEntry> getAllPDBEntries();
319
320   /**
321    * Adds the entry to the *normalised* list of PDBIds.
322    * 
323    * If a PDBEntry is passed with the same entry.getID() string as one already
324    * in the list, or one is added that appears to be the same but has a chain ID
325    * appended, then the existing PDBEntry will be updated with the new
326    * attributes instead, unless the entries have distinct chain codes or
327    * associated structure files.
328    * 
329    * @param entry
330    * @return true if the entry was added, false if updated
331    */
332   public boolean addPDBId(PDBEntry entry);
333
334   /**
335    * update the list of PDBEntrys to include any DBRefEntrys citing structural
336    * databases
337    * 
338    * @return true if PDBEntry list was modified
339    */
340   public boolean updatePDBIds();
341
342   public String getVamsasId();
343
344   public void setVamsasId(String id);
345
346   /**
347    * set the array of Database references for the sequence.
348    * 
349    * @param dbs
350    * @deprecated - use is discouraged since side-effects may occur if DBRefEntry
351    *             set are not normalised.
352    */
353   @Deprecated
354   public void setDBRefs(DBRefEntry[] dbs);
355
356   public DBRefEntry[] getDBRefs();
357
358   /**
359    * add the given entry to the list of DBRefs for this sequence, or replace a
360    * similar one if entry contains a map object and the existing one doesnt.
361    * 
362    * @param entry
363    */
364   public void addDBRef(DBRefEntry entry);
365
366   /**
367    * Adds the given sequence feature and returns true, or returns false if it is
368    * already present on the sequence, or if the feature type is null.
369    * 
370    * @param sf
371    * @return
372    */
373   public boolean addSequenceFeature(SequenceFeature sf);
374
375   public void deleteFeature(SequenceFeature sf);
376
377   public void setDatasetSequence(SequenceI seq);
378
379   public SequenceI getDatasetSequence();
380
381   /**
382    * Returns a new array containing this sequence's annotations, or null.
383    */
384   public AlignmentAnnotation[] getAnnotation();
385
386   /**
387    * Returns true if this sequence has the given annotation (by object
388    * identity).
389    */
390   public boolean hasAnnotation(AlignmentAnnotation ann);
391
392   /**
393    * Add the given annotation, if not already added, and set its sequence ref to
394    * be this sequence. Does nothing if this sequence's annotations already
395    * include this annotation (by identical object reference).
396    */
397   public void addAlignmentAnnotation(AlignmentAnnotation annotation);
398
399   public void removeAlignmentAnnotation(AlignmentAnnotation annotation);
400
401   /**
402    * Derive a sequence (using this one's dataset or as the dataset)
403    * 
404    * @return duplicate sequence with valid dataset sequence
405    */
406   public SequenceI deriveSequence();
407
408   /**
409    * set the array of associated AlignmentAnnotation for this sequenceI
410    * 
411    * @param revealed
412    */
413   public void setAlignmentAnnotation(AlignmentAnnotation[] annotation);
414
415   /**
416    * Get one or more alignment annotations with a particular label.
417    * 
418    * @param label
419    *          string which each returned annotation must have as a label.
420    * @return null or array of annotations.
421    */
422   public AlignmentAnnotation[] getAnnotation(String label);
423
424   /**
425    * Returns a (possibly empty) list of any annotations that match on given
426    * calcId (source) and label (type). Null values do not match.
427    * 
428    * @param calcId
429    * @param label
430    */
431   public List<AlignmentAnnotation> getAlignmentAnnotations(String calcId,
432           String label);
433
434   /**
435    * create a new dataset sequence (if necessary) for this sequence and sets
436    * this sequence to refer to it. This call will move any features or
437    * references on the sequence onto the dataset. It will also make a duplicate
438    * of existing annotation rows for the dataset sequence, rather than relocate
439    * them in order to preserve external references (since 2.8.2).
440    * 
441    * @return dataset sequence for this sequence
442    */
443   public SequenceI createDatasetSequence();
444
445   /**
446    * Transfer any database references or annotation from entry under a sequence
447    * mapping. <br/>
448    * <strong>Note: DOES NOT transfer sequence associated alignment annotation
449    * </strong><br/>
450    * 
451    * @param entry
452    * @param mp
453    *          null or mapping from entry's numbering to local start/end
454    */
455   public void transferAnnotation(SequenceI entry, Mapping mp);
456
457   /**
458    * @return The RNA of the sequence in the alignment
459    */
460
461   public RNA getRNA();
462
463   /**
464    * @param rna
465    *          The RNA.
466    */
467   public void setRNA(RNA rna);
468
469   /**
470    * 
471    * @return list of insertions (gap characters) in sequence
472    */
473   public List<int[]> getInsertions();
474
475   /**
476    * Given a pdbId String, return the equivalent PDBEntry if available in the
477    * given sequence
478    * 
479    * @param pdbId
480    * @return
481    */
482   public PDBEntry getPDBEntry(String pdbId);
483
484   /**
485    * Get all primary database/accessions for this sequence's data. These
486    * DBRefEntry are expected to resolve to a valid record in the associated
487    * external database, either directly or via a provided 1:1 Mapping.
488    * 
489    * @return just the primary references (if any) for this sequence, or an empty
490    *         list
491    */
492   public List<DBRefEntry> getPrimaryDBRefs();
493
494   public void updateHMMMapping();
495
496   boolean isHMMConsensusSequence();
497
498   void setIsHMMConsensusSequence(boolean isHMMConsensusSequence);
499
500   boolean hasHMMAnnotation();
501
502   void setHasInfo(boolean status);
503
504   int getPreviousPosition();
505
506   void setPreviousPosition(int previousPosition);
507
508   /**
509    * Returns a (possibly empty) list of sequence features that overlap the given
510    * alignment column range, optionally restricted to one or more specified
511    * feature types. If the range is all gaps, then features which enclose it are
512    * included (but not contact features).
513    * 
514    * @param fromCol
515    *          start column of range inclusive (1..)
516    * @param toCol
517    *          end column of range inclusive (1..)
518    * @param types
519    *          optional feature types to restrict results to
520    * @return
521    */
522   List<SequenceFeature> findFeatures(int fromCol, int toCol, String... types);
523
524   /**
525    * Method to call to indicate that the sequence (characters or alignment/gaps)
526    * has been modified. Provided to allow any cursors on residue/column
527    * positions to be invalidated.
528    */
529   void sequenceChanged();
530   
531   /**
532    * 
533    * @return BitSet corresponding to index [0,length) where Comparison.isGap()
534    *         returns true.
535    */
536   BitSet getInsertionsAsBits();
537
538   void mapToReference(AlignmentAnnotation rf);
539
540   /**
541    * Replaces every occurrence of c1 in the sequence with c2 and returns the
542    * number of characters changed
543    * 
544    * @param c1
545    * @param c2
546    */
547   int replace(char c1, char c2);
548
549   /**
550    * Answers the GeneLociI, or null if not known
551    * 
552    * @return
553    */
554   GeneLociI getGeneLoci();
555
556   /**
557    * Sets the mapping to gene loci for the sequence
558    * 
559    * @param speciesId
560    * @param assemblyId
561    * @param chromosomeId
562    * @param map
563    */
564   void setGeneLoci(String speciesId, String assemblyId,
565           String chromosomeId, MapList map);
566 }