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 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 License for more details.
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.
21 package jalview.datamodel;
23 import java.util.Hashtable;
24 import java.util.List;
29 * Data structure to hold and manipulate a multiple sequence alignment
31 public interface AlignmentI extends AnnotatedCollectionI
34 * Calculates the number of sequences in an alignment
36 * @return Number of sequences in alignment
42 * Calculates the maximum width of the alignment, including gaps.
44 * @return Greatest sequence length within alignment, or -1 if no sequences
51 * Calculates if this set of sequences (visible and invisible) are all the
54 * @return true if all sequences in alignment are the same length
59 * Calculates if this set of sequences is all the same length
61 * @param includeHidden
62 * optionally exclude hidden sequences from test
63 * @return true if all (or just visible) sequences are the same length
65 boolean isAligned(boolean includeHidden);
68 * Gets sequences as a Synchronized collection
70 * @return All sequences in alignment.
73 List<SequenceI> getSequences();
76 * Gets sequences as a SequenceI[]
78 * @return All sequences in alignment.
80 SequenceI[] getSequencesArray();
83 * Find a specific sequence in this alignment.
86 * Index of required sequence.
88 * @return SequenceI at given index.
90 SequenceI getSequenceAt(int i);
93 * Returns a map of lists of sequences keyed by sequence name.
97 Map<String, List<SequenceI>> getSequencesByName();
100 * Add a new sequence to this alignment.
103 * New sequence will be added at end of alignment.
105 void addSequence(SequenceI seq);
108 * Used to set a particular index of the alignment with the given sequence.
111 * Index of sequence to be updated. if i>length, sequence will be
112 * added to end, with no intervening positions.
114 * New sequence to be inserted. The existing sequence at position i
116 * @return existing sequence (or null if i>current length)
118 SequenceI replaceSequenceAt(int i, SequenceI seq);
121 * Deletes a sequence from the alignment
124 * Sequence to be deleted.
126 void deleteSequence(SequenceI s);
129 * Deletes a sequence from the alignment.
132 * Index of sequence to be deleted.
134 void deleteSequence(int i);
137 * Finds sequence in alignment using sequence name as query.
140 * Id of sequence to search for.
142 * @return Sequence matching query, if found. If not found returns null.
144 SequenceI findName(String name);
146 SequenceI[] findSequenceMatch(String name);
149 * Finds index of a given sequence in the alignment.
152 * Sequence to look for.
154 * @return Index of sequence within the alignment or -1 if not found
156 int findIndex(SequenceI s);
159 * Returns the first group (in the order in which groups were added) that
160 * includes the given sequence and aligned position (base 0), or null if none
168 SequenceGroup findGroup(SequenceI seq, int position);
171 * Finds all groups that a given sequence is part of.
174 * Sequence in alignment.
176 * @return All groups containing given sequence.
178 SequenceGroup[] findAllGroups(SequenceI s);
181 * Adds a new SequenceGroup to this alignment.
184 * New group to be added.
186 void addGroup(SequenceGroup sg);
189 * Deletes a specific SequenceGroup
192 * Group will be deleted from alignment.
194 void deleteGroup(SequenceGroup g);
197 * Get all the groups associated with this alignment.
199 * @return All groups as a list.
201 List<SequenceGroup> getGroups();
204 * Deletes all groups from this alignment.
206 void deleteAllGroups();
209 * Adds a new AlignmentAnnotation to this alignment
211 * @note Care should be taken to ensure that annotation is at least as wide as
212 * the longest sequence in the alignment for rendering purposes.
214 void addAnnotation(AlignmentAnnotation aa);
217 * moves annotation to a specified index in alignment annotation display stack
220 * the annotation object to be moved
222 * the destination position
224 void setAnnotationIndex(AlignmentAnnotation aa, int index);
227 * Delete all annotations, including auto-calculated if the flag is set true.
228 * Returns true if at least one annotation was deleted, else false.
230 * @param includingAutoCalculated
233 boolean deleteAllAnnotations(boolean includingAutoCalculated);
236 * Deletes a specific AlignmentAnnotation from the alignment, and removes its
237 * reference from any SequenceI or SequenceGroup object's annotation if and
238 * only if aa is contained within the alignment's annotation vector.
239 * Otherwise, it will do nothing.
242 * the annotation to delete
243 * @return true if annotation was deleted from this alignment.
245 boolean deleteAnnotation(AlignmentAnnotation aa);
248 * Deletes a specific AlignmentAnnotation from the alignment, and optionally
249 * removes any reference from any SequenceI or SequenceGroup object's
250 * annotation if and only if aa is contained within the alignment's annotation
251 * vector. Otherwise, it will do nothing.
254 * the annotation to delete
256 * flag indicating if any references should be removed from
257 * annotation - use this if you intend to add the annotation back
259 * @return true if annotation was deleted from this alignment.
261 boolean deleteAnnotation(AlignmentAnnotation aa, boolean unhook);
264 * Get the annotation associated with this alignment (this can be null if no
265 * annotation has ever been created on the alignment)
267 * @return array of AlignmentAnnotation objects
270 AlignmentAnnotation[] getAlignmentAnnotation();
273 * Change the gap character used in this alignment to 'gc'
276 * the new gap character.
278 void setGapCharacter(char gc);
281 * Get the gap character used in this alignment
283 * @return gap character
285 char getGapCharacter();
288 * Test if alignment contains RNA structure
290 * @return true if RNA structure AligmnentAnnotation was added to alignment
292 boolean hasRNAStructure();
295 * Get the associated dataset for the alignment.
297 * @return Alignment containing dataset sequences or null of this is a
300 AlignmentI getDataset();
303 * Set the associated dataset for the alignment, or create one.
306 * The dataset alignment or null to construct one.
308 void setDataset(AlignmentI dataset);
311 * pads sequences with gaps (to ensure the set looks like an alignment)
313 * @return boolean true if alignment was modified
317 HiddenSequences getHiddenSequences();
320 * Compact representation of alignment
324 CigarArray getCompactAlignment();
327 * Set an arbitrary key value pair for an alignment. Note: both key and value
328 * objects should return a meaningful, human readable response to .toString()
333 void setProperty(Object key, Object value);
336 * Get a named property from the alignment.
339 * @return value of property
341 Object getProperty(Object key);
344 * Get the property hashtable.
346 * @return hashtable of alignment properties (or null if none are defined)
348 Hashtable getProperties();
351 * add a reference to a frame of aligned codons for this alignment
355 void addCodonFrame(AlignedCodonFrame codons);
358 * remove a particular codon frame reference from this alignment
361 * @return true if codon frame was removed.
363 boolean removeCodonFrame(AlignedCodonFrame codons);
366 * get all codon frames associated with this alignment
370 List<AlignedCodonFrame> getCodonFrames();
373 * Set the codon frame mappings (replacing any existing list).
375 void setCodonFrames(List<AlignedCodonFrame> acfs);
378 * get codon frames involving sequenceI
380 List<AlignedCodonFrame> getCodonFrame(SequenceI seq);
383 * find sequence with given name in alignment
388 * true implies that case insensitive matching will <em>also</em> be
390 * @return matched sequence or null
392 SequenceI findName(String token, boolean b);
395 * find next sequence with given name in alignment starting after a given
399 * the sequence after which the search will be started (usually the
400 * result of the last call to findName)
404 * true implies that case insensitive matching will <em>also</em> be
406 * @return matched sequence or null
408 SequenceI findName(SequenceI startAfter, String token, boolean b);
411 * find first sequence in alignment which is involved in the given search
415 * @return -1 or index of sequence in alignment
417 int findIndex(SearchResultsI results);
420 * append sequences and annotation from another alignment object to this one.
421 * Note: this is a straight transfer of object references, and may result in
422 * toappend's dependent data being transformed to fit the alignment (changing
423 * gap characters, etc...). If you are uncertain, use the copy Alignment copy
424 * constructor to create a new version which can be appended without side
428 * - the alignment to be appended.
430 void append(AlignmentI toappend);
433 * Justify the sequences to the left or right by deleting and inserting gaps
434 * before the initial residue or after the terminal residue
437 * true if alignment padded to right, false to justify to left
438 * @return true if alignment was changed TODO: return undo object
440 boolean justify(boolean right);
443 * add given annotation row at given position (0 is start, -1 is end)
448 void addAnnotation(AlignmentAnnotation consensus, int i);
451 * search for or create a specific annotation row on the alignment
454 * name for annotation (must match)
456 * calcId for the annotation (null or must match)
458 * - value of autocalc flag for the annotation
460 * - null or specific sequence reference
462 * - null or specific group reference
464 * - CalcId for the annotation (must match)
466 * @return existing annotation matching the given attributes
468 AlignmentAnnotation findOrCreateAnnotation(String name, String calcId,
469 boolean autoCalc, SequenceI seqRef, SequenceGroup groupRef);
472 * move the given group up or down in the alignment by the given number of
473 * rows. Implementor assumes given group is already present on alignment - no
474 * recalculations are triggered.
481 void moveSelectedSequencesByOne(SequenceGroup sg,
482 Map<SequenceI, SequenceCollectionI> map, boolean up);
485 * validate annotation after an edit and update any alignment state flags
488 * @param alignmentAnnotation
490 void validateAnnotation(AlignmentAnnotation alignmentAnnotation);
493 * Align this alignment the same as the given one. If both of the same type
494 * (nucleotide/protein) then align both identically. If this is nucleotide and
495 * the other is protein, make 3 gaps for each gap in the protein sequences. If
496 * this is protein and the other is nucleotide, insert a gap for each 3 gaps
497 * (or part thereof) between nucleotide bases. Returns the number of mapped
498 * sequences that were realigned .
503 int alignAs(AlignmentI al);
506 * Returns the set of distinct sequence names in the alignment.
510 Set<String> getSequenceNames();
513 * Checks if the alignment has at least one sequence with one non-gaped
518 public boolean hasValidSequence();
521 * Update any mappings to 'virtual' sequences to compatible real ones, if
522 * present in the added sequences. Returns a count of mappings updated.
527 int realiseMappings(List<SequenceI> seqs);
530 * Returns the first AlignedCodonFrame that has a mapping between the given
537 AlignedCodonFrame getMapping(SequenceI mapFrom, SequenceI mapTo);
540 * Calculate the visible start and end index of an alignment. The result is
541 * returned an int array where: int[0] = startIndex, and int[1] = endIndex.
546 public int[] getVisibleStartAndEndIndex(List<int[]> hiddenCols);