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