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.List;
  26 import java.util.Vector;
  27
  28 import fr.orsay.lri.varna.models.rna.RNA;
  29
  30 /**
  31  * Methods for manipulating a sequence, its metadata and related annotation in
  32  * an alignment or dataset.
  33  *
  34  * @author $author$
  35  * @version $Revision$
  36  */
  37 public interface SequenceI extends ASequenceI
  38 {
  39   /**
  40    * Set the display name for the sequence
  41    *
  42    * @param name
  43    */
  44   public void setName(String name);
  45
  46   /**
  47    * Get the display name
  48    */
  49   public String getName();
  50
  51   /**
  52    * Set start position of first non-gapped symbol in sequence
  53    *
  54    * @param start
  55    *          new start position
  56    */
  57   public void setStart(int start);
  58
  59   /**
  60    * get start position of first non-gapped residue in sequence
  61    *
  62    * @return
  63    */
  64   public int getStart();
  65
  66   /**
  67    * get the displayed id of the sequence
  68    *
  69    * @return true means the id will be returned in the form
  70    *         DisplayName/Start-End
  71    */
  72   public String getDisplayId(boolean jvsuffix);
  73
  74   /**
  75    * set end position for last residue in sequence
  76    *
  77    * @param end
  78    */
  79   public void setEnd(int end);
  80
  81   /**
  82    * get end position for last residue in sequence getEnd()>getStart() unless
  83    * sequence only consists of gap characters
  84    *
  85    * @return
  86    */
  87   public int getEnd();
  88
  89   /**
  90    * @return length of sequence including gaps
  91    *
  92    */
  93   public int getLength();
  94
  95   /**
  96    * Replace the sequence with the given string
  97    *
  98    * @param sequence
  99    *          new sequence string
 100    */
 101   public void setSequence(String sequence);
 102
 103   /**
 104    * @return sequence as string
 105    */
 106   public String getSequenceAsString();
 107
 108   /**
 109    * get a range on the sequence as a string
 110    *
 111    * @param start
 112    *          position relative to start of sequence including gaps (from 0)
 113    * @param end
 114    *          position relative to start of sequence including gaps (from 0)
 115    *
 116    * @return String containing all gap and symbols in specified range
 117    */
 118   public String getSequenceAsString(int start, int end);
 119
 120   /**
 121    * Get the sequence as a character array
 122    *
 123    * @return seqeunce and any gaps
 124    */
 125   public char[] getSequence();
 126
 127   /**
 128    * get stretch of sequence characters in an array
 129    *
 130    * @param start
 131    *          absolute index into getSequence()
 132    * @param end
 133    *          exclusive index of last position in segment to be returned.
 134    *
 135    * @return char[max(0,end-start)];
 136    */
 137   public char[] getSequence(int start, int end);
 138
 139   /**
 140    * create a new sequence object with a subsequence of this one but sharing the
 141    * same dataset sequence
 142    *
 143    * @param start
 144    *          int index for start position (base 0, inclusive)
 145    * @param end
 146    *          int index for end position (base 0, exclusive)
 147    *
 148    * @return SequenceI
 149    * @note implementations may use getSequence to get the sequence data
 150    */
 151   public SequenceI getSubSequence(int start, int end);
 152
 153   /**
 154    * get the i'th character in this sequence's local reference frame (ie from
 155    * 0-number of characters lying from start-end)
 156    *
 157    * @param i
 158    *          index
 159    * @return character or ' '
 160    */
 161   public char getCharAt(int i);
 162
 163   /**
 164    * DOCUMENT ME!
 165    *
 166    * @param desc
 167    *          DOCUMENT ME!
 168    */
 169   public void setDescription(String desc);
 170
 171   /**
 172    * DOCUMENT ME!
 173    *
 174    * @return DOCUMENT ME!
 175    */
 176   public String getDescription();
 177
 178   /**
 179    * Return the alignment column (from 1..) for a sequence position
 180    *
 181    * @param pos
 182    *          lying from start to end
 183    *
 184    * @return aligned column for residue (0 if residue is upstream from
 185    *         alignment, -1 if residue is downstream from alignment) note.
 186    *         Sequence object returns sequence.getEnd() for positions upstream
 187    *         currently. TODO: change sequence for
 188    *         assert(findIndex(seq.getEnd()+1)==-1) and fix incremental bugs
 189    *
 190    */
 191   public int findIndex(int pos);
 192
 193   /**
 194    * Returns the sequence position for an alignment position.
 195    *
 196    * @param i
 197    *          column index in alignment (from 0..<length)
 198    *
 199    * @return TODO: JAL-2562 - residue number for residue (left of and) nearest
 200    *         ith column
 201    */
 202   public int findPosition(int i);
 203
 204   /**
 205    * Returns the range of sequence positions included in the given alignment
 206    * position range. If no positions are included (the range is entirely gaps),
 207    * then returns null.
 208    *
 209    * <pre>
 210    * Example:
 211    * >Seq/8-13
 212    * ABC--DE-F
 213    * findPositions(1, 4) returns Range(9, 9) // B only
 214    * findPositions(3, 4) returns null // all gaps
 215    * findPositions(2, 6) returns Range(10, 12) // CDE
 216    * findPositions(3, 7) returns Range(11,12) // DE
 217    * </pre>
 218    *
 219    * @param fromCol
 220    *          first aligned column position (base 0, inclusive)
 221    * @param toCol
 222    *          last aligned column position (base 0, inclusive)
 223    *
 224    * @return
 225    */
 226   public Range findPositions(int fromCol, int toCol);
 227
 228   /**
 229    * Returns an int array where indices correspond to each residue in the
 230    * sequence and the element value gives its position in the alignment
 231    *
 232    * @return int[SequenceI.getEnd()-SequenceI.getStart()+1] or null if no
 233    *         residues in SequenceI object
 234    */
 235   public int[] gapMap();
 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 hard reference to array
 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    * @param index
 466    *          The sequence index in the MSA
 467    */
 468   public void setIndex(int index);
 469
 470   /**
 471    * @return The index of the sequence in the alignment
 472    */
 473   public int getIndex();
 474
 475   /**
 476    * @return The RNA of the sequence in the alignment
 477    */
 478
 479   public RNA getRNA();
 480
 481   /**
 482    * @param rna
 483    *          The RNA.
 484    */
 485   public void setRNA(RNA rna);
 486
 487   /**
 488    *
 489    * @return list of insertions (gap characters) in sequence
 490    */
 491   public List<int[]> getInsertions();
 492
 493   /**
 494    * Given a pdbId String, return the equivalent PDBEntry if available in the
 495    * given sequence
 496    *
 497    * @param pdbId
 498    * @return
 499    */
 500   public PDBEntry getPDBEntry(String pdbId);
 501
 502   /**
 503    * Get all primary database/accessions for this sequence's data. These
 504    * DBRefEntry are expected to resolve to a valid record in the associated
 505    * external database, either directly or via a provided 1:1 Mapping.
 506    *
 507    * @return just the primary references (if any) for this sequence, or an empty
 508    *         list
 509    */
 510   public List<DBRefEntry> getPrimaryDBRefs();
 511
 512   /**
 513    * Returns a (possibly empty) list of sequence features that overlap the range
 514    * from-to (inclusive), optionally restricted to one or more specified feature
 515    * types
 516    *
 517    * @param from
 518    * @param to
 519    * @param types
 520    * @return
 521    */
 522   List<SequenceFeature> findFeatures(int from, int to, String... types);
 523
 524   /**
 525    * Invalidate any cursors on the sequence (e.g. after an edit)
 526    */
 527   public void zapCursor();
 528 }