Merge branch 'releases/Release_2_11_4_Branch'
[jalview.git] / datamodel / SequenceI.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
3  * Copyright (C) 2014 The Jalview Authors
4  * 
5  * This file is part of Jalview.
6  * 
7  * Jalview is free software: you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License 
9  * as published by the Free Software Foundation, either version 3
10  * of the License, or (at your option) any later version.
11  *  
12  * Jalview is distributed in the hope that it will be useful, but 
13  * WITHOUT ANY WARRANTY; without even the implied warranty 
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
15  * PURPOSE.  See the GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License
18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
19  * The Jalview Authors are detailed in the 'AUTHORS' file.
20  */
21 package jalview.datamodel;
22
23 import java.util.List;
24 import java.util.Vector;
25
26 import fr.orsay.lri.varna.models.rna.RNA;
27
28 /**
29  * DOCUMENT ME!
30  * 
31  * @author $author$
32  * @version $Revision$
33  */
34 public interface SequenceI
35 {
36   /**
37    * Set the display name for the sequence
38    * 
39    * @param name
40    */
41   public void setName(String name);
42
43   /**
44    * Get the display name
45    */
46   public String getName();
47
48   /**
49    * Set start position of first non-gapped symbol in sequence
50    * 
51    * @param start
52    *          new start position
53    */
54   public void setStart(int start);
55
56   /**
57    * get start position of first non-gapped residue in sequence
58    * 
59    * @return
60    */
61   public int getStart();
62
63   /**
64    * get the displayed id of the sequence
65    * 
66    * @return true means the id will be returned in the form
67    *         DisplayName/Start-End
68    */
69   public String getDisplayId(boolean jvsuffix);
70
71   /**
72    * set end position for last residue in sequence
73    * 
74    * @param end
75    */
76   public void setEnd(int end);
77
78   /**
79    * get end position for last residue in sequence getEnd()>getStart() unless
80    * sequence only consists of gap characters
81    * 
82    * @return
83    */
84   public int getEnd();
85
86   /**
87    * @return length of sequence including gaps
88    * 
89    */
90   public int getLength();
91
92   /**
93    * Replace the sequence with the given string
94    * 
95    * @param sequence
96    *          new sequence string
97    */
98   public void setSequence(String sequence);
99
100   /**
101    * @return sequence as string
102    */
103   public String getSequenceAsString();
104
105   /**
106    * get a range on the sequence as a string
107    * 
108    * @param start
109    *          position relative to start of sequence including gaps (from 0)
110    * @param end
111    *          position relative to start of sequence including gaps (from 0)
112    * 
113    * @return String containing all gap and symbols in specified range
114    */
115   public String getSequenceAsString(int start, int end);
116
117   /**
118    * Get the sequence as a character array
119    * 
120    * @return seqeunce and any gaps
121    */
122   public char[] getSequence();
123
124   /**
125    * get stretch of sequence characters in an array
126    * 
127    * @param start
128    *          absolute index into getSequence()
129    * @param end
130    *          exclusive index of last position in segment to be returned.
131    * 
132    * @return char[max(0,end-start)];
133    */
134   public char[] getSequence(int start, int end);
135
136   /**
137    * create a new sequence object from start to end of this sequence
138    * 
139    * @param start
140    *          int
141    * @param end
142    *          int
143    * @return SequenceI
144    */
145   public SequenceI getSubSequence(int start, int end);
146
147   /**
148    * DOCUMENT ME!
149    * 
150    * @param i
151    *          DOCUMENT ME!
152    * 
153    * @return DOCUMENT ME!
154    */
155   public char getCharAt(int i);
156
157   /**
158    * DOCUMENT ME!
159    * 
160    * @param desc
161    *          DOCUMENT ME!
162    */
163   public void setDescription(String desc);
164
165   /**
166    * DOCUMENT ME!
167    * 
168    * @return DOCUMENT ME!
169    */
170   public String getDescription();
171
172   /**
173    * Return the alignment column for a sequence position * Return the alignment
174    * position for a sequence position
175    * 
176    * @param pos
177    *          lying from start to end
178    * 
179    * @return aligned column for residue (0 if residue is upstream from
180    *         alignment, -1 if residue is downstream from alignment) note.
181    *         Sequence object returns sequence.getEnd() for positions upstream
182    *         currently. TODO: change sequence for
183    *         assert(findIndex(seq.getEnd()+1)==-1) and fix incremental bugs
184    * 
185    */
186   public int findIndex(int pos);
187
188   /**
189    * Returns the sequence position for an alignment position
190    * 
191    * @param i
192    *          column index in alignment (from 1)
193    * 
194    * @return residue number for residue (left of and) nearest ith column
195    */
196   public int findPosition(int i);
197
198   /**
199    * Returns an int array where indices correspond to each residue in the
200    * sequence and the element value gives its position in the alignment
201    * 
202    * @return int[SequenceI.getEnd()-SequenceI.getStart()+1] or null if no
203    *         residues in SequenceI object
204    */
205   public int[] gapMap();
206
207   /**
208    * Returns an int array where indices correspond to each position in sequence
209    * char array and the element value gives the result of findPosition for that
210    * index in the sequence.
211    * 
212    * @return int[SequenceI.getLength()]
213    */
214   public int[] findPositionMap();
215
216   /**
217    * Delete a range of aligned sequence columns, creating a new dataset sequence
218    * if necessary and adjusting start and end positions accordingly.
219    * 
220    * @param i
221    *          first column in range to delete
222    * @param j
223    *          last column in range to delete
224    */
225   public void deleteChars(int i, int j);
226
227   /**
228    * DOCUMENT ME!
229    * 
230    * @param i
231    *          DOCUMENT ME!
232    * @param c
233    *          DOCUMENT ME!
234    */
235   public void insertCharAt(int i, char c);
236
237   /**
238    * DOCUMENT ME!
239    * 
240    * @param i
241    *          DOCUMENT ME!
242    * @param c
243    *          DOCUMENT ME!
244    */
245   public void insertCharAt(int i, int length, char c);
246
247   /**
248    * DOCUMENT ME!
249    * 
250    * @return DOCUMENT ME!
251    */
252   public SequenceFeature[] getSequenceFeatures();
253
254   /**
255    * DOCUMENT ME!
256    * 
257    * @param v
258    *          DOCUMENT ME!
259    */
260   public void setSequenceFeatures(SequenceFeature[] features);
261
262   /**
263    * DOCUMENT ME!
264    * 
265    * @param id
266    *          DOCUMENT ME!
267    */
268   public void setPDBId(Vector ids);
269
270   /**
271    * DOCUMENT ME!
272    * 
273    * @return DOCUMENT ME!
274    */
275   public Vector getPDBId();
276
277   /**
278    * add entry to the vector of PDBIds, if it isn't in the list already
279    * 
280    * @param entry
281    */
282   public void addPDBId(PDBEntry entry);
283
284   /**
285    * update the list of PDBEntrys to include any DBRefEntrys citing structural
286    * databases
287    * 
288    * @return true if PDBEntry list was modified
289    */
290   public boolean updatePDBIds();
291
292   public String getVamsasId();
293
294   public void setVamsasId(String id);
295
296   public void setDBRef(DBRefEntry[] dbs);
297
298   public DBRefEntry[] getDBRef();
299
300   /**
301    * add the given entry to the list of DBRefs for this sequence, or replace a
302    * similar one if entry contains a map object and the existing one doesnt.
303    * 
304    * @param entry
305    */
306   public void addDBRef(DBRefEntry entry);
307
308   public void addSequenceFeature(SequenceFeature sf);
309
310   public void deleteFeature(SequenceFeature sf);
311
312   public void setDatasetSequence(SequenceI seq);
313
314   public SequenceI getDatasetSequence();
315
316   public AlignmentAnnotation[] getAnnotation();
317
318   public void addAlignmentAnnotation(AlignmentAnnotation annotation);
319
320   public void removeAlignmentAnnotation(AlignmentAnnotation annotation);
321
322   /**
323    * Derive a sequence (using this one's dataset or as the dataset)
324    * 
325    * @return duplicate sequence with valid dataset sequence
326    */
327   public SequenceI deriveSequence();
328
329   /**
330    * set the array of associated AlignmentAnnotation for this sequenceI
331    * 
332    * @param revealed
333    */
334   public void setAlignmentAnnotation(AlignmentAnnotation[] annotation);
335
336   /**
337    * Get one or more alignment annotations with a particular label.
338    * 
339    * @param label
340    *          string which each returned annotation must have as a label.
341    * @return null or array of annotations.
342    */
343   public AlignmentAnnotation[] getAnnotation(String label);
344
345   /**
346    * Return a list of any annotations which match the given calcId (source) and
347    * label (type). Null values do not match.
348    * 
349    * @param calcId
350    * @param label
351    * @return
352    */
353   public List<AlignmentAnnotation> getAlignmentAnnotations(String calcId,
354           String label);
355
356   /**
357    * create a new dataset sequence (if necessary) for this sequence and sets
358    * this sequence to refer to it. This call will move any features or
359    * references on the sequence onto the dataset. It will also make a duplicate
360    * of existing annotation rows for the dataset sequence, rather than relocate
361    * them in order to preserve external references (since 2.8.2).
362    * 
363    * @return dataset sequence for this sequence
364    */
365   public SequenceI createDatasetSequence();
366
367   /**
368    * Transfer any database references or annotation from entry under a sequence
369    * mapping. <br/>
370    * <strong>Note: DOES NOT transfer sequence associated alignment
371    * annotation </strong><br/>
372    * 
373    * @param entry
374    * @param mp
375    *          null or mapping from entry's numbering to local start/end
376    */
377   public void transferAnnotation(SequenceI entry, Mapping mp);
378
379   /**
380    * @param index
381    *          The sequence index in the MSA
382    */
383   public void setIndex(int index);
384
385   /**
386    * @return The index of the sequence in the alignment
387    */
388   public int getIndex();
389
390   /**
391    * @return The RNA of the sequence in the alignment
392    */
393
394   public RNA getRNA();
395
396   /**
397    * @param rna
398    *          The RNA.
399    */
400   public void setRNA(RNA rna);
401
402 }