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