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