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
  26 import java.util.BitSet;
  27 import java.util.Iterator;
  28 import java.util.List;
  29 import java.util.Vector;
  30
  31 import fr.orsay.lri.varna.models.rna.RNA;
  32 import intervalstore.api.IntervalI;
  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 from-to sequence positions (start..) for the given column
 211    * positions (1..), or null if no residues are included in the range
 212    *
 213    * @param fromColum
 214    * @param toColumn
 215    * @return
 216    */
 217   public IntervalI 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    * Build a bitset corresponding to sequence gaps
 230    *
 231    * @return a BitSet where set values correspond to gaps in the sequence
 232    */
 233   public BitSet gapBitset();
 234
 235   /**
 236    * Returns an int array where indices correspond to each position in sequence
 237    * char array and the element value gives the result of findPosition for that
 238    * index in the sequence.
 239    *
 240    * @return int[SequenceI.getLength()]
 241    */
 242   public int[] findPositionMap();
 243
 244   /**
 245    * Answers true if the sequence is composed of amino acid characters. Note
 246    * that implementations may use heuristic methods which are not guaranteed to
 247    * give the biologically 'right' answer.
 248    *
 249    * @return
 250    */
 251   public boolean isProtein();
 252
 253   /**
 254    * Delete a range of aligned sequence columns, creating a new dataset sequence
 255    * if necessary and adjusting start and end positions accordingly.
 256    *
 257    * @param i
 258    *          first column in range to delete (inclusive)
 259    * @param j
 260    *          last column in range to delete (exclusive)
 261    */
 262   public void deleteChars(int i, int j);
 263
 264   /**
 265    * DOCUMENT ME!
 266    *
 267    * @param i
 268    *          alignment column number
 269    * @param c
 270    *          character to insert
 271    */
 272   public void insertCharAt(int i, char c);
 273
 274   /**
 275    * insert given character at alignment column position
 276    *
 277    * @param position
 278    *          alignment column number
 279    * @param count
 280    *          length of insert
 281    * @param ch
 282    *          character to insert
 283    */
 284   public void insertCharAt(int position, int count, char ch);
 285
 286   /**
 287    * Answers a list of all sequence features associated with this sequence. The
 288    * list may be held by the sequence's dataset sequence if that is defined.
 289    *
 290    * @return
 291    */
 292   public List<SequenceFeature> getSequenceFeatures();
 293
 294   /**
 295    * Answers the object holding features for the sequence
 296    *
 297    * @return
 298    */
 299   SequenceFeaturesI getFeatures();
 300
 301   /**
 302    * Replaces the sequence features associated with this sequence with the given
 303    * features. If this sequence has a dataset sequence, then this method will
 304    * update the dataset sequence's features instead.
 305    *
 306    * @param features
 307    */
 308   public void setSequenceFeatures(List<SequenceFeature> features);
 309
 310   /**
 311    * DOCUMENT ME!
 312    *
 313    * @param id
 314    *          DOCUMENT ME!
 315    */
 316   public void setPDBId(Vector<PDBEntry> ids);
 317
 318   /**
 319    * Returns a list
 320    *
 321    * @return DOCUMENT ME!
 322    */
 323   public Vector<PDBEntry> getAllPDBEntries();
 324
 325   /**
 326    * Adds the entry to the *normalised* list of PDBIds.
 327    *
 328    * If a PDBEntry is passed with the same entry.getID() string as one already
 329    * in the list, or one is added that appears to be the same but has a chain ID
 330    * appended, then the existing PDBEntry will be updated with the new
 331    * attributes instead, unless the entries have distinct chain codes or
 332    * associated structure files.
 333    *
 334    * @param entry
 335    * @return true if the entry was added, false if updated
 336    */
 337   public boolean addPDBId(PDBEntry entry);
 338
 339   /**
 340    * update the list of PDBEntrys to include any DBRefEntrys citing structural
 341    * databases
 342    *
 343    * @return true if PDBEntry list was modified
 344    */
 345   public boolean updatePDBIds();
 346
 347   public String getVamsasId();
 348
 349   public void setVamsasId(String id);
 350
 351   /**
 352    * set the array of Database references for the sequence.
 353    *
 354    * @param dbs
 355    * @deprecated - use is discouraged since side-effects may occur if DBRefEntry
 356    *             set are not normalised.
 357    */
 358   @Deprecated
 359   public void setDBRefs(DBRefEntry[] dbs);
 360
 361   public DBRefEntry[] getDBRefs();
 362
 363   /**
 364    * add the given entry to the list of DBRefs for this sequence, or replace a
 365    * similar one if entry contains a map object and the existing one doesnt.
 366    *
 367    * @param entry
 368    */
 369   public void addDBRef(DBRefEntry entry);
 370
 371   /**
 372    * Adds the given sequence feature and returns true, or returns false if it is
 373    * already present on the sequence, or if the feature type is null.
 374    *
 375    * @param sf
 376    * @return
 377    */
 378   public boolean addSequenceFeature(SequenceFeature sf);
 379
 380   public void deleteFeature(SequenceFeature sf);
 381
 382   public void setDatasetSequence(SequenceI seq);
 383
 384   public SequenceI getDatasetSequence();
 385
 386   /**
 387    * Returns a new array containing this sequence's annotations, or null.
 388    */
 389   public AlignmentAnnotation[] getAnnotation();
 390
 391   /**
 392    * Returns true if this sequence has the given annotation (by object
 393    * identity).
 394    */
 395   public boolean hasAnnotation(AlignmentAnnotation ann);
 396
 397   /**
 398    * Add the given annotation, if not already added, and set its sequence ref to
 399    * be this sequence. Does nothing if this sequence's annotations already
 400    * include this annotation (by identical object reference).
 401    */
 402   public void addAlignmentAnnotation(AlignmentAnnotation annotation);
 403
 404   public void removeAlignmentAnnotation(AlignmentAnnotation annotation);
 405
 406   /**
 407    * Derive a sequence (using this one's dataset or as the dataset)
 408    *
 409    * @return duplicate sequence with valid dataset sequence
 410    */
 411   public SequenceI deriveSequence();
 412
 413   /**
 414    * set the array of associated AlignmentAnnotation for this sequenceI
 415    *
 416    * @param revealed
 417    */
 418   public void setAlignmentAnnotation(AlignmentAnnotation[] annotation);
 419
 420   /**
 421    * Get one or more alignment annotations with a particular label.
 422    *
 423    * @param label
 424    *          string which each returned annotation must have as a label.
 425    * @return null or array of annotations.
 426    */
 427   public AlignmentAnnotation[] getAnnotation(String label);
 428
 429   /**
 430    * Returns a (possibly empty) list of any annotations that match on given
 431    * calcId (source) and label (type). Null values do not match.
 432    *
 433    * @param calcId
 434    * @param label
 435    */
 436   public List<AlignmentAnnotation> getAlignmentAnnotations(String calcId,
 437           String label);
 438
 439   /**
 440    * create a new dataset sequence (if necessary) for this sequence and sets
 441    * this sequence to refer to it. This call will move any features or
 442    * references on the sequence onto the dataset. It will also make a duplicate
 443    * of existing annotation rows for the dataset sequence, rather than relocate
 444    * them in order to preserve external references (since 2.8.2).
 445    *
 446    * @return dataset sequence for this sequence
 447    */
 448   public SequenceI createDatasetSequence();
 449
 450   /**
 451    * Transfer any database references or annotation from entry under a sequence
 452    * mapping. <br/>
 453    * <strong>Note: DOES NOT transfer sequence associated alignment annotation
 454    * </strong><br/>
 455    *
 456    * @param entry
 457    * @param mp
 458    *          null or mapping from entry's numbering to local start/end
 459    */
 460   public void transferAnnotation(SequenceI entry, Mapping mp);
 461
 462   /**
 463    * @return The RNA of the sequence in the alignment
 464    */
 465
 466   public RNA getRNA();
 467
 468   /**
 469    * @param rna
 470    *          The RNA.
 471    */
 472   public void setRNA(RNA rna);
 473
 474   /**
 475    *
 476    * @return list of insertions (gap characters) in sequence
 477    */
 478   public List<int[]> getInsertions();
 479
 480   /**
 481    * Given a pdbId String, return the equivalent PDBEntry if available in the
 482    * given sequence
 483    *
 484    * @param pdbId
 485    * @return
 486    */
 487   public PDBEntry getPDBEntry(String pdbId);
 488
 489   /**
 490    * Get all primary database/accessions for this sequence's data. These
 491    * DBRefEntry are expected to resolve to a valid record in the associated
 492    * external database, either directly or via a provided 1:1 Mapping.
 493    *
 494    * @return just the primary references (if any) for this sequence, or an empty
 495    *         list
 496    */
 497   public List<DBRefEntry> getPrimaryDBRefs();
 498
 499   /**
 500    * Returns a (possibly empty) list of sequence features that overlap the given
 501    * alignment column range, optionally restricted to one or more specified
 502    * feature types. If the range is all gaps, then features which enclose it are
 503    * included (but not contact features).
 504    *
 505    * @param fromCol
 506    *          start column of range inclusive (1..)
 507    * @param toCol
 508    *          end column of range inclusive (1..)
 509    * @param types
 510    *          optional feature types to restrict results to
 511    * @return
 512    */
 513   List<SequenceFeature> findFeatures(int fromCol, int toCol, String... types);
 514
 515   /**
 516    * Method to call to indicate that the sequence (characters or alignment/gaps)
 517    * has been modified. Provided to allow any cursors on residue/column
 518    * positions to be invalidated.
 519    */
 520   void sequenceChanged();
 521
 522   /**
 523    *
 524    * @return BitSet corresponding to index [0,length) where Comparison.isGap()
 525    *         returns true.
 526    */
 527   BitSet getInsertionsAsBits();
 528
 529   /**
 530    * Replaces every occurrence of c1 in the sequence with c2 and returns the
 531    * number of characters changed
 532    *
 533    * @param c1
 534    * @param c2
 535    */
 536   public int replace(char c1, char c2);
 537
 538   /**
 539    * Answers the GeneLociI, or null if not known
 540    *
 541    * @return
 542    */
 543   GeneLociI getGeneLoci();
 544
 545   /**
 546    * Sets the mapping to gene loci for the sequence
 547    *
 548    * @param speciesId
 549    * @param assemblyId
 550    * @param chromosomeId
 551    * @param map
 552    */
 553   void setGeneLoci(String speciesId, String assemblyId,
 554           String chromosomeId, MapList map);
 555
 556
 557   /**
 558    * Returns the sequence string constructed from the substrings of a sequence
 559    * defined by the int[] ranges provided by an iterator. E.g. the iterator
 560    * could iterate over all visible regions of the alignment
 561    *
 562    * @param it
 563    *          the iterator to use
 564    * @return a String corresponding to the sequence
 565    */
 566   public String getSequenceStringFromIterator(Iterator<int[]> it);
 567
 568   /**
 569    * Locate the first position in this sequence which is not contained in an
 570    * iterator region. If no such position exists, return 0
 571    *
 572    * @param it
 573    *          iterator over regions
 574    * @return first residue not contained in regions
 575    */
 576   public int firstResidueOutsideIterator(Iterator<int[]> it);
 577 }