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() throws IOException\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                 if (maxLength < head.length())\r
 151                 {\r
 152                     maxLength = head.length();\r
 153                 }\r
 154 \r
 155                 // Replace ~ with a sensible gap character\r
 156                 seq = seq.replace('~', '-');\r
 157                 if (!isValidProteinSequence(seq))\r
 158                 {\r
 159                     throw new IOException(AppletFormatAdapter.\r
 160                                           INVALID_CHARACTERS\r
 161                                           + " : " + head\r
 162                                           + " : " + invalidCharacter);\r
 163                 }\r
 164 \r
 165 \r
 166                 Sequence newSeq = parseId(head);\r
 167 \r
 168                 newSeq.setSequence(seq);\r
 169 \r
 170                 seqs.addElement(newSeq);\r
 171             }\r
 172             else\r
 173             {\r
 174                 System.err.println("MSFFile Parser: Can't find sequence for " +\r
 175                     headers.elementAt(i));\r
 176             }\r
 177         }\r
 178     }\r
 179 \r
 180     /**\r
 181      * DOCUMENT ME!\r
 182      *\r
 183      * @param seq DOCUMENT ME!\r
 184      *\r
 185      * @return DOCUMENT ME!\r
 186      */\r
 187     public int checkSum(String seq)\r
 188     {\r
 189         int check = 0;\r
 190         String sequence = seq.toUpperCase();\r
 191 \r
 192         for (int i = 0; i < sequence.length(); i++)\r
 193         {\r
 194             try\r
 195             {\r
 196 \r
 197                     int value = sequence.charAt(i);\r
 198                     if (value!=-1)\r
 199                     {\r
 200                         check += (i % 57 +1) * value;\r
 201                     }\r
 202             }\r
 203             catch (Exception e)\r
 204             {\r
 205                 System.err.println("Exception during MSF Checksum calculation");\r
 206                 e.printStackTrace();\r
 207             }\r
 208         }\r
 209 \r
 210         return check % 10000;\r
 211     }\r
 212 \r
 213 \r
 214     /**\r
 215      * DOCUMENT ME!\r
 216      *\r
 217      * @param s DOCUMENT ME!\r
 218      * @param is_NA DOCUMENT ME!\r
 219      *\r
 220      * @return DOCUMENT ME!\r
 221      */\r
 222     public String print(SequenceI[] seqs)\r
 223     {\r
 224 \r
 225       boolean is_NA = jalview.util.Comparison.isNucleotide(seqs);\r
 226 \r
 227       SequenceI [] s = new SequenceI[seqs.length];\r
 228 \r
 229         StringBuffer out = new StringBuffer("!!" + (is_NA ? "NA" : "AA") +\r
 230                 "_MULTIPLE_ALIGNMENT 1.0\n\n"); // TODO: JBPNote : Jalview doesn't remember NA or AA yet.\r
 231 \r
 232         int max = 0;\r
 233         int maxid = 0;\r
 234         int i = 0;\r
 235 \r
 236         while ((i < seqs.length) && (seqs[i] != null))\r
 237         {\r
 238           // Replace all internal gaps with . and external spaces with ~\r
 239           s[i] =new Sequence(seqs[i].getName(),seqs[i].getSequence().replace('-', '.'));\r
 240 \r
 241           StringBuffer sb = new StringBuffer(s[i].getSequence());\r
 242           for (int ii = 0; ii < sb.length(); ii++)\r
 243           {\r
 244             if (sb.charAt(ii) == '.')\r
 245             {\r
 246               sb.setCharAt(ii, '~');\r
 247             }\r
 248             else\r
 249               break;\r
 250           }\r
 251 \r
 252           for (int ii = sb.length() - 1; ii > 0; ii--)\r
 253           {\r
 254             if (sb.charAt(ii) == '.')\r
 255             {\r
 256               sb.setCharAt(ii,'~');\r
 257             }\r
 258             else\r
 259               break;\r
 260           }\r
 261 \r
 262             s[i].setSequence(sb.toString());\r
 263 \r
 264             if (s[i].getSequence().length() > max)\r
 265             {\r
 266                 max = s[i].getSequence().length();\r
 267             }\r
 268 \r
 269             i++;\r
 270         }\r
 271 \r
 272         Format maxLenpad = new Format("%" + (new String("" + max)).length() +\r
 273                 "d");\r
 274         Format maxChkpad = new Format("%" + (new String("1" + max)).length() +\r
 275                 "d");\r
 276         i = 0;\r
 277 \r
 278         int bigChecksum = 0;\r
 279         int [] checksums = new int[s.length];\r
 280         while ( i < s.length )\r
 281         {\r
 282           checksums[i] = checkSum(s[i].getSequence());\r
 283           bigChecksum += checksums[i];\r
 284           i++;\r
 285         }\r
 286 \r
 287         long maxNB = 0;\r
 288         out.append("   MSF: " + s[0].getSequence().length() + "   Type: " +\r
 289             (is_NA ? "N" : "P") + "    Check:  " + (bigChecksum%10000) + "   ..\n\n\n");\r
 290 \r
 291         String[] nameBlock = new String[s.length];\r
 292         String[] idBlock = new String[s.length];\r
 293 \r
 294         i=0;\r
 295         while ((i < s.length) && (s[i] != null))\r
 296         {\r
 297 \r
 298             nameBlock[i] = new String("  Name: " + printId(s[i])+" ");\r
 299 \r
 300             idBlock[i] = new String("Len: " +\r
 301                     maxLenpad.form(s[i].getSequence().length()) + "  Check: " +\r
 302                     maxChkpad.form(checksums[i]) + "  Weight: 1.00\n");\r
 303 \r
 304             if (s[i].getName().length() > maxid)\r
 305             {\r
 306                 maxid = s[i].getName().length();\r
 307             }\r
 308 \r
 309             if (nameBlock[i].length() > maxNB)\r
 310             {\r
 311                 maxNB = nameBlock[i].length();\r
 312             }\r
 313 \r
 314             i++;\r
 315         }\r
 316 \r
 317         if (maxid < 10)\r
 318         {\r
 319             maxid = 10;\r
 320         }\r
 321 \r
 322         if (maxNB < 15)\r
 323         {\r
 324             maxNB = 15;\r
 325         }\r
 326 \r
 327         Format nbFormat = new Format("%-" + maxNB + "s");\r
 328 \r
 329         for (i = 0; (i < s.length) && (s[i] != null); i++)\r
 330         {\r
 331             out.append(nbFormat.form(nameBlock[i]) + idBlock[i]);\r
 332         }\r
 333 \r
 334         maxid++;\r
 335         out.append("\n\n//\n\n");\r
 336 \r
 337         int len = 50;\r
 338 \r
 339         int nochunks = (max / len) + 1;\r
 340 \r
 341         if ((max % len) == 0)\r
 342         {\r
 343             nochunks--;\r
 344         }\r
 345 \r
 346         for (i = 0; i < nochunks; i++)\r
 347         {\r
 348             int j = 0;\r
 349 \r
 350             while ((j < s.length) && (s[j] != null))\r
 351             {\r
 352                 String name = printId( s[j] );\r
 353 \r
 354                 out.append(new Format("%-" + maxid + "s").form(name+" "));\r
 355 \r
 356 \r
 357                 for (int k = 0; k < 5; k++)\r
 358                 {\r
 359                     int start = (i * 50) + (k * 10);\r
 360                     int end = start + 10;\r
 361 \r
 362                     if ((end < s[j].getSequence().length()) &&\r
 363                             (start < s[j].getSequence().length()))\r
 364                     {\r
 365                         out.append(s[j].getSequence().substring(start, end));\r
 366 \r
 367                         if (k < 4)\r
 368                         {\r
 369                              out.append(" ");\r
 370                         }\r
 371                         else\r
 372                         {\r
 373                             out.append("\n");\r
 374                         }\r
 375                     }\r
 376                     else\r
 377                     {\r
 378                         if (start < s[j].getSequence().length())\r
 379                         {\r
 380                             out.append(s[j].getSequence().substring(start));\r
 381                             out.append("\n");\r
 382                         }\r
 383                         else\r
 384                         {\r
 385                             if (k == 0)\r
 386                             {\r
 387                                 out.append("\n");\r
 388                             }\r
 389                         }\r
 390                     }\r
 391                 }\r
 392 \r
 393                 j++;\r
 394             }\r
 395 \r
 396             out.append("\n");\r
 397         }\r
 398 \r
 399         return out.toString();\r
 400     }\r
 401 \r
 402     /**\r
 403      * DOCUMENT ME!\r
 404      *\r
 405      * @return DOCUMENT ME!\r
 406      */\r
 407     public String print()\r
 408     {\r
 409         return print(getSeqsAsArray());\r
 410     }\r
 411 }\r