X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fio%2FAnnotationFile.java;h=7f71df18f9bb06686b879766426cde6203dd9dec;hb=67b2671b1ded591a6f8eb7f13d319e58f993df77;hp=a7c67cd0638dd6b4520fbc588ee33cf5c02ed3f7;hpb=d70d7e5bc8da1189f44709b6ec59ea1e23f6f557;p=jalview.git

diff --git a/src/jalview/io/AnnotationFile.java b/src/jalview/io/AnnotationFile.java
index a7c67cd..7f71df1 100755
--- a/src/jalview/io/AnnotationFile.java
+++ b/src/jalview/io/AnnotationFile.java
@@ -1,175 +1,368 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer
- * Copyright (C) 2006 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
- *
+ * Jalview - A Sequence Alignment Editor and Viewer (Development Version 2.4.1)
+ * Copyright (C) 2009 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
  */
-
 package jalview.io;
 
 import java.io.*;
-import jalview.datamodel.*;
+import java.net.*;
 import java.util.*;
-import java.net.URL;
-import jalview.schemes.*;
 
+import jalview.analysis.*;
+import jalview.datamodel.*;
+import jalview.schemes.*;
 
 public class AnnotationFile
 {
-
-  public String printAnnotations(AlignmentAnnotation [] annotations)
+  StringBuffer text = new StringBuffer("JALVIEW_ANNOTATION\n"
+          + "# Created: " + new java.util.Date() + "\n\n");
+
+  /**
+   * convenience method for pre-2.4 feature files which have no view, hidden
+   * columns or hidden row keywords.
+   * 
+   * @param annotations
+   * @param groups
+   * @param properties
+   * @return feature file as a string.
+   */
+  public String printAnnotations(AlignmentAnnotation[] annotations,
+          Vector groups, Hashtable properties)
   {
-    StringBuffer text = new StringBuffer(
-      "JALVIEW_ANNOTATION\n"
-      +"# Created: "
-      +new java.util.Date()+"\n\n");
+    return printAnnotations(annotations, groups, properties, null);
 
-    AlignmentAnnotation row;
-    String comma;
-    SequenceI seqref = null;
+  }
 
-    StringBuffer colours = new StringBuffer();
-    StringBuffer graphLine = new StringBuffer();
+  /**
+   * hold all the information about a particular view definition read from or
+   * written out in an annotations file.
+   */
+  public class ViewDef
+  {
+    public String viewname;
 
-    Hashtable graphGroup = new Hashtable();
+    public HiddenSequences hidseqs;
 
-    java.awt.Color color;
+    public ColumnSelection hiddencols;
 
-    for(int i=0; i<annotations.length; i++)
+    public Vector visibleGroups;
+    public Hashtable hiddenRepSeqs;
+    
+    public ViewDef(String viewname, HiddenSequences hidseqs,
+            ColumnSelection hiddencols, Hashtable hiddenRepSeqs)
     {
-      row = annotations[i];
+      this.viewname = viewname;
+      this.hidseqs = hidseqs;
+      this.hiddencols = hiddencols;
+      this.hiddenRepSeqs = hiddenRepSeqs;
+    }
+  }
 
-      if(!row.visible)
-        continue;
+  public String printAnnotations(AlignmentAnnotation[] annotations,
+          Vector groups, Hashtable properties, ViewDef[] views)
+  {
+    if (annotations != null)
+    {
+      boolean oneColour = true;
+      AlignmentAnnotation row;
+      String comma;
+      SequenceI refSeq = null;
 
-      color = null;
+      StringBuffer colours = new StringBuffer();
+      StringBuffer graphLine = new StringBuffer();
 
-      if( row.sequenceRef == null)
-      {
-        if(seqref!=null)
-          text.append("\nSEQUENCE_REF\tALIGNMENT\n");
+      Hashtable graphGroup = new Hashtable();
 
-        seqref = null;
-      }
+      java.awt.Color color;
 
-      else if (seqref == null || seqref != row.sequenceRef)
+      for (int i = 0; i < annotations.length; i++)
       {
-        seqref = row.sequenceRef;
-        text.append("\nSEQUENCE_REF\t" + seqref.getName() + "\n");
-      }
+        row = annotations[i];
 
+        if (!row.visible && !row.hasScore())
+        {
+          continue;
+        }
 
-      if( row.graph == AlignmentAnnotation.NO_GRAPH)
-      {
+        color = null;
+        oneColour = true;
+
+        if (row.sequenceRef == null)
+        {
+          if (refSeq != null)
+          {
+            text.append("\nSEQUENCE_REF\tALIGNMENT\n");
+          }
+
+          refSeq = null;
+        }
+
+        else if (refSeq == null || refSeq != row.sequenceRef)
+        {
+          refSeq = row.sequenceRef;
+          text.append("\nSEQUENCE_REF\t" + refSeq.getName() + "\n");
+        }
+
+        if (row.graph == AlignmentAnnotation.NO_GRAPH)
+        {
           text.append("NO_GRAPH\t");
-      }
-      else
-      {
-        if( row.graph == AlignmentAnnotation.BAR_GRAPH)
-          text.append("BAR_GRAPH\t");
-        else if(row.graph == AlignmentAnnotation.LINE_GRAPH)
-          text.append("LINE_GRAPH\t");
-
-        if(row.getThreshold()!=null)
-            graphLine.append("GRAPHLINE\t"
-                             + row.label + "\t"
-                             + row.getThreshold().value + "\t"
-                             + row.getThreshold().label + "\t"
-                             + jalview.util.Format.getHexString(
-                                 row.getThreshold().colour)+"\n"
-                );
-
-          if(row.graphGroup>-1)
+        }
+        else
+        {
+          if (row.graph == AlignmentAnnotation.BAR_GRAPH)
+          {
+            text.append("BAR_GRAPH\t");
+          }
+          else if (row.graph == AlignmentAnnotation.LINE_GRAPH)
+          {
+            text.append("LINE_GRAPH\t");
+          }
+
+          if (row.getThreshold() != null)
+          {
+            graphLine
+                    .append("GRAPHLINE\t"
+                            + row.label
+                            + "\t"
+                            + row.getThreshold().value
+                            + "\t"
+                            + row.getThreshold().label
+                            + "\t"
+                            + jalview.util.Format.getHexString(row
+                                    .getThreshold().colour) + "\n");
+          }
+
+          if (row.graphGroup > -1)
           {
             String key = String.valueOf(row.graphGroup);
-            if(graphGroup.containsKey(key))
-              graphGroup.put(key, graphGroup.get(key)
-                             +"\t"+row.label);
+            if (graphGroup.containsKey(key))
+            {
+              graphGroup.put(key, graphGroup.get(key) + "\t" + row.label);
+            }
             else
+            {
               graphGroup.put(key, row.label);
+            }
           }
-      }
-
-      text.append(row.label+"\t");
-      if(row.description!=null)
-        text.append(row.description+"\t");
+        }
 
-      for(int j=0; j<row.annotations.length; j++)
-      {
-        if (seqref != null && jalview.util.Comparison.isGap(seqref.getCharAt(j)))
-          continue;
+        text.append(row.label + "\t");
+        if (row.description != null)
+        {
+          text.append(row.description + "\t");
+        }
 
-        if(row.annotations[j]!=null)
+        for (int j = 0; row.annotations != null
+                && j < row.annotations.length; j++)
         {
-          comma = "";
-          if (row.annotations[j].secondaryStructure!=' ')
+          if (refSeq != null
+                  && jalview.util.Comparison.isGap(refSeq.getCharAt(j)))
           {
-            text.append(comma + row.annotations[j].secondaryStructure);
-            comma = ",";
+            continue;
           }
-          if (row.annotations[j].displayCharacter.length() > 0
-                  && !row.annotations[j].displayCharacter.equals(" "))
+
+          if (row.annotations[j] != null)
+          {
+            comma = "";
+            if (row.annotations[j].secondaryStructure != ' ')
+            {
+              text.append(comma + row.annotations[j].secondaryStructure);
+              comma = ",";
+            }
+            if (row.annotations[j].displayCharacter != null
+                    && row.annotations[j].displayCharacter.length() > 0
+                    && !row.annotations[j].displayCharacter.equals(" "))
+            {
+              text.append(comma + row.annotations[j].displayCharacter);
+              comma = ",";
+            }
+
+            if (row.annotations[j] != null)
+            {
+              if (color != null && !color.equals(row.annotations[j].colour))
               {
-                text.append(comma + row.annotations[j].displayCharacter);
-                comma = ",";
+                oneColour = false;
               }
 
-          if (row.annotations[j]!=null)
-          {
-            color = row.annotations[j].colour;
-            if (row.annotations[j].value!=0f)
-              text.append(comma + row.annotations[j].value);
+              color = row.annotations[j].colour;
+              if (row.annotations[j].value != 0f
+                      && row.annotations[j].value != Float.NaN)
+              {
+                text.append(comma + row.annotations[j].value);
+              }
+            }
+
+            if (row.annotations[j].colour != null
+                    && row.annotations[j].colour != java.awt.Color.black)
+            {
+              text.append(comma
+                      + "["
+                      + jalview.util.Format
+                              .getHexString(row.annotations[j].colour)
+                      + "]");
+            }
           }
+          text.append("|");
         }
-        text.append("|");
+
+        if (row.hasScore())
+          text.append("\t" + row.score);
+
+        text.append("\n");
+
+        if (color != null && color != java.awt.Color.black && oneColour)
+        {
+          colours.append("COLOUR\t" + row.label + "\t"
+                  + jalview.util.Format.getHexString(color) + "\n");
+        }
+
       }
 
       text.append("\n");
 
-      if(color!=null && color!=java.awt.Color.black)
+      text.append(colours.toString());
+      text.append(graphLine.toString());
+      if (graphGroup.size() > 0)
       {
-        colours.append("COLOUR\t"
-                       +row.label+"\t"
-                       +jalview.util.Format.getHexString(color)+"\n");
+        text.append("COMBINE\t");
+        Enumeration en = graphGroup.elements();
+        while (en.hasMoreElements())
+        {
+          text.append(en.nextElement() + "\n");
+        }
       }
-
     }
 
-    text.append("\n");
+    if (groups != null)
+    {
+      printGroups(groups);
+    }
 
-    text.append(colours.toString());
-    text.append(graphLine.toString());
-    if(graphGroup.size()>0)
+    if (properties != null)
     {
-      text.append("COMBINE\t");
-      Enumeration en = graphGroup.elements();
-      while(en.hasMoreElements())
+      text.append("\n\nALIGNMENT");
+      Enumeration en = properties.keys();
+      while (en.hasMoreElements())
       {
-        text.append(en.nextElement()+"\n");
+        String key = en.nextElement().toString();
+        text.append("\t" + key + "=" + properties.get(key));
       }
+      // TODO: output alignment visualization settings here if required
+
     }
 
     return text.toString();
   }
 
+  public void printGroups(Vector sequenceGroups)
+  {
+    SequenceGroup sg;
+    SequenceI seqrep=null;
+    for (int i = 0; i < sequenceGroups.size(); i++)
+    {
+      sg = (SequenceGroup) sequenceGroups.elementAt(i);
+      if (!sg.hasSeqrep())
+      {
+        text.append("SEQUENCE_GROUP\t" + sg.getName() + "\t"
+                + (sg.getStartRes() + 1) + "\t" + (sg.getEndRes() + 1) + "\t"
+                + "-1\t");
+        seqrep = null;
+      } else {
+        seqrep = sg.getSeqrep();
+        text.append("SEQUENCE_REF\t"+seqrep.getName()+"\n");
+        text.append("SEQUENCE_GROUP\t" + sg.getName() + "\t"
+                + (seqrep.findPosition(sg.getStartRes())) + "\t" + (seqrep.findPosition(sg.getEndRes())) + "\t"
+                + "-1\t");
+      }
+      for (int s = 0; s < sg.getSize(); s++)
+      {
+        text.append(sg.getSequenceAt(s).getName() + "\t");
+      }
+
+      text.append("\nPROPERTIES\t" + sg.getName() + "\t");
+
+      if (sg.getDescription() != null)
+      {
+        text.append("description=" + sg.getDescription() + "\t");
+      }
+      if (sg.cs != null)
+      {
+        text.append("colour=" + ColourSchemeProperty.getColourName(sg.cs)
+                + "\t");
+        if (sg.cs.getThreshold() != 0)
+        {
+          text.append("pidThreshold=" + sg.cs.getThreshold());
+        }
+        if (sg.cs.conservationApplied())
+        {
+          text.append("consThreshold=" + sg.cs.getConservationInc() + "\t");
+        }
+      }
+      text.append("outlineColour="
+              + jalview.util.Format.getHexString(sg.getOutlineColour())
+              + "\t");
+
+      text.append("displayBoxes=" + sg.getDisplayBoxes() + "\t");
+      text.append("displayText=" + sg.getDisplayText() + "\t");
+      text.append("colourText=" + sg.getColourText() + "\t");
+      text.append("showUnconserved="+sg.getShowunconserved()+"\t");
+      if (sg.textColour != java.awt.Color.black)
+      {
+        text.append("textCol1="
+                + jalview.util.Format.getHexString(sg.textColour) + "\t");
+      }
+      if (sg.textColour2 != java.awt.Color.white)
+      {
+        text.append("textCol2="
+                + jalview.util.Format.getHexString(sg.textColour2) + "\t");
+      }
+      if (sg.thresholdTextColour != 0)
+      {
+        text.append("textColThreshold=" + sg.thresholdTextColour+"\t");
+      }
+      if (sg.idColour != null)
+      {
+        text.append("idColour="
+                + jalview.util.Format.getHexString(sg.idColour) + "\t");
+      }
+      if (sg.isHidereps())
+      {
+        text.append("hide=true\t");
+      }
+      if (sg.isHideCols())
+      {
+        text.append("hidecols=true\t");
+      }
+      if (seqrep!=null)
+      {
+        // terminate the last line and clear the sequence ref for the group
+        text.append("\nSEQUENCE_REF");
+      }
+      text.append("\n\n");
+
+    }
+  }
 
   SequenceI refSeq = null;
-  Hashtable annotationsHash = new Hashtable();
-  public boolean readAnnotationFile(AlignmentI al,
-                                    String file,
-                                    String protocol)
+
+  String refSeqId = null;
+
+  public boolean readAnnotationFile(AlignmentI al, String file,
+          String protocol)
   {
     try
     {
@@ -183,7 +376,7 @@ public class AnnotationFile
         URL url = new URL(file);
         in = new BufferedReader(new InputStreamReader(url.openStream()));
       }
-     else if (protocol.equals(AppletFormatAdapter.PASTE))
+      else if (protocol.equals(AppletFormatAdapter.PASTE))
       {
         in = new BufferedReader(new StringReader(file));
       }
@@ -194,14 +387,16 @@ public class AnnotationFile
         {
           in = new BufferedReader(new java.io.InputStreamReader(is));
         }
-    }
+      }
 
       String line, label, description, token;
       int graphStyle, index;
       int refSeqIndex = 1;
       int existingAnnotations = 0;
-      if(al.getAlignmentAnnotation()!=null)
-       existingAnnotations = al.getAlignmentAnnotation().length;
+      if (al.getAlignmentAnnotation() != null)
+      {
+        existingAnnotations = al.getAlignmentAnnotation().length;
+      }
 
       int alWidth = al.getWidth();
 
@@ -211,10 +406,12 @@ public class AnnotationFile
 
       // First confirm this is an Annotation file
       boolean jvAnnotationFile = false;
-      while ( (line = in.readLine()) != null)
+      while ((line = in.readLine()) != null)
       {
-        if (line.indexOf("#") == 0 )
+        if (line.indexOf("#") == 0)
+        {
           continue;
+        }
 
         if (line.indexOf("JALVIEW_ANNOTATION") > -1)
         {
@@ -223,28 +420,31 @@ public class AnnotationFile
         }
       }
 
-      if(!jvAnnotationFile)
+      if (!jvAnnotationFile)
       {
         in.close();
         return false;
       }
 
-      while ( (line = in.readLine()) != null)
+      while ((line = in.readLine()) != null)
       {
-        if(line.indexOf("#")==0
-           || line.indexOf("JALVIEW_ANNOTATION")>-1
-           || line.length()==0)
+        if (line.indexOf("#") == 0
+                || line.indexOf("JALVIEW_ANNOTATION") > -1
+                || line.length() == 0)
+        {
           continue;
+        }
 
         st = new StringTokenizer(line, "\t");
         token = st.nextToken();
-        if(token.equalsIgnoreCase("COLOUR"))
+        if (token.equalsIgnoreCase("COLOUR"))
         {
+          // TODO: use graduated colour def'n here too
           colourAnnotations(al, st.nextToken(), st.nextToken());
           continue;
         }
 
-        else if(token.equalsIgnoreCase("COMBINE") )
+        else if (token.equalsIgnoreCase("COMBINE"))
         {
           combineAnnotations(al, st);
           continue;
@@ -256,95 +456,165 @@ public class AnnotationFile
           continue;
         }
 
-
-        else if(token.equalsIgnoreCase("SEQUENCE_REF") )
+        else if (token.equalsIgnoreCase("SEQUENCE_REF"))
         {
-          refSeq = al.findName(st.nextToken());
-          try{
-            refSeqIndex = Integer.parseInt(st.nextToken());
-            if(refSeqIndex<1)
+          if (st.hasMoreTokens())
+          {
+            refSeq = al.findName(refSeqId = st.nextToken());
+            if (refSeq == null)
+            {
+              refSeqId = null;
+            }
+            try
+            {
+              refSeqIndex = Integer.parseInt(st.nextToken());
+              if (refSeqIndex < 1)
+              {
+                refSeqIndex = 1;
+                System.out
+                        .println("WARNING: SEQUENCE_REF index must be > 0 in AnnotationFile");
+              }
+            } catch (Exception ex)
             {
               refSeqIndex = 1;
-              System.out.println("WARNING: SEQUENCE_REF index must be > 0 in AnnotationFile");
             }
           }
-          catch(Exception ex)
+          else
           {
-            refSeqIndex = 1;
+            refSeq = null;
+            refSeqId = null;
           }
-
           continue;
         }
 
-        else if(token.equalsIgnoreCase("SEQUENCE_GROUP"))
+        else if (token.equalsIgnoreCase("SEQUENCE_GROUP"))
         {
           addGroup(al, st);
           continue;
         }
 
-        else if(token.equalsIgnoreCase("PROPERTIES"))
+        else if (token.equalsIgnoreCase("PROPERTIES"))
         {
           addProperties(al, st);
           continue;
         }
 
+        else if (token.equalsIgnoreCase("BELOW_ALIGNMENT"))
+        {
+          setBelowAlignment(al, st);
+          continue;
+        }
+        else if (token.equalsIgnoreCase("ALIGNMENT"))
+        {
+          addAlignmentDetails(al, st);
+          continue;
+        }
 
         graphStyle = AlignmentAnnotation.getGraphValueFromString(token);
         label = st.nextToken();
 
-        if(st.countTokens()>1)
-          description = st.nextToken();
-        else
-          description = null;
-
-        line = st.nextToken();
-
-        st = new StringTokenizer(line, "|", true);
-        annotations = new Annotation[alWidth];
-
         index = 0;
-        boolean emptyColumn = true;
-
+        annotations = new Annotation[alWidth];
+        description = null;
+        float score = Float.NaN;
 
-        while (st.hasMoreElements() && index<alWidth)
+        if (st.hasMoreTokens())
         {
-          token = st.nextToken().trim();
-          if(token.equals("|"))
+          line = st.nextToken();
+
+          if (line.indexOf("|") == -1)
           {
-            if(emptyColumn)
-              index++;
+            description = line;
+            if (st.hasMoreTokens())
+              line = st.nextToken();
+          }
 
-            emptyColumn = true;
+          if (st.hasMoreTokens())
+          {
+            // This must be the score
+            score = Float.valueOf(st.nextToken()).floatValue();
           }
-          else
+
+          st = new StringTokenizer(line, "|", true);
+
+          boolean emptyColumn = true;
+          boolean onlyOneElement = (st.countTokens() == 1);
+
+          while (st.hasMoreElements() && index < alWidth)
           {
-            annotations[index++] = parseAnnotation(token);
-            emptyColumn = false;
+            token = st.nextToken().trim();
+
+            if (onlyOneElement)
+            {
+              try
+              {
+                score = Float.valueOf(token).floatValue();
+                break;
+              } catch (NumberFormatException ex)
+              {
+              }
+            }
+
+            if (token.equals("|"))
+            {
+              if (emptyColumn)
+              {
+                index++;
+              }
+
+              emptyColumn = true;
+            }
+            else
+            {
+              annotations[index++] = parseAnnotation(token);
+              emptyColumn = false;
+            }
           }
-        }
 
-       annotation = new AlignmentAnnotation(label,
-                                          description,
-                                          annotations,
-                                          0,
-                                          0,
-                                          graphStyle);
+        }
 
-       if(refSeq!=null)
-       {
-         annotation.createSequenceMapping(refSeq, refSeqIndex, false);
-         refSeq.addAlignmentAnnotation(annotation);
-       }
+        annotation = new AlignmentAnnotation(label, description,
+                (index == 0) ? null : annotations, 0, 0, graphStyle);
 
-       al.addAnnotation(annotation);
+        annotation.score = score;
 
-       al.setAnnotationIndex(annotation,  al.getAlignmentAnnotation().length - existingAnnotations-1);
+        if (refSeq != null)
+        {
+          annotation.belowAlignment = false;
+          // make a copy of refSeq so we can find other matches in the alignment
+          SequenceI referedSeq = refSeq;
+          do
+          {
+            // copy before we do any mapping business.
+            // TODO: verify that undo/redo with 1:many sequence associated
+            // annotations can be undone correctly
+            AlignmentAnnotation ann = new AlignmentAnnotation(annotation);
+            annotation.createSequenceMapping(referedSeq, refSeqIndex, false);
+            annotation.adjustForAlignment();
+            referedSeq.addAlignmentAnnotation(annotation);
+            al.addAnnotation(annotation);
+            al.setAnnotationIndex(annotation,
+                    al.getAlignmentAnnotation().length
+                            - existingAnnotations - 1);
+            // and recover our virgin copy to use again if necessary.
+            annotation = ann;
+
+          } while (refSeqId != null
+                  && (referedSeq = al.findName(referedSeq, refSeqId, true)) != null);
+        }
+        else
+        {
+          al.addAnnotation(annotation);
+          al.setAnnotationIndex(annotation,
+                  al.getAlignmentAnnotation().length - existingAnnotations
+                          - 1);
+        }
       }
 
-    }catch(Exception ex)
+    } catch (Exception ex)
     {
       ex.printStackTrace();
-      System.out.println("Problem reading annotation file: "+ex);
+      System.out.println("Problem reading annotation file: " + ex);
       return false;
     }
     return true;
@@ -352,67 +622,99 @@ public class AnnotationFile
 
   Annotation parseAnnotation(String string)
   {
-    String desc = null, displayChar="";
+    String desc = null, displayChar = null;
     char ss = ' '; // secondaryStructure
     float value = 0;
     boolean parsedValue = false;
+
+    // find colour here
+    java.awt.Color colour = null;
+    int i = string.indexOf("[");
+    int j = string.indexOf("]");
+    if (i > -1 && j > -1)
+    {
+      UserColourScheme ucs = new UserColourScheme();
+
+      colour = ucs.getColourFromString(string.substring(i + 1, j));
+
+      string = string.substring(0, i) + string.substring(j + 1);
+    }
+
     StringTokenizer st = new StringTokenizer(string, ",");
     String token;
-    while(st.hasMoreTokens())
+    while (st.hasMoreTokens())
     {
       token = st.nextToken().trim();
-      if(token.length()==0)
+      if (token.length() == 0)
+      {
         continue;
+      }
 
-      if(!parsedValue)
+      if (!parsedValue)
       {
-        try{
+        try
+        {
           displayChar = token;
           value = new Float(token).floatValue();
           parsedValue = true;
           continue;
-        }catch(NumberFormatException ex){}
+        } catch (NumberFormatException ex)
+        {
+        }
       }
 
-      if(token.equals("H") || token.equals("E"))
+      if (token.equals("H") || token.equals("E"))
       {
         // Either this character represents a helix or sheet
         // or an integer which can be displayed
         ss = token.charAt(0);
-        if(displayChar.equals(token.substring(0,1)))
+        if (displayChar.equals(token.substring(0, 1)))
+        {
           displayChar = "";
+        }
       }
-      else if(desc==null)
+      else if (desc == null)
+      {
         desc = token;
+      }
 
     }
 
-    if(desc == null)
-      desc = value+"";
-
-    if(displayChar.length()>1 && desc.length()==1)
+    if (displayChar != null && displayChar.length() > 1 && desc != null
+            && desc.length() == 1)
     {
       String tmp = displayChar;
       displayChar = desc;
       desc = tmp;
     }
+    /*
+     * In principle, this code will ensure that the Annotation element generated
+     * is renderable by any of the applet or application rendering code but
+     * instead we check for null strings when the display character is rendered.
+     * if (displayChar==null) { displayChar=""; }
+     */
+    Annotation anot = new Annotation(displayChar, desc, ss, value);
+
+    anot.colour = colour;
 
-    return new Annotation(displayChar, desc, ss, value);
+    return anot;
   }
 
   void colourAnnotations(AlignmentI al, String label, String colour)
   {
     UserColourScheme ucs = new UserColourScheme(colour);
     Annotation[] annotations;
-    for(int i=0; i<al.getAlignmentAnnotation().length; i++)
+    for (int i = 0; i < al.getAlignmentAnnotation().length; i++)
     {
-      if(al.getAlignmentAnnotation()[i].label.equalsIgnoreCase(label))
+      if (al.getAlignmentAnnotation()[i].label.equalsIgnoreCase(label))
       {
         annotations = al.getAlignmentAnnotation()[i].annotations;
-        for(int j=0; j<annotations.length; j++)
+        for (int j = 0; j < annotations.length; j++)
         {
-          if(annotations[j]!=null)
+          if (annotations[j] != null)
+          {
             annotations[j].colour = ucs.findColour('A');
+          }
         }
       }
     }
@@ -422,22 +724,22 @@ public class AnnotationFile
   {
     int graphGroup = -1;
     String group = st.nextToken();
-    //First make sure we are not overwriting the graphIndex
-    for(int i=0; i<al.getAlignmentAnnotation().length; i++)
+    // First make sure we are not overwriting the graphIndex
+    for (int i = 0; i < al.getAlignmentAnnotation().length; i++)
     {
-      if(al.getAlignmentAnnotation()[i].label.equalsIgnoreCase(group))
+      if (al.getAlignmentAnnotation()[i].label.equalsIgnoreCase(group))
       {
-        graphGroup = al.getAlignmentAnnotation()[i].graphGroup +1;
+        graphGroup = al.getAlignmentAnnotation()[i].graphGroup + 1;
         al.getAlignmentAnnotation()[i].graphGroup = graphGroup;
         break;
       }
     }
 
-    //Now update groups
-    while(st.hasMoreTokens())
+    // Now update groups
+    while (st.hasMoreTokens())
     {
       group = st.nextToken();
-      for(int i=0; i<al.getAlignmentAnnotation().length; i++)
+      for (int i = 0; i < al.getAlignmentAnnotation().length; i++)
       {
         if (al.getAlignmentAnnotation()[i].label.equalsIgnoreCase(group))
         {
@@ -462,12 +764,14 @@ public class AnnotationFile
       }
     }
 
-    if(annotation==null)
+    if (annotation == null)
+    {
       return;
+    }
     float value = new Float(st.nextToken()).floatValue();
-    String label = st.hasMoreTokens() ?  st.nextToken() : null;
+    String label = st.hasMoreTokens() ? st.nextToken() : null;
     java.awt.Color colour = null;
-    if(st.hasMoreTokens())
+    if (st.hasMoreTokens())
     {
       UserColourScheme ucs = new UserColourScheme(st.nextToken());
       colour = ucs.findColour('A');
@@ -475,16 +779,36 @@ public class AnnotationFile
 
     annotation.setThreshold(new GraphLine(value, label, colour));
   }
-
   void addGroup(AlignmentI al, StringTokenizer st)
   {
     SequenceGroup sg = new SequenceGroup();
     sg.setName(st.nextToken());
-    sg.setStartRes(Integer.parseInt(st.nextToken())-1);
-    sg.setEndRes(Integer.parseInt(st.nextToken())-1);
+    String rng ="";
+    try {
+      rng = st.nextToken();
+      if (rng.length()>0 && !rng.startsWith("*"))
+      {
+        sg.setStartRes(Integer.parseInt(rng) - 1);
+      } else {
+        sg.setStartRes(0);
+      }
+      rng = st.nextToken();
+      if (rng.length()>0 && !rng.startsWith("*"))
+      {
+        sg.setEndRes(Integer.parseInt(rng) - 1);
+      } else {
+        sg.setEndRes(al.getWidth()-1);
+      }
+    } catch (Exception e)
+    {
+      System.err.println("Couldn't parse Group Start or End Field as '*' or a valid column or sequence index: '"+rng+"' - assuming alignment width for group.");
+      // assume group is full width
+      sg.setStartRes(0);
+      sg.setEndRes(al.getWidth()-1);
+    }
 
     String index = st.nextToken();
-    if(index.equals("-1"))
+    if (index.equals("-1"))
     {
       while (st.hasMoreElements())
       {
@@ -513,74 +837,218 @@ public class AnnotationFile
           int end = (Integer.parseInt(st3.nextToken()));
 
           if (end > start)
+          {
             for (int i = start; i <= end; i++)
-              sg.addSequence(al.getSequenceAt(i-1), false);
+            {
+              sg.addSequence(al.getSequenceAt(i - 1), false);
+            }
+          }
         }
         else
         {
-          sg.addSequence(al.getSequenceAt(Integer.parseInt(tmp)-1 ), false);
+          sg
+                  .addSequence(al.getSequenceAt(Integer.parseInt(tmp) - 1),
+                          false);
         }
       }
     }
 
-    if(refSeq!=null)
+    if (refSeq != null)
     {
-      sg.setStartRes( refSeq.findIndex( sg.getStartRes()+1 )-1 );
-      sg.setEndRes(   refSeq.findIndex( sg.getEndRes() +1) -1 );
+      sg.setStartRes(refSeq.findIndex(sg.getStartRes() + 1) - 1);
+      sg.setEndRes(refSeq.findIndex(sg.getEndRes() + 1) - 1);
+      sg.setSeqrep(refSeq);
     }
 
-
-    al.addGroup(sg);
-    annotationsHash.put(sg.getName(), sg);
+    if (sg.getSize() > 0)
+    {
+      al.addGroup(sg);
+    }
   }
 
   void addProperties(AlignmentI al, StringTokenizer st)
   {
 
-    //So far we have only added groups to the annotationHash,
-    //the idea is in the future properties can be added to
-    //alignments, other annotations etc
-    SequenceGroup sg = (SequenceGroup)annotationsHash.get(st.nextToken());
+    // So far we have only added groups to the annotationHash,
+    // the idea is in the future properties can be added to
+    // alignments, other annotations etc
+    if (al.getGroups() == null)
+    {
+      return;
+    }
+    SequenceGroup sg = null;
+
+    String name = st.nextToken();
+
+    Vector groups = al.getGroups();
+    for (int i = 0; i < groups.size(); i++)
+    {
+      sg = (SequenceGroup) groups.elementAt(i);
+      if (sg.getName().equals(name))
+      {
+        break;
+      }
+      else
+      {
+        sg = null;
+      }
+    }
 
-    if(sg!=null)
+    if (sg != null)
     {
       String keyValue, key, value;
-      while(st.hasMoreTokens())
+      ColourSchemeI def = sg.cs;
+      sg.cs = null;
+      while (st.hasMoreTokens())
       {
         keyValue = st.nextToken();
-        key = keyValue.substring(0,keyValue.indexOf("="));
-        value=keyValue.substring(keyValue.indexOf("=")+1);
+        key = keyValue.substring(0, keyValue.indexOf("="));
+        value = keyValue.substring(keyValue.indexOf("=") + 1);
 
-        if(key.equalsIgnoreCase("description"))
+        if (key.equalsIgnoreCase("description"))
+        {
           sg.setDescription(value);
-        else if(key.equalsIgnoreCase("colour"))
+        }
+        else if (key.equalsIgnoreCase("colour"))
+        {
           sg.cs = ColourSchemeProperty.getColour(al, value);
+        }
         else if (key.equalsIgnoreCase("pidThreshold"))
-          sg.cs.setThreshold(Integer.parseInt(value), false);//
-        else if (key.equalsIgnoreCase("outlineColour"))
-         {
-           sg.setOutlineColour(new UserColourScheme(value).findColour('A'));
-         }
+        {
+          sg.cs.setThreshold(Integer.parseInt(value), true);
 
-         //Boolean.valueOf(string).booleanValue();
+        }
+        else if (key.equalsIgnoreCase("consThreshold"))
+        {
+          sg.cs.setConservationInc(Integer.parseInt(value));
+          Conservation c = new Conservation("Group",
+                  ResidueProperties.propHash, 3, sg.getSequences(null), sg
+                          .getStartRes(), sg.getEndRes() + 1);
+
+          c.calculate();
+          c.verdict(false, 25);
+
+          sg.cs.setConservation(c);
+
+        }
+        else if (key.equalsIgnoreCase("outlineColour"))
+        {
+          sg.setOutlineColour(new UserColourScheme(value).findColour('A'));
+        }
         else if (key.equalsIgnoreCase("displayBoxes"))
-         sg.setDisplayBoxes( Boolean.valueOf(value).booleanValue() );
+        {
+          sg.setDisplayBoxes(Boolean.valueOf(value).booleanValue());
+        }
+        else if (key.equalsIgnoreCase("showUnconserved"))
+        {
+          sg.setShowunconserved(Boolean.valueOf(value).booleanValue());
+        }
         else if (key.equalsIgnoreCase("displayText"))
-         sg.setDisplayText( Boolean.valueOf(value).booleanValue() );
+        {
+          sg.setDisplayText(Boolean.valueOf(value).booleanValue());
+        }
         else if (key.equalsIgnoreCase("colourText"))
-         sg.setColourText( Boolean.valueOf(value).booleanValue() );
+        {
+          sg.setColourText(Boolean.valueOf(value).booleanValue());
+        }
         else if (key.equalsIgnoreCase("textCol1"))
-         {
-           sg.textColour = new UserColourScheme(value).findColour('A');
-         }
+        {
+          sg.textColour = new UserColourScheme(value).findColour('A');
+        }
         else if (key.equalsIgnoreCase("textCol2"))
         {
           sg.textColour2 = new UserColourScheme(value).findColour('A');
         }
         else if (key.equalsIgnoreCase("textColThreshold"))
-         sg.thresholdTextColour = Integer.parseInt(value);
+        {
+          sg.thresholdTextColour = Integer.parseInt(value);
+        }
+        else if (key.equalsIgnoreCase("idColour"))
+        {
+          // consider warning if colour doesn't resolve to a real colour
+          sg.setIdColour((def = new UserColourScheme(value))
+                  .findColour('A'));
+        }
+        else if (key.equalsIgnoreCase("hide"))
+        {
+          // see bug https://mantis.lifesci.dundee.ac.uk/view.php?id=25847
+          sg.setHidereps(true);
+        }
+        else if (key.equalsIgnoreCase("hidecols"))
+        {
+          // see bug https://mantis.lifesci.dundee.ac.uk/view.php?id=25847
+          sg.setHideCols(true);
+        }
+        sg.recalcConservation();
+      }
+      if (sg.cs == null)
+      {
+        sg.cs = def;
+      }
+    }
+  }
 
+  void setBelowAlignment(AlignmentI al, StringTokenizer st)
+  {
+    String token;
+    AlignmentAnnotation aa;
+    while (st.hasMoreTokens())
+    {
+      token = st.nextToken();
+      for (int i = 0; i < al.getAlignmentAnnotation().length; i++)
+      {
+        aa = al.getAlignmentAnnotation()[i];
+        if (aa.sequenceRef == refSeq && aa.label.equals(token))
+        {
+          aa.belowAlignment = true;
+        }
       }
     }
   }
+
+  void addAlignmentDetails(AlignmentI al, StringTokenizer st)
+  {
+    String keyValue, key, value;
+    while (st.hasMoreTokens())
+    {
+      keyValue = st.nextToken();
+      key = keyValue.substring(0, keyValue.indexOf("="));
+      value = keyValue.substring(keyValue.indexOf("=") + 1);
+      al.setProperty(key, value);
+    }
+  }
+
+  /**
+   * Write annotations as a CSV file of the form 'label, value, value, ...' for
+   * each row.
+   * 
+   * @param annotations
+   * @return CSV file as a string.
+   */
+  public String printCSVAnnotations(AlignmentAnnotation[] annotations)
+  {
+    StringBuffer sp = new StringBuffer();
+    for (int i = 0; i < annotations.length; i++)
+    {
+      String atos = annotations[i].toString();
+      int p = 0;
+      do
+      {
+        int cp = atos.indexOf("\n", p);
+        sp.append(annotations[i].label);
+        sp.append(",");
+        if (cp > p)
+        {
+          sp.append(atos.substring(p, cp + 1));
+        }
+        else
+        {
+          sp.append(atos.substring(p));
+          sp.append("\n");
+        }
+        p = cp + 1;
+      } while (p > 0);
+    }
+    return sp.toString();
+  }
 }