Formatting changes
[jalview.git] / src / jalview / io / MSFfile.java
index 2a6e10f..5f81215 100755 (executable)
@@ -27,24 +27,54 @@ import java.io.*;
 import java.util.*;\r
 \r
 \r
-public class MSFfile extends AlignFile {\r
+/**\r
+ * DOCUMENT ME!\r
+ *\r
+ * @author $author$\r
+ * @version $Revision$\r
+ */\r
+public class MSFfile extends AlignFile\r
+{\r
     private static com.stevesoft.pat.Regex gapre = new com.stevesoft.pat.Regex("\\~",\r
             "-");\r
     private static com.stevesoft.pat.Regex re2gap = new com.stevesoft.pat.Regex(\r
             "[" + jalview.util.Comparison.GapChars + "]", "\\~");\r
 \r
-    public MSFfile() {\r
+    /**\r
+     * Creates a new MSFfile object.\r
+     */\r
+    public MSFfile()\r
+    {\r
     }\r
 \r
-    public MSFfile(String inStr) {\r
+    /**\r
+     * Creates a new MSFfile object.\r
+     *\r
+     * @param inStr DOCUMENT ME!\r
+     */\r
+    public MSFfile(String inStr)\r
+    {\r
         super(inStr);\r
     }\r
 \r
-    public MSFfile(String inFile, String type) throws IOException {\r
+    /**\r
+     * Creates a new MSFfile object.\r
+     *\r
+     * @param inFile DOCUMENT ME!\r
+     * @param type DOCUMENT ME!\r
+     *\r
+     * @throws IOException DOCUMENT ME!\r
+     */\r
+    public MSFfile(String inFile, String type) throws IOException\r
+    {\r
         super(inFile, type);\r
     }\r
 \r
-    public void parse() {\r
+    /**\r
+     * DOCUMENT ME!\r
+     */\r
+    public void parse()\r
+    {\r
         int i = 0;\r
         boolean seqFlag = false;\r
         String key = new String();\r
@@ -52,48 +82,60 @@ public class MSFfile extends AlignFile {
         Hashtable seqhash = new Hashtable();\r
         String line;\r
 \r
-        try {\r
-            while ((line = nextLine()) != null) {\r
+        try\r
+        {\r
+            while ((line = nextLine()) != null)\r
+            {\r
                 StringTokenizer str = new StringTokenizer(line);\r
 \r
-                while (str.hasMoreTokens()) {\r
+                while (str.hasMoreTokens())\r
+                {\r
                     String inStr = str.nextToken();\r
 \r
                     //If line has header information add to the headers vector\r
-                    if (inStr.indexOf("Name:") != -1) {\r
+                    if (inStr.indexOf("Name:") != -1)\r
+                    {\r
                         key = str.nextToken();\r
                         headers.addElement(key);\r
                     }\r
 \r
                     //if line has // set SeqFlag to 1 so we know sequences are coming\r
-                    if (inStr.indexOf("//") != -1) {\r
+                    if (inStr.indexOf("//") != -1)\r
+                    {\r
                         seqFlag = true;\r
                     }\r
 \r
                     //Process lines as sequence lines if seqFlag is set\r
-                    if ((inStr.indexOf("//") == -1) && (seqFlag == true)) {\r
+                    if ((inStr.indexOf("//") == -1) && (seqFlag == true))\r
+                    {\r
                         //seqeunce id is the first field\r
                         key = inStr;\r
 \r
                         StringBuffer tempseq;\r
 \r
                         //Get sequence from hash if it exists\r
-                        if (seqhash.containsKey(key)) {\r
+                        if (seqhash.containsKey(key))\r
+                        {\r
                             tempseq = (StringBuffer) seqhash.get(key);\r
-                        } else {\r
+                        }\r
+                        else\r
+                        {\r
                             tempseq = new StringBuffer();\r
                             seqhash.put(key, tempseq);\r
                         }\r
 \r
                         //loop through the rest of the words\r
-                        while (str.hasMoreTokens()) {\r
+                        while (str.hasMoreTokens())\r
+                        {\r
                             //append the word to the sequence\r
                             tempseq.append(str.nextToken());\r
                         }\r
                     }\r
                 }\r
             }\r
-        } catch (IOException e) {\r
+        }\r
+        catch (IOException e)\r
+        {\r
             System.err.println("Exception parsing MSFFile " + e);\r
             e.printStackTrace();\r
         }\r
@@ -101,28 +143,34 @@ public class MSFfile extends AlignFile {
         this.noSeqs = headers.size();\r
 \r
         //Add sequences to the hash\r
-        for (i = 0; i < headers.size(); i++) {\r
-            if (seqhash.get(headers.elementAt(i)) != null) {\r
+        for (i = 0; i < headers.size(); i++)\r
+        {\r
+            if (seqhash.get(headers.elementAt(i)) != null)\r
+            {\r
                 String head = headers.elementAt(i).toString();\r
                 String seq = seqhash.get(head).toString();\r
 \r
                 int start = 1;\r
                 int end = seq.length();\r
 \r
-                if (maxLength < head.length()) {\r
+                if (maxLength < head.length())\r
+                {\r
                     maxLength = head.length();\r
                 }\r
 \r
-                if (head.indexOf("/") > 0) {\r
+                if (head.indexOf("/") > 0)\r
+                {\r
                     StringTokenizer st = new StringTokenizer(head, "/");\r
 \r
-                    if (st.countTokens() == 2) {\r
+                    if (st.countTokens() == 2)\r
+                    {\r
                         head = st.nextToken();\r
 \r
                         String tmp = st.nextToken();\r
                         st = new StringTokenizer(tmp, "-");\r
 \r
-                        if (st.countTokens() == 2) {\r
+                        if (st.countTokens() == 2)\r
+                        {\r
                             start = Integer.valueOf(st.nextToken()).intValue();\r
                             end = Integer.valueOf(st.nextToken()).intValue();\r
                         }\r
@@ -135,30 +183,44 @@ public class MSFfile extends AlignFile {
                 Sequence newSeq = new Sequence(head, seq, start, end);\r
 \r
                 seqs.addElement(newSeq);\r
-            } else {\r
+            }\r
+            else\r
+            {\r
                 System.err.println("MSFFile Parser: Can't find sequence for " +\r
                     headers.elementAt(i));\r
             }\r
         }\r
     }\r
 \r
-    public static int checkSum(String seq) {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param seq DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public static int checkSum(String seq)\r
+    {\r
         //String chars =  "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz.*~&@";\r
         int check = 0;\r
+        String sequence = seq.toUpperCase();\r
 \r
         String index = "--------------------------------------&---*---.-----------------@ABCDEFGHIJKLMNOPQRSTUVWXYZ------ABCDEFGHIJKLMNOPQRSTUVWXYZ----@";\r
-        index += "--------------------------------------------------------------------------------------------------------------------------------";\r
+        index +=       "--------------------------------------------------------------------------------------------------------------------------------";\r
 \r
-        for (int i = 0; i < seq.length(); i++) {\r
-            try {\r
-                if (i < seq.length()) {\r
-                    int pos = index.indexOf(seq.substring(i, i + 1));\r
+        for (int i = 0; i < sequence.length(); i++)\r
+        {\r
+            try\r
+            {\r
+                    int pos = index.indexOf(sequence.charAt(i));\r
 \r
-                    if (!index.substring(pos, pos + 1).equals("_")) {\r
+                    if (index.charAt(pos)!='_')\r
+                    {\r
                         check += (((i % 57) + 1) * pos);\r
                     }\r
-                }\r
-            } catch (Exception e) {\r
+            }\r
+            catch (Exception e)\r
+            {\r
                 System.err.println("Exception during MSF Checksum calculation");\r
                 e.printStackTrace();\r
             }\r
@@ -167,11 +229,28 @@ public class MSFfile extends AlignFile {
         return check % 10000;\r
     }\r
 \r
-    public static String print(SequenceI[] s) {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param s DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public static String print(SequenceI[] s)\r
+    {\r
         return print(s, false);\r
     }\r
 \r
-    public static String print(SequenceI[] s, boolean is_NA) {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param s DOCUMENT ME!\r
+     * @param is_NA DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public static String print(SequenceI[] s, boolean is_NA)\r
+    {\r
         StringBuffer out = new StringBuffer("!!" + (is_NA ? "NA" : "AA") +\r
                 "_MULTIPLE_ALIGNMENT 1.0\n\n"); // TODO: JBPNote : Jalview doesn't remember NA or AA yet.\r
 \r
@@ -180,11 +259,13 @@ public class MSFfile extends AlignFile {
         int i = 0;\r
         String big = "";\r
 \r
-        while ((i < s.length) && (s[i] != null)) {\r
+        while ((i < s.length) && (s[i] != null))\r
+        {\r
             String sq;\r
             big += (sq = s[i].getSequence());\r
 \r
-            if (sq.length() > max) {\r
+            if (sq.length() > max)\r
+            {\r
                 max = sq.length();\r
             }\r
 \r
@@ -205,8 +286,8 @@ public class MSFfile extends AlignFile {
         String[] nameBlock = new String[s.length];\r
         String[] idBlock = new String[s.length];\r
 \r
-        while ((i < s.length) && (s[i] != null)) {\r
-            String seq = s[i].getSequence();\r
+        while ((i < s.length) && (s[i] != null))\r
+        {\r
             String name = s[i].getName() + "/" + s[i].getStart() + "-" +\r
                 s[i].getEnd();\r
             int check = checkSum(s[i].getSequence());\r
@@ -215,28 +296,33 @@ public class MSFfile extends AlignFile {
                     maxLenpad.form(s[i].getSequence().length()) + "  Check:" +\r
                     maxChkpad.form(check) + "  Weight: 1.00\n");\r
 \r
-            if (name.length() > maxid) {\r
+            if (name.length() > maxid)\r
+            {\r
                 maxid = name.length();\r
             }\r
 \r
-            if (nameBlock[i].length() > maxNB) {\r
+            if (nameBlock[i].length() > maxNB)\r
+            {\r
                 maxNB = nameBlock[i].length();\r
             }\r
 \r
             i++;\r
         }\r
 \r
-        if (maxid < 10) {\r
+        if (maxid < 10)\r
+        {\r
             maxid = 10;\r
         }\r
 \r
-        if (maxNB < 15) {\r
+        if (maxNB < 15)\r
+        {\r
             maxNB = 15;\r
         }\r
 \r
         Format nbFormat = new Format("%-" + maxNB + "s");\r
 \r
-        for (i = 0; (i < s.length) && (s[i] != null); i++) {\r
+        for (i = 0; (i < s.length) && (s[i] != null); i++)\r
+        {\r
             out.append(nbFormat.form(nameBlock[i]) + idBlock[i]);\r
         }\r
 \r
@@ -247,39 +333,53 @@ public class MSFfile extends AlignFile {
 \r
         int nochunks = (max / len) + 1;\r
 \r
-        if ((max % len) == 0) {\r
+        if ((max % len) == 0)\r
+        {\r
             nochunks--;\r
         }\r
 \r
-        for (i = 0; i < nochunks; i++) {\r
+        for (i = 0; i < nochunks; i++)\r
+        {\r
             int j = 0;\r
 \r
-            while ((j < s.length) && (s[j] != null)) {\r
+            while ((j < s.length) && (s[j] != null))\r
+            {\r
                 String name = s[j].getName();\r
                 out.append(new Format("%-" + maxid + "s").form(name + "/" +\r
                         s[j].getStart() + "-" + s[j].getEnd()) + " ");\r
 \r
-                for (int k = 0; k < 5; k++) {\r
+                for (int k = 0; k < 5; k++)\r
+                {\r
                     int start = (i * 50) + (k * 10);\r
                     int end = start + 10;\r
 \r
                     if ((end < s[j].getSequence().length()) &&\r
-                            (start < s[j].getSequence().length())) {\r
+                            (start < s[j].getSequence().length()))\r
+                    {\r
                         out.append(re2gap.replaceAll(s[j].getSequence()\r
                                                          .substring(start, end)));\r
 \r
-                        if (k < 4) {\r
+                        if (k < 4)\r
+                        {\r
                             // out.append(" ");\r
-                        } else {\r
+                        }\r
+                        else\r
+                        {\r
                             out.append("\n");\r
                         }\r
-                    } else {\r
-                        if (start < s[j].getSequence().length()) {\r
+                    }\r
+                    else\r
+                    {\r
+                        if (start < s[j].getSequence().length())\r
+                        {\r
                             out.append(re2gap.replaceAll(\r
                                     s[j].getSequence().substring(start)));\r
                             out.append("\n");\r
-                        } else {\r
-                            if (k == 0) {\r
+                        }\r
+                        else\r
+                        {\r
+                            if (k == 0)\r
+                            {\r
                                 out.append("\n");\r
                             }\r
                         }\r
@@ -295,7 +395,13 @@ public class MSFfile extends AlignFile {
         return out.toString();\r
     }\r
 \r
-    public String print() {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public String print()\r
+    {\r
         return print(getSeqsAsArray());\r
     }\r
 }\r