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