Any character non aa or nucleotide is a space
[jalview.git] / src / jalview / io / JPredFile.java
index cc8fb56..3f308be 100755 (executable)
@@ -1,3 +1,22 @@
+/*
+* Jalview - A Sequence Alignment Editor and Viewer
+* Copyright (C) 2006 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
+* 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.
+*
+* 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
+*/
+
 /**
  * PredFile.java
  * JalviewX / Vamsas Project
  */
 package jalview.io;
 
-import jalview.datamodel.*;
-import jalview.util.*;
-
 import java.io.*;
 import java.util.*;
 
-public class JPredFile
-    extends AlignFile
-{
-  Vector ids;
-  Vector conf;
-  Hashtable Scores; // Hash of names and score vectors
+import jalview.datamodel.*;
 
-  public JPredFile(String inStr)
-  {
-    super(inStr);
-  }
 
-  public void initData()
-  {
+/**
+ * DOCUMENT ME!
+ *
+ * @author $author$
+ * @version $Revision$
+ */
+public class JPredFile extends AlignFile
+{
+    Vector ids;
+    Vector conf;
+    Hashtable Scores; // Hash of names and score vectors
+    Hashtable Symscores; // indexes of symbol annotation properties in sequenceI vector
+    private int QuerySeqPosition;
 
-    super.initData();
-    Scores = new Hashtable();
-  }
 
-  public JPredFile(String inFile, String type)
-      throws IOException
-  {
+    /**
+     * Creates a new JPredFile object.
+     *
+     * @param inFile DOCUMENT ME!
+     * @param type DOCUMENT ME!
+     *
+     * @throws IOException DOCUMENT ME!
+     */
+    public JPredFile(String inFile, String type) throws IOException
+    {
+        super(inFile, type);
+    }
 
-    super(inFile, type);
-  }
+    /**
+     * DOCUMENT ME!
+     *
+     * @param QuerySeqPosition DOCUMENT ME!
+     */
+    public void setQuerySeqPosition(int QuerySeqPosition)
+    {
+        this.QuerySeqPosition = QuerySeqPosition;
+    }
 
-  /**
-   * parse a JPred concise file into a sequence-alignment like object.
-   */
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public int getQuerySeqPosition()
+    {
+        return QuerySeqPosition;
+    }
 
-  public void parse()
-      throws IOException
-  {
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public Hashtable getScores()
+    {
+        return Scores;
+    }
 
-    String line;
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public Hashtable getSymscores()
+    {
+        return Symscores;
+    }
 
-    noSeqs = 0;
-    Vector seq_entries = new Vector();
-    Vector ids = new Vector();
+    /**
+     * DOCUMENT ME!
+     */
+    public void initData()
+    {
+        super.initData();
+        Scores = new Hashtable();
+        ids = null;
+        conf = null;
+    }
 
-    while ( (line = nextLine()) != null)
+    /**
+ * parse a JPred concise file into a sequence-alignment like object.
+ */
+    public void parse() throws IOException
     {
-      // Concise format allows no comments or non comma-formatted data
-      StringTokenizer str = new StringTokenizer(line, ":");
-      String id = "";
-      String seq = "";
-      if (str.hasMoreTokens())
-      {
-        id = str.nextToken();
-        String seqsym = str.nextToken();
-        StringTokenizer symbols = new StringTokenizer(seqsym, ",");
-        // decide if we have more than just alphanumeric symbols
-        int numSymbols = symbols.countTokens();
-        if (seq.length() != (2 * numSymbols))
+        // JBPNote log.System.out.println("all read in ");
+        String line;
+        QuerySeqPosition = -1;
+        noSeqs = 0;
+
+        Vector seq_entries = new Vector();
+        Vector ids = new Vector();
+        Hashtable Symscores = new Hashtable();
+
+        while ((line = nextLine()) != null)
         {
-          // Set of scalars for some property
-          if (Scores.containsKey(id))
-          {
-            int i = 1;
-            while (Scores.containsKey(id + "_" + i))
+            // Concise format allows no comments or non comma-formatted data
+            StringTokenizer str = new StringTokenizer(line, ":");
+            String id = "";
+
+            if (!str.hasMoreTokens())
             {
-              i++;
+                continue;
             }
-            id = id + "_" + i;
-          }
-          Vector scores = new Vector(numSymbols);
-          // Typecheck from first entry
-          int i = 0;
-          String ascore = symbols.nextToken();
-          try
-          {
-            // store elements as floats...
-            do
+
+            id = str.nextToken();
+
+            String seqsym = str.nextToken();
+            StringTokenizer symbols = new StringTokenizer(seqsym, ",");
+
+            // decide if we have more than just alphanumeric symbols
+            int numSymbols = symbols.countTokens();
+
+            if (numSymbols == 0)
             {
-              Float score = new Float(ascore);
-              scores.set(i, (Object) score);
-              ascore = symbols.nextToken();
+                continue;
             }
-            while (++i < numSymbols);
-          }
-          catch (Exception e)
-          {
-            // or just keep them as strings
-            for (int j = 0; j < i; j++)
+
+            if (seqsym.length() != (2 * numSymbols))
             {
-              scores.set(j,
-                         (Object)
-                         ( (Float) scores.get(j)).toString());
+                // Set of scalars for some property
+                if (Scores.containsKey(id))
+                {
+                    int i = 1;
+
+                    while (Scores.containsKey(id + "_" + i))
+                    {
+                        i++;
+                    }
+
+                    id = id + "_" + i;
+                }
+
+                Vector scores = new Vector();
+
+                // Typecheck from first entry
+                int i = 0;
+                String ascore = "dead";
+
+                try
+                {
+                    // store elements as floats...
+                    while (symbols.hasMoreTokens())
+                    {
+                        ascore = symbols.nextToken();
+
+                        Float score = new Float(ascore);
+                        scores.addElement((Object) score);
+                    }
+
+                    Scores.put(id, scores);
+                }
+                catch (Exception e)
+                {
+                    // or just keep them as strings
+                    i = scores.size();
+
+                    for (int j = 0; j < i; j++)
+                    {
+                        scores.setElementAt(
+                            (Object) ((Float) scores.elementAt(j)).toString(), j);
+                    }
+
+                    scores.addElement((Object) ascore);
+
+                    while (symbols.hasMoreTokens())
+                    {
+                        ascore = symbols.nextToken();
+                        scores.addElement((Object) ascore);
+                    }
+
+                    Scores.put(id, scores);
+                }
             }
-            do
+            else if (id.equals("jnetconf"))
             {
-              scores.set(i, ascore);
-              ascore = symbols.nextToken();
+                // log.debug System.out.println("here");
+                id = "Prediction Confidence";
+                this.conf = new Vector(numSymbols);
+
+                for (int i = 0; i < numSymbols; i++)
+                {
+                    conf.setElementAt( symbols.nextToken(), i);
+                }
             }
-            while (++i < numSymbols);
-          }
-          Scores.put(id, scores);
-        }
-        else
-        {
-          if (id.equals("jnetconf"))
-          {
-            id = "Prediction Confidence";
-            this.conf = new Vector(numSymbols);
-            for (int i = 0; i < numSymbols; i++)
+            else
             {
-              conf.set(i, (Object) symbols.nextToken());
-            }
-          }
-          else
-          {
-            // Sequence or a prediction string (rendered as sequence)
+                // Sequence or a prediction string (rendered as sequence)
+                StringBuffer newseq = new StringBuffer();
 
-            StringBuffer newseq = new StringBuffer();
-            for (int i = 0; i < numSymbols; i++)
-            {
-              newseq.append(symbols.nextToken());
+                for (int i = 0; i < numSymbols; i++)
+                {
+                    newseq.append(symbols.nextToken());
+                }
+
+                if (id.indexOf(";") > -1)
+                {
+                    seq_entries.addElement(newseq);
+
+                    int i = 1;
+                    String name = id.substring(id.indexOf(";") + 1);
+
+                    while (ids.lastIndexOf(name) > -1)
+                    {
+                        name = id.substring(id.indexOf(";") + 1) + "_" + ++i;
+                    }
+
+                    ids.addElement(name);
+
+                    noSeqs++;
+                }
+                else
+                {
+                    if (id.equals("JNETPRED"))
+                    {
+                        id = "Predicted Secondary Structure";
+                    }
+
+                    seq_entries.addElement(newseq.toString());
+                    ids.addElement(id);
+                    Symscores.put((Object) id,
+                        (Object) new Integer(ids.size() - 1));
+                }
             }
-            if (id.indexOf(";") > -1)
+        }
+        /* leave it to the parser user to actually check this.
+        if (noSeqs < 1)
+        {
+            throw new IOException(
+                "JpredFile Parser: No sequence in the prediction!");
+        }*/
+
+        maxLength = seq_entries.elementAt(0).toString().length();
+
+        for (int i = 0; i < ids.size(); i++)
+        {
+            // Add all sequence like objects
+            Sequence newSeq = new Sequence(ids.elementAt(i).toString(),
+                    seq_entries.elementAt(i).toString(), 1,
+                    seq_entries.elementAt(i).toString().length());
+
+
+            if (maxLength != seq_entries.elementAt(i).toString().length())
             {
-              seq_entries.addElement(newseq);
-              ids.addElement(id.substring(id.indexOf(";")));
-              noSeqs++;
+                throw new IOException("JPredConcise: Entry (" +
+                    ids.elementAt(i).toString() +
+                    ") has an unexpected number of columns");
             }
-            else
+
+            if (newSeq.getName().startsWith("QUERY") &&
+                    (QuerySeqPosition == -1))
             {
-              if (id.equals("JNETPRED"))
-              {
-                id = "Predicted Secondary Structure";
-              }
-              seq_entries.addElement(newseq);
-              ids.addElement(id);
+                QuerySeqPosition = seqs.size();
             }
-          }
-        }
 
-      }
+            seqs.addElement(newSeq);
+        }
     }
 
-    if (noSeqs < 1)
+    /**
+ * print
+ *
+ * @return String
+   */
+    public String print()
     {
-      throw new IOException("JpredFile Parser: No sequence in the prediction!");
+        return "Not Supported";
     }
-    maxLength = seq_entries.elementAt(0).toString().length();
-    for (int i = 0; i < ids.size(); i++)
-    {
-      // Add all sequence like objects
-
-      Sequence newSeq = new Sequence(ids.elementAt(i).toString(),
-                                     seq_entries.elementAt(i).toString(), 1,
-                                     seq_entries.elementAt(i).toString().length());
-      if (!isValidProteinSequence(newSeq.getSequence()))
-      {
-        throw new IOException("JPredConcise: Not a valid protein sequence - ("
-                              + ids.elementAt(i).toString() + ")");
-      }
 
-      if (maxLength != seq_entries.elementAt(i).toString().length())
-      {
-        throw new IOException("JPredConcise: Entry (" +
-                              ids.elementAt(i).toString()
-                              + ") has an unexpected number of columns");
-      }
-      seqs.addElement(newSeq);
+    /**
+     * DOCUMENT ME!
+     *
+     * @param args DOCUMENT ME!
+     */
+    public static void main(String[] args)
+    {
+        try
+        {
+            JPredFile blc = new JPredFile(args[0], "File");
 
+            for (int i = 0; i < blc.seqs.size(); i++)
+            {
+                System.out.println(((Sequence) blc.seqs.elementAt(i)).getName() +
+                    "\n" + ((Sequence) blc.seqs.elementAt(i)).getSequenceAsString() +
+                    "\n");
+            }
+        }
+        catch (java.io.IOException e)
+        {
+            System.err.println("Exception " + e);
+            e.printStackTrace();
+        }
     }
-  }
-
+    Vector annotSeqs=null;
   /**
-   * print
-   *
-   * @return String
+   * removeNonSequences
    */
-
-  public String print()
+  public void removeNonSequences()
   {
-    return "Not Supported";
+    if (annotSeqs!=null)
+      return;
+    annotSeqs = new Vector();
+    Vector newseqs = new Vector();
+    int i=0;
+    int j=seqs.size();
+    for (; i<QuerySeqPosition; i++)
+        annotSeqs.addElement(seqs.elementAt(i));
+      // check that no stray annotations have been added at the end.
+      {
+        SequenceI sq = (SequenceI) seqs.elementAt(j-1);
+        if (sq.getName().toUpperCase().startsWith("JPRED")) {
+          annotSeqs.addElement(sq);
+          seqs.removeElementAt(--j);
+        }
+      }
+    for (; i<j; i++)
+        newseqs.addElement(seqs.elementAt(i));
+
+    seqs.removeAllElements();
+    seqs = newseqs;
   }
 }
+
+
 /*
-StringBuffer out = new StringBuffer();
+ StringBuffer out = new StringBuffer();
 
-out.append("START PRED\n");
-for (int i = 0; i < s[0].sequence.length(); i++)
-{
+ out.append("START PRED\n");
+ for (int i = 0; i < s[0].sequence.length(); i++)
+ {
   out.append(s[0].sequence.substring(i, i + 1) + " ");
   out.append(s[1].sequence.substring(i, i + 1) + " ");
   out.append(s[1].score[0].elementAt(i) + " ");
@@ -204,13 +367,13 @@ for (int i = 0; i < s[0].sequence.length(); i++)
   out.append(s[1].score[3].elementAt(i) + " ");
 
   out.append("\n");
-}
-out.append("END PRED\n");
-return out.toString();
-}
+ }
+ out.append("END PRED\n");
+ return out.toString();
+ }
 
     public static void main(String[] args)
-{
+ {
   try
   {
     BLCFile blc = new BLCFile(args[0], "File");
@@ -230,7 +393,7 @@ return out.toString();
   {
     System.out.println("Exception " + e);
   }
-}
+ }
 
-}
-*/
+ }
+ */