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 import jalview.util.MapList;
  25
  26 import java.util.BitSet;
  27 import java.util.List;
  28 import java.util.Vector;
  29
  30 import fr.orsay.lri.varna.models.rna.RNA;
  31
  32 /**
  33  * Methods for manipulating a sequence, its metadata and related annotation in
  34  * an alignment or dataset.
  35  *
  36  * @author $author$
  37  * @version $Revision$
  38  */
  39 public interface SequenceI extends ASequenceI
  40 {
  41   /**
  42    * Set the display name for the sequence
  43    *
  44    * @param name
  45    */
  46   public void setName(String name);
  47
  48   /**
  49    * Get the display name
  50    */
  51   public String getName();
  52
  53   /**
  54    * Set start position of first non-gapped symbol in sequence
  55    *
  56    * @param start
  57    *          new start position
  58    */
  59   public void setStart(int start);
  60
  61   /**
  62    * get start position of first non-gapped residue in sequence
  63    *
  64    * @return
  65    */
  66   public int getStart();
  67
  68   /**
  69    * get the displayed id of the sequence
  70    *
  71    * @return true means the id will be returned in the form
  72    *         DisplayName/Start-End
  73    */
  74   public String getDisplayId(boolean jvsuffix);
  75
  76   /**
  77    * set end position for last residue in sequence
  78    *
  79    * @param end
  80    */
  81   public void setEnd(int end);
  82
  83   /**
  84    * get end position for last residue in sequence getEnd()>getStart() unless
  85    * sequence only consists of gap characters
  86    *
  87    * @return
  88    */
  89   public int getEnd();
  90
  91   /**
  92    * @return length of sequence including gaps
  93    *
  94    */
  95   public int getLength();
  96
  97   /**
  98    * Replace the sequence with the given string
  99    *
 100    * @param sequence
 101    *          new sequence string
 102    */
 103   public void setSequence(String sequence);
 104
 105   /**
 106    * @return sequence as string
 107    */
 108   public String getSequenceAsString();
 109
 110   /**
 111    * get a range on the sequence as a string
 112    *
 113    * @param start
 114    *          position relative to start of sequence including gaps (from 0)
 115    * @param end
 116    *          position relative to start of sequence including gaps (from 0)
 117    *
 118    * @return String containing all gap and symbols in specified range
 119    */
 120   public String getSequenceAsString(int start, int end);
 121
 122   /**
 123    * Answers a copy of the sequence as a character array
 124    *
 125    * @return
 126    */
 127   public char[] getSequence();
 128
 129   /**
 130    * get stretch of sequence characters in an array
 131    *
 132    * @param start
 133    *          absolute index into getSequence()
 134    * @param end
 135    *          exclusive index of last position in segment to be returned.
 136    *
 137    * @return char[max(0,end-start)];
 138    */
 139   public char[] getSequence(int start, int end);
 140
 141   /**
 142    * create a new sequence object with a subsequence of this one but sharing the
 143    * same dataset sequence
 144    *
 145    * @param start
 146    *          int index for start position (base 0, inclusive)
 147    * @param end
 148    *          int index for end position (base 0, exclusive)
 149    *
 150    * @return SequenceI
 151    * @note implementations may use getSequence to get the sequence data
 152    */
 153   public SequenceI getSubSequence(int start, int end);
 154
 155   /**
 156    * get the i'th character in this sequence's local reference frame (ie from
 157    * 0-number of characters lying from start-end)
 158    *
 159    * @param i
 160    *          index
 161    * @return character or ' '
 162    */
 163   public char getCharAt(int i);
 164
 165   /**
 166    * DOCUMENT ME!
 167    *
 168    * @param desc
 169    *          DOCUMENT ME!
 170    */
 171   public void setDescription(String desc);
 172
 173   /**
 174    * DOCUMENT ME!
 175    *
 176    * @return DOCUMENT ME!
 177    */
 178   public String getDescription();
 179
 180   /**
 181    * Return the alignment column (from 1..) for a sequence position
 182    *
 183    * @param pos
 184    *          lying from start to end
 185    *
 186    * @return aligned column for residue (0 if residue is upstream from
 187    *         alignment, -1 if residue is downstream from alignment) note.
 188    *         Sequence object returns sequence.getEnd() for positions upstream
 189    *         currently. TODO: change sequence for
 190    *         assert(findIndex(seq.getEnd()+1)==-1) and fix incremental bugs
 191    *
 192    */
 193   public int findIndex(int pos);
 194
 195   /**
 196    * Returns the sequence position for an alignment (column) position. If at a
 197    * gap, returns the position of the next residue to the right. If beyond the
 198    * end of the sequence, returns 1 more than the last residue position.
 199    *
 200    * @param i
 201    *          column index in alignment (from 0..<length)
 202    *
 203    * @return
 204    */
 205   public int findPosition(int i);
 206
 207   /**
 208    * Returns the from-to sequence positions (start..) for the given column
 209    * positions (1..), or null if no residues are included in the range
 210    *
 211    * @param fromColum
 212    * @param toColumn
 213    * @return
 214    */
 215   public Range findPositions(int fromColum, int toColumn);
 216
 217   /**
 218    * Returns an int array where indices correspond to each residue in the
 219    * sequence and the element value gives its position in the alignment
 220    *
 221    * @return int[SequenceI.getEnd()-SequenceI.getStart()+1] or null if no
 222    *         residues in SequenceI object
 223    */
 224   public int[] gapMap();
 225
 226   /**
 227    * Returns an int array where indices correspond to each position in sequence
 228    * char array and the element value gives the result of findPosition for that
 229    * index in the sequence.
 230    *
 231    * @return int[SequenceI.getLength()]
 232    */
 233   public int[] findPositionMap();
 234
 235   /**
 236    * Answers true if the sequence is composed of amino acid characters. Note
 237    * that implementations may use heuristic methods which are not guaranteed to
 238    * give the biologically 'right' answer.
 239    *
 240    * @return
 241    */
 242   public boolean isProtein();
 243
 244   /**
 245    * Delete a range of aligned sequence columns, creating a new dataset sequence
 246    * if necessary and adjusting start and end positions accordingly.
 247    *
 248    * @param i
 249    *          first column in range to delete (inclusive)
 250    * @param j
 251    *          last column in range to delete (exclusive)
 252    */
 253   public void deleteChars(int i, int j);
 254
 255   /**
 256    * DOCUMENT ME!
 257    *
 258    * @param i
 259    *          alignment column number
 260    * @param c
 261    *          character to insert
 262    */
 263   public void insertCharAt(int i, char c);
 264
 265   /**
 266    * insert given character at alignment column position
 267    *
 268    * @param position
 269    *          alignment column number
 270    * @param count
 271    *          length of insert
 272    * @param ch
 273    *          character to insert
 274    */
 275   public void insertCharAt(int position, int count, char ch);
 276
 277   /**
 278    * Answers a list of all sequence features associated with this sequence. The
 279    * list may be held by the sequence's dataset sequence if that is defined.
 280    *
 281    * @return
 282    */
 283   public List<SequenceFeature> getSequenceFeatures();
 284
 285   /**
 286    * Answers the object holding features for the sequence
 287    *
 288    * @return
 289    */
 290   SequenceFeaturesI getFeatures();
 291
 292   /**
 293    * Replaces the sequence features associated with this sequence with the given
 294    * features. If this sequence has a dataset sequence, then this method will
 295    * update the dataset sequence's features instead.
 296    *
 297    * @param features
 298    */
 299   public void setSequenceFeatures(List<SequenceFeature> features);
 300
 301   /**
 302    * DOCUMENT ME!
 303    *
 304    * @param id
 305    *          DOCUMENT ME!
 306    */
 307   public void setPDBId(Vector<PDBEntry> ids);
 308
 309   /**
 310    * Returns a list
 311    *
 312    * @return DOCUMENT ME!
 313    */
 314   public Vector<PDBEntry> getAllPDBEntries();
 315
 316   /**
 317    * Adds the entry to the *normalised* list of PDBIds.
 318    *
 319    * If a PDBEntry is passed with the same entry.getID() string as one already
 320    * in the list, or one is added that appears to be the same but has a chain ID
 321    * appended, then the existing PDBEntry will be updated with the new
 322    * attributes instead, unless the entries have distinct chain codes or
 323    * associated structure files.
 324    *
 325    * @param entry
 326    * @return true if the entry was added, false if updated
 327    */
 328   public boolean addPDBId(PDBEntry entry);
 329
 330   /**
 331    * update the list of PDBEntrys to include any DBRefEntrys citing structural
 332    * databases
 333    *
 334    * @return true if PDBEntry list was modified
 335    */
 336   public boolean updatePDBIds();
 337
 338   public String getVamsasId();
 339
 340   public void setVamsasId(String id);
 341
 342   /**
 343    * set the array of Database references for the sequence.
 344    *
 345    * @param dbs
 346    * @deprecated - use is discouraged since side-effects may occur if DBRefEntry
 347    *             set are not normalised.
 348    */
 349   @Deprecated
 350   public void setDBRefs(DBRefEntry[] dbs);
 351
 352   public DBRefEntry[] getDBRefs();
 353
 354   /**
 355    * add the given entry to the list of DBRefs for this sequence, or replace a
 356    * similar one if entry contains a map object and the existing one doesnt.
 357    *
 358    * @param entry
 359    */
 360   public void addDBRef(DBRefEntry entry);
 361
 362   /**
 363    * Adds the given sequence feature and returns true, or returns false if it is
 364    * already present on the sequence, or if the feature type is null.
 365    *
 366    * @param sf
 367    * @return
 368    */
 369   public boolean addSequenceFeature(SequenceFeature sf);
 370
 371   public void deleteFeature(SequenceFeature sf);
 372
 373   public void setDatasetSequence(SequenceI seq);
 374
 375   public SequenceI getDatasetSequence();
 376
 377   /**
 378    * Returns a new array containing this sequence's annotations, or null.
 379    */
 380   public AlignmentAnnotation[] getAnnotation();
 381
 382   /**
 383    * Returns true if this sequence has the given annotation (by object
 384    * identity).
 385    */
 386   public boolean hasAnnotation(AlignmentAnnotation ann);
 387
 388   /**
 389    * Add the given annotation, if not already added, and set its sequence ref to
 390    * be this sequence. Does nothing if this sequence's annotations already
 391    * include this annotation (by identical object reference).
 392    */
 393   public void addAlignmentAnnotation(AlignmentAnnotation annotation);
 394
 395   public void removeAlignmentAnnotation(AlignmentAnnotation annotation);
 396
 397   /**
 398    * Derive a sequence (using this one's dataset or as the dataset)
 399    *
 400    * @return duplicate sequence with valid dataset sequence
 401    */
 402   public SequenceI deriveSequence();
 403
 404   /**
 405    * set the array of associated AlignmentAnnotation for this sequenceI
 406    *
 407    * @param revealed
 408    */
 409   public void setAlignmentAnnotation(AlignmentAnnotation[] annotation);
 410
 411   /**
 412    * Get one or more alignment annotations with a particular label.
 413    *
 414    * @param label
 415    *          string which each returned annotation must have as a label.
 416    * @return null or array of annotations.
 417    */
 418   public AlignmentAnnotation[] getAnnotation(String label);
 419
 420   /**
 421    * Returns a (possibly empty) list of any annotations that match on given
 422    * calcId (source) and label (type). Null values do not match.
 423    *
 424    * @param calcId
 425    * @param label
 426    */
 427   public List<AlignmentAnnotation> getAlignmentAnnotations(String calcId,
 428           String label);
 429
 430   /**
 431    * create a new dataset sequence (if necessary) for this sequence and sets
 432    * this sequence to refer to it. This call will move any features or
 433    * references on the sequence onto the dataset. It will also make a duplicate
 434    * of existing annotation rows for the dataset sequence, rather than relocate
 435    * them in order to preserve external references (since 2.8.2).
 436    *
 437    * @return dataset sequence for this sequence
 438    */
 439   public SequenceI createDatasetSequence();
 440
 441   /**
 442    * Transfer any database references or annotation from entry under a sequence
 443    * mapping. <br/>
 444    * <strong>Note: DOES NOT transfer sequence associated alignment annotation
 445    * </strong><br/>
 446    *
 447    * @param entry
 448    * @param mp
 449    *          null or mapping from entry's numbering to local start/end
 450    */
 451   public void transferAnnotation(SequenceI entry, Mapping mp);
 452
 453   /**
 454    * @return The RNA of the sequence in the alignment
 455    */
 456
 457   public RNA getRNA();
 458
 459   /**
 460    * @param rna
 461    *          The RNA.
 462    */
 463   public void setRNA(RNA rna);
 464
 465   /**
 466    *
 467    * @return list of insertions (gap characters) in sequence
 468    */
 469   public List<int[]> getInsertions();
 470
 471   /**
 472    * Given a pdbId String, return the equivalent PDBEntry if available in the
 473    * given sequence
 474    *
 475    * @param pdbId
 476    * @return
 477    */
 478   public PDBEntry getPDBEntry(String pdbId);
 479
 480   /**
 481    * Get all primary database/accessions for this sequence's data. These
 482    * DBRefEntry are expected to resolve to a valid record in the associated
 483    * external database, either directly or via a provided 1:1 Mapping.
 484    *
 485    * @return just the primary references (if any) for this sequence, or an empty
 486    *         list
 487    */
 488   public List<DBRefEntry> getPrimaryDBRefs();
 489
 490   /**
 491    * Returns a (possibly empty) list of sequence features that overlap the given
 492    * alignment column range, optionally restricted to one or more specified
 493    * feature types. If the range is all gaps, then features which enclose it are
 494    * included (but not contact features).
 495    *
 496    * @param fromCol
 497    *          start column of range inclusive (1..)
 498    * @param toCol
 499    *          end column of range inclusive (1..)
 500    * @param types
 501    *          optional feature types to restrict results to
 502    * @return
 503    */
 504   List<SequenceFeature> findFeatures(int fromCol, int toCol, String... types);
 505
 506   /**
 507    * Method to call to indicate that the sequence (characters or alignment/gaps)
 508    * has been modified. Provided to allow any cursors on residue/column
 509    * positions to be invalidated.
 510    */
 511   void sequenceChanged();
 512
 513   /**
 514    *
 515    * @return BitSet corresponding to index [0,length) where Comparison.isGap()
 516    *         returns true.
 517    */
 518   BitSet getInsertionsAsBits();
 519
 520   /**
 521    * Replaces every occurrence of c1 in the sequence with c2 and returns the
 522    * number of characters changed
 523    *
 524    * @param c1
 525    * @param c2
 526    */
 527   public int replace(char c1, char c2);
 528
 529   /**
 530    * Answers the GeneLociI, or null if not known
 531    *
 532    * @return
 533    */
 534   GeneLociI getGeneLoci();
 535
 536   /**
 537    * Sets the mapping to gene loci for the sequence
 538    *
 539    * @param speciesId
 540    * @param assemblyId
 541    * @param chromosomeId
 542    * @param map
 543    */
 544   void setGeneLoci(String speciesId, String assemblyId,
 545           String chromosomeId, MapList map);
 546 }