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 java.util.List;
  24 import java.util.Vector;
  25
  26 import fr.orsay.lri.varna.models.rna.RNA;
  27
  28 /**
  29  * Methods for manipulating a sequence, its metadata and related annotation in
  30  * an alignment or dataset.
  31  *
  32  * @author $author$
  33  * @version $Revision$
  34  */
  35 public interface SequenceI extends ASequenceI
  36 {
  37   /**
  38    * Set the display name for the sequence
  39    *
  40    * @param name
  41    */
  42   public void setName(String name);
  43
  44   /**
  45    * Get the display name
  46    */
  47   public String getName();
  48
  49   /**
  50    * Set start position of first non-gapped symbol in sequence
  51    *
  52    * @param start
  53    *          new start position
  54    */
  55   public void setStart(int start);
  56
  57   /**
  58    * get start position of first non-gapped residue in sequence
  59    *
  60    * @return
  61    */
  62   public int getStart();
  63
  64   /**
  65    * get the displayed id of the sequence
  66    *
  67    * @return true means the id will be returned in the form
  68    *         DisplayName/Start-End
  69    */
  70   public String getDisplayId(boolean jvsuffix);
  71
  72   /**
  73    * set end position for last residue in sequence
  74    *
  75    * @param end
  76    */
  77   public void setEnd(int end);
  78
  79   /**
  80    * get end position for last residue in sequence getEnd()>getStart() unless
  81    * sequence only consists of gap characters
  82    *
  83    * @return
  84    */
  85   public int getEnd();
  86
  87   /**
  88    * @return length of sequence including gaps
  89    *
  90    */
  91   public int getLength();
  92
  93   /**
  94    * Replace the sequence with the given string
  95    *
  96    * @param sequence
  97    *          new sequence string
  98    */
  99   public void setSequence(String sequence);
 100
 101   /**
 102    * @return sequence as string
 103    */
 104   public String getSequenceAsString();
 105
 106   /**
 107    * get a range on the sequence as a string
 108    *
 109    * @param start
 110    *          position relative to start of sequence including gaps (from 0)
 111    * @param end
 112    *          position relative to start of sequence including gaps (from 0)
 113    *
 114    * @return String containing all gap and symbols in specified range
 115    */
 116   public String getSequenceAsString(int start, int end);
 117
 118   /**
 119    * Get the sequence as a character array
 120    *
 121    * @return seqeunce and any gaps
 122    */
 123   public char[] getSequence();
 124
 125   /**
 126    * get stretch of sequence characters in an array
 127    *
 128    * @param start
 129    *          absolute index into getSequence()
 130    * @param end
 131    *          exclusive index of last position in segment to be returned.
 132    *
 133    * @return char[max(0,end-start)];
 134    */
 135   public char[] getSequence(int start, int end);
 136
 137   /**
 138    * create a new sequence object with a subsequence of this one but sharing the
 139    * same dataset sequence
 140    *
 141    * @param start
 142    *          int index for start position (base 0, inclusive)
 143    * @param end
 144    *          int index for end position (base 0, exclusive)
 145    *
 146    * @return SequenceI
 147    * @note implementations may use getSequence to get the sequence data
 148    */
 149   public SequenceI getSubSequence(int start, int end);
 150
 151   /**
 152    * get the i'th character in this sequence's local reference frame (ie from
 153    * 0-number of characters lying from start-end)
 154    *
 155    * @param i
 156    *          index
 157    * @return character or ' '
 158    */
 159   public char getCharAt(int i);
 160
 161   /**
 162    * DOCUMENT ME!
 163    *
 164    * @param desc
 165    *          DOCUMENT ME!
 166    */
 167   public void setDescription(String desc);
 168
 169   /**
 170    * DOCUMENT ME!
 171    *
 172    * @return DOCUMENT ME!
 173    */
 174   public String getDescription();
 175
 176   /**
 177    * Return the alignment column for a sequence position
 178    *
 179    * @param pos
 180    *          lying from start to end
 181    *
 182    * @return aligned column for residue (0 if residue is upstream from
 183    *         alignment, -1 if residue is downstream from alignment) note.
 184    *         Sequence object returns sequence.getEnd() for positions upstream
 185    *         currently. TODO: change sequence for
 186    *         assert(findIndex(seq.getEnd()+1)==-1) and fix incremental bugs
 187    *
 188    */
 189   public int findIndex(int pos);
 190
 191   /**
 192    * Returns the sequence position for an alignment position.
 193    *
 194    * @param i
 195    *          column index in alignment (from 0..<length)
 196    *
 197    * @return TODO: JAL-2562 - residue number for residue (left of and) nearest
 198    *         ith column
 199    */
 200   public int findPosition(int i);
 201
 202   /**
 203    * Returns an int array where indices correspond to each residue in the
 204    * sequence and the element value gives its position in the alignment
 205    *
 206    * @return int[SequenceI.getEnd()-SequenceI.getStart()+1] or null if no
 207    *         residues in SequenceI object
 208    */
 209   public int[] gapMap();
 210
 211   /**
 212    * Returns an int array where indices correspond to each position in sequence
 213    * char array and the element value gives the result of findPosition for that
 214    * index in the sequence.
 215    *
 216    * @return int[SequenceI.getLength()]
 217    */
 218   public int[] findPositionMap();
 219
 220   /**
 221    * Answers true if the sequence is composed of amino acid characters. Note
 222    * that implementations may use heuristic methods which are not guaranteed to
 223    * give the biologically 'right' answer.
 224    *
 225    * @return
 226    */
 227   public boolean isProtein();
 228
 229   /**
 230    * Delete a range of aligned sequence columns, creating a new dataset sequence
 231    * if necessary and adjusting start and end positions accordingly.
 232    *
 233    * @param i
 234    *          first column in range to delete (inclusive)
 235    * @param j
 236    *          last column in range to delete (exclusive)
 237    */
 238   public void deleteChars(int i, int j);
 239
 240   /**
 241    * DOCUMENT ME!
 242    *
 243    * @param i
 244    *          alignment column number
 245    * @param c
 246    *          character to insert
 247    */
 248   public void insertCharAt(int i, char c);
 249
 250   /**
 251    * insert given character at alignment column position
 252    *
 253    * @param position
 254    *          alignment column number
 255    * @param count
 256    *          length of insert
 257    * @param ch
 258    *          character to insert
 259    */
 260   public void insertCharAt(int position, int count, char ch);
 261
 262   /**
 263    * Gets array holding sequence features associated with this sequence. The
 264    * array may be held by the sequence's dataset sequence if that is defined.
 265    *
 266    * @return hard reference to array
 267    */
 268   public SequenceFeature[] getSequenceFeatures();
 269
 270   /**
 271    * Replaces the array of sequence features associated with this sequence with
 272    * a new array reference. If this sequence has a dataset sequence, then this
 273    * method will update the dataset sequence's feature array
 274    *
 275    * @param features
 276    *          New array of sequence features
 277    */
 278   public void setSequenceFeatures(SequenceFeature[] features);
 279
 280   /**
 281    * DOCUMENT ME!
 282    *
 283    * @param id
 284    *          DOCUMENT ME!
 285    */
 286   public void setPDBId(Vector<PDBEntry> ids);
 287
 288   /**
 289    * Returns a list
 290    *
 291    * @return DOCUMENT ME!
 292    */
 293   public Vector<PDBEntry> getAllPDBEntries();
 294
 295   /**
 296    * Adds the entry to the *normalised* list of PDBIds.
 297    *
 298    * If a PDBEntry is passed with the same entry.getID() string as one already
 299    * in the list, or one is added that appears to be the same but has a chain ID
 300    * appended, then the existing PDBEntry will be updated with the new
 301    * attributes instead, unless the entries have distinct chain codes or
 302    * associated structure files.
 303    *
 304    * @param entry
 305    * @return true if the entry was added, false if updated
 306    */
 307   public boolean addPDBId(PDBEntry entry);
 308
 309   /**
 310    * update the list of PDBEntrys to include any DBRefEntrys citing structural
 311    * databases
 312    *
 313    * @return true if PDBEntry list was modified
 314    */
 315   public boolean updatePDBIds();
 316
 317   public String getVamsasId();
 318
 319   public void setVamsasId(String id);
 320
 321   /**
 322    * set the array of Database references for the sequence.
 323    *
 324    * @param dbs
 325    * @deprecated - use is discouraged since side-effects may occur if DBRefEntry
 326    *             set are not normalised.
 327    */
 328   @Deprecated
 329   public void setDBRefs(DBRefEntry[] dbs);
 330
 331   public DBRefEntry[] getDBRefs();
 332
 333   /**
 334    * add the given entry to the list of DBRefs for this sequence, or replace a
 335    * similar one if entry contains a map object and the existing one doesnt.
 336    *
 337    * @param entry
 338    */
 339   public void addDBRef(DBRefEntry entry);
 340
 341   /**
 342    * Adds the given sequence feature and returns true, or returns false if it is
 343    * already present on the sequence
 344    *
 345    * @param sf
 346    * @return
 347    */
 348   public boolean addSequenceFeature(SequenceFeature sf);
 349
 350   public void deleteFeature(SequenceFeature sf);
 351
 352   public void setDatasetSequence(SequenceI seq);
 353
 354   public SequenceI getDatasetSequence();
 355
 356   /**
 357    * Returns a new array containing this sequence's annotations, or null.
 358    */
 359   public AlignmentAnnotation[] getAnnotation();
 360
 361   /**
 362    * Returns true if this sequence has the given annotation (by object
 363    * identity).
 364    */
 365   public boolean hasAnnotation(AlignmentAnnotation ann);
 366
 367   /**
 368    * Add the given annotation, if not already added, and set its sequence ref to
 369    * be this sequence. Does nothing if this sequence's annotations already
 370    * include this annotation (by identical object reference).
 371    */
 372   public void addAlignmentAnnotation(AlignmentAnnotation annotation);
 373
 374   public void removeAlignmentAnnotation(AlignmentAnnotation annotation);
 375
 376   /**
 377    * Derive a sequence (using this one's dataset or as the dataset)
 378    *
 379    * @return duplicate sequence with valid dataset sequence
 380    */
 381   public SequenceI deriveSequence();
 382
 383   /**
 384    * set the array of associated AlignmentAnnotation for this sequenceI
 385    *
 386    * @param revealed
 387    */
 388   public void setAlignmentAnnotation(AlignmentAnnotation[] annotation);
 389
 390   /**
 391    * Get one or more alignment annotations with a particular label.
 392    *
 393    * @param label
 394    *          string which each returned annotation must have as a label.
 395    * @return null or array of annotations.
 396    */
 397   public AlignmentAnnotation[] getAnnotation(String label);
 398
 399   /**
 400    * Returns a (possibly empty) list of any annotations that match on given
 401    * calcId (source) and label (type). Null values do not match.
 402    *
 403    * @param calcId
 404    * @param label
 405    */
 406   public List<AlignmentAnnotation> getAlignmentAnnotations(String calcId,
 407           String label);
 408
 409   /**
 410    * create a new dataset sequence (if necessary) for this sequence and sets
 411    * this sequence to refer to it. This call will move any features or
 412    * references on the sequence onto the dataset. It will also make a duplicate
 413    * of existing annotation rows for the dataset sequence, rather than relocate
 414    * them in order to preserve external references (since 2.8.2).
 415    *
 416    * @return dataset sequence for this sequence
 417    */
 418   public SequenceI createDatasetSequence();
 419
 420   /**
 421    * Transfer any database references or annotation from entry under a sequence
 422    * mapping. <br/>
 423    * <strong>Note: DOES NOT transfer sequence associated alignment annotation
 424    * </strong><br/>
 425    *
 426    * @param entry
 427    * @param mp
 428    *          null or mapping from entry's numbering to local start/end
 429    */
 430   public void transferAnnotation(SequenceI entry, Mapping mp);
 431
 432   /**
 433    * @param index
 434    *          The sequence index in the MSA
 435    */
 436   public void setIndex(int index);
 437
 438   /**
 439    * @return The index of the sequence in the alignment
 440    */
 441   public int getIndex();
 442
 443   /**
 444    * @return The RNA of the sequence in the alignment
 445    */
 446
 447   public RNA getRNA();
 448
 449   /**
 450    * @param rna
 451    *          The RNA.
 452    */
 453   public void setRNA(RNA rna);
 454
 455   /**
 456    *
 457    * @return list of insertions (gap characters) in sequence
 458    */
 459   public List<int[]> getInsertions();
 460
 461   /**
 462    * Given a pdbId String, return the equivalent PDBEntry if available in the
 463    * given sequence
 464    *
 465    * @param pdbId
 466    * @return
 467    */
 468   public PDBEntry getPDBEntry(String pdbId);
 469
 470   /**
 471    * Get all primary database/accessions for this sequence's data. These
 472    * DBRefEntry are expected to resolve to a valid record in the associated
 473    * external database, either directly or via a provided 1:1 Mapping.
 474    *
 475    * @return just the primary references (if any) for this sequence, or an empty
 476    *         list
 477    */
 478   public List<DBRefEntry> getPrimaryDBRefs();
 479 }