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