src/jalview/datamodel/SequenceI.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
   3  * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, 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 sequence as a string
 101    *
 102    * @param start
 103    *          position relative to start of sequence including gaps (from 0)
 104    * @param end
 105    *          position relative to start of sequence including gaps (from 0)
 106    *
 107    * @return String containing all gap and symbols in specified range
 108    */
 109   public String getSequenceAsString(int start, int end);
 110
 111   /**
 112    * Get the sequence as a character array
 113    *
 114    * @return seqeunce and any gaps
 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 * Return the alignment
 168    * 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
 174    *         alignment, -1 if residue is downstream from alignment) note.
 175    *         Sequence object returns sequence.getEnd() for positions upstream
 176    *         currently. TODO: change sequence for
 177    *         assert(findIndex(seq.getEnd()+1)==-1) and fix incremental bugs
 178    *
 179    */
 180   public int findIndex(int pos);
 181
 182   /**
 183    * Returns the sequence position for an alignment position
 184    *
 185    * @param i
 186    *          column index in alignment (from 1)
 187    *
 188    * @return residue number for residue (left of and) nearest ith column
 189    */
 190   public int findPosition(int i);
 191
 192   /**
 193    * Returns an int array where indices correspond to each residue in the
 194    * sequence and the element value gives its position in the alignment
 195    *
 196    * @return int[SequenceI.getEnd()-SequenceI.getStart()+1] or null if no
 197    *         residues in SequenceI object
 198    */
 199   public int[] gapMap();
 200
 201   /**
 202    * Returns an int array where indices correspond to each position in sequence
 203    * char array and the element value gives the result of findPosition for that
 204    * index in the sequence.
 205    *
 206    * @return int[SequenceI.getLength()]
 207    */
 208   public int[] findPositionMap();
 209
 210   /**
 211    * Delete a range of aligned sequence columns, creating a new dataset sequence
 212    * if necessary and adjusting start and end positions accordingly.
 213    *
 214    * @param i
 215    *          first column in range to delete
 216    * @param j
 217    *          last column in range to delete
 218    */
 219   public void deleteChars(int i, int j);
 220
 221   /**
 222    * DOCUMENT ME!
 223    *
 224    * @param i
 225    *          DOCUMENT ME!
 226    * @param c
 227    *          DOCUMENT ME!
 228    */
 229   public void insertCharAt(int i, char c);
 230
 231   /**
 232    * DOCUMENT ME!
 233    *
 234    * @param i
 235    *          DOCUMENT ME!
 236    * @param c
 237    *          DOCUMENT ME!
 238    */
 239   public void insertCharAt(int i, int length, char c);
 240
 241   /**
 242    * DOCUMENT ME!
 243    *
 244    * @return DOCUMENT ME!
 245    */
 246   public SequenceFeature[] getSequenceFeatures();
 247
 248   /**
 249    * DOCUMENT ME!
 250    *
 251    * @param v
 252    *          DOCUMENT ME!
 253    */
 254   public void setSequenceFeatures(SequenceFeature[] features);
 255
 256   /**
 257    * DOCUMENT ME!
 258    *
 259    * @param id
 260    *          DOCUMENT ME!
 261    */
 262   public void setPDBId(Vector ids);
 263
 264   /**
 265    * DOCUMENT ME!
 266    *
 267    * @return DOCUMENT ME!
 268    */
 269   public Vector getPDBId();
 270
 271   /**
 272    * add entry to the vector of PDBIds, if it isn't in the list already
 273    *
 274    * @param entry
 275    */
 276   public void addPDBId(PDBEntry entry);
 277
 278   /**
 279    * update the list of PDBEntrys to include any DBRefEntrys citing structural
 280    * databases
 281    *
 282    * @return true if PDBEntry list was modified
 283    */
 284   public boolean updatePDBIds();
 285
 286   public String getVamsasId();
 287
 288   public void setVamsasId(String id);
 289
 290   public void setDBRef(DBRefEntry[] dbs);
 291
 292   public DBRefEntry[] getDBRef();
 293
 294   /**
 295    * add the given entry to the list of DBRefs for this sequence, or replace a
 296    * similar one if entry contains a map object and the existing one doesnt.
 297    *
 298    * @param entry
 299    */
 300   public void addDBRef(DBRefEntry entry);
 301
 302   public void addSequenceFeature(SequenceFeature sf);
 303
 304   public void deleteFeature(SequenceFeature sf);
 305
 306   public void setDatasetSequence(SequenceI seq);
 307
 308   public SequenceI getDatasetSequence();
 309
 310   public AlignmentAnnotation[] getAnnotation();
 311
 312   public void addAlignmentAnnotation(AlignmentAnnotation annotation);
 313
 314   public void removeAlignmentAnnotation(AlignmentAnnotation annotation);
 315
 316   /**
 317    * Derive a sequence (using this one's dataset or as the dataset)
 318    *
 319    * @return duplicate sequence with valid dataset sequence
 320    */
 321   public SequenceI deriveSequence();
 322
 323   /**
 324    * set the array of associated AlignmentAnnotation for this sequenceI
 325    *
 326    * @param revealed
 327    */
 328   public void setAlignmentAnnotation(AlignmentAnnotation[] annotation);
 329
 330   /**
 331    * Get one or more alignment annotations with a particular label.
 332    *
 333    * @param label
 334    *          string which each returned annotation must have as a label.
 335    * @return null or array of annotations.
 336    */
 337   public AlignmentAnnotation[] getAnnotation(String label);
 338
 339   /**
 340    * create a new dataset sequence (if necessary) for this sequence and sets
 341    * this sequence to refer to it. This call will move any features or
 342    * references on the sequence onto the dataset.
 343    *
 344    * @return dataset sequence for this sequence
 345    */
 346   public SequenceI createDatasetSequence();
 347
 348   /**
 349    * Transfer any database references or annotation from entry under a sequence
 350    * mapping.
 351    *
 352    * @param entry
 353    * @param mp
 354    *          null or mapping from entry's numbering to local start/end
 355    */
 356   public void transferAnnotation(SequenceI entry, Mapping mp);
 357
 358   /**
 359    * @param index
 360    *          The sequence index in the MSA
 361    */
 362   public void setIndex(int index);
 363
 364   /**
 365    * @return The index of the sequence in the alignment
 366    */
 367   public int getIndex();
 368
 369 }