src/jalview/datamodel/SequenceI.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
   3  * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
   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 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18 package jalview.datamodel;
  19
  20 import java.util.Vector;
  21
  22 /**
  23  * DOCUMENT ME!
  24  *
  25  * @author $author$
  26  * @version $Revision$
  27  */
  28 public interface SequenceI
  29 {
  30   /**
  31    * Set the display name for the sequence
  32    *
  33    * @param name
  34    */
  35   public void setName(String name);
  36
  37   /**
  38    * Get the display name
  39    */
  40   public String getName();
  41
  42   /**
  43    * Set start position of first non-gapped symbol in sequence
  44    *
  45    * @param start
  46    *          new start position
  47    */
  48   public void setStart(int start);
  49
  50   /**
  51    * get start position of first non-gapped residue in sequence
  52    *
  53    * @return
  54    */
  55   public int getStart();
  56
  57   /**
  58    * get the displayed id of the sequence
  59    *
  60    * @return true means the id will be returned in the form
  61    *         DisplayName/Start-End
  62    */
  63   public String getDisplayId(boolean jvsuffix);
  64
  65   /**
  66    * set end position for last residue in sequence
  67    *
  68    * @param end
  69    */
  70   public void setEnd(int end);
  71
  72   /**
  73    * get end position for last residue in sequence getEnd()>getStart() unless
  74    * sequence only consists of gap characters
  75    *
  76    * @return
  77    */
  78   public int getEnd();
  79
  80   /**
  81    * @return length of sequence including gaps
  82    *
  83    */
  84   public int getLength();
  85
  86   /**
  87    * Replace the sequence with the given string
  88    *
  89    * @param sequence
  90    *          new sequence string
  91    */
  92   public void setSequence(String sequence);
  93
  94   /**
  95    * @return sequence as string
  96    */
  97   public String getSequenceAsString();
  98
  99   /**
 100    * get a range on the seuqence as a string
 101    *
 102    * @param start
 103    *          DOCUMENT ME!
 104    * @param end
 105    *          DOCUMENT ME!
 106    *
 107    * @return DOCUMENT ME!
 108    */
 109   public String getSequenceAsString(int start, int end);
 110
 111   /**
 112    * DOCUMENT ME!
 113    *
 114    * @return DOCUMENT ME!
 115    */
 116   public char[] getSequence();
 117
 118   /**
 119    * get stretch of sequence characters in an array
 120    *
 121    * @param start
 122    *          absolute index into getSequence()
 123    * @param end
 124    *          exclusive index of last position in segment to be returned.
 125    *
 126    * @return char[max(0,end-start)];
 127    */
 128   public char[] getSequence(int start, int end);
 129
 130   /**
 131    * create a new sequence object from start to end of this sequence
 132    *
 133    * @param start
 134    *          int
 135    * @param end
 136    *          int
 137    * @return SequenceI
 138    */
 139   public SequenceI getSubSequence(int start, int end);
 140
 141   /**
 142    * DOCUMENT ME!
 143    *
 144    * @param i
 145    *          DOCUMENT ME!
 146    *
 147    * @return DOCUMENT ME!
 148    */
 149   public char getCharAt(int i);
 150
 151   /**
 152    * DOCUMENT ME!
 153    *
 154    * @param desc
 155    *          DOCUMENT ME!
 156    */
 157   public void setDescription(String desc);
 158
 159   /**
 160    * DOCUMENT ME!
 161    *
 162    * @return DOCUMENT ME!
 163    */
 164   public String getDescription();
 165
 166   /**
 167    * Return the alignment column for a sequence position
 168    *    * Return the alignment position for a sequence position
 169    *
 170    * @param pos
 171    *          lying from start to end
 172    *
 173    * @return aligned column for residue (0 if residue is upstream from alignment, -1 if residue is downstream from alignment)
 174    * note. Sequence object returns sequence.getEnd() for positions upstream currently. TODO: change sequence for assert(findIndex(seq.getEnd()+1)==-1) and fix incremental bugs
 175    *
 176    */
 177   public int findIndex(int pos);
 178
 179   /**
 180    * Returns the sequence position for an alignment position
 181    *
 182    * @param i
 183    *          column index in alignment (from 1)
 184    *
 185    * @return residue number for residue (left of and) nearest ith column
 186    */
 187   public int findPosition(int i);
 188
 189   /**
 190    * Returns an int array where indices correspond to each residue in the
 191    * sequence and the element value gives its position in the alignment
 192    *
 193    * @return int[SequenceI.getEnd()-SequenceI.getStart()+1] or null if no
 194    *         residues in SequenceI object
 195    */
 196   public int[] gapMap();
 197
 198   /**
 199    * Returns an int array where indices correspond to each position in sequence
 200    * char array and the element value gives the result of findPosition for that
 201    * index in the sequence.
 202    *
 203    * @return int[SequenceI.getLength()]
 204    */
 205   public int[] findPositionMap();
 206
 207   /**
 208    * Delete a range of aligned sequence columns, creating a new dataset sequence
 209    * if necessary and adjusting start and end positions accordingly.
 210    *
 211    * @param i
 212    *          first column in range to delete
 213    * @param j
 214    *          last column in range to delete
 215    */
 216   public void deleteChars(int i, int j);
 217
 218   /**
 219    * DOCUMENT ME!
 220    *
 221    * @param i
 222    *          DOCUMENT ME!
 223    * @param c
 224    *          DOCUMENT ME!
 225    */
 226   public void insertCharAt(int i, char c);
 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, int length, char c);
 237
 238   /**
 239    * DOCUMENT ME!
 240    *
 241    * @return DOCUMENT ME!
 242    */
 243   public SequenceFeature[] getSequenceFeatures();
 244
 245   /**
 246    * DOCUMENT ME!
 247    *
 248    * @param v
 249    *          DOCUMENT ME!
 250    */
 251   public void setSequenceFeatures(SequenceFeature[] features);
 252
 253   /**
 254    * DOCUMENT ME!
 255    *
 256    * @param id
 257    *          DOCUMENT ME!
 258    */
 259   public void setPDBId(Vector ids);
 260
 261   /**
 262    * DOCUMENT ME!
 263    *
 264    * @return DOCUMENT ME!
 265    */
 266   public Vector getPDBId();
 267
 268   /**
 269    * add entry to the vector of PDBIds, if it isn't in the list already
 270    *
 271    * @param entry
 272    */
 273   public void addPDBId(PDBEntry entry);
 274
 275   /**
 276    * update the list of PDBEntrys to include any DBRefEntrys citing structural
 277    * databases
 278    *
 279    * @return true if PDBEntry list was modified
 280    */
 281   public boolean updatePDBIds();
 282
 283   public String getVamsasId();
 284
 285   public void setVamsasId(String id);
 286
 287   public void setDBRef(DBRefEntry[] dbs);
 288
 289   public DBRefEntry[] getDBRef();
 290
 291   /**
 292    * add the given entry to the list of DBRefs for this sequence, or replace a
 293    * similar one if entry contains a map object and the existing one doesnt.
 294    *
 295    * @param entry
 296    */
 297   public void addDBRef(DBRefEntry entry);
 298
 299   public void addSequenceFeature(SequenceFeature sf);
 300
 301   public void deleteFeature(SequenceFeature sf);
 302
 303   public void setDatasetSequence(SequenceI seq);
 304
 305   public SequenceI getDatasetSequence();
 306
 307   public AlignmentAnnotation[] getAnnotation();
 308
 309   public void addAlignmentAnnotation(AlignmentAnnotation annotation);
 310
 311   public void removeAlignmentAnnotation(AlignmentAnnotation annotation);
 312
 313   /**
 314    * Derive a sequence (using this one's dataset or as the dataset)
 315    *
 316    * @return duplicate sequence with valid dataset sequence
 317    */
 318   public SequenceI deriveSequence();
 319
 320   /**
 321    * set the array of associated AlignmentAnnotation for this sequenceI
 322    *
 323    * @param revealed
 324    */
 325   public void setAlignmentAnnotation(AlignmentAnnotation[] annotation);
 326
 327   /**
 328    * Get one or more alignment annotations with a particular label.
 329    *
 330    * @param label
 331    *          string which each returned annotation must have as a label.
 332    * @return null or array of annotations.
 333    */
 334   public AlignmentAnnotation[] getAnnotation(String label);
 335
 336   /**
 337    * create a new dataset sequence (if necessary) for this sequence and sets
 338    * this sequence to refer to it. This call will move any features or
 339    * references on the sequence onto the dataset.
 340    *
 341    * @return dataset sequence for this sequence
 342    */
 343   public SequenceI createDatasetSequence();
 344
 345   /**
 346    * Transfer any database references or annotation from entry under a sequence
 347    * mapping.
 348    *
 349    * @param entry
 350    * @param mp
 351    *          null or mapping from entry's numbering to local start/end
 352    */
 353   public void transferAnnotation(SequenceI entry, Mapping mp);
 354
 355   /**
 356    * @param index The sequence index in the MSA
 357    */
 358   public void setIndex(int index);
 359
 360   /**
 361    * @return The index of the sequence in the alignment
 362    */
 363   public int getIndex();
 364
 365 }