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