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