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