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