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