src/jalview/datamodel/SequenceI.java

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