update author list in license for (JAL-826)
[jalview.git] / src / jalview / io / ClustalFile.java
index e3f83ee..1e198c4 100755 (executable)
-/*\r
- * Jalview - A Sequence Alignment Editor and Viewer\r
- * Copyright (C) 2006 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
- *\r
- * This program is free software; you can redistribute it and/or\r
- * modify it under the terms of the GNU General Public License\r
- * as published by the Free Software Foundation; either version 2\r
- * of the License, or (at your option) any later version.\r
- *\r
- * This program is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License\r
- * along with this program; if not, write to the Free Software\r
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
- */\r
-package jalview.io;\r
-\r
-import java.io.*;\r
-import java.util.*;\r
-\r
-import jalview.datamodel.*;\r
-import jalview.util.*;\r
-\r
-public class ClustalFile\r
-    extends AlignFile\r
-{\r
-\r
-  public ClustalFile()\r
-  {\r
-  }\r
-\r
-  public ClustalFile(String inFile, String type)\r
-      throws IOException\r
-  {\r
-    super(inFile, type);\r
-  }\r
-\r
-  public void initData()\r
-  {\r
-    super.initData();\r
-  }\r
-\r
-  public void parse() throws IOException\r
-  {\r
-    int i = 0;\r
-    boolean flag = false;\r
-\r
-    Vector headers = new Vector();\r
-    Hashtable seqhash = new Hashtable();\r
-    StringBuffer tempseq;\r
-    String line, id;\r
-    StringTokenizer str;\r
-\r
-    try\r
-    {\r
-      while ( (line = nextLine()) != null)\r
-      {\r
-        if (line.indexOf(" ") != 0)\r
-        {\r
-          str = new StringTokenizer(line, " ");\r
-\r
-          if (str.hasMoreTokens())\r
-          {\r
-            id = str.nextToken();\r
-\r
-            if (id.equalsIgnoreCase("CLUSTAL"))\r
-            {\r
-              flag = true;\r
-            }\r
-            else\r
-            {\r
-              if (flag)\r
-              {\r
-                if (seqhash.containsKey(id))\r
-                {\r
-                  tempseq = (StringBuffer) seqhash.get(id);\r
-                }\r
-                else\r
-                {\r
-                  tempseq = new StringBuffer();\r
-                  seqhash.put(id, tempseq);\r
-                }\r
-\r
-                if (! (headers.contains(id)))\r
-                {\r
-                  headers.addElement(id);\r
-                }\r
-\r
-                if (str.hasMoreTokens())\r
-                {\r
-                  tempseq.append(str.nextToken());\r
-                }\r
-              }\r
-            }\r
-          }\r
-          else\r
-            flag = true;\r
-        }\r
-      }\r
-    }\r
-    catch (IOException e)\r
-    {\r
-      System.err.println("Exception parsing clustal file " + e);\r
-      e.printStackTrace();\r
-    }\r
-\r
-    if (flag)\r
-    {\r
-      this.noSeqs = headers.size();\r
-\r
-      //Add sequences to the hash\r
-      for (i = 0; i < headers.size(); i++)\r
-      {\r
-        if (seqhash.get(headers.elementAt(i)) != null)\r
-        {\r
-          if (maxLength < seqhash.get(headers.elementAt(i)).toString()\r
-              .length())\r
-          {\r
-            maxLength = seqhash.get(headers.elementAt(i)).toString()\r
-                .length();\r
-          }\r
-\r
-          Sequence newSeq = parseId(headers.elementAt(i).toString());\r
-          newSeq.setSequence( seqhash.get(headers.elementAt(i).toString()).toString() );\r
-\r
-          if (!isValidProteinSequence(newSeq.getSequence()))\r
-          {\r
-              throw new IOException(AppletFormatAdapter.INVALID_CHARACTERS\r
-                                    + " : " + newSeq.getName()\r
-                                    + " : " + invalidCharacter);\r
-          }\r
-\r
-\r
-          seqs.addElement(newSeq);\r
-        }\r
-        else\r
-        {\r
-          System.err.println(\r
-              "Clustal File Reader: Can't find sequence for " +\r
-              headers.elementAt(i));\r
-        }\r
-      }\r
-    }\r
-  }\r
-\r
-  public String print()\r
-  {\r
-    return print(getSeqsAsArray());\r
-  }\r
-\r
-  public String print(SequenceI[] s)\r
-  {\r
-    StringBuffer out = new StringBuffer("CLUSTAL\n\n");\r
-\r
-    int max = 0;\r
-    int maxid = 0;\r
-\r
-    int i = 0;\r
-\r
-    while ( (i < s.length) && (s[i] != null))\r
-    {\r
-      String tmp = printId(s[i]);\r
-\r
-      if (s[i].getSequence().length() > max)\r
-      {\r
-        max = s[i].getSequence().length();\r
-      }\r
-\r
-      if (tmp.length() > maxid)\r
-      {\r
-        maxid = tmp.length();\r
-      }\r
-\r
-      i++;\r
-    }\r
-\r
-    if (maxid < 15)\r
-    {\r
-      maxid = 15;\r
-    }\r
-\r
-    maxid++;\r
-\r
-    int len = 60;\r
-    int nochunks = (max / len) + 1;\r
-\r
-    for (i = 0; i < nochunks; i++)\r
-    {\r
-      int j = 0;\r
-\r
-      while ( (j < s.length) && (s[j] != null))\r
-      {\r
-        out.append(new Format("%-" + maxid + "s").form( printId(s[j]) + " "));\r
-\r
-        int start = i * len;\r
-        int end = start + len;\r
-\r
-        if ( (end < s[j].getSequence().length()) &&\r
-            (start < s[j].getSequence().length()))\r
-        {\r
-          out.append(s[j].getSequence().substring(start, end));\r
-        }\r
-        else\r
-        {\r
-          if (start < s[j].getSequence().length())\r
-          {\r
-            out.append(s[j].getSequence().substring(start));\r
-          }\r
-        }\r
-\r
-        out.append("\n");\r
-        j++;\r
-      }\r
-\r
-      out.append("\n");\r
-    }\r
-\r
-    return out.toString();\r
-  }\r
-}\r
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
+ * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
+ * 
+ * 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.
+ * 
+ * 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 Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package jalview.io;
+
+import java.io.*;
+import java.util.*;
+
+import jalview.datamodel.*;
+import jalview.util.*;
+
+public class ClustalFile extends AlignFile
+{
+
+  public ClustalFile()
+  {
+  }
+
+  public ClustalFile(String inFile, String type) throws IOException
+  {
+    super(inFile, type);
+  }
+
+  public ClustalFile(FileParse source) throws IOException
+  {
+    super(source);
+  }
+
+  public void initData()
+  {
+    super.initData();
+  }
+
+  public void parse() throws IOException
+  {
+    int i = 0;
+    boolean flag = false;
+
+    Vector headers = new Vector();
+    Hashtable seqhash = new Hashtable();
+    StringBuffer tempseq;
+    String line, id;
+    StringTokenizer str;
+
+    try
+    {
+      while ((line = nextLine()) != null)
+      {
+        if (line.indexOf(" ") != 0)
+        {
+          str = new StringTokenizer(line, " ");
+
+          if (str.hasMoreTokens())
+          {
+            id = str.nextToken();
+
+            if (id.equalsIgnoreCase("CLUSTAL"))
+            {
+              flag = true;
+            }
+            else
+            {
+              if (flag)
+              {
+                if (seqhash.containsKey(id))
+                {
+                  tempseq = (StringBuffer) seqhash.get(id);
+                }
+                else
+                {
+                  tempseq = new StringBuffer();
+                  seqhash.put(id, tempseq);
+                }
+
+                if (!(headers.contains(id)))
+                {
+                  headers.addElement(id);
+                }
+
+                if (str.hasMoreTokens())
+                {
+                  tempseq.append(str.nextToken());
+                }
+              }
+            }
+          }
+          else
+          {
+            flag = true;
+          }
+        }
+      }
+    } catch (IOException e)
+    {
+      System.err.println("Exception parsing clustal file " + e);
+      e.printStackTrace();
+    }
+
+    if (flag)
+    {
+      this.noSeqs = headers.size();
+
+      // Add sequences to the hash
+      for (i = 0; i < headers.size(); i++)
+      {
+        if (seqhash.get(headers.elementAt(i)) != null)
+        {
+          if (maxLength < seqhash.get(headers.elementAt(i)).toString()
+                  .length())
+          {
+            maxLength = seqhash.get(headers.elementAt(i)).toString()
+                    .length();
+          }
+
+          Sequence newSeq = parseId(headers.elementAt(i).toString());
+          newSeq.setSequence(seqhash.get(headers.elementAt(i).toString())
+                  .toString());
+
+          seqs.addElement(newSeq);
+        }
+        else
+        {
+          System.err
+                  .println("Clustal File Reader: Can't find sequence for "
+                          + headers.elementAt(i));
+        }
+      }
+    }
+  }
+
+  public String print()
+  {
+    return print(getSeqsAsArray());
+  }
+
+  public String print(SequenceI[] s)
+  {
+    StringBuffer out = new StringBuffer("CLUSTAL"+newline+newline);
+
+    int max = 0;
+    int maxid = 0;
+
+    int i = 0;
+
+    while ((i < s.length) && (s[i] != null))
+    {
+      String tmp = printId(s[i]);
+
+      if (s[i].getSequence().length > max)
+      {
+        max = s[i].getSequence().length;
+      }
+
+      if (tmp.length() > maxid)
+      {
+        maxid = tmp.length();
+      }
+
+      i++;
+    }
+
+    if (maxid < 15)
+    {
+      maxid = 15;
+    }
+
+    maxid++;
+
+    int len = 60;
+    int nochunks = (max / len) + 1;
+
+    for (i = 0; i < nochunks; i++)
+    {
+      int j = 0;
+
+      while ((j < s.length) && (s[j] != null))
+      {
+        out.append(new Format("%-" + maxid + "s").form(printId(s[j]) + " "));
+
+        int start = i * len;
+        int end = start + len;
+
+        if ((end < s[j].getSequence().length)
+                && (start < s[j].getSequence().length))
+        {
+          out.append(s[j].getSequenceAsString(start, end));
+        }
+        else
+        {
+          if (start < s[j].getSequence().length)
+          {
+            out.append(s[j].getSequenceAsString().substring(start));
+          }
+        }
+
+        out.append(newline);
+        j++;
+      }
+
+      out.append(newline);
+    }
+
+    return out.toString();
+  }
+}