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