src/jalview/datamodel/SequenceI.java

   1 /*\r
   2  * Jalview - A Sequence Alignment Editor and Viewer\r
   3  * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
   4  *\r
   5  * This program is free software; you can redistribute it and/or\r
   6  * modify it under the terms of the GNU General Public License\r
   7  * as published by the Free Software Foundation; either version 2\r
   8  * of the License, or (at your option) any later version.\r
   9  *\r
  10  * This program is distributed in the hope that it will be useful,\r
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  13  * GNU General Public License for more details.\r
  14  *\r
  15  * You should have received a copy of the GNU General Public License\r
  16  * along with this program; if not, write to the Free Software\r
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
  18  */\r
  19 package jalview.datamodel;\r
  20 \r
  21 import java.awt.*;\r
  22 \r
  23 import java.util.*;\r
  24 \r
  25 \r
  26 /**\r
  27  * DOCUMENT ME!\r
  28  *\r
  29  * @author $author$\r
  30  * @version $Revision$\r
  31  */\r
  32 public interface SequenceI\r
  33 {\r
  34     /**\r
  35      * DOCUMENT ME!\r
  36      *\r
  37      * @param name DOCUMENT ME!\r
  38      */\r
  39     public void setName(String name);\r
  40 \r
  41     /**\r
  42      * DOCUMENT ME!\r
  43      *\r
  44      * @return DOCUMENT ME!\r
  45      */\r
  46     public String getName();\r
  47 \r
  48     /**\r
  49      * DOCUMENT ME!\r
  50      *\r
  51      * @param start DOCUMENT ME!\r
  52      */\r
  53     public void setStart(int start);\r
  54 \r
  55     /**\r
  56      * DOCUMENT ME!\r
  57      *\r
  58      * @return DOCUMENT ME!\r
  59      */\r
  60     public int getStart();\r
  61 \r
  62     /**\r
  63      * DOCUMENT ME!\r
  64      *\r
  65      * @return DOCUMENT ME!\r
  66      */\r
  67     public String getDisplayId();\r
  68 \r
  69     /**\r
  70      * DOCUMENT ME!\r
  71      *\r
  72      * @param end DOCUMENT ME!\r
  73      */\r
  74     public void setEnd(int end);\r
  75 \r
  76     /**\r
  77      * DOCUMENT ME!\r
  78      *\r
  79      * @return DOCUMENT ME!\r
  80      */\r
  81     public int getEnd();\r
  82 \r
  83     /**\r
  84      * DOCUMENT ME!\r
  85      *\r
  86      * @return DOCUMENT ME!\r
  87      */\r
  88     public int getLength();\r
  89 \r
  90     /**\r
  91      * DOCUMENT ME!\r
  92      *\r
  93      * @param sequence DOCUMENT ME!\r
  94      */\r
  95     public void setSequence(String sequence);\r
  96 \r
  97     /**\r
  98      * DOCUMENT ME!\r
  99      *\r
 100      * @return DOCUMENT ME!\r
 101      */\r
 102     public String getSequence();\r
 103 \r
 104     /**\r
 105      * DOCUMENT ME!\r
 106      *\r
 107      * @param start DOCUMENT ME!\r
 108      * @param end DOCUMENT ME!\r
 109      *\r
 110      * @return DOCUMENT ME!\r
 111      */\r
 112     public String getSequence(int start, int end);\r
 113 \r
 114     /**\r
 115      * DOCUMENT ME!\r
 116      *\r
 117      * @param i DOCUMENT ME!\r
 118      *\r
 119      * @return DOCUMENT ME!\r
 120      */\r
 121     public char getCharAt(int i);\r
 122 \r
 123     /**\r
 124      * DOCUMENT ME!\r
 125      *\r
 126      * @param desc DOCUMENT ME!\r
 127      */\r
 128     public void setDescription(String desc);\r
 129 \r
 130     /**\r
 131      * DOCUMENT ME!\r
 132      *\r
 133      * @return DOCUMENT ME!\r
 134      */\r
 135     public String getDescription();\r
 136 \r
 137     /**\r
 138      * DOCUMENT ME!\r
 139      *\r
 140      * @param pos DOCUMENT ME!\r
 141      *\r
 142      * @return DOCUMENT ME!\r
 143      */\r
 144     public int findIndex(int pos);\r
 145 \r
 146     /**\r
 147      * DOCUMENT ME!\r
 148      *\r
 149      * @param i DOCUMENT ME!\r
 150      *\r
 151      * @return DOCUMENT ME!\r
 152      */\r
 153     public int findPosition(int i);\r
 154 \r
 155     /**\r
 156      * DOCUMENT ME!\r
 157      *\r
 158      * @return DOCUMENT ME!\r
 159      */\r
 160     public int[] gapMap();\r
 161 \r
 162     /**\r
 163      * DOCUMENT ME!\r
 164      *\r
 165      * @param i DOCUMENT ME!\r
 166      * @param j DOCUMENT ME!\r
 167      */\r
 168     public void deleteChars(int i, int j);\r
 169 \r
 170     /**\r
 171      * DOCUMENT ME!\r
 172      *\r
 173      * @param i DOCUMENT ME!\r
 174      */\r
 175     public void deleteCharAt(int i);\r
 176 \r
 177     /**\r
 178      * DOCUMENT ME!\r
 179      *\r
 180      * @param i DOCUMENT ME!\r
 181      * @param c DOCUMENT ME!\r
 182      */\r
 183     public void insertCharAt(int i, char c);\r
 184 \r
 185     /**\r
 186      * DOCUMENT ME!\r
 187      *\r
 188      * @param i DOCUMENT ME!\r
 189      * @param c DOCUMENT ME!\r
 190      * @param chop DOCUMENT ME!\r
 191      */\r
 192     public void insertCharAt(int i, char c, boolean chop);\r
 193 \r
 194     /**\r
 195      * DOCUMENT ME!\r
 196      *\r
 197      * @param c DOCUMENT ME!\r
 198      */\r
 199     public void setColor(Color c);\r
 200 \r
 201     /**\r
 202      * DOCUMENT ME!\r
 203      *\r
 204      * @return DOCUMENT ME!\r
 205      */\r
 206     public Color getColor();\r
 207 \r
 208     /**\r
 209      * DOCUMENT ME!\r
 210      *\r
 211      * @return DOCUMENT ME!\r
 212      */\r
 213     public Vector getSequenceFeatures();\r
 214 \r
 215     /**\r
 216      * DOCUMENT ME!\r
 217      *\r
 218      * @param v DOCUMENT ME!\r
 219      */\r
 220     public void setSequenceFeatures(Vector v);\r
 221 \r
 222     /**\r
 223      * DOCUMENT ME!\r
 224      *\r
 225      * @param id DOCUMENT ME!\r
 226      */\r
 227     public void setPDBId(String id);\r
 228 \r
 229     /**\r
 230      * DOCUMENT ME!\r
 231      *\r
 232      * @return DOCUMENT ME!\r
 233      */\r
 234     public String getPDBId();\r
 235 }\r