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