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