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 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.datamodel.features.SequenceFeaturesI;
25 import java.util.List;
26 import java.util.Vector;
28 import fr.orsay.lri.varna.models.rna.RNA;
31 * Methods for manipulating a sequence, its metadata and related annotation in
32 * an alignment or dataset.
37 public interface SequenceI extends ASequenceI
40 * Set the display name for the sequence
44 public void setName(String name);
47 * Get the display name
49 public String getName();
52 * Set start position of first non-gapped symbol in sequence
57 public void setStart(int start);
60 * get start position of first non-gapped residue in sequence
64 public int getStart();
67 * get the displayed id of the sequence
69 * @return true means the id will be returned in the form
70 * DisplayName/Start-End
72 public String getDisplayId(boolean jvsuffix);
75 * set end position for last residue in sequence
79 public void setEnd(int end);
82 * get end position for last residue in sequence getEnd()>getStart() unless
83 * sequence only consists of gap characters
90 * @return length of sequence including gaps
93 public int getLength();
96 * Replace the sequence with the given string
101 public void setSequence(String sequence);
104 * @return sequence as string
106 public String getSequenceAsString();
109 * get a range on the sequence as a string
112 * position relative to start of sequence including gaps (from 0)
114 * position relative to start of sequence including gaps (from 0)
116 * @return String containing all gap and symbols in specified range
118 public String getSequenceAsString(int start, int end);
121 * Get the sequence as a character array
123 * @return seqeunce and any gaps
125 public char[] getSequence();
128 * get stretch of sequence characters in an array
131 * absolute index into getSequence()
133 * exclusive index of last position in segment to be returned.
135 * @return char[max(0,end-start)];
137 public char[] getSequence(int start, int end);
140 * create a new sequence object with a subsequence of this one but sharing the
141 * same dataset sequence
144 * int index for start position (base 0, inclusive)
146 * int index for end position (base 0, exclusive)
149 * @note implementations may use getSequence to get the sequence data
151 public SequenceI getSubSequence(int start, int end);
154 * get the i'th character in this sequence's local reference frame (ie from
155 * 0-number of characters lying from start-end)
159 * @return character or ' '
161 public char getCharAt(int i);
169 public void setDescription(String desc);
174 * @return DOCUMENT ME!
176 public String getDescription();
179 * Return the alignment column (from 1..) for a sequence position
182 * lying from start to end
184 * @return aligned column for residue (0 if residue is upstream from
185 * alignment, -1 if residue is downstream from alignment) note.
186 * Sequence object returns sequence.getEnd() for positions upstream
187 * currently. TODO: change sequence for
188 * assert(findIndex(seq.getEnd()+1)==-1) and fix incremental bugs
191 public int findIndex(int pos);
194 * Returns the sequence position for an alignment position.
197 * column index in alignment (from 0..<length)
199 * @return TODO: JAL-2562 - residue number for residue (left of and) nearest
202 public int findPosition(int i);
205 * Returns the range of sequence positions included in the given alignment
206 * position range. If no positions are included (the range is entirely gaps),
213 * findPositions(1, 4) returns Range(9, 9) // B only
214 * findPositions(3, 4) returns null // all gaps
215 * findPositions(2, 6) returns Range(10, 12) // CDE
216 * findPositions(3, 7) returns Range(11,12) // DE
220 * first aligned column position (base 0, inclusive)
222 * last aligned column position (base 0, inclusive)
226 public Range findPositions(int fromCol, int toCol);
229 * Returns an int array where indices correspond to each residue in the
230 * sequence and the element value gives its position in the alignment
232 * @return int[SequenceI.getEnd()-SequenceI.getStart()+1] or null if no
233 * residues in SequenceI object
235 public int[] gapMap();
238 * Returns an int array where indices correspond to each position in sequence
239 * char array and the element value gives the result of findPosition for that
240 * index in the sequence.
242 * @return int[SequenceI.getLength()]
244 public int[] findPositionMap();
247 * Answers true if the sequence is composed of amino acid characters. Note
248 * that implementations may use heuristic methods which are not guaranteed to
249 * give the biologically 'right' answer.
253 public boolean isProtein();
256 * Delete a range of aligned sequence columns, creating a new dataset sequence
257 * if necessary and adjusting start and end positions accordingly.
260 * first column in range to delete (inclusive)
262 * last column in range to delete (exclusive)
264 public void deleteChars(int i, int j);
270 * alignment column number
272 * character to insert
274 public void insertCharAt(int i, char c);
277 * insert given character at alignment column position
280 * alignment column number
284 * character to insert
286 public void insertCharAt(int position, int count, char ch);
289 * Answers a list of all sequence features associated with this sequence. The
290 * list may be held by the sequence's dataset sequence if that is defined.
292 * @return hard reference to array
294 public List<SequenceFeature> getSequenceFeatures();
297 * Answers the object holding features for the sequence
301 SequenceFeaturesI getFeatures();
304 * Replaces the sequence features associated with this sequence with the given
305 * features. If this sequence has a dataset sequence, then this method will
306 * update the dataset sequence's features instead.
310 public void setSequenceFeatures(List<SequenceFeature> features);
318 public void setPDBId(Vector<PDBEntry> ids);
323 * @return DOCUMENT ME!
325 public Vector<PDBEntry> getAllPDBEntries();
328 * Adds the entry to the *normalised* list of PDBIds.
330 * If a PDBEntry is passed with the same entry.getID() string as one already
331 * in the list, or one is added that appears to be the same but has a chain ID
332 * appended, then the existing PDBEntry will be updated with the new
333 * attributes instead, unless the entries have distinct chain codes or
334 * associated structure files.
337 * @return true if the entry was added, false if updated
339 public boolean addPDBId(PDBEntry entry);
342 * update the list of PDBEntrys to include any DBRefEntrys citing structural
345 * @return true if PDBEntry list was modified
347 public boolean updatePDBIds();
349 public String getVamsasId();
351 public void setVamsasId(String id);
354 * set the array of Database references for the sequence.
357 * @deprecated - use is discouraged since side-effects may occur if DBRefEntry
358 * set are not normalised.
361 public void setDBRefs(DBRefEntry[] dbs);
363 public DBRefEntry[] getDBRefs();
366 * add the given entry to the list of DBRefs for this sequence, or replace a
367 * similar one if entry contains a map object and the existing one doesnt.
371 public void addDBRef(DBRefEntry entry);
374 * Adds the given sequence feature and returns true, or returns false if it is
375 * already present on the sequence, or if the feature type is null.
380 public boolean addSequenceFeature(SequenceFeature sf);
382 public void deleteFeature(SequenceFeature sf);
384 public void setDatasetSequence(SequenceI seq);
386 public SequenceI getDatasetSequence();
389 * Returns a new array containing this sequence's annotations, or null.
391 public AlignmentAnnotation[] getAnnotation();
394 * Returns true if this sequence has the given annotation (by object
397 public boolean hasAnnotation(AlignmentAnnotation ann);
400 * Add the given annotation, if not already added, and set its sequence ref to
401 * be this sequence. Does nothing if this sequence's annotations already
402 * include this annotation (by identical object reference).
404 public void addAlignmentAnnotation(AlignmentAnnotation annotation);
406 public void removeAlignmentAnnotation(AlignmentAnnotation annotation);
409 * Derive a sequence (using this one's dataset or as the dataset)
411 * @return duplicate sequence with valid dataset sequence
413 public SequenceI deriveSequence();
416 * set the array of associated AlignmentAnnotation for this sequenceI
420 public void setAlignmentAnnotation(AlignmentAnnotation[] annotation);
423 * Get one or more alignment annotations with a particular label.
426 * string which each returned annotation must have as a label.
427 * @return null or array of annotations.
429 public AlignmentAnnotation[] getAnnotation(String label);
432 * Returns a (possibly empty) list of any annotations that match on given
433 * calcId (source) and label (type). Null values do not match.
438 public List<AlignmentAnnotation> getAlignmentAnnotations(String calcId,
442 * create a new dataset sequence (if necessary) for this sequence and sets
443 * this sequence to refer to it. This call will move any features or
444 * references on the sequence onto the dataset. It will also make a duplicate
445 * of existing annotation rows for the dataset sequence, rather than relocate
446 * them in order to preserve external references (since 2.8.2).
448 * @return dataset sequence for this sequence
450 public SequenceI createDatasetSequence();
453 * Transfer any database references or annotation from entry under a sequence
455 * <strong>Note: DOES NOT transfer sequence associated alignment annotation
460 * null or mapping from entry's numbering to local start/end
462 public void transferAnnotation(SequenceI entry, Mapping mp);
466 * The sequence index in the MSA
468 public void setIndex(int index);
471 * @return The index of the sequence in the alignment
473 public int getIndex();
476 * @return The RNA of the sequence in the alignment
485 public void setRNA(RNA rna);
489 * @return list of insertions (gap characters) in sequence
491 public List<int[]> getInsertions();
494 * Given a pdbId String, return the equivalent PDBEntry if available in the
500 public PDBEntry getPDBEntry(String pdbId);
503 * Get all primary database/accessions for this sequence's data. These
504 * DBRefEntry are expected to resolve to a valid record in the associated
505 * external database, either directly or via a provided 1:1 Mapping.
507 * @return just the primary references (if any) for this sequence, or an empty
510 public List<DBRefEntry> getPrimaryDBRefs();
513 * Returns a (possibly empty) list of sequence features that overlap the range
514 * from-to (inclusive), optionally restricted to one or more specified feature
522 List<SequenceFeature> findFeatures(int from, int to, String... types);
525 * Invalidate any cursors on the sequence (e.g. after an edit)
527 public void zapCursor();