JAL-1683 replace year/version strings with tokens in source
[jalview.git] / src / jalview / io / StockholmFile.java
index 9d21a40..e5e14ad 100644 (file)
@@ -1,6 +1,6 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
- * Copyright (C) 2014 The Jalview Authors
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
@@ -23,7 +23,6 @@
  */
 package jalview.io;
 
-import jalview.datamodel.AlignmentI;
 import jalview.datamodel.AlignmentAnnotation;
 import jalview.datamodel.AlignmentI;
 import jalview.datamodel.Annotation;
@@ -33,6 +32,7 @@ import jalview.datamodel.Sequence;
 import jalview.datamodel.SequenceFeature;
 import jalview.datamodel.SequenceI;
 import jalview.util.Format;
+import jalview.util.MessageManager;
 
 import java.io.BufferedReader;
 import java.io.FileReader;
@@ -40,7 +40,9 @@ import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Enumeration;
 import java.util.Hashtable;
+import java.util.LinkedHashMap;
 import java.util.List;
+import java.util.Map;
 import java.util.StringTokenizer;
 import java.util.Vector;
 
@@ -185,7 +187,7 @@ public class StockholmFile extends AlignFile
     String version;
     // String id;
     Hashtable seqAnn = new Hashtable(); // Sequence related annotations
-    Hashtable seqs = new Hashtable();
+    LinkedHashMap<String, String> seqs = new LinkedHashMap<String, String>();
     Regex p, r, rend, s, x;
     // Temporary line for processing RNA annotation
     // String RNAannot = "";
@@ -198,7 +200,8 @@ public class StockholmFile extends AlignFile
     if (!r.search(nextLine()))
     {
       throw new IOException(
-              "This file is not in valid STOCKHOLM format: First line does not contain '# STOCKHOLM'");
+              MessageManager
+                      .getString("exception.stockholm_invalid_format"));
     }
     else
     {
@@ -258,12 +261,11 @@ public class StockholmFile extends AlignFile
           }
         }
         // logger.debug("Number of sequences: " + this.noSeqs);
-        Enumeration accs = seqs.keys();
-        while (accs.hasMoreElements())
+        for (Map.Entry<String, String> skey : seqs.entrySet())
         {
-          String acc = (String) accs.nextElement();
           // logger.debug("Processing sequence " + acc);
-          String seq = (String) seqs.remove(acc);
+          String acc = skey.getKey();
+          String seq = skey.getValue();
           if (maxLength < seq.length())
           {
             maxLength = seq.length();
@@ -367,6 +369,7 @@ public class StockholmFile extends AlignFile
                     AlignmentAnnotation an = (AlignmentAnnotation) vv
                             .elementAt(ii);
                     seqO.addAlignmentAnnotation(an);
+                    annotations.add(an);
                   }
                 }
               }
@@ -416,9 +419,11 @@ public class StockholmFile extends AlignFile
         if (!x.search(line))
         {
           // logger.error("Could not parse sequence line: " + line);
-          throw new IOException("Could not parse sequence line: " + line);
+          throw new IOException(MessageManager.formatMessage(
+                  "exception.couldnt_parse_sequence_line", new String[]
+                  { line }));
         }
-        String ns = (String) seqs.get(x.stringMatched(1));
+        String ns = seqs.get(x.stringMatched(1));
         if (ns == null)
         {
           ns = "";
@@ -528,7 +533,9 @@ public class StockholmFile extends AlignFile
           }
           else
           {
-            throw new IOException("Error parsing " + line);
+            throw new IOException(MessageManager.formatMessage(
+                    "exception.error_parsing_line", new String[]
+                    { line }));
           }
         }
         else if (annType.equals("GC"))
@@ -636,9 +643,13 @@ public class StockholmFile extends AlignFile
               strucAnn = new Hashtable();
             }
 
-            Vector newStruc = new Vector();
+            Vector<AlignmentAnnotation> newStruc = new Vector<AlignmentAnnotation>();
             parseAnnotationRow(newStruc, type, ns);
-
+            for (AlignmentAnnotation alan : newStruc)
+            {
+              alan.visible = false;
+            }
+            // annotations.addAll(newStruc);
             strucAnn.put(type, newStruc);
             seqAnn.put(acc, strucAnn);
           }
@@ -653,8 +664,9 @@ public class StockholmFile extends AlignFile
         }
         else
         {
-          throw new IOException("Unknown annotation detected: " + annType
-                  + " " + annContent);
+          throw new IOException(MessageManager.formatMessage(
+                  "exception.unknown_annotation_detected", new String[]
+                  { annType, annContent }));
         }
       }
     }
@@ -814,25 +826,29 @@ public class StockholmFile extends AlignFile
       // be written out
       if (ss)
       {
-        if (detectbrackets.search(pos))
-        {
-          ann.secondaryStructure = jalview.schemes.ResidueProperties
-                  .getRNASecStrucState(pos).charAt(0);
-        }
-        else
+        //if (" .-_".indexOf(pos) == -1)
         {
-          ann.secondaryStructure = jalview.schemes.ResidueProperties
-                  .getDssp3state(pos).charAt(0);
-        }
+          if (detectbrackets.search(pos))
+          {
+            ann.secondaryStructure = jalview.schemes.ResidueProperties
+                    .getRNASecStrucState(pos).charAt(0);
+          }
+          else
+          {
+            ann.secondaryStructure = jalview.schemes.ResidueProperties
+                    .getDssp3state(pos).charAt(0);
+          }
 
-        if (ann.secondaryStructure == pos.charAt(0) || pos.charAt(0) == 'C')
-        {
-          ann.displayCharacter = ""; // null; // " ";
-        }
-        else
-        {
-          ann.displayCharacter = " " + ann.displayCharacter;
+          if (ann.secondaryStructure == pos.charAt(0))
+          {
+            ann.displayCharacter = ""; // null; // " ";
+          }
+          else
+          {
+            ann.displayCharacter = " " + ann.displayCharacter;
+          }
         }
+        
       }
 
       els[i] = ann;
@@ -843,7 +859,9 @@ public class StockholmFile extends AlignFile
     {
       annot = (AlignmentAnnotation) e.nextElement();
       if (annot.label.equals(type))
+      {
         break;
+      }
       annot = null;
     }
     if (annot == null)
@@ -888,7 +906,9 @@ public class StockholmFile extends AlignFile
         for (int idb = 0; idb < s[in].getDBRef().length; idb++)
         {
           if (dataRef == null)
+          {
             dataRef = new Hashtable();
+          }
 
           String datAs1 = s[in].getDBRef()[idb].getSource().toString()
                   + " ; "
@@ -961,39 +981,19 @@ public class StockholmFile extends AlignFile
             String key = type2id(feature);
 
             if (key == null)
+            {
               continue;
+            }
 
             // out.append("#=GR ");
             out.append(new Format("%-" + maxid + "s").form("#=GR "
                     + printId(s[i]) + " " + key + " "));
             ann = alAnot[j].annotations;
+            boolean isrna = alAnot[j].isValidStruc();
             String seq = "";
             for (int k = 0; k < ann.length; k++)
             {
-              annot = ann[k];
-              String ch = (annot == null) ? Character.toString(s[i]
-                      .getCharAt(k)) : annot.displayCharacter;
-              if (ch.length() == 0)
-              {
-                if (key.equals("SS"))
-                {
-                  char ll = annot.secondaryStructure;
-                  seq = (Character.toString(ll).equals(" ")) ? seq + "C"
-                          : seq + ll;
-                }
-                else
-                {
-                  seq += ".";
-                }
-              }
-              else if (ch.length() == 1)
-              {
-                seq += ch;
-              }
-              else if (ch.length() > 1)
-              {
-                seq += ch.charAt(1);
-              }
+              seq += outputCharacter(key, k, isrna, ann, s[i]);
             }
             out.append(seq);
             out.append(newline);
@@ -1014,43 +1014,41 @@ public class StockholmFile extends AlignFile
       for (int ia = 0; ia < al.getAlignmentAnnotation().length; ia++)
       {
         aa = al.getAlignmentAnnotation()[ia];
-        if (aa.autoCalculated || !aa.visible)
+        if (aa.autoCalculated || !aa.visible || aa.sequenceRef != null)
         {
           continue;
         }
         String seq = "";
         String label;
-
+        String key = "";
         if (aa.label.equals("seq"))
+        {
           label = "seq_cons";
+        }
         else
-          label = type2id(aa.label.toLowerCase()) + "_cons";
-
+        {
+          key = type2id(aa.label.toLowerCase());
+          if (key == null)
+          {
+            label = aa.label;
+          }
+          else
+          {
+            label = key + "_cons";
+          }
+        }
         if (label == null)
+        {
           label = aa.label;
+        }
+        label = label.replace(" ", "_");
 
         out.append(new Format("%-" + maxid + "s").form("#=GC " + label
                 + " "));
+        boolean isrna = aa.isValidStruc();
         for (int j = 0; j < aa.annotations.length; j++)
         {
-          String ch = (aa.annotations[j] == null) ? "-"
-                  : aa.annotations[j].displayCharacter;
-          if (ch.length() == 0)
-          {
-            char ll = aa.annotations[j].secondaryStructure;
-            if (Character.toString(ll).equals(" "))
-              seq += "C";
-            else
-              seq += ll;
-          }
-          else if (ch.length() == 1)
-          {
-            seq += ch;
-          }
-          else if (ch.length() > 1)
-          {
-            seq += ch.charAt(1);
-          }
+          seq += outputCharacter(key, j, isrna, aa.annotations, null);
         }
         out.append(seq);
         out.append(newline);
@@ -1059,6 +1057,57 @@ public class StockholmFile extends AlignFile
     return out.toString();
   }
 
+  /**
+   * add an annotation character to the output row
+   * 
+   * @param seq
+   * @param key
+   * @param k
+   * @param isrna
+   * @param ann
+   * @param sequenceI
+   */
+  private char outputCharacter(String key, int k,
+          boolean isrna, Annotation[] ann, SequenceI sequenceI)
+  {
+    char seq = ' ';
+    Annotation annot = ann[k];
+    String ch = (annot == null) ? ((sequenceI == null) ? "-" : Character
+            .toString(sequenceI.getCharAt(k)))
+            : annot.displayCharacter;
+    if (key != null && key.equals("SS"))
+    {
+      if (annot == null)
+      {
+        // sensible gap character if one is available or make one up
+        return sequenceI == null ? '-' : sequenceI
+                .getCharAt(k);
+      }
+      else
+      {
+        // valid secondary structure AND no alternative label (e.g. ' B')
+        if (annot.secondaryStructure > ' ' && ch.length() < 2)
+        {
+          return annot.secondaryStructure;
+        }
+      }
+    }
+
+    if (ch.length() == 0)
+    {
+      seq = '.';
+    }
+    else if (ch.length() == 1)
+    {
+      seq = ch.charAt(0);
+    }
+    else if (ch.length() > 1)
+    {
+      seq = ch.charAt(1);
+    }
+    return seq;
+  }
+
   public String print()
   {
     out = new StringBuffer();
@@ -1122,7 +1171,7 @@ public class StockholmFile extends AlignFile
     }
     if (key != null)
     {
-      return (String) key;
+      return key;
     }
     System.err.println("Warning : Unknown Stockholm annotation type: "
             + type);