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     public String getShortName();\r
  49     /**\r
  50      * DOCUMENT ME!\r
  51      *\r
  52      * @param start DOCUMENT ME!\r
  53      */\r
  54     public void setStart(int start);\r
  55 \r
  56     /**\r
  57      * DOCUMENT ME!\r
  58      *\r
  59      * @return DOCUMENT ME!\r
  60      */\r
  61     public int getStart();\r
  62 \r
  63     /**\r
  64      * DOCUMENT ME!\r
  65      *\r
  66      * @return DOCUMENT ME!\r
  67      */\r
  68     public String getDisplayId(boolean dbref, boolean jvsuffix);\r
  69 \r
  70     /**\r
  71      * DOCUMENT ME!\r
  72      *\r
  73      * @param end DOCUMENT ME!\r
  74      */\r
  75     public void setEnd(int end);\r
  76 \r
  77     /**\r
  78      * DOCUMENT ME!\r
  79      *\r
  80      * @return DOCUMENT ME!\r
  81      */\r
  82     public int getEnd();\r
  83 \r
  84     /**\r
  85      * DOCUMENT ME!\r
  86      *\r
  87      * @return DOCUMENT ME!\r
  88      */\r
  89     public int getLength();\r
  90 \r
  91     /**\r
  92      * DOCUMENT ME!\r
  93      *\r
  94      * @param sequence DOCUMENT ME!\r
  95      */\r
  96     public void setSequence(String sequence);\r
  97 \r
  98     /**\r
  99      * DOCUMENT ME!\r
 100      *\r
 101      * @return DOCUMENT ME!\r
 102      */\r
 103     public String getSequence();\r
 104 \r
 105     /**\r
 106      * DOCUMENT ME!\r
 107      *\r
 108      * @param start DOCUMENT ME!\r
 109      * @param end DOCUMENT ME!\r
 110      *\r
 111      * @return DOCUMENT ME!\r
 112      */\r
 113     public String getSequence(int start, int end);\r
 114 \r
 115     /**\r
 116      * DOCUMENT ME!\r
 117      *\r
 118      * @param i DOCUMENT ME!\r
 119      *\r
 120      * @return DOCUMENT ME!\r
 121      */\r
 122     public char getCharAt(int i);\r
 123 \r
 124     /**\r
 125      * DOCUMENT ME!\r
 126      *\r
 127      * @param desc DOCUMENT ME!\r
 128      */\r
 129     public void setDescription(String desc);\r
 130 \r
 131     /**\r
 132      * DOCUMENT ME!\r
 133      *\r
 134      * @return DOCUMENT ME!\r
 135      */\r
 136     public String getDescription();\r
 137 \r
 138     /**\r
 139      * DOCUMENT ME!\r
 140      *\r
 141      * @param pos DOCUMENT ME!\r
 142      *\r
 143      * @return DOCUMENT ME!\r
 144      */\r
 145     public int findIndex(int pos);\r
 146 \r
 147     /**\r
 148      * DOCUMENT ME!\r
 149      *\r
 150      * @param i DOCUMENT ME!\r
 151      *\r
 152      * @return DOCUMENT ME!\r
 153      */\r
 154     public int findPosition(int i);\r
 155 \r
 156     /**\r
 157      * DOCUMENT ME!\r
 158      *\r
 159      * @return DOCUMENT ME!\r
 160      */\r
 161     public int[] gapMap();\r
 162 \r
 163     /**\r
 164      * DOCUMENT ME!\r
 165      *\r
 166      * @param i DOCUMENT ME!\r
 167      * @param j DOCUMENT ME!\r
 168      */\r
 169     public void deleteChars(int i, int j);\r
 170 \r
 171     /**\r
 172      * DOCUMENT ME!\r
 173      *\r
 174      * @param i DOCUMENT ME!\r
 175      */\r
 176     public void deleteCharAt(int i);\r
 177 \r
 178     /**\r
 179      * DOCUMENT ME!\r
 180      *\r
 181      * @param i DOCUMENT ME!\r
 182      * @param c DOCUMENT ME!\r
 183      */\r
 184     public void insertCharAt(int i, char c);\r
 185 \r
 186     /**\r
 187      * DOCUMENT ME!\r
 188      *\r
 189      * @param i DOCUMENT ME!\r
 190      * @param c DOCUMENT ME!\r
 191      * @param chop DOCUMENT ME!\r
 192      */\r
 193     public void insertCharAt(int i, char c, boolean chop);\r
 194 \r
 195     /**\r
 196      * DOCUMENT ME!\r
 197      *\r
 198      * @param c DOCUMENT ME!\r
 199      */\r
 200     public void setColor(Color c);\r
 201 \r
 202     /**\r
 203      * DOCUMENT ME!\r
 204      *\r
 205      * @return DOCUMENT ME!\r
 206      */\r
 207     public Color getColor();\r
 208 \r
 209     /**\r
 210      * DOCUMENT ME!\r
 211      *\r
 212      * @return DOCUMENT ME!\r
 213      */\r
 214     public Vector getSequenceFeatures();\r
 215 \r
 216     /**\r
 217      * DOCUMENT ME!\r
 218      *\r
 219      * @param v DOCUMENT ME!\r
 220      */\r
 221     public void setSequenceFeatures(Vector v);\r
 222 \r
 223     /**\r
 224      * DOCUMENT ME!\r
 225      *\r
 226      * @param id DOCUMENT ME!\r
 227      */\r
 228     public void setPDBId(Vector ids);\r
 229 \r
 230     /**\r
 231      * DOCUMENT ME!\r
 232      *\r
 233      * @return DOCUMENT ME!\r
 234      */\r
 235     public Vector getPDBId();\r
 236 \r
 237     public void addPDBId(PDBEntry entry);\r
 238 \r
 239     public String getVamsasId();\r
 240 \r
 241     public void setVamsasId(String id);\r
 242 \r
 243     public void setDBRef(Vector dbs);\r
 244 \r
 245     public Vector getDBRef();\r
 246 \r
 247     public void addDBRef(DBRefEntry entry);\r
 248 \r
 249     public void addSequenceFeature(SequenceFeature sf);\r
 250 \r
 251     public void setDatasetSequence(SequenceI seq);\r
 252 \r
 253     public SequenceI getDatasetSequence();\r
 254 }\r