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  * DOCUMENT ME!
  30  *
  31  * @author $author$
  32  * @version $Revision$
  33  */
  34 public interface SequenceI
  35 {
  36   /**
  37    * Set the display name for the sequence
  38    *
  39    * @param name
  40    */
  41   public void setName(String name);
  42
  43   /**
  44    * Get the display name
  45    */
  46   public String getName();
  47
  48   /**
  49    * Set start position of first non-gapped symbol in sequence
  50    *
  51    * @param start
  52    *          new start position
  53    */
  54   public void setStart(int start);
  55
  56   /**
  57    * get start position of first non-gapped residue in sequence
  58    *
  59    * @return
  60    */
  61   public int getStart();
  62
  63   /**
  64    * get the displayed id of the sequence
  65    *
  66    * @return true means the id will be returned in the form
  67    *         DisplayName/Start-End
  68    */
  69   public String getDisplayId(boolean jvsuffix);
  70
  71   /**
  72    * set end position for last residue in sequence
  73    *
  74    * @param end
  75    */
  76   public void setEnd(int end);
  77
  78   /**
  79    * get end position for last residue in sequence getEnd()>getStart() unless
  80    * sequence only consists of gap characters
  81    *
  82    * @return
  83    */
  84   public int getEnd();
  85
  86   /**
  87    * @return length of sequence including gaps
  88    *
  89    */
  90   public int getLength();
  91
  92   /**
  93    * Replace the sequence with the given string
  94    *
  95    * @param sequence
  96    *          new sequence string
  97    */
  98   public void setSequence(String sequence);
  99
 100   /**
 101    * @return sequence as string
 102    */
 103   public String getSequenceAsString();
 104
 105   /**
 106    * get a range on the sequence as a string
 107    *
 108    * @param start
 109    *          position relative to start of sequence including gaps (from 0)
 110    * @param end
 111    *          position relative to start of sequence including gaps (from 0)
 112    *
 113    * @return String containing all gap and symbols in specified range
 114    */
 115   public String getSequenceAsString(int start, int end);
 116
 117   /**
 118    * Get the sequence as a character array
 119    *
 120    * @return seqeunce and any gaps
 121    */
 122   public char[] getSequence();
 123
 124   /**
 125    * get stretch of sequence characters in an array
 126    *
 127    * @param start
 128    *          absolute index into getSequence()
 129    * @param end
 130    *          exclusive index of last position in segment to be returned.
 131    *
 132    * @return char[max(0,end-start)];
 133    */
 134   public char[] getSequence(int start, int end);
 135
 136   /**
 137    * create a new sequence object from start to end of this sequence
 138    *
 139    * @param start
 140    *          int index for start position
 141    * @param end
 142    *          int index for end position
 143    *
 144    * @return SequenceI
 145    * @note implementations may use getSequence to get the sequence data
 146    */
 147   public SequenceI getSubSequence(int start, int end);
 148
 149   /**
 150    * get the i'th character in this sequence's local reference frame (ie from
 151    * 0-number of characters lying from start-end)
 152    *
 153    * @param i
 154    *          index
 155    * @return character or ' '
 156    */
 157   public char getCharAt(int i);
 158
 159   /**
 160    * DOCUMENT ME!
 161    *
 162    * @param desc
 163    *          DOCUMENT ME!
 164    */
 165   public void setDescription(String desc);
 166
 167   /**
 168    * DOCUMENT ME!
 169    *
 170    * @return DOCUMENT ME!
 171    */
 172   public String getDescription();
 173
 174   /**
 175    * Return the alignment column for a sequence position
 176    *
 177    * @param pos
 178    *          lying from start to end
 179    *
 180    * @return aligned column for residue (0 if residue is upstream from
 181    *         alignment, -1 if residue is downstream from alignment) note.
 182    *         Sequence object returns sequence.getEnd() for positions upstream
 183    *         currently. TODO: change sequence for
 184    *         assert(findIndex(seq.getEnd()+1)==-1) and fix incremental bugs
 185    *
 186    */
 187   public int findIndex(int pos);
 188
 189   /**
 190    * Returns the sequence position for an alignment position
 191    *
 192    * @param i
 193    *          column index in alignment (from 0..<length)
 194    *
 195    * @return residue number for residue (left of and) nearest ith column
 196    */
 197   public int findPosition(int i);
 198
 199   /**
 200    * Returns an int array where indices correspond to each residue in the
 201    * sequence and the element value gives its position in the alignment
 202    *
 203    * @return int[SequenceI.getEnd()-SequenceI.getStart()+1] or null if no
 204    *         residues in SequenceI object
 205    */
 206   public int[] gapMap();
 207
 208   /**
 209    * Returns an int array where indices correspond to each position in sequence
 210    * char array and the element value gives the result of findPosition for that
 211    * index in the sequence.
 212    *
 213    * @return int[SequenceI.getLength()]
 214    */
 215   public int[] findPositionMap();
 216
 217   /**
 218    * Delete a range of aligned sequence columns, creating a new dataset sequence
 219    * if necessary and adjusting start and end positions accordingly.
 220    *
 221    * @param i
 222    *          first column in range to delete (inclusive)
 223    * @param j
 224    *          last column in range to delete (exclusive)
 225    */
 226   public void deleteChars(int i, int j);
 227
 228   /**
 229    * DOCUMENT ME!
 230    *
 231    * @param i
 232    *          DOCUMENT ME!
 233    * @param c
 234    *          DOCUMENT ME!
 235    */
 236   public void insertCharAt(int i, char c);
 237
 238   /**
 239    * DOCUMENT ME!
 240    * @param position
 241    *          DOCUMENT ME!
 242    * @param ch
 243    *          DOCUMENT ME!
 244    */
 245   public void insertCharAt(int position, int count, char ch);
 246
 247   /**
 248    * DOCUMENT ME!
 249    *
 250    * @return DOCUMENT ME!
 251    */
 252   public SequenceFeature[] getSequenceFeatures();
 253
 254   /**
 255    * DOCUMENT ME!
 256    *
 257    * @param v
 258    *          DOCUMENT ME!
 259    */
 260   public void setSequenceFeatures(SequenceFeature[] features);
 261
 262   /**
 263    * DOCUMENT ME!
 264    *
 265    * @param id
 266    *          DOCUMENT ME!
 267    */
 268   public void setPDBId(Vector ids);
 269
 270   /**
 271    * DOCUMENT ME!
 272    *
 273    * @return DOCUMENT ME!
 274    */
 275   public Vector getPDBId();
 276
 277   /**
 278    * add entry to the vector of PDBIds, if it isn't in the list already
 279    *
 280    * @param entry
 281    */
 282   public void addPDBId(PDBEntry entry);
 283
 284   /**
 285    * update the list of PDBEntrys to include any DBRefEntrys citing structural
 286    * databases
 287    *
 288    * @return true if PDBEntry list was modified
 289    */
 290   public boolean updatePDBIds();
 291
 292   public String getVamsasId();
 293
 294   public void setVamsasId(String id);
 295
 296   public void setDBRef(DBRefEntry[] dbs);
 297
 298   public DBRefEntry[] getDBRef();
 299
 300   /**
 301    * add the given entry to the list of DBRefs for this sequence, or replace a
 302    * similar one if entry contains a map object and the existing one doesnt.
 303    *
 304    * @param entry
 305    */
 306   public void addDBRef(DBRefEntry entry);
 307
 308   public void addSequenceFeature(SequenceFeature sf);
 309
 310   public void deleteFeature(SequenceFeature sf);
 311
 312   public void setDatasetSequence(SequenceI seq);
 313
 314   public SequenceI getDatasetSequence();
 315
 316   /**
 317    * Returns a new array containing this sequence's annotations, or null.
 318    */
 319   public AlignmentAnnotation[] getAnnotation();
 320
 321   /**
 322    * Returns true if this sequence has the given annotation (by object
 323    * identity).
 324    */
 325   public boolean hasAnnotation(AlignmentAnnotation ann);
 326
 327   /**
 328    * Add the given annotation, if not already added, and set its sequence ref to
 329    * be this sequence. Does nothing if this sequence's annotations already
 330    * include this annotation (by identical object reference).
 331    */
 332   public void addAlignmentAnnotation(AlignmentAnnotation annotation);
 333
 334   public void removeAlignmentAnnotation(AlignmentAnnotation annotation);
 335
 336   /**
 337    * Derive a sequence (using this one's dataset or as the dataset)
 338    *
 339    * @return duplicate sequence with valid dataset sequence
 340    */
 341   public SequenceI deriveSequence();
 342
 343   /**
 344    * set the array of associated AlignmentAnnotation for this sequenceI
 345    *
 346    * @param revealed
 347    */
 348   public void setAlignmentAnnotation(AlignmentAnnotation[] annotation);
 349
 350   /**
 351    * Get one or more alignment annotations with a particular label.
 352    *
 353    * @param label
 354    *          string which each returned annotation must have as a label.
 355    * @return null or array of annotations.
 356    */
 357   public AlignmentAnnotation[] getAnnotation(String label);
 358
 359   /**
 360    * Returns a (possibly empty) list of any annotations that match on given
 361    * calcId (source) and label (type). Null values do not match.
 362    *
 363    * @param calcId
 364    * @param label
 365    */
 366   public List<AlignmentAnnotation> getAlignmentAnnotations(String calcId,
 367           String label);
 368
 369   /**
 370    * create a new dataset sequence (if necessary) for this sequence and sets
 371    * this sequence to refer to it. This call will move any features or
 372    * references on the sequence onto the dataset. It will also make a duplicate
 373    * of existing annotation rows for the dataset sequence, rather than relocate
 374    * them in order to preserve external references (since 2.8.2).
 375    *
 376    * @return dataset sequence for this sequence
 377    */
 378   public SequenceI createDatasetSequence();
 379
 380   /**
 381    * Transfer any database references or annotation from entry under a sequence
 382    * mapping. <br/>
 383    * <strong>Note: DOES NOT transfer sequence associated alignment
 384    * annotation </strong><br/>
 385    *
 386    * @param entry
 387    * @param mp
 388    *          null or mapping from entry's numbering to local start/end
 389    */
 390   public void transferAnnotation(SequenceI entry, Mapping mp);
 391
 392   /**
 393    * @param index
 394    *          The sequence index in the MSA
 395    */
 396   public void setIndex(int index);
 397
 398   /**
 399    * @return The index of the sequence in the alignment
 400    */
 401   public int getIndex();
 402
 403   /**
 404    * @return The RNA of the sequence in the alignment
 405    */
 406
 407   public RNA getRNA();
 408
 409   /**
 410    * @param rna
 411    *          The RNA.
 412    */
 413   public void setRNA(RNA rna);
 414
 415   /**
 416    *
 417    * @return list of insertions (gap characters) in sequence
 418    */
 419   public List<int[]> getInsertions();
 420
 421 }