src/jalview/datamodel/SequenceGroup.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 jalview.analysis.*;\r
  22 \r
  23 import jalview.datamodel.*;\r
  24 \r
  25 import jalview.schemes.*;\r
  26 \r
  27 import java.awt.*;\r
  28 \r
  29 import java.util.Vector;\r
  30 \r
  31 public class SequenceGroup\r
  32 {\r
  33   String groupName;\r
  34   Conservation conserve;\r
  35   Vector aaFrequency;\r
  36   boolean displayBoxes;\r
  37   boolean displayText;\r
  38   boolean colourText;\r
  39   public Vector sequences = new Vector();\r
  40   int width = -1;\r
  41   public ColourSchemeI cs;\r
  42   int startRes = 0;\r
  43   int endRes = 0;\r
  44   Color outlineColour = Color.black;\r
  45 \r
  46   public SequenceGroup()\r
  47   {\r
  48     groupName = "Group";\r
  49     this.displayBoxes = true;\r
  50     this.displayText = true;\r
  51     this.colourText = false;\r
  52     cs = null;\r
  53   }\r
  54 \r
  55   public SequenceGroup(Vector sequences, String groupName, ColourSchemeI scheme,\r
  56                        boolean displayBoxes, boolean displayText,\r
  57                        boolean colourText,\r
  58                        int start, int end)\r
  59   {\r
  60     this.sequences = sequences;\r
  61     this.groupName = groupName;\r
  62     this.displayBoxes = displayBoxes;\r
  63     this.displayText = displayText;\r
  64     this.colourText = colourText;\r
  65     this.cs = scheme;\r
  66     startRes = start;\r
  67     endRes = end;\r
  68     recalcConservation();\r
  69   }\r
  70 \r
  71   public SequenceGroup(String groupName, ColourSchemeI scheme,\r
  72                        boolean displayBoxes, boolean displayText,\r
  73                        boolean colourText,\r
  74                        int start, int end)\r
  75   {\r
  76     this.groupName = groupName;\r
  77     this.displayBoxes = displayBoxes;\r
  78     this.displayText = displayText;\r
  79     this.colourText = colourText;\r
  80     this.cs = scheme;\r
  81     startRes = start;\r
  82     endRes = end;\r
  83   }\r
  84 \r
  85   public boolean adjustForRemoveLeft(int col)\r
  86   {\r
  87     // return value is true if the group still exists\r
  88     if (startRes >= col)\r
  89     {\r
  90       startRes = startRes - col;\r
  91     }\r
  92 \r
  93     if (endRes >= col)\r
  94     {\r
  95       endRes = endRes - col;\r
  96 \r
  97       if (startRes > endRes)\r
  98       {\r
  99         startRes = 0;\r
 100       }\r
 101     }\r
 102     else\r
 103     {\r
 104       // must delete this group!!\r
 105       return false;\r
 106     }\r
 107 \r
 108     return true;\r
 109   }\r
 110 \r
 111   public boolean adjustForRemoveRight(int col)\r
 112   {\r
 113     if (startRes > col)\r
 114     {\r
 115       // delete this group\r
 116       return false;\r
 117     }\r
 118 \r
 119     if (endRes >= col)\r
 120     {\r
 121       endRes = col;\r
 122     }\r
 123 \r
 124     return true;\r
 125   }\r
 126 \r
 127   public String getName()\r
 128   {\r
 129     return groupName;\r
 130   }\r
 131 \r
 132   public void setName(String name)\r
 133   {\r
 134     groupName = name;\r
 135   }\r
 136 \r
 137   public Conservation getConservation()\r
 138   {\r
 139     return conserve;\r
 140   }\r
 141 \r
 142   public void setConservation(Conservation c)\r
 143   {\r
 144     conserve = c;\r
 145   }\r
 146 \r
 147   public void addSequence(SequenceI s, boolean recalc)\r
 148   {\r
 149     if (!sequences.contains(s))\r
 150       sequences.addElement(s);\r
 151 \r
 152     if(recalc)\r
 153       recalcConservation();\r
 154   }\r
 155 \r
 156 \r
 157   public void recalcConservation()\r
 158   {\r
 159     if (cs != null)\r
 160     {\r
 161       cs.setConsensus(AAFrequency.calculate(sequences, 0, getWidth()));\r
 162     }\r
 163 \r
 164     if ( cs  instanceof ConservationColourScheme)\r
 165     {\r
 166       Conservation c = new Conservation(groupName,\r
 167                                         ResidueProperties.propHash, 3, sequences,\r
 168                                         0, getWidth());\r
 169       c.calculate();\r
 170       c.verdict(false, 25);\r
 171 \r
 172       ConservationColourScheme ccs = (ConservationColourScheme) cs;\r
 173       ccs.conserve = c;\r
 174     }\r
 175   }\r
 176 \r
 177   public void addOrRemove(SequenceI s, boolean recalc)\r
 178   {\r
 179     if (sequences.contains(s))\r
 180     {\r
 181       deleteSequence(s, recalc);\r
 182     }\r
 183     else\r
 184     {\r
 185       addSequence(s, recalc);\r
 186     }\r
 187   }\r
 188 \r
 189   public void deleteSequence(SequenceI s, boolean recalc)\r
 190   {\r
 191     sequences.removeElement(s);\r
 192     if(recalc)\r
 193       recalcConservation();\r
 194   }\r
 195 \r
 196   public int getStartRes()\r
 197   {\r
 198     return startRes;\r
 199   }\r
 200 \r
 201   public int getEndRes()\r
 202   {\r
 203     return endRes;\r
 204   }\r
 205 \r
 206   public void setStartRes(int i)\r
 207   {\r
 208     startRes = i;\r
 209   }\r
 210 \r
 211   public void setEndRes(int i)\r
 212   {\r
 213     endRes = i;\r
 214   }\r
 215 \r
 216   public int getSize()\r
 217   {\r
 218     return sequences.size();\r
 219   }\r
 220 \r
 221   public SequenceI getSequenceAt(int i)\r
 222   {\r
 223     return (SequenceI) sequences.elementAt(i);\r
 224   }\r
 225 \r
 226   public void setColourText(boolean state)\r
 227   {\r
 228     colourText = state;\r
 229   }\r
 230 \r
 231   public boolean getColourText()\r
 232   {\r
 233     return colourText;\r
 234   }\r
 235 \r
 236   public void setDisplayText(boolean state)\r
 237   {\r
 238     displayText = state;\r
 239   }\r
 240 \r
 241   public boolean getDisplayText()\r
 242   {\r
 243     return displayText;\r
 244   }\r
 245 \r
 246   public void setDisplayBoxes(boolean state)\r
 247   {\r
 248     displayBoxes = state;\r
 249   }\r
 250 \r
 251   public boolean getDisplayBoxes()\r
 252   {\r
 253     return displayBoxes;\r
 254   }\r
 255 \r
 256   public int getWidth()\r
 257   {\r
 258     // MC This needs to get reset when characters are inserted and deleted\r
 259     if (sequences.size() > 0)\r
 260     {\r
 261       width = ( (SequenceI) sequences.elementAt(0)).getLength();\r
 262     }\r
 263 \r
 264     for (int i = 1; i < sequences.size(); i++)\r
 265     {\r
 266       SequenceI seq = (SequenceI) sequences.elementAt(i);\r
 267 \r
 268       if (seq.getLength() > width)\r
 269       {\r
 270         width = seq.getLength();\r
 271       }\r
 272     }\r
 273 \r
 274     return width;\r
 275   }\r
 276 \r
 277   public void setOutlineColour(Color c)\r
 278   {\r
 279     outlineColour = c;\r
 280   }\r
 281 \r
 282   public Color getOutlineColour()\r
 283   {\r
 284     return outlineColour;\r
 285   }\r
 286 \r
 287   /**\r
 288    *\r
 289    * returns the sequences in the group ordered by the ordering given by al\r
 290    *\r
 291    * @param al Alignment\r
 292    * @return SequenceI[]\r
 293    */\r
 294   public SequenceI[] getSequencesInOrder(Alignment al)\r
 295   {\r
 296     int sz;\r
 297     java.util.Hashtable orderedSeqs = new java.util.Hashtable();\r
 298     SequenceI[] seqs = new SequenceI[sz = sequences.size()];\r
 299 \r
 300     for (int i = 0; i < sz; i++)\r
 301     {\r
 302       SequenceI seq = (SequenceI) sequences.elementAt(i);\r
 303       int index = al.findIndex(seq);\r
 304       orderedSeqs.put(index + "", seq);\r
 305     }\r
 306 \r
 307     int index = 0;\r
 308 \r
 309     for (int i = 0; i < sz; i++)\r
 310     {\r
 311       SequenceI seq = null;\r
 312 \r
 313       while (seq == null)\r
 314       {\r
 315         if (orderedSeqs.containsKey(index + ""))\r
 316         {\r
 317           seq = (SequenceI) orderedSeqs.get(index + "");\r
 318           index++;\r
 319 \r
 320           break;\r
 321         }\r
 322         else\r
 323         {\r
 324           index++;\r
 325         }\r
 326       }\r
 327 \r
 328       seqs[index] = seq;\r
 329     }\r
 330 \r
 331     return seqs;\r
 332   }\r
 333 }\r