JAL-1645 Version-Rel Version 2.9 Year-Rel 2015 Licensing glob
[jalview.git] / src / jalview / io / MSFfile.java
index e2d3704..67ace7c 100755 (executable)
@@ -1,37 +1,41 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer
- * Copyright (C) 2007 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9)
+ * Copyright (C) 2015 The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3
  * of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
+ *  
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 package jalview.io;
 
-import java.io.*;
-import java.util.*;
+import jalview.datamodel.Sequence;
+import jalview.datamodel.SequenceI;
+import jalview.util.Format;
 
-import jalview.datamodel.*;
-import jalview.util.*;
+import java.io.IOException;
+import java.util.Hashtable;
+import java.util.StringTokenizer;
+import java.util.Vector;
 
 /**
  * DOCUMENT ME!
- *
+ * 
  * @author $author$
  * @version $Revision$
  */
-public class MSFfile
-    extends AlignFile
+public class MSFfile extends AlignFile
 {
 
   /**
@@ -43,14 +47,16 @@ public class MSFfile
 
   /**
    * Creates a new MSFfile object.
-   *
-   * @param inFile DOCUMENT ME!
-   * @param type DOCUMENT ME!
-   *
-   * @throws IOException DOCUMENT ME!
+   * 
+   * @param inFile
+   *          DOCUMENT ME!
+   * @param type
+   *          DOCUMENT ME!
+   * 
+   * @throws IOException
+   *           DOCUMENT ME!
    */
-  public MSFfile(String inFile, String type)
-      throws IOException
+  public MSFfile(String inFile, String type) throws IOException
   {
     super(inFile, type);
   }
@@ -59,15 +65,11 @@ public class MSFfile
   {
     super(source);
   }
-{
-    // TODO Auto-generated constructor stub
-  }
 
   /**
    * DOCUMENT ME!
    */
-  public void parse()
-      throws IOException
+  public void parse() throws IOException
   {
     int i = 0;
     boolean seqFlag = false;
@@ -78,7 +80,7 @@ public class MSFfile
 
     try
     {
-      while ( (line = nextLine()) != null)
+      while ((line = nextLine()) != null)
       {
         StringTokenizer str = new StringTokenizer(line);
 
@@ -86,28 +88,28 @@ public class MSFfile
         {
           String inStr = str.nextToken();
 
-          //If line has header information add to the headers vector
+          // If line has header information add to the headers vector
           if (inStr.indexOf("Name:") != -1)
           {
             key = str.nextToken();
             headers.addElement(key);
           }
 
-          //if line has // set SeqFlag to 1 so we know sequences are coming
+          // if line has // set SeqFlag to 1 so we know sequences are coming
           if (inStr.indexOf("//") != -1)
           {
             seqFlag = true;
           }
 
-          //Process lines as sequence lines if seqFlag is set
-          if ( (inStr.indexOf("//") == -1) && (seqFlag == true))
+          // Process lines as sequence lines if seqFlag is set
+          if ((inStr.indexOf("//") == -1) && (seqFlag == true))
           {
-            //seqeunce id is the first field
+            // seqeunce id is the first field
             key = inStr;
 
             StringBuffer tempseq;
 
-            //Get sequence from hash if it exists
+            // Get sequence from hash if it exists
             if (seqhash.containsKey(key))
             {
               tempseq = (StringBuffer) seqhash.get(key);
@@ -118,17 +120,16 @@ public class MSFfile
               seqhash.put(key, tempseq);
             }
 
-            //loop through the rest of the words
+            // loop through the rest of the words
             while (str.hasMoreTokens())
             {
-              //append the word to the sequence
+              // append the word to the sequence
               tempseq.append(str.nextToken());
             }
           }
         }
       }
-    }
-    catch (IOException e)
+    } catch (IOException e)
     {
       System.err.println("Exception parsing MSFFile " + e);
       e.printStackTrace();
@@ -136,7 +137,7 @@ public class MSFfile
 
     this.noSeqs = headers.size();
 
-    //Add sequences to the hash
+    // Add sequences to the hash
     for (i = 0; i < headers.size(); i++)
     {
       if (seqhash.get(headers.elementAt(i)) != null)
@@ -160,17 +161,18 @@ public class MSFfile
       }
       else
       {
-        System.err.println("MSFFile Parser: Can't find sequence for " +
-                           headers.elementAt(i));
+        System.err.println("MSFFile Parser: Can't find sequence for "
+                + headers.elementAt(i));
       }
     }
   }
 
   /**
    * DOCUMENT ME!
-   *
-   * @param seq DOCUMENT ME!
-   *
+   * 
+   * @param seq
+   *          DOCUMENT ME!
+   * 
    * @return DOCUMENT ME!
    */
   public int checkSum(String seq)
@@ -188,8 +190,7 @@ public class MSFfile
         {
           check += (i % 57 + 1) * value;
         }
-      }
-      catch (Exception e)
+      } catch (Exception e)
       {
         System.err.println("Exception during MSF Checksum calculation");
         e.printStackTrace();
@@ -201,10 +202,12 @@ public class MSFfile
 
   /**
    * DOCUMENT ME!
-   *
-   * @param s DOCUMENT ME!
-   * @param is_NA DOCUMENT ME!
-   *
+   * 
+   * @param s
+   *          DOCUMENT ME!
+   * @param is_NA
+   *          DOCUMENT ME!
+   * 
    * @return DOCUMENT ME!
    */
   public String print(SequenceI[] seqs)
@@ -214,18 +217,20 @@ public class MSFfile
 
     SequenceI[] s = new SequenceI[seqs.length];
 
-    StringBuffer out = new StringBuffer("!!" + (is_NA ? "NA" : "AA") +
-                                        "_MULTIPLE_ALIGNMENT 1.0\n\n"); // TODO: JBPNote : Jalview doesn't remember NA or AA yet.
-
+    StringBuffer out = new StringBuffer("!!" + (is_NA ? "NA" : "AA")
+            + "_MULTIPLE_ALIGNMENT 1.0");
+    // TODO: JBPNote : Jalview doesn't remember NA or AA yet.
+    out.append(newline);
+    out.append(newline);
     int max = 0;
     int maxid = 0;
     int i = 0;
 
-    while ( (i < seqs.length) && (seqs[i] != null))
+    while ((i < seqs.length) && (seqs[i] != null))
     {
       // Replace all internal gaps with . and external spaces with ~
-      s[i] = new Sequence(seqs[i].getName(),
-                          seqs[i].getSequenceAsString().replace('-', '.'));
+      s[i] = new Sequence(seqs[i].getName(), seqs[i].getSequenceAsString()
+              .replace('-', '.'), seqs[i].getStart(), seqs[i].getEnd());
 
       StringBuffer sb = new StringBuffer();
       sb.append(s[i].getSequence());
@@ -264,10 +269,10 @@ public class MSFfile
       i++;
     }
 
-    Format maxLenpad = new Format("%" + (new String("" + max)).length() +
-                                  "d");
-    Format maxChkpad = new Format("%" + (new String("1" + max)).length() +
-                                  "d");
+    Format maxLenpad = new Format("%" + (new String("" + max)).length()
+            + "d");
+    Format maxChkpad = new Format("%" + (new String("1" + max)).length()
+            + "d");
     i = 0;
 
     int bigChecksum = 0;
@@ -280,23 +285,25 @@ public class MSFfile
     }
 
     long maxNB = 0;
-    out.append("   MSF: " + s[0].getSequence().length + "   Type: " +
-               (is_NA ? "N" : "P") + "    Check:  " + (bigChecksum % 10000) +
-               "   ..\n\n\n");
+    out.append("   MSF: " + s[0].getSequence().length + "   Type: "
+            + (is_NA ? "N" : "P") + "    Check:  " + (bigChecksum % 10000)
+            + "   ..");
+    out.append(newline);
+    out.append(newline);
+    out.append(newline);
 
     String[] nameBlock = new String[s.length];
     String[] idBlock = new String[s.length];
 
     i = 0;
-    while ( (i < s.length) && (s[i] != null))
+    while ((i < s.length) && (s[i] != null))
     {
 
       nameBlock[i] = new String("  Name: " + printId(s[i]) + " ");
 
-      idBlock[i] = new String("Len: " +
-                              maxLenpad.form(s[i].getSequence().length) +
-                              "  Check: " +
-                              maxChkpad.form(checksums[i]) + "  Weight: 1.00\n");
+      idBlock[i] = new String("Len: "
+              + maxLenpad.form(s[i].getSequence().length) + "  Check: "
+              + maxChkpad.form(checksums[i]) + "  Weight: 1.00" + newline);
 
       if (s[i].getName().length() > maxid)
       {
@@ -329,13 +336,16 @@ public class MSFfile
     }
 
     maxid++;
-    out.append("\n\n//\n\n");
-
+    out.append(newline);
+    out.append(newline);
+    out.append("//");
+    out.append(newline);
+    out.append(newline);
     int len = 50;
 
     int nochunks = (max / len) + 1;
 
-    if ( (max % len) == 0)
+    if ((max % len) == 0)
     {
       nochunks--;
     }
@@ -344,7 +354,7 @@ public class MSFfile
     {
       int j = 0;
 
-      while ( (j < s.length) && (s[j] != null))
+      while ((j < s.length) && (s[j] != null))
       {
         String name = printId(s[j]);
 
@@ -355,8 +365,8 @@ public class MSFfile
           int start = (i * 50) + (k * 10);
           int end = start + 10;
 
-          if ( (end < s[j].getSequence().length) &&
-              (start < s[j].getSequence().length))
+          if ((end < s[j].getSequence().length)
+                  && (start < s[j].getSequence().length))
           {
             out.append(s[j].getSequence(start, end));
 
@@ -366,7 +376,7 @@ public class MSFfile
             }
             else
             {
-              out.append("\n");
+              out.append(newline);
             }
           }
           else
@@ -374,13 +384,13 @@ public class MSFfile
             if (start < s[j].getSequence().length)
             {
               out.append(s[j].getSequenceAsString().substring(start));
-              out.append("\n");
+              out.append(newline);
             }
             else
             {
               if (k == 0)
               {
-                out.append("\n");
+                out.append(newline);
               }
             }
           }
@@ -389,7 +399,7 @@ public class MSFfile
         j++;
       }
 
-      out.append("\n");
+      out.append(newline);
     }
 
     return out.toString();
@@ -397,7 +407,7 @@ public class MSFfile
 
   /**
    * DOCUMENT ME!
-   *
+   * 
    * @return DOCUMENT ME!
    */
   public String print()