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