src/jalview/io/MSFfile.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.io;\r
  20 \r
  21 import jalview.datamodel.*;\r
  22 \r
  23 import jalview.util.*;\r
  24 \r
  25 import java.io.*;\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 MSFfile extends AlignFile\r
  37 {\r
  38 \r
  39 \r
  40     /**\r
  41      * Creates a new MSFfile object.\r
  42      */\r
  43     public MSFfile()\r
  44     {\r
  45     }\r
  46 \r
  47     /**\r
  48      * Creates a new MSFfile object.\r
  49      *\r
  50      * @param inStr DOCUMENT ME!\r
  51      */\r
  52     public MSFfile(String inStr)\r
  53     {\r
  54         super(inStr);\r
  55     }\r
  56 \r
  57     /**\r
  58      * Creates a new MSFfile object.\r
  59      *\r
  60      * @param inFile DOCUMENT ME!\r
  61      * @param type DOCUMENT ME!\r
  62      *\r
  63      * @throws IOException DOCUMENT ME!\r
  64      */\r
  65     public MSFfile(String inFile, String type) throws IOException\r
  66     {\r
  67         super(inFile, type);\r
  68     }\r
  69 \r
  70     /**\r
  71      * DOCUMENT ME!\r
  72      */\r
  73     public void parse()\r
  74     {\r
  75         int i = 0;\r
  76         boolean seqFlag = false;\r
  77         String key = new String();\r
  78         Vector headers = new Vector();\r
  79         Hashtable seqhash = new Hashtable();\r
  80         String line;\r
  81 \r
  82         try\r
  83         {\r
  84             while ((line = nextLine()) != null)\r
  85             {\r
  86                 StringTokenizer str = new StringTokenizer(line);\r
  87 \r
  88                 while (str.hasMoreTokens())\r
  89                 {\r
  90                     String inStr = str.nextToken();\r
  91 \r
  92                     //If line has header information add to the headers vector\r
  93                     if (inStr.indexOf("Name:") != -1)\r
  94                     {\r
  95                         key = str.nextToken();\r
  96                         headers.addElement(key);\r
  97                     }\r
  98 \r
  99                     //if line has // set SeqFlag to 1 so we know sequences are coming\r
 100                     if (inStr.indexOf("//") != -1)\r
 101                     {\r
 102                         seqFlag = true;\r
 103                     }\r
 104 \r
 105                     //Process lines as sequence lines if seqFlag is set\r
 106                     if ((inStr.indexOf("//") == -1) && (seqFlag == true))\r
 107                     {\r
 108                         //seqeunce id is the first field\r
 109                         key = inStr;\r
 110 \r
 111                         StringBuffer tempseq;\r
 112 \r
 113                         //Get sequence from hash if it exists\r
 114                         if (seqhash.containsKey(key))\r
 115                         {\r
 116                             tempseq = (StringBuffer) seqhash.get(key);\r
 117                         }\r
 118                         else\r
 119                         {\r
 120                             tempseq = new StringBuffer();\r
 121                             seqhash.put(key, tempseq);\r
 122                         }\r
 123 \r
 124                         //loop through the rest of the words\r
 125                         while (str.hasMoreTokens())\r
 126                         {\r
 127                             //append the word to the sequence\r
 128                             tempseq.append(str.nextToken());\r
 129                         }\r
 130                     }\r
 131                 }\r
 132             }\r
 133         }\r
 134         catch (IOException e)\r
 135         {\r
 136             System.err.println("Exception parsing MSFFile " + e);\r
 137             e.printStackTrace();\r
 138         }\r
 139 \r
 140         this.noSeqs = headers.size();\r
 141 \r
 142         //Add sequences to the hash\r
 143         for (i = 0; i < headers.size(); i++)\r
 144         {\r
 145             if (seqhash.get(headers.elementAt(i)) != null)\r
 146             {\r
 147                 String head = headers.elementAt(i).toString();\r
 148                 String seq = seqhash.get(head).toString();\r
 149 \r
 150                 int start = -1;\r
 151                 int end =  -1;\r
 152 \r
 153                 if (maxLength < head.length())\r
 154                 {\r
 155                     maxLength = head.length();\r
 156                 }\r
 157 \r
 158                 // Replace ~ with a sensible gap character\r
 159                 seq = seq.replace('~', '-');\r
 160 \r
 161                 Sequence newSeq = parseId(head);\r
 162                 newSeq.setSequence(seq);\r
 163 \r
 164                 seqs.addElement(newSeq);\r
 165             }\r
 166             else\r
 167             {\r
 168                 System.err.println("MSFFile Parser: Can't find sequence for " +\r
 169                     headers.elementAt(i));\r
 170             }\r
 171         }\r
 172     }\r
 173 \r
 174     /**\r
 175      * DOCUMENT ME!\r
 176      *\r
 177      * @param seq DOCUMENT ME!\r
 178      *\r
 179      * @return DOCUMENT ME!\r
 180      */\r
 181     public int checkSum(String seq)\r
 182     {\r
 183         int check = 0;\r
 184         String sequence = seq.toUpperCase();\r
 185 \r
 186         for (int i = 0; i < sequence.length(); i++)\r
 187         {\r
 188             try\r
 189             {\r
 190 \r
 191                     int value = sequence.charAt(i);\r
 192                     if (value!=-1)\r
 193                     {\r
 194                         check += (i % 57 +1) * value;\r
 195                     }\r
 196             }\r
 197             catch (Exception e)\r
 198             {\r
 199                 System.err.println("Exception during MSF Checksum calculation");\r
 200                 e.printStackTrace();\r
 201             }\r
 202         }\r
 203 \r
 204         return check % 10000;\r
 205     }\r
 206 \r
 207 \r
 208     /**\r
 209      * DOCUMENT ME!\r
 210      *\r
 211      * @param s DOCUMENT ME!\r
 212      * @param is_NA DOCUMENT ME!\r
 213      *\r
 214      * @return DOCUMENT ME!\r
 215      */\r
 216     public String print(SequenceI[] seqs)\r
 217     {\r
 218 \r
 219       boolean is_NA = jalview.util.Comparison.isNucleotide(seqs);\r
 220 \r
 221       SequenceI [] s = new SequenceI[seqs.length];\r
 222 \r
 223         StringBuffer out = new StringBuffer("!!" + (is_NA ? "NA" : "AA") +\r
 224                 "_MULTIPLE_ALIGNMENT 1.0\n\n"); // TODO: JBPNote : Jalview doesn't remember NA or AA yet.\r
 225 \r
 226         int max = 0;\r
 227         int maxid = 0;\r
 228         int i = 0;\r
 229 \r
 230         while ((i < seqs.length) && (seqs[i] != null))\r
 231         {\r
 232           // Replace all internal gaps with . and external spaces with ~\r
 233           s[i] =new Sequence(seqs[i].getName(),seqs[i].getSequence().replace('-', '.'));\r
 234 \r
 235           StringBuffer sb = new StringBuffer(s[i].getSequence());\r
 236           for (int ii = 0; ii < sb.length(); ii++)\r
 237           {\r
 238             if (sb.charAt(ii) == '.')\r
 239             {\r
 240               sb.setCharAt(ii, '~');\r
 241             }\r
 242             else\r
 243               break;\r
 244           }\r
 245 \r
 246           for (int ii = sb.length() - 1; ii > 0; ii--)\r
 247           {\r
 248             if (sb.charAt(ii) == '.')\r
 249             {\r
 250               sb.setCharAt(ii,'~');\r
 251             }\r
 252             else\r
 253               break;\r
 254           }\r
 255 \r
 256             s[i].setSequence(sb.toString());\r
 257 \r
 258             if (s[i].getSequence().length() > max)\r
 259             {\r
 260                 max = s[i].getSequence().length();\r
 261             }\r
 262 \r
 263             i++;\r
 264         }\r
 265 \r
 266         Format maxLenpad = new Format("%" + (new String("" + max)).length() +\r
 267                 "d");\r
 268         Format maxChkpad = new Format("%" + (new String("1" + max)).length() +\r
 269                 "d");\r
 270         i = 0;\r
 271 \r
 272         int bigChecksum = 0;\r
 273         int [] checksums = new int[s.length];\r
 274         while ( i < s.length )\r
 275         {\r
 276           checksums[i] = checkSum(s[i].getSequence());\r
 277           bigChecksum += checksums[i];\r
 278           i++;\r
 279         }\r
 280 \r
 281         long maxNB = 0;\r
 282         out.append("   MSF: " + s[0].getSequence().length() + "   Type: " +\r
 283             (is_NA ? "N" : "P") + "    Check:  " + (bigChecksum%10000) + "   ..\n\n\n");\r
 284 \r
 285         String[] nameBlock = new String[s.length];\r
 286         String[] idBlock = new String[s.length];\r
 287 \r
 288         i=0;\r
 289         while ((i < s.length) && (s[i] != null))\r
 290         {\r
 291 \r
 292             nameBlock[i] = new String("  Name: " + printId(s[i])+" ");\r
 293 \r
 294             idBlock[i] = new String("Len: " +\r
 295                     maxLenpad.form(s[i].getSequence().length()) + "  Check: " +\r
 296                     maxChkpad.form(checksums[i]) + "  Weight: 1.00\n");\r
 297 \r
 298             if (s[i].getName().length() > maxid)\r
 299             {\r
 300                 maxid = s[i].getName().length();\r
 301             }\r
 302 \r
 303             if (nameBlock[i].length() > maxNB)\r
 304             {\r
 305                 maxNB = nameBlock[i].length();\r
 306             }\r
 307 \r
 308             i++;\r
 309         }\r
 310 \r
 311         if (maxid < 10)\r
 312         {\r
 313             maxid = 10;\r
 314         }\r
 315 \r
 316         if (maxNB < 15)\r
 317         {\r
 318             maxNB = 15;\r
 319         }\r
 320 \r
 321         Format nbFormat = new Format("%-" + maxNB + "s");\r
 322 \r
 323         for (i = 0; (i < s.length) && (s[i] != null); i++)\r
 324         {\r
 325             out.append(nbFormat.form(nameBlock[i]) + idBlock[i]);\r
 326         }\r
 327 \r
 328         maxid++;\r
 329         out.append("\n\n//\n\n");\r
 330 \r
 331         int len = 50;\r
 332 \r
 333         int nochunks = (max / len) + 1;\r
 334 \r
 335         if ((max % len) == 0)\r
 336         {\r
 337             nochunks--;\r
 338         }\r
 339 \r
 340         for (i = 0; i < nochunks; i++)\r
 341         {\r
 342             int j = 0;\r
 343 \r
 344             while ((j < s.length) && (s[j] != null))\r
 345             {\r
 346                 String name = printId( s[j] );\r
 347 \r
 348                 out.append(new Format("%-" + maxid + "s").form(name+" "));\r
 349 \r
 350 \r
 351                 for (int k = 0; k < 5; k++)\r
 352                 {\r
 353                     int start = (i * 50) + (k * 10);\r
 354                     int end = start + 10;\r
 355 \r
 356                     if ((end < s[j].getSequence().length()) &&\r
 357                             (start < s[j].getSequence().length()))\r
 358                     {\r
 359                         out.append(s[j].getSequence().substring(start, end));\r
 360 \r
 361                         if (k < 4)\r
 362                         {\r
 363                              out.append(" ");\r
 364                         }\r
 365                         else\r
 366                         {\r
 367                             out.append("\n");\r
 368                         }\r
 369                     }\r
 370                     else\r
 371                     {\r
 372                         if (start < s[j].getSequence().length())\r
 373                         {\r
 374                             out.append(s[j].getSequence().substring(start));\r
 375                             out.append("\n");\r
 376                         }\r
 377                         else\r
 378                         {\r
 379                             if (k == 0)\r
 380                             {\r
 381                                 out.append("\n");\r
 382                             }\r
 383                         }\r
 384                     }\r
 385                 }\r
 386 \r
 387                 j++;\r
 388             }\r
 389 \r
 390             out.append("\n");\r
 391         }\r
 392 \r
 393         return out.toString();\r
 394     }\r
 395 \r
 396     /**\r
 397      * DOCUMENT ME!\r
 398      *\r
 399      * @return DOCUMENT ME!\r
 400      */\r
 401     public String print()\r
 402     {\r
 403         return print(getSeqsAsArray());\r
 404     }\r
 405 }\r