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