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