JAL-1834 removed quotes around truncated strings with ellipsis
[jalview.git] / src / jalview / datamodel / AlignmentI.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 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 License for more details.
16  * 
17  * You should have received a copy of the GNU General 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.Hashtable;
24 import java.util.List;
25 import java.util.Map;
26 import java.util.Set;
27
28 /**
29  * Data structure to hold and manipulate a multiple sequence alignment
30  */
31 public interface AlignmentI extends AnnotatedCollectionI
32 {
33   /**
34    * Calculates the number of sequences in an alignment
35    * 
36    * @return Number of sequences in alignment
37    */
38   int getHeight();
39
40   /**
41    * 
42    * Calculates the maximum width of the alignment, including gaps.
43    * 
44    * @return Greatest sequence length within alignment.
45    */
46   @Override
47   int getWidth();
48
49   /**
50    * Calculates if this set of sequences (visible and invisible) are all the
51    * same length
52    * 
53    * @return true if all sequences in alignment are the same length
54    */
55   boolean isAligned();
56
57   /**
58    * Calculates if this set of sequences is all the same length
59    * 
60    * @param includeHidden
61    *          optionally exclude hidden sequences from test
62    * @return true if all (or just visible) sequences are the same length
63    */
64   boolean isAligned(boolean includeHidden);
65
66   /**
67    * Gets sequences as a Synchronized collection
68    * 
69    * @return All sequences in alignment.
70    */
71   @Override
72   List<SequenceI> getSequences();
73
74   /**
75    * Gets sequences as a SequenceI[]
76    * 
77    * @return All sequences in alignment.
78    */
79   SequenceI[] getSequencesArray();
80
81   /**
82    * Find a specific sequence in this alignment.
83    * 
84    * @param i
85    *          Index of required sequence.
86    * 
87    * @return SequenceI at given index.
88    */
89   SequenceI getSequenceAt(int i);
90
91   /**
92    * Returns a map of lists of sequences keyed by sequence name.
93    * 
94    * @return
95    */
96   Map<String, List<SequenceI>> getSequencesByName();
97
98   /**
99    * Add a new sequence to this alignment.
100    * 
101    * @param seq
102    *          New sequence will be added at end of alignment.
103    */
104   void addSequence(SequenceI seq);
105
106   /**
107    * Used to set a particular index of the alignment with the given sequence.
108    * 
109    * @param i
110    *          Index of sequence to be updated.
111    * @param seq
112    *          New sequence to be inserted.
113    */
114   void setSequenceAt(int i, SequenceI seq);
115
116   /**
117    * Deletes a sequence from the alignment
118    * 
119    * @param s
120    *          Sequence to be deleted.
121    */
122   void deleteSequence(SequenceI s);
123
124   /**
125    * Deletes a sequence from the alignment.
126    * 
127    * @param i
128    *          Index of sequence to be deleted.
129    */
130   void deleteSequence(int i);
131
132   /**
133    * Finds sequence in alignment using sequence name as query.
134    * 
135    * @param name
136    *          Id of sequence to search for.
137    * 
138    * @return Sequence matching query, if found. If not found returns null.
139    */
140   SequenceI findName(String name);
141
142   SequenceI[] findSequenceMatch(String name);
143
144   /**
145    * Finds index of a given sequence in the alignment.
146    * 
147    * @param s
148    *          Sequence to look for.
149    * 
150    * @return Index of sequence within the alignment or -1 if not found
151    */
152   int findIndex(SequenceI s);
153
154   /**
155    * Finds group that given sequence is part of.
156    * 
157    * @param s
158    *          Sequence in alignment.
159    * 
160    * @return First group found for sequence. WARNING : Sequences may be members
161    *         of several groups. This method is incomplete.
162    */
163   SequenceGroup findGroup(SequenceI s);
164
165   /**
166    * Finds all groups that a given sequence is part of.
167    * 
168    * @param s
169    *          Sequence in alignment.
170    * 
171    * @return All groups containing given sequence.
172    */
173   SequenceGroup[] findAllGroups(SequenceI s);
174
175   /**
176    * Adds a new SequenceGroup to this alignment.
177    * 
178    * @param sg
179    *          New group to be added.
180    */
181   void addGroup(SequenceGroup sg);
182
183   /**
184    * Deletes a specific SequenceGroup
185    * 
186    * @param g
187    *          Group will be deleted from alignment.
188    */
189   void deleteGroup(SequenceGroup g);
190
191   /**
192    * Get all the groups associated with this alignment.
193    * 
194    * @return All groups as a list.
195    */
196   List<SequenceGroup> getGroups();
197
198   /**
199    * Deletes all groups from this alignment.
200    */
201   void deleteAllGroups();
202
203   /**
204    * Adds a new AlignmentAnnotation to this alignment
205    * 
206    * @note Care should be taken to ensure that annotation is at least as wide as
207    *       the longest sequence in the alignment for rendering purposes.
208    */
209   void addAnnotation(AlignmentAnnotation aa);
210
211   /**
212    * moves annotation to a specified index in alignment annotation display stack
213    * 
214    * @param aa
215    *          the annotation object to be moved
216    * @param index
217    *          the destination position
218    */
219   void setAnnotationIndex(AlignmentAnnotation aa, int index);
220
221   /**
222    * Delete all annotations, including auto-calculated if the flag is set true.
223    * Returns true if at least one annotation was deleted, else false.
224    * 
225    * @param includingAutoCalculated
226    * @return
227    */
228   boolean deleteAllAnnotations(boolean includingAutoCalculated);
229
230   /**
231    * Deletes a specific AlignmentAnnotation from the alignment, and removes its
232    * reference from any SequenceI or SequenceGroup object's annotation if and
233    * only if aa is contained within the alignment's annotation vector.
234    * Otherwise, it will do nothing.
235    * 
236    * @param aa
237    *          the annotation to delete
238    * @return true if annotation was deleted from this alignment.
239    */
240   boolean deleteAnnotation(AlignmentAnnotation aa);
241
242   /**
243    * Deletes a specific AlignmentAnnotation from the alignment, and optionally
244    * removes any reference from any SequenceI or SequenceGroup object's
245    * annotation if and only if aa is contained within the alignment's annotation
246    * vector. Otherwise, it will do nothing.
247    * 
248    * @param aa
249    *          the annotation to delete
250    * @param unhook
251    *          flag indicating if any references should be removed from
252    *          annotation - use this if you intend to add the annotation back
253    *          into the alignment
254    * @return true if annotation was deleted from this alignment.
255    */
256   boolean deleteAnnotation(AlignmentAnnotation aa, boolean unhook);
257
258   /**
259    * Get the annotation associated with this alignment (this can be null if no
260    * annotation has ever been created on the alignment)
261    * 
262    * @return array of AlignmentAnnotation objects
263    */
264   @Override
265   AlignmentAnnotation[] getAlignmentAnnotation();
266
267   /**
268    * Change the gap character used in this alignment to 'gc'
269    * 
270    * @param gc
271    *          the new gap character.
272    */
273   void setGapCharacter(char gc);
274
275   /**
276    * Get the gap character used in this alignment
277    * 
278    * @return gap character
279    */
280   char getGapCharacter();
281
282   /**
283    * Test for all nucleotide alignment
284    * 
285    * @return true if alignment is nucleotide sequence
286    */
287   boolean isNucleotide();
288
289   /**
290    * Test if alignment contains RNA structure
291    * 
292    * @return true if RNA structure AligmnentAnnotation was added to alignment
293    */
294   boolean hasRNAStructure();
295
296   /**
297    * Set alignment to be a nucleotide sequence
298    * 
299    */
300   void setNucleotide(boolean b);
301
302   /**
303    * Get the associated dataset for the alignment.
304    * 
305    * @return Alignment containing dataset sequences or null of this is a
306    *         dataset.
307    */
308   Alignment getDataset();
309
310   /**
311    * Set the associated dataset for the alignment, or create one.
312    * 
313    * @param dataset
314    *          The dataset alignment or null to construct one.
315    */
316   void setDataset(Alignment dataset);
317
318   /**
319    * pads sequences with gaps (to ensure the set looks like an alignment)
320    * 
321    * @return boolean true if alignment was modified
322    */
323   boolean padGaps();
324
325   HiddenSequences getHiddenSequences();
326
327   /**
328    * Compact representation of alignment
329    * 
330    * @return CigarArray
331    */
332   CigarArray getCompactAlignment();
333
334   /**
335    * Set an arbitrary key value pair for an alignment. Note: both key and value
336    * objects should return a meaningful, human readable response to .toString()
337    * 
338    * @param key
339    * @param value
340    */
341   void setProperty(Object key, Object value);
342
343   /**
344    * Get a named property from the alignment.
345    * 
346    * @param key
347    * @return value of property
348    */
349   Object getProperty(Object key);
350
351   /**
352    * Get the property hashtable.
353    * 
354    * @return hashtable of alignment properties (or null if none are defined)
355    */
356   Hashtable getProperties();
357
358   /**
359    * add a reference to a frame of aligned codons for this alignment
360    * 
361    * @param codons
362    */
363   void addCodonFrame(AlignedCodonFrame codons);
364
365   /**
366    * remove a particular codon frame reference from this alignment
367    * 
368    * @param codons
369    * @return true if codon frame was removed.
370    */
371   boolean removeCodonFrame(AlignedCodonFrame codons);
372
373   /**
374    * get all codon frames associated with this alignment
375    * 
376    * @return
377    */
378   Set<AlignedCodonFrame> getCodonFrames();
379
380   /**
381    * Set the codon frame mappings (replacing any existing set).
382    */
383   void setCodonFrames(Set<AlignedCodonFrame> acfs);
384
385   /**
386    * get codon frames involving sequenceI
387    */
388   List<AlignedCodonFrame> getCodonFrame(SequenceI seq);
389
390   /**
391    * find sequence with given name in alignment
392    * 
393    * @param token
394    *          name to find
395    * @param b
396    *          true implies that case insensitive matching will <em>also</em> be
397    *          tried
398    * @return matched sequence or null
399    */
400   SequenceI findName(String token, boolean b);
401
402   /**
403    * find next sequence with given name in alignment starting after a given
404    * sequence
405    * 
406    * @param startAfter
407    *          the sequence after which the search will be started (usually the
408    *          result of the last call to findName)
409    * @param token
410    *          name to find
411    * @param b
412    *          true implies that case insensitive matching will <em>also</em> be
413    *          tried
414    * @return matched sequence or null
415    */
416   SequenceI findName(SequenceI startAfter, String token, boolean b);
417
418   /**
419    * find first sequence in alignment which is involved in the given search
420    * result object
421    * 
422    * @param results
423    * @return -1 or index of sequence in alignment
424    */
425   int findIndex(SearchResults results);
426
427   /**
428    * append sequences and annotation from another alignment object to this one.
429    * Note: this is a straight transfer of object references, and may result in
430    * toappend's dependent data being transformed to fit the alignment (changing
431    * gap characters, etc...). If you are uncertain, use the copy Alignment copy
432    * constructor to create a new version which can be appended without side
433    * effect.
434    * 
435    * @param toappend
436    *          - the alignment to be appended.
437    */
438   void append(AlignmentI toappend);
439
440   /**
441    * Justify the sequences to the left or right by deleting and inserting gaps
442    * before the initial residue or after the terminal residue
443    * 
444    * @param right
445    *          true if alignment padded to right, false to justify to left
446    * @return true if alignment was changed TODO: return undo object
447    */
448   boolean justify(boolean right);
449
450   /**
451    * add given annotation row at given position (0 is start, -1 is end)
452    * 
453    * @param consensus
454    * @param i
455    */
456   void addAnnotation(AlignmentAnnotation consensus, int i);
457
458   /**
459    * search for or create a specific annotation row on the alignment
460    * 
461    * @param name
462    *          name for annotation (must match)
463    * @param calcId
464    *          calcId for the annotation (null or must match)
465    * @param autoCalc
466    *          - value of autocalc flag for the annotation
467    * @param seqRef
468    *          - null or specific sequence reference
469    * @param groupRef
470    *          - null or specific group reference
471    * @param method
472    *          - CalcId for the annotation (must match)
473    * 
474    * @return existing annotation matching the given attributes
475    */
476   AlignmentAnnotation findOrCreateAnnotation(String name,
477           String calcId, boolean autoCalc, SequenceI seqRef,
478           SequenceGroup groupRef);
479
480   /**
481    * move the given group up or down in the alignment by the given number of
482    * rows. Implementor assumes given group is already present on alignment - no
483    * recalculations are triggered.
484    * 
485    * @param sg
486    * @param map
487    * @param up
488    * @param i
489    */
490   void moveSelectedSequencesByOne(SequenceGroup sg,
491           Map<SequenceI, SequenceCollectionI> map, boolean up);
492
493   /**
494    * validate annotation after an edit and update any alignment state flags
495    * accordingly
496    * 
497    * @param alignmentAnnotation
498    */
499   void validateAnnotation(AlignmentAnnotation alignmentAnnotation);
500
501   /**
502    * Align this alignment the same as the given one. If both of the same type
503    * (nucleotide/protein) then align both identically. If this is nucleotide and
504    * the other is protein, make 3 gaps for each gap in the protein sequences. If
505    * this is protein and the other is nucleotide, insert a gap for each 3 gaps
506    * (or part thereof) between nucleotide bases. Returns the number of mapped
507    * sequences that were realigned .
508    * 
509    * @param al
510    * @return
511    */
512   int alignAs(AlignmentI al);
513
514   /**
515    * Returns the set of distinct sequence names in the alignment.
516    * 
517    * @return
518    */
519   Set<String> getSequenceNames();
520
521   /**
522    * Checks if the alignment has at least one sequence with one non-gaped
523    * residue
524    * 
525    * @return
526    */
527   public boolean hasValidSequence();
528 }