skips any annotation that appears to be identical to existing autogenerated annotatio...
[jalview.git] / src / jalview / io / AnnotationFile.java
index 0095aef..aac48eb 100755 (executable)
@@ -72,10 +72,18 @@ public class AnnotationFile
       this.hiddenRepSeqs = hiddenRepSeqs;\r
     }\r
   }\r
-\r
+  /**\r
+   * Prepare an annotation file given a set of annotations, groups, alignment properties and views. \r
+   * @param annotations\r
+   * @param groups\r
+   * @param properties\r
+   * @param views\r
+   * @return annotation file\r
+   */\r
   public String printAnnotations(AlignmentAnnotation[] annotations,\r
           Vector groups, Hashtable properties, ViewDef[] views)\r
   {\r
+    // TODO: resolve views issue : annotationFile could contain visible region, or full data + hidden region specifications for a view.\r
     if (annotations != null)\r
     {\r
       boolean oneColour = true;\r
@@ -85,7 +93,7 @@ public class AnnotationFile
 \r
       StringBuffer colours = new StringBuffer();\r
       StringBuffer graphLine = new StringBuffer();\r
-\r
+      StringBuffer rowprops = new StringBuffer();\r
       Hashtable graphGroup = new Hashtable();\r
 \r
       java.awt.Color color;\r
@@ -117,7 +125,7 @@ public class AnnotationFile
           refSeq = row.sequenceRef;\r
           text.append("\nSEQUENCE_REF\t" + refSeq.getName() + "\n");\r
         }\r
-        boolean hasGlyphs = false, hasLabels = false, hasValues = false, hasText = false;\r
+        boolean hasGlyphs = row.hasIcons, hasLabels = row.hasText, hasValues = row.hasScore, hasText = false;\r
         // lookahead to check what the annotation row object actually contains.\r
         for (int j = 0; row.annotations != null\r
                 && j < row.annotations.length\r
@@ -202,10 +210,15 @@ public class AnnotationFile
           if (row.annotations[j] != null)\r
           {\r
             comma = "";\r
-            if (hasGlyphs && row.annotations[j].secondaryStructure != ' ')\r
+            if (hasGlyphs) // could be also hasGlyphs || ... \r
             {\r
 \r
-              text.append(comma + row.annotations[j].secondaryStructure);\r
+              text.append(comma);\r
+              if (row.annotations[j].secondaryStructure != ' ')\r
+              {\r
+                // only write out the field if its not whitespace.\r
+                text.append(row.annotations[j].secondaryStructure);\r
+              }\r
               comma = ",";\r
             }\r
             if (hasValues)\r
@@ -224,7 +237,6 @@ public class AnnotationFile
             if (hasLabels)\r
             {\r
               // TODO: labels are emitted after values for bar graphs.\r
-              text.append(comma);\r
               if // empty labels are allowed, so\r
               (row.annotations[j].displayCharacter != null\r
                       && row.annotations[j].displayCharacter.length() > 0\r
@@ -276,7 +288,14 @@ public class AnnotationFile
           colours.append("COLOUR\t" + row.label + "\t"\r
                   + jalview.util.Format.getHexString(color) + "\n");\r
         }\r
-\r
+        if (row.scaleColLabel || row.showAllColLabels || row.centreColLabels)\r
+        {\r
+          rowprops.append("ROWPROPERTIES\t"+row.label);\r
+          rowprops.append("\tscaletofit="+row.scaleColLabel);\r
+          rowprops.append("\tshowalllabs="+row.showAllColLabels);\r
+          rowprops.append("\tcentrelabs="+row.centreColLabels);\r
+          rowprops.append("\n");\r
+        }\r
       }\r
 \r
       text.append("\n");\r
@@ -292,6 +311,7 @@ public class AnnotationFile
           text.append(en.nextElement() + "\n");\r
         }\r
       }\r
+      text.append(rowprops.toString());\r
     }\r
 \r
     if (groups != null)\r
@@ -413,6 +433,7 @@ public class AnnotationFile
   public boolean readAnnotationFile(AlignmentI al, String file,\r
           String protocol)\r
   {\r
+    Hashtable autoAnnots=new Hashtable();\r
     try\r
     {\r
       BufferedReader in = null;\r
@@ -442,9 +463,24 @@ public class AnnotationFile
       int graphStyle, index;\r
       int refSeqIndex = 1;\r
       int existingAnnotations = 0;\r
+      // when true - will add new rows regardless of whether they are duplicate auto-annotation like consensus or conservation graphs\r
+      boolean overrideAutoAnnot=false; \r
       if (al.getAlignmentAnnotation() != null)\r
       {\r
         existingAnnotations = al.getAlignmentAnnotation().length;\r
+        if (existingAnnotations>0)\r
+        {\r
+          AlignmentAnnotation[] aa = al.getAlignmentAnnotation();\r
+          for (int aai=0;aai<aa.length;aai++)\r
+          {\r
+            if (aa[aai].autoCalculated)\r
+            {\r
+              // make a note of the name and description\r
+              autoAnnots.put(aa[aai].graph+"\t"+aa[aai].label+"\t"+aa[aai].description+"\t"+(aa[aai].sequenceRef!=null ? aa[aai].sequenceRef.getDisplayId(true) : "")\r
+                      ,new Integer(1));\r
+            }\r
+          }\r
+        }\r
       }\r
 \r
       int alWidth = al.getWidth();\r
@@ -498,7 +534,11 @@ public class AnnotationFile
           combineAnnotations(al, st);\r
           continue;\r
         }\r
-\r
+        else if (token.equalsIgnoreCase("ROWPROPERTIES"))\r
+        {\r
+          addRowProperties(al, st);\r
+          continue;\r
+        }\r
         else if (token.equalsIgnoreCase("GRAPHLINE"))\r
         {\r
           addLine(al, st);\r
@@ -615,20 +655,26 @@ public class AnnotationFile
             }\r
             else\r
             {\r
-              annotations[index++] = parseAnnotation(token);\r
+              annotations[index++] = parseAnnotation(token, graphStyle);\r
               emptyColumn = false;\r
             }\r
           }\r
 \r
         }\r
-\r
+        \r
         annotation = new AlignmentAnnotation(label, description,\r
                 (index == 0) ? null : annotations, 0, 0, graphStyle);\r
 \r
         annotation.score = score;\r
-\r
+        if (!overrideAutoAnnot && autoAnnots.containsKey(annotation.graph+"\t"+annotation.label+"\t"+annotation.description+"\t"+(refSeq!=null ? refSeq.getDisplayId(true) : "")))\r
+        {\r
+          // skip - we've already got an automatic annotation of this type.\r
+          continue;\r
+        }\r
+        // otherwise add it!\r
         if (refSeq != null)\r
         {\r
+          \r
           annotation.belowAlignment = false;\r
           // make a copy of refSeq so we can find other matches in the alignment\r
           SequenceI referedSeq = refSeq;\r
@@ -670,8 +716,9 @@ public class AnnotationFile
     return true;\r
   }\r
 \r
-  Annotation parseAnnotation(String string)\r
+  Annotation parseAnnotation(String string, int graphStyle)\r
   {\r
+    boolean hasSymbols = (graphStyle == AlignmentAnnotation.NO_GRAPH); // don't do the glyph test if we don't want secondary structure\r
     String desc = null, displayChar = null;\r
     char ss = ' '; // secondaryStructure\r
     float value = 0;\r
@@ -686,40 +733,55 @@ public class AnnotationFile
       UserColourScheme ucs = new UserColourScheme();\r
 \r
       colour = ucs.getColourFromString(string.substring(i + 1, j));\r
-\r
+      if ( i>0 && string.charAt(i-1)==',')\r
+      {\r
+        // clip the preceding comma as well\r
+        i--;\r
+      }\r
       string = string.substring(0, i) + string.substring(j + 1);\r
     }\r
 \r
-    StringTokenizer st = new StringTokenizer(string, ",");\r
+    StringTokenizer st = new StringTokenizer(string, ",", true);\r
     String token;\r
+    boolean seenContent=false;\r
+    int pass=0;\r
     while (st.hasMoreTokens())\r
     {\r
+      pass++;\r
       token = st.nextToken().trim();\r
-      if (token.length() == 0)\r
+      if (token.equals(","))\r
       {\r
-        if (parsedValue && !dcset)\r
+        if (!seenContent && parsedValue && !dcset)\r
         {\r
           // allow the value below the bar/line to be empty\r
           dcset = true;\r
           displayChar = " ";\r
         }\r
+        seenContent = false;\r
         continue;\r
+      } else {\r
+        seenContent = true;\r
       }\r
 \r
       if (!parsedValue)\r
       {\r
         try\r
         {\r
-          displayChar = token;\r
+          displayChar = token; \r
+          // foo\r
           value = new Float(token).floatValue();\r
           parsedValue = true;\r
           continue;\r
         } catch (NumberFormatException ex)\r
         {\r
         }\r
+      } else {\r
+        if (token.length()==1)\r
+        {\r
+          displayChar = token;\r
+        }\r
       }\r
-\r
-      if (token.equals("H") || token.equals("E"))\r
+      if (hasSymbols && (token.equals("H") || token.equals("E") || token.equals(" ")))\r
       {\r
         // Either this character represents a helix or sheet\r
         // or an integer which can be displayed\r
@@ -729,29 +791,31 @@ public class AnnotationFile
           displayChar = "";\r
         }\r
       }\r
-      else if (desc == null)\r
+      else if (desc == null || (parsedValue && pass>2))\r
       {\r
         desc = token;\r
       }\r
 \r
     }\r
-    if (!dcset && string.charAt(string.length() - 1) == ',')\r
+//    if (!dcset && string.charAt(string.length() - 1) == ',')\r
+//    {\r
+//      displayChar = " "; // empty display char symbol.\r
+//    }\r
+    if (displayChar != null && desc!=null && desc.length()==1) \r
     {\r
-      displayChar = " "; // empty display char symbol.\r
-    }\r
-    if (displayChar != null && displayChar.length() > 1 && desc != null\r
-            && desc.length() == 1)\r
-    {\r
-      String tmp = displayChar;\r
-      displayChar = desc;\r
-      desc = tmp;\r
+      if (displayChar.length() > 1)\r
+      {\r
+        // switch desc and displayChar - legacy support  \r
+        String tmp = displayChar;\r
+        displayChar = desc;\r
+        desc = tmp;\r
+      } else {\r
+        if (displayChar.equals(desc)) {\r
+          // duplicate label - hangover from the 'robust parser' above\r
+          desc = null;\r
+        }\r
+      }\r
     }\r
-    /*\r
-     * In principle, this code will ensure that the Annotation element generated\r
-     * is renderable by any of the applet or application rendering code but\r
-     * instead we check for null strings when the display character is rendered.\r
-     * if (displayChar==null) { displayChar=""; }\r
-     */\r
     Annotation anot = new Annotation(displayChar, desc, ss, value);\r
 \r
     anot.colour = colour;\r
@@ -933,6 +997,35 @@ public class AnnotationFile
     }\r
   }\r
 \r
+  void addRowProperties(AlignmentI al, StringTokenizer st)\r
+  {\r
+    String label = st.nextToken(),keyValue,key,value;\r
+    boolean scaletofit=false,centerlab=false,showalllabs=false;\r
+    while (st.hasMoreTokens()) {\r
+      keyValue=st.nextToken();\r
+      key = keyValue.substring(0, keyValue.indexOf("="));\r
+      value = keyValue.substring(keyValue.indexOf("=") + 1);\r
+      if (key.equalsIgnoreCase("scaletofit")) {\r
+        scaletofit = Boolean.valueOf(value).booleanValue();\r
+      }\r
+        if (key.equalsIgnoreCase("showalllabs")) {\r
+          showalllabs = Boolean.valueOf(value).booleanValue();\r
+        }\r
+        if (key.equalsIgnoreCase("centrelabs")) {\r
+          centerlab = Boolean.valueOf(value).booleanValue();\r
+    }\r
+        AlignmentAnnotation[] alr = al.getAlignmentAnnotation(); \r
+        for (int i = 0; i < alr.length; i++)\r
+        {\r
+          if (alr[i].label.equalsIgnoreCase(label))\r
+          {\r
+            alr[i].centreColLabels = centerlab;\r
+            alr[i].scaleColLabel = scaletofit;\r
+            alr[i].showAllColLabels = showalllabs;\r
+          }\r
+        }\r
+    }\r
+  }\r
   void addProperties(AlignmentI al, StringTokenizer st)\r
   {\r
 \r