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.api.DBRefEntryI;
  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 (from
 117    *         start .. end-1)
 118    */
 119   public String getSequenceAsString(int start, int end);
 120
 121   /**
 122    * Get the sequence as a character array
 123    *
 124    * @return sequence and any gaps
 125    */
 126   public char[] getSequence();
 127
 128   /**
 129    * get stretch of sequence characters in an array
 130    *
 131    * @param start
 132    *          absolute index into getSequence()
 133    * @param end
 134    *          exclusive index of last position in segment to be returned.
 135    *
 136    * @return char[max(0,end-start)];
 137    */
 138   public char[] getSequence(int start, int end);
 139
 140   /**
 141    * create a new sequence object with a subsequence of this one but sharing the
 142    * same dataset sequence
 143    *
 144    * @param start
 145    *          int index for start position (base 0, inclusive)
 146    * @param end
 147    *          int index for end position (base 0, exclusive)
 148    *
 149    * @return SequenceI
 150    * @note implementations may use getSequence to get the sequence data
 151    */
 152   public SequenceI getSubSequence(int start, int end);
 153
 154   /**
 155    * get the i'th character in this sequence's local reference frame (ie from
 156    * 0-number of characters lying from start-end)
 157    *
 158    * @param i
 159    *          index
 160    * @return character or ' '
 161    */
 162   public char getCharAt(int i);
 163
 164   /**
 165    * DOCUMENT ME!
 166    *
 167    * @param desc
 168    *          DOCUMENT ME!
 169    */
 170   public void setDescription(String desc);
 171
 172   /**
 173    * DOCUMENT ME!
 174    *
 175    * @return DOCUMENT ME!
 176    */
 177   public String getDescription();
 178
 179   /**
 180    * Return the alignment column for a sequence position
 181    *
 182    * @param pos
 183    *          lying from start to end
 184    *
 185    * @return aligned column for residue (0 if residue is upstream from
 186    *         alignment, -1 if residue is downstream from alignment) note.
 187    *         Sequence object returns sequence.getEnd() for positions upstream
 188    *         currently. TODO: change sequence for
 189    *         assert(findIndex(seq.getEnd()+1)==-1) and fix incremental bugs
 190    *
 191    */
 192   public int findIndex(int pos);
 193
 194   /**
 195    * Returns the sequence position for an alignment position
 196    *
 197    * @param i
 198    *          column index in alignment (from 0..<length)
 199    *
 200    * @return residue number for residue (left of and) nearest ith column
 201    */
 202   public int findPosition(int i);
 203
 204   /**
 205    * Returns an int array where indices correspond to each residue in the
 206    * sequence and the element value gives its position in the alignment
 207    *
 208    * @return int[SequenceI.getEnd()-SequenceI.getStart()+1] or null if no
 209    *         residues in SequenceI object
 210    */
 211   public int[] gapMap();
 212
 213   /**
 214    * Returns an int array where indices correspond to each position in sequence
 215    * char array and the element value gives the result of findPosition for that
 216    * index in the sequence.
 217    *
 218    * @return int[SequenceI.getLength()]
 219    */
 220   public int[] findPositionMap();
 221
 222   /**
 223    * Delete a range of aligned sequence columns, creating a new dataset sequence
 224    * if necessary and adjusting start and end positions accordingly.
 225    *
 226    * @param i
 227    *          first column in range to delete (inclusive)
 228    * @param j
 229    *          last column in range to delete (exclusive)
 230    */
 231   public void deleteChars(int i, int j);
 232
 233   /**
 234    * DOCUMENT ME!
 235    *
 236    * @param i
 237    *          DOCUMENT ME!
 238    * @param c
 239    *          DOCUMENT ME!
 240    */
 241   public void insertCharAt(int i, char c);
 242
 243   /**
 244    * DOCUMENT ME!
 245    *
 246    * @param position
 247    *          DOCUMENT ME!
 248    * @param ch
 249    *          DOCUMENT ME!
 250    */
 251   public void insertCharAt(int position, int count, char ch);
 252
 253   /**
 254    * Gets array holding sequence features associated with this sequence. The
 255    * array may be held by the sequence's dataset sequence if that is defined.
 256    *
 257    * @return hard reference to array
 258    */
 259   public SequenceFeature[] getSequenceFeatures();
 260
 261   /**
 262    * Replaces the array of sequence features associated with this sequence with
 263    * a new array reference. If this sequence has a dataset sequence, then this
 264    * method will update the dataset sequence's feature array
 265    *
 266    * @param features
 267    *          New array of sequence features
 268    */
 269   public void setSequenceFeatures(SequenceFeature[] features);
 270
 271   /**
 272    * DOCUMENT ME!
 273    *
 274    * @param id
 275    *          DOCUMENT ME!
 276    */
 277   public void setPDBId(Vector<PDBEntry> ids);
 278
 279   /**
 280    * Returns a list
 281    *
 282    * @return DOCUMENT ME!
 283    */
 284   public Vector<PDBEntry> getAllPDBEntries();
 285
 286   /**
 287    * add entry to the vector of PDBIds, if it isn't in the list already
 288    *
 289    * @param entry
 290    */
 291   public void addPDBId(PDBEntry entry);
 292
 293   /**
 294    * update the list of PDBEntrys to include any DBRefEntrys citing structural
 295    * databases
 296    *
 297    * @return true if PDBEntry list was modified
 298    */
 299   public boolean updatePDBIds();
 300
 301   public String getVamsasId();
 302
 303   public void setVamsasId(String id);
 304
 305   public void setDBRefs(DBRefEntry[] dbs);
 306
 307   public DBRefEntry[] getDBRefs();
 308
 309   /**
 310    * add the given entry to the list of DBRefs for this sequence, or replace a
 311    * similar one if entry contains a map object and the existing one doesnt.
 312    *
 313    * @param entry
 314    */
 315   public void addDBRef(DBRefEntry entry);
 316
 317   public void addSequenceFeature(SequenceFeature sf);
 318
 319   public void deleteFeature(SequenceFeature sf);
 320
 321   public void setDatasetSequence(SequenceI seq);
 322
 323   public SequenceI getDatasetSequence();
 324
 325   /**
 326    * Returns a new array containing this sequence's annotations, or null.
 327    */
 328   public AlignmentAnnotation[] getAnnotation();
 329
 330   /**
 331    * Returns true if this sequence has the given annotation (by object
 332    * identity).
 333    */
 334   public boolean hasAnnotation(AlignmentAnnotation ann);
 335
 336   /**
 337    * Add the given annotation, if not already added, and set its sequence ref to
 338    * be this sequence. Does nothing if this sequence's annotations already
 339    * include this annotation (by identical object reference).
 340    */
 341   public void addAlignmentAnnotation(AlignmentAnnotation annotation);
 342
 343   public void removeAlignmentAnnotation(AlignmentAnnotation annotation);
 344
 345   /**
 346    * Derive a sequence (using this one's dataset or as the dataset)
 347    *
 348    * @return duplicate sequence with valid dataset sequence
 349    */
 350   public SequenceI deriveSequence();
 351
 352   /**
 353    * set the array of associated AlignmentAnnotation for this sequenceI
 354    *
 355    * @param revealed
 356    */
 357   public void setAlignmentAnnotation(AlignmentAnnotation[] annotation);
 358
 359   /**
 360    * Get one or more alignment annotations with a particular label.
 361    *
 362    * @param label
 363    *          string which each returned annotation must have as a label.
 364    * @return null or array of annotations.
 365    */
 366   public AlignmentAnnotation[] getAnnotation(String label);
 367
 368   /**
 369    * Returns a (possibly empty) list of any annotations that match on given
 370    * calcId (source) and label (type). Null values do not match.
 371    *
 372    * @param calcId
 373    * @param label
 374    */
 375   public List<AlignmentAnnotation> getAlignmentAnnotations(String calcId,
 376           String label);
 377
 378   /**
 379    * create a new dataset sequence (if necessary) for this sequence and sets
 380    * this sequence to refer to it. This call will move any features or
 381    * references on the sequence onto the dataset. It will also make a duplicate
 382    * of existing annotation rows for the dataset sequence, rather than relocate
 383    * them in order to preserve external references (since 2.8.2).
 384    *
 385    * @return dataset sequence for this sequence
 386    */
 387   public SequenceI createDatasetSequence();
 388
 389   /**
 390    * Transfer any database references or annotation from entry under a sequence
 391    * mapping. <br/>
 392    * <strong>Note: DOES NOT transfer sequence associated alignment annotation
 393    * </strong><br/>
 394    *
 395    * @param entry
 396    * @param mp
 397    *          null or mapping from entry's numbering to local start/end
 398    */
 399   public void transferAnnotation(SequenceI entry, Mapping mp);
 400
 401   /**
 402    * @param index
 403    *          The sequence index in the MSA
 404    */
 405   public void setIndex(int index);
 406
 407   /**
 408    * @return The index of the sequence in the alignment
 409    */
 410   public int getIndex();
 411
 412   /**
 413    * @return The RNA of the sequence in the alignment
 414    */
 415
 416   public RNA getRNA();
 417
 418   /**
 419    * @param rna
 420    *          The RNA.
 421    */
 422   public void setRNA(RNA rna);
 423
 424   /**
 425    *
 426    * @return list of insertions (gap characters) in sequence
 427    */
 428   public List<int[]> getInsertions();
 429
 430   /**
 431    * Given a pdbId String, return the equivalent PDBEntry if available in the
 432    * given sequence
 433    *
 434    * @param pdbId
 435    * @return
 436    */
 437   public PDBEntry getPDBEntry(String pdbId);
 438
 439   public void setSourceDBRef(DBRefEntryI dbRef);
 440
 441   public DBRefEntryI getSourceDBRef();
 442 }