src/jalview/datamodel/SequenceGroup.java

   1 /*\r
   2  * Jalview - A Sequence Alignment Editor and Viewer\r
   3  * Copyright (C) 2006 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.schemes.*;\r
  24 \r
  25 import java.awt.*;\r
  26 \r
  27 import java.util.*;\r
  28 \r
  29 \r
  30 /**\r
  31  * DOCUMENT ME!\r
  32  *\r
  33  * @author $author$\r
  34  * @version $Revision$\r
  35  */\r
  36 public class SequenceGroup\r
  37 {\r
  38     String groupName;\r
  39     String description;\r
  40     Conservation conserve;\r
  41     Vector aaFrequency;\r
  42     boolean displayBoxes = true;\r
  43     boolean displayText = true;\r
  44     boolean colourText = true;\r
  45     private Vector sequences = new Vector();\r
  46     int width = -1;\r
  47 \r
  48     /** DOCUMENT ME!! */\r
  49     public ColourSchemeI cs;\r
  50     int startRes = 0;\r
  51     int endRes = 0;\r
  52     Color outlineColour = Color.black;\r
  53     public int thresholdTextColour = 0;\r
  54     public Color textColour = Color.black;\r
  55     public Color textColour2 = Color.white;\r
  56 \r
  57 \r
  58     /**\r
  59      * Creates a new SequenceGroup object.\r
  60      */\r
  61     public SequenceGroup()\r
  62     {\r
  63         groupName = "JGroup:"+this.hashCode();\r
  64     }\r
  65 \r
  66     /**\r
  67      * Creates a new SequenceGroup object.\r
  68      *\r
  69      * @param sequences DOCUMENT ME!\r
  70      * @param groupName DOCUMENT ME!\r
  71      * @param scheme DOCUMENT ME!\r
  72      * @param displayBoxes DOCUMENT ME!\r
  73      * @param displayText DOCUMENT ME!\r
  74      * @param colourText DOCUMENT ME!\r
  75      * @param start DOCUMENT ME!\r
  76      * @param end DOCUMENT ME!\r
  77      */\r
  78     public SequenceGroup(Vector sequences, String groupName,\r
  79         ColourSchemeI scheme, boolean displayBoxes, boolean displayText,\r
  80         boolean colourText, int start, int end)\r
  81     {\r
  82         this.sequences = sequences;\r
  83         this.groupName = groupName;\r
  84         this.displayBoxes = displayBoxes;\r
  85         this.displayText = displayText;\r
  86         this.colourText = colourText;\r
  87         this.cs = scheme;\r
  88         startRes = start;\r
  89         endRes = end;\r
  90         recalcConservation();\r
  91     }\r
  92 \r
  93     public SequenceI [] getSelectionAsNewSequences(AlignmentI align)\r
  94     {\r
  95       int iSize = sequences.size();\r
  96       SequenceI [] seqs = new SequenceI[iSize];\r
  97       SequenceI [] inorder = getSequencesInOrder(align);\r
  98 \r
  99 \r
 100     for (int i = 0; i < iSize; i++)\r
 101     {\r
 102       SequenceI seq = inorder[i];\r
 103 \r
 104       seqs[i] = new Sequence(seq.getName(),\r
 105                              seq.getSequence(startRes, endRes + 1),\r
 106                              seq.findPosition(startRes),\r
 107                              findEndRes(seq));\r
 108 \r
 109       seqs[i].setDescription(seq.getDescription());\r
 110       seqs[i].setDBRef(seq.getDBRef());\r
 111       seqs[i].setSequenceFeatures(seq.getSequenceFeatures());\r
 112       if (seq.getDatasetSequence() != null)\r
 113         seqs[i].setDatasetSequence(seq.getDatasetSequence());\r
 114 \r
 115       if(seq.getAnnotation()!=null)\r
 116       {\r
 117         for(int a=0; a<seq.getAnnotation().length; a++)\r
 118           seqs[i].addAlignmentAnnotation(seq.getAnnotation()[a]);\r
 119       }\r
 120     }\r
 121 \r
 122     return seqs;\r
 123 \r
 124     }\r
 125 \r
 126     /**\r
 127      * If sequence ends in gaps, the end residue can\r
 128      * be correctly calculated here\r
 129      * @param seq SequenceI\r
 130      * @return int\r
 131      */\r
 132     public int findEndRes(SequenceI seq)\r
 133     {\r
 134       int eres = 0;\r
 135       char ch;\r
 136 \r
 137       for (int j = 0; j < endRes + 1 && j < seq.getLength(); j++)\r
 138       {\r
 139         ch = seq.getCharAt(j);\r
 140         if (!jalview.util.Comparison.isGap( (ch)))\r
 141         {\r
 142           eres++;\r
 143         }\r
 144       }\r
 145 \r
 146       if (eres > 0)\r
 147       {\r
 148         eres += seq.getStart() - 1;\r
 149       }\r
 150 \r
 151       return eres;\r
 152     }\r
 153 \r
 154     public Vector getSequences(Hashtable hiddenReps)\r
 155     {\r
 156       if(hiddenReps == null)\r
 157         return sequences;\r
 158       else\r
 159       {\r
 160         Vector allSequences = new Vector();\r
 161         SequenceI seq, seq2;\r
 162         for (int i = 0; i < sequences.size(); i++)\r
 163         {\r
 164           seq = (SequenceI) sequences.elementAt(i);\r
 165           allSequences.addElement(seq);\r
 166           if (hiddenReps.containsKey(seq) )\r
 167           {\r
 168             SequenceGroup hsg = (SequenceGroup)hiddenReps.get(seq);\r
 169             for (int h = 0; h < hsg.getSize(); h++)\r
 170             {\r
 171               seq2 = hsg.getSequenceAt(h);\r
 172               if (seq2 != seq\r
 173                   && !allSequences.contains(seq2))\r
 174                 allSequences.addElement(seq2);\r
 175             }\r
 176           }\r
 177         }\r
 178 \r
 179         return allSequences;\r
 180       }\r
 181     }\r
 182 \r
 183     public SequenceI[] getSequencesAsArray(Hashtable hiddenReps)\r
 184     {\r
 185       Vector tmp = getSequences(hiddenReps);\r
 186       if(tmp==null)\r
 187         return null;\r
 188       SequenceI [] result = new SequenceI[tmp.size()];\r
 189       for(int i=0; i<result.length; i++)\r
 190         result[i] = (SequenceI)tmp.elementAt(i);\r
 191 \r
 192       return result;\r
 193     }\r
 194 \r
 195     /**\r
 196      * DOCUMENT ME!\r
 197      *\r
 198      * @param col DOCUMENT ME!\r
 199      *\r
 200      * @return DOCUMENT ME!\r
 201      */\r
 202     public boolean adjustForRemoveLeft(int col)\r
 203     {\r
 204         // return value is true if the group still exists\r
 205         if (startRes >= col)\r
 206         {\r
 207             startRes = startRes - col;\r
 208         }\r
 209 \r
 210         if (endRes >= col)\r
 211         {\r
 212             endRes = endRes - col;\r
 213 \r
 214             if (startRes > endRes)\r
 215             {\r
 216                 startRes = 0;\r
 217             }\r
 218         }\r
 219         else\r
 220         {\r
 221             // must delete this group!!\r
 222             return false;\r
 223         }\r
 224 \r
 225         return true;\r
 226     }\r
 227 \r
 228     /**\r
 229      * DOCUMENT ME!\r
 230      *\r
 231      * @param col DOCUMENT ME!\r
 232      *\r
 233      * @return DOCUMENT ME!\r
 234      */\r
 235     public boolean adjustForRemoveRight(int col)\r
 236     {\r
 237         if (startRes > col)\r
 238         {\r
 239             // delete this group\r
 240             return false;\r
 241         }\r
 242 \r
 243         if (endRes >= col)\r
 244         {\r
 245             endRes = col;\r
 246         }\r
 247 \r
 248         return true;\r
 249     }\r
 250 \r
 251     /**\r
 252      * DOCUMENT ME!\r
 253      *\r
 254      * @return DOCUMENT ME!\r
 255      */\r
 256     public String getName()\r
 257     {\r
 258         return groupName;\r
 259     }\r
 260 \r
 261     public String getDescription()\r
 262     {\r
 263       return description;\r
 264     }\r
 265 \r
 266     /**\r
 267      * DOCUMENT ME!\r
 268      *\r
 269      * @param name DOCUMENT ME!\r
 270      */\r
 271     public void setName(String name)\r
 272     {\r
 273         groupName = name;\r
 274     }\r
 275 \r
 276     public void setDescription(String desc)\r
 277     {\r
 278       description = desc;\r
 279     }\r
 280 \r
 281     /**\r
 282      * DOCUMENT ME!\r
 283      *\r
 284      * @return DOCUMENT ME!\r
 285      */\r
 286     public Conservation getConservation()\r
 287     {\r
 288         return conserve;\r
 289     }\r
 290 \r
 291     /**\r
 292      * DOCUMENT ME!\r
 293      *\r
 294      * @param c DOCUMENT ME!\r
 295      */\r
 296     public void setConservation(Conservation c)\r
 297     {\r
 298         conserve = c;\r
 299     }\r
 300 \r
 301     /**\r
 302      * DOCUMENT ME!\r
 303      *\r
 304      * @param s DOCUMENT ME!\r
 305      * @param recalc DOCUMENT ME!\r
 306      */\r
 307     public void addSequence(SequenceI s, boolean recalc)\r
 308     {\r
 309         if (s!=null && !sequences.contains(s))\r
 310         {\r
 311             sequences.addElement(s);\r
 312         }\r
 313 \r
 314         if (recalc)\r
 315         {\r
 316             recalcConservation();\r
 317         }\r
 318     }\r
 319 \r
 320     /**\r
 321      * DOCUMENT ME!\r
 322      */\r
 323     public void recalcConservation()\r
 324     {\r
 325         if(cs == null)\r
 326           return;\r
 327 \r
 328         try\r
 329         {\r
 330           cs.setConsensus(AAFrequency.calculate(sequences, startRes, endRes+1));\r
 331 \r
 332           if (cs instanceof ClustalxColourScheme)\r
 333           {\r
 334             ( (ClustalxColourScheme) cs).resetClustalX(sequences, getWidth());\r
 335           }\r
 336 \r
 337           if (cs.conservationApplied())\r
 338           {\r
 339             Conservation c = new Conservation(groupName,\r
 340                                               ResidueProperties.propHash, 3, sequences,\r
 341                                               startRes, endRes+1);\r
 342             c.calculate();\r
 343             c.verdict(false, 25);\r
 344 \r
 345             cs.setConservation(c);\r
 346 \r
 347             if (cs instanceof ClustalxColourScheme)\r
 348             {\r
 349               ( (ClustalxColourScheme) cs).resetClustalX(sequences,\r
 350                                                          getWidth());\r
 351             }\r
 352           }\r
 353         }\r
 354         catch (java.lang.OutOfMemoryError err)\r
 355         {\r
 356           System.out.println("Out of memory loading groups: " + err);\r
 357         }\r
 358 \r
 359     }\r
 360 \r
 361     /**\r
 362      * DOCUMENT ME!\r
 363      *\r
 364      * @param s DOCUMENT ME!\r
 365      * @param recalc DOCUMENT ME!\r
 366      */\r
 367     public void addOrRemove(SequenceI s, boolean recalc)\r
 368     {\r
 369         if (sequences.contains(s))\r
 370         {\r
 371             deleteSequence(s, recalc);\r
 372         }\r
 373         else\r
 374         {\r
 375             addSequence(s, recalc);\r
 376         }\r
 377     }\r
 378 \r
 379     /**\r
 380      * DOCUMENT ME!\r
 381      *\r
 382      * @param s DOCUMENT ME!\r
 383      * @param recalc DOCUMENT ME!\r
 384      */\r
 385     public void deleteSequence(SequenceI s, boolean recalc)\r
 386     {\r
 387         sequences.removeElement(s);\r
 388 \r
 389         if (recalc)\r
 390         {\r
 391             recalcConservation();\r
 392         }\r
 393     }\r
 394 \r
 395     /**\r
 396      * DOCUMENT ME!\r
 397      *\r
 398      * @return DOCUMENT ME!\r
 399      */\r
 400     public int getStartRes()\r
 401     {\r
 402         return startRes;\r
 403     }\r
 404 \r
 405     /**\r
 406      * DOCUMENT ME!\r
 407      *\r
 408      * @return DOCUMENT ME!\r
 409      */\r
 410     public int getEndRes()\r
 411     {\r
 412         return endRes;\r
 413     }\r
 414 \r
 415     /**\r
 416      * DOCUMENT ME!\r
 417      *\r
 418      * @param i DOCUMENT ME!\r
 419      */\r
 420     public void setStartRes(int i)\r
 421     {\r
 422         startRes = i;\r
 423     }\r
 424 \r
 425     /**\r
 426      * DOCUMENT ME!\r
 427      *\r
 428      * @param i DOCUMENT ME!\r
 429      */\r
 430     public void setEndRes(int i)\r
 431     {\r
 432         endRes = i;\r
 433     }\r
 434 \r
 435     /**\r
 436      * DOCUMENT ME!\r
 437      *\r
 438      * @return DOCUMENT ME!\r
 439      */\r
 440     public int getSize()\r
 441     {\r
 442         return sequences.size();\r
 443     }\r
 444 \r
 445     /**\r
 446      * DOCUMENT ME!\r
 447      *\r
 448      * @param i DOCUMENT ME!\r
 449      *\r
 450      * @return DOCUMENT ME!\r
 451      */\r
 452     public SequenceI getSequenceAt(int i)\r
 453     {\r
 454         return (SequenceI) sequences.elementAt(i);\r
 455     }\r
 456 \r
 457     /**\r
 458      * DOCUMENT ME!\r
 459      *\r
 460      * @param state DOCUMENT ME!\r
 461      */\r
 462     public void setColourText(boolean state)\r
 463     {\r
 464         colourText = state;\r
 465     }\r
 466 \r
 467     /**\r
 468      * DOCUMENT ME!\r
 469      *\r
 470      * @return DOCUMENT ME!\r
 471      */\r
 472     public boolean getColourText()\r
 473     {\r
 474         return colourText;\r
 475     }\r
 476 \r
 477     /**\r
 478      * DOCUMENT ME!\r
 479      *\r
 480      * @param state DOCUMENT ME!\r
 481      */\r
 482     public void setDisplayText(boolean state)\r
 483     {\r
 484         displayText = state;\r
 485     }\r
 486 \r
 487     /**\r
 488      * DOCUMENT ME!\r
 489      *\r
 490      * @return DOCUMENT ME!\r
 491      */\r
 492     public boolean getDisplayText()\r
 493     {\r
 494         return displayText;\r
 495     }\r
 496 \r
 497     /**\r
 498      * DOCUMENT ME!\r
 499      *\r
 500      * @param state DOCUMENT ME!\r
 501      */\r
 502     public void setDisplayBoxes(boolean state)\r
 503     {\r
 504         displayBoxes = state;\r
 505     }\r
 506 \r
 507     /**\r
 508      * DOCUMENT ME!\r
 509      *\r
 510      * @return DOCUMENT ME!\r
 511      */\r
 512     public boolean getDisplayBoxes()\r
 513     {\r
 514         return displayBoxes;\r
 515     }\r
 516 \r
 517     /**\r
 518      * DOCUMENT ME!\r
 519      *\r
 520      * @return DOCUMENT ME!\r
 521      */\r
 522     public int getWidth()\r
 523     {\r
 524         // MC This needs to get reset when characters are inserted and deleted\r
 525         if (sequences.size() > 0)\r
 526         {\r
 527             width = ((SequenceI) sequences.elementAt(0)).getLength();\r
 528         }\r
 529 \r
 530         for (int i = 1; i < sequences.size(); i++)\r
 531         {\r
 532             SequenceI seq = (SequenceI) sequences.elementAt(i);\r
 533 \r
 534             if (seq.getLength() > width)\r
 535             {\r
 536                 width = seq.getLength();\r
 537             }\r
 538         }\r
 539 \r
 540         return width;\r
 541     }\r
 542 \r
 543     /**\r
 544      * DOCUMENT ME!\r
 545      *\r
 546      * @param c DOCUMENT ME!\r
 547      */\r
 548     public void setOutlineColour(Color c)\r
 549     {\r
 550         outlineColour = c;\r
 551     }\r
 552 \r
 553     /**\r
 554      * DOCUMENT ME!\r
 555      *\r
 556      * @return DOCUMENT ME!\r
 557      */\r
 558     public Color getOutlineColour()\r
 559     {\r
 560         return outlineColour;\r
 561     }\r
 562 \r
 563     /**\r
 564      *\r
 565      * returns the sequences in the group ordered by the ordering given by al\r
 566      *\r
 567      * @param al Alignment\r
 568      * @return SequenceI[]\r
 569      */\r
 570     public SequenceI[] getSequencesInOrder(AlignmentI al)\r
 571     {\r
 572         int sSize = sequences.size();\r
 573         int alHeight = al.getHeight();\r
 574 \r
 575         SequenceI[] seqs = new SequenceI[sSize];\r
 576 \r
 577         int index = 0;\r
 578         for (int i = 0; i < alHeight && index<sSize; i++)\r
 579         {\r
 580           if(sequences.contains( al.getSequenceAt(i) ) )\r
 581             seqs[index++] = al.getSequenceAt(i);\r
 582         }\r
 583 \r
 584         return seqs;\r
 585     }\r
 586 }\r