Javadoc fixes
[jabaws.git] / datamodel / compbio / data / sequence / SequenceUtil.java
index d0a6cd7..6e20988 100644 (file)
@@ -1,15 +1,19 @@
-/*\r
- * @(#)SequenceUtil.java 1.0 September 2009 Copyright (c) 2009 Peter Troshin\r
- * Jalview Web Services version: 2.0 This library is free software; you can\r
- * redistribute it and/or modify it under the terms of the Apache License\r
- * version 2 as published by the Apache Software Foundation This library is\r
- * distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;\r
- * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A\r
- * PARTICULAR PURPOSE. See the Apache License for more details. A copy of the\r
- * license is in apache_license.txt. It is also available here: see:\r
- * http://www.apache.org/licenses/LICENSE-2.0.txt Any republication or derived\r
- * work distributed in source code form must include this copyright and license\r
- * notice.\r
+/* Copyright (c) 2011 Peter Troshin\r
+ *  \r
+ *  JAva Bioinformatics Analysis Web Services (JABAWS) @version: 2.0     \r
+ * \r
+ *  This library is free software; you can redistribute it and/or modify it under the terms of the\r
+ *  Apache License version 2 as published by the Apache Software Foundation\r
+ * \r
+ *  This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without\r
+ *  even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Apache \r
+ *  License for more details.\r
+ * \r
+ *  A copy of the license is in apache_license.txt. It is also available here:\r
+ * @see: http://www.apache.org/licenses/LICENSE-2.0.txt\r
+ * \r
+ * Any republication or derived work distributed in source code form\r
+ * must include this copyright and license notice.\r
  */\r
 \r
 package compbio.data.sequence;\r
@@ -41,8 +45,9 @@ import compbio.util.Util;
 /**\r
  * Utility class for operations on sequences\r
  * \r
- * @author Petr Troshin\r
- * @version 1.0\r
+ * @author Peter Troshin\r
+ * @since 1.0\r
+ * @version 2.0 June 2011\r
  */\r
 public final class SequenceUtil {\r
 \r
@@ -99,19 +104,6 @@ public final class SequenceUtil {
        private SequenceUtil() {\r
        } // utility class, no instantiation\r
 \r
-       /*\r
-        * public static void write_PirSeq(OutputStream os, FastaSequence seq)\r
-        * throws IOException { BufferedWriter pir_out = new BufferedWriter(new\r
-        * OutputStreamWriter(os)); pir_out.write(">P1;" + seq.getId() +\r
-        * SysPrefs.newlinechar); pir_out.write(seq.getSequence() +\r
-        * SysPrefs.newlinechar); pir_out.close(); } public static void\r
-        * write_FastaSeq(OutputStream os, FastaSequence seq) throws IOException {\r
-        * BufferedWriter fasta_out = new BufferedWriter( new\r
-        * OutputStreamWriter(os)); fasta_out.write(">" + seq.getId() +\r
-        * SysPrefs.newlinechar); fasta_out.write(seq.getSequence() +\r
-        * SysPrefs.newlinechar); fasta_out.close(); }\r
-        */\r
-\r
        /**\r
         * @return true is the sequence contains only letters a,c, t, g, u\r
         */\r
@@ -170,6 +162,17 @@ public final class SequenceUtil {
        }\r
 \r
        /**\r
+        * Remove all non AA chars from the sequence\r
+        * \r
+        * @param sequence\r
+        *            the sequence to clean\r
+        * @return cleaned sequence\r
+        */\r
+       public static String cleanProteinSequence(String sequence) {\r
+               return SequenceUtil.NON_AA.matcher(sequence).replaceAll("");\r
+       }\r
+\r
+       /**\r
         * @param sequence\r
         * @return true is the sequence is a protein sequence, false overwise\r
         */\r
@@ -257,28 +260,11 @@ public final class SequenceUtil {
        public static List<FastaSequence> readFasta(final InputStream inStream)\r
                        throws IOException {\r
                final List<FastaSequence> seqs = new ArrayList<FastaSequence>();\r
-\r
-               final BufferedReader infasta = new BufferedReader(\r
-                               new InputStreamReader(inStream, "UTF8"), 16000);\r
-               final Pattern pattern = Pattern.compile("//s+");\r
-\r
-               String line;\r
-               String sname = "", seqstr = null;\r
-               do {\r
-                       line = infasta.readLine();\r
-                       if ((line == null) || line.startsWith(">")) {\r
-                               if (seqstr != null) {\r
-                                       seqs.add(new FastaSequence(sname.substring(1), seqstr));\r
-                               }\r
-                               sname = line; // remove >\r
-                               seqstr = "";\r
-                       } else {\r
-                               final String subseq = pattern.matcher(line).replaceAll("");\r
-                               seqstr += subseq;\r
-                       }\r
-               } while (line != null);\r
-\r
-               infasta.close();\r
+               FastaReader reader = new FastaReader(inStream);\r
+               while (reader.hasNext()) {\r
+                       seqs.add(reader.next());\r
+               }\r
+               inStream.close();\r
                return seqs;\r
        }\r
 \r
@@ -300,6 +286,127 @@ public final class SequenceUtil {
                outWriter.close();\r
        }\r
 \r
+       /**\r
+        * Read IUPred output\r
+        * \r
+        * @param result\r
+        * @return Map key->sequence name, value->Score\r
+        * @throws IOException\r
+        * @throws UnknownFileFormatException\r
+        */\r
+       public static Map<String, Score> readIUPred(final File result)\r
+                       throws IOException, UnknownFileFormatException {\r
+               InputStream input = new FileInputStream(result);\r
+               Map<String, Score> sequences = readIUPred(input,\r
+                               IUPredResult.getType(result));\r
+               input.close();\r
+               return sequences;\r
+       }\r
+\r
+       // Check the type of the file e.g. long| short or domain\r
+       // and read\r
+       /**\r
+        * ## Long Disorder\r
+        * \r
+        * # P53_HUMAN\r
+        * \r
+        * 1 M 0.9943\r
+        * \r
+        * 2 E 0.9917\r
+        * \r
+        * 3 E 0.9879\r
+        * \r
+        * (every line)\r
+        * \r
+        * @throws IOException\r
+        * @throws UnknownFileFormatException\r
+        * \r
+        * \r
+        */\r
+       private static Map<String, Score> readIUPred(InputStream input,\r
+                       IUPredResult type) throws IOException, UnknownFileFormatException {\r
+\r
+               Score score = null;\r
+               final Map<String, Score> seqs = new HashMap<String, Score>();\r
+               Scanner scan = new Scanner(input);\r
+               scan.useDelimiter("#");\r
+               while (scan.hasNext()) {\r
+                       String nextEntry = scan.next();\r
+                       Scanner entry = new Scanner(nextEntry);\r
+                       String name = entry.nextLine().trim();\r
+                       // inside entry:\r
+                       if (IUPredResult.Glob == type) {\r
+                               // parse domains\r
+                               TreeSet<Range> ranges = parseIUPredDomains(entry);\r
+                               score = new Score(type, ranges);\r
+                       } else {\r
+                               // parse short | long\r
+                               float[] scores = parseIUPredScores(entry);\r
+                               score = new Score(type, scores);\r
+                       }\r
+                       entry.close();\r
+                       seqs.put(name, score);\r
+               }\r
+\r
+               scan.close();\r
+               return seqs;\r
+       }\r
+\r
+       /**\r
+        * # P53_HUMA\r
+        * \r
+        * Number of globular domains: 2\r
+        * \r
+        * globular domain 1. 98 - 269\r
+        * \r
+        * globular domain 2. 431 - 482\r
+        * \r
+        * >P53_HUMA\r
+        * \r
+        * meepqsdpsv epplsqetfs dlwkllpenn vlsplpsqam ddlmlspddi eqwftedpgp\r
+        * \r
+        * @param scan\r
+        */\r
+       private static TreeSet<Range> parseIUPredDomains(Scanner scan) {\r
+               String header = "Number of globular domains:";\r
+               String domainPref = "globular domain";\r
+               TreeSet<Range> ranges = new TreeSet<Range>();\r
+               String line = scan.nextLine().trim();\r
+               assert line.startsWith(header);\r
+               line = line.substring(header.length()).trim();\r
+               int domainNum = Integer.parseInt(line);\r
+               if (domainNum == 0) {\r
+                       return ranges;\r
+               }\r
+\r
+               for (int i = 0; i < domainNum; i++) {\r
+                       assert scan.hasNextLine();\r
+                       line = scan.nextLine();\r
+                       assert line.trim().startsWith(domainPref);\r
+                       line = line.substring(line.indexOf(".") + 1).trim();\r
+                       Range r = new Range(line.split("-"));\r
+                       ranges.add(r);\r
+               }\r
+\r
+               return ranges;\r
+       }\r
+       /*\r
+        * 1 M 0.9943\r
+        * \r
+        * 2 E 0.9917\r
+        */\r
+       private static float[] parseIUPredScores(Scanner scan)\r
+                       throws UnknownFileFormatException {\r
+               List<String> annotation = new ArrayList<String>();\r
+               while (scan.hasNextLine()) {\r
+                       String line = scan.nextLine().trim();\r
+                       String[] val = line.split("\\s+");\r
+                       annotation.add(val[2]);\r
+               }\r
+               return convertToNumber(annotation\r
+                               .toArray(new String[annotation.size()]));\r
+       }\r
+\r
        public static Map<String, Score> readJRonn(final File result)\r
                        throws IOException, UnknownFileFormatException {\r
                InputStream input = new FileInputStream(result);\r
@@ -320,7 +427,7 @@ public final class SequenceUtil {
         * \r
         * @param inStream\r
         *            the InputStream connected to the JRonn output file\r
-        * @return List of {@link AnnotatedSequence} objects\r
+        * @return Map key=sequence name value=Score\r
         * @throws IOException\r
         *             is thrown if the inStream has problems accessing the data\r
         * @throws UnknownFileFormatException\r
@@ -426,7 +533,8 @@ public final class SequenceUtil {
         * \r
         * \r
         * @param input\r
-        * @return\r
+        *            the InputStream\r
+        * @return Map key=sequence name, value=set of score\r
         * @throws IOException\r
         * @throws UnknownFileFormatException\r
         */\r
@@ -548,7 +656,7 @@ public final class SequenceUtil {
         * \r
         * \r
         * @param input\r
-        * @return\r
+        * @return Map key=sequence name, value=set of score\r
         * @throws IOException\r
         * @throws UnknownFileFormatException\r
         */\r
@@ -599,7 +707,7 @@ public final class SequenceUtil {
                         * Also possible FastaSequence fs = new FastaSequence(sequenceName,\r
                         * seqbuffer.toString());\r
                         */\r
-                       HashSet<Score> scores = new HashSet<Score>();\r
+                       Set<Score> scores = new TreeSet<Score>();\r
                        scores.add(new Score(GlobProtResult.Disorder, disorderR));\r
                        scores.add(new Score(GlobProtResult.GlobDoms, domsR));\r
                        scores.add(new Score(GlobProtResult.Dydx, dydxScore));\r
@@ -700,4 +808,37 @@ enum GlobProtResult {
        SmoothedScore,\r
        /** This a score with no range */\r
        RawScore\r
+}\r
+\r
+enum IUPredResult {\r
+       /**\r
+        * Short disorder\r
+        */\r
+       Short,\r
+       /**\r
+        * Long disorder\r
+        */\r
+       Long,\r
+       /**\r
+        * Globular domains\r
+        */\r
+       Glob;\r
+\r
+       static IUPredResult getType(File file) {\r
+               assert file != null;\r
+               String name = file.getName();\r
+               if (name.endsWith(Long.toString().toLowerCase())) {\r
+                       return Long;\r
+               }\r
+               if (name.endsWith(Short.toString().toLowerCase())) {\r
+                       return Short;\r
+               }\r
+               if (name.endsWith(Glob.toString().toLowerCase())) {\r
+                       return Glob;\r
+               }\r
+               throw new AssertionError(\r
+                               "IUPred result file type cannot be recognised! "\r
+                                               + "\nFile must ends with one of [glob, long or short]"\r
+                                               + "\n but given file name was: " + file.getName());\r
+       }\r
 }
\ No newline at end of file