update author list in license for (JAL-826)
[jalview.git] / src / jalview / io / FeaturesFile.java
index 3e0314a..2ac0e13 100755 (executable)
@@ -1,28 +1,29 @@
 /*\r
- * Jalview - A Sequence Alignment Editor and Viewer\r
- * Copyright (C) 2007 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
- *\r
- * This program is free software; you can redistribute it and/or\r
- * modify it under the terms of the GNU General Public License\r
- * as published by the Free Software Foundation; either version 2\r
- * of the License, or (at your option) any later version.\r
- *\r
- * This program is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License\r
- * along with this program; if not, write to the Free Software\r
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)\r
+ * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle\r
+ * \r
+ * This file is part of Jalview.\r
+ * \r
+ * Jalview is free software: you can redistribute it and/or\r
+ * modify it under the terms of the GNU General Public License \r
+ * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.\r
+ * \r
+ * Jalview is distributed in the hope that it will be useful, but \r
+ * WITHOUT ANY WARRANTY; without even the implied warranty \r
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR \r
+ * PURPOSE.  See the GNU General Public License for more details.\r
+ * \r
+ * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.\r
  */\r
 package jalview.io;\r
 \r
 import java.io.*;\r
 import java.util.*;\r
 \r
+import jalview.analysis.SequenceIdMatcher;\r
 import jalview.datamodel.*;\r
 import jalview.schemes.*;\r
+import jalview.util.Format;\r
 \r
 /**\r
  * Parse and create Jalview Features files Detects GFF format features files and\r
@@ -36,6 +37,12 @@ import jalview.schemes.*;
 public class FeaturesFile extends AlignFile\r
 {\r
   /**\r
+   * work around for GFF interpretation bug where source string becomes\r
+   * description rather than a group\r
+   */\r
+  private boolean doGffSource = true;\r
+\r
+  /**\r
    * Creates a new FeaturesFile object.\r
    */\r
   public FeaturesFile()\r
@@ -46,12 +53,12 @@ public class FeaturesFile extends AlignFile
    * Creates a new FeaturesFile object.\r
    * \r
    * @param inFile\r
-   *                DOCUMENT ME!\r
+   *          DOCUMENT ME!\r
    * @param type\r
-   *                DOCUMENT ME!\r
+   *          DOCUMENT ME!\r
    * \r
    * @throws IOException\r
-   *                 DOCUMENT ME!\r
+   *           DOCUMENT ME!\r
    */\r
   public FeaturesFile(String inFile, String type) throws IOException\r
   {\r
@@ -64,28 +71,60 @@ public class FeaturesFile extends AlignFile
   }\r
 \r
   /**\r
-   * The Application can render HTML, but the applet will remove HTML tags and\r
-   * replace links with %LINK% Both need to read links in HTML however\r
-   * \r
-   * @throws IOException\r
-   *                 DOCUMENT ME!\r
+   * Parse GFF or sequence features file using case-independent matching, discarding URLs\r
+   * @param align - alignment/dataset containing sequences that are to be annotated\r
+   * @param colours - hashtable to store feature colour definitions\r
+   * @param removeHTML - process html strings into plain text\r
+   * @return true if features were added\r
    */\r
   public boolean parse(AlignmentI align, Hashtable colours,\r
           boolean removeHTML)\r
   {\r
-    return parse(align, colours, null, removeHTML);\r
+    return parse(align, colours, null, removeHTML, false);\r
   }\r
 \r
   /**\r
-   * The Application can render HTML, but the applet will remove HTML tags and\r
-   * replace links with %LINK% Both need to read links in HTML however\r
-   * \r
-   * @throws IOException\r
-   *                 DOCUMENT ME!\r
+   * Parse GFF or sequence features file optionally using case-independent matching, discarding URLs\r
+   * @param align - alignment/dataset containing sequences that are to be annotated\r
+   * @param colours - hashtable to store feature colour definitions\r
+   * @param removeHTML - process html strings into plain text\r
+   * @param relaxedIdmatching - when true, ID matches to compound sequence IDs are allowed\r
+   * @return true if features were added\r
+   */\r
+  public boolean parse(AlignmentI align, \r
+          Hashtable colours, boolean removeHTML, boolean relaxedIdMatching)\r
+  {\r
+    return parse(align, colours, null, removeHTML, relaxedIdMatching);\r
+  }\r
+\r
+  /**\r
+   * Parse GFF or sequence features file optionally using case-independent matching\r
+   * @param align - alignment/dataset containing sequences that are to be annotated\r
+   * @param colours - hashtable to store feature colour definitions\r
+   * @param featureLink - hashtable to store associated URLs \r
+   * @param removeHTML - process html strings into plain text\r
+   * @return true if features were added\r
    */\r
   public boolean parse(AlignmentI align, Hashtable colours,\r
           Hashtable featureLink, boolean removeHTML)\r
   {\r
+    return parse(align, colours, featureLink, removeHTML, false);\r
+  }\r
+\r
+  /**\r
+  /**\r
+   * Parse GFF or sequence features file \r
+   * @param align - alignment/dataset containing sequences that are to be annotated\r
+   * @param colours - hashtable to store feature colour definitions\r
+   * @param featureLink - hashtable to store associated URLs \r
+   * @param removeHTML - process html strings into plain text\r
+   * @param relaxedIdmatching - when true, ID matches to compound sequence IDs are allowed\r
+   * @return true if features were added\r
+   */\r
+  public boolean parse(AlignmentI align,\r
+          Hashtable colours, Hashtable featureLink, boolean removeHTML, boolean relaxedIdmatching)\r
+  {\r
+\r
     String line = null;\r
     try\r
     {\r
@@ -98,9 +137,10 @@ public class FeaturesFile extends AlignFile
       SequenceFeature sf;\r
       String featureGroup = null, groupLink = null;\r
       Hashtable typeLink = new Hashtable();\r
-\r
+      /**\r
+       * when true, assume GFF style features rather than Jalview style.\r
+       */\r
       boolean GFFFile = true;\r
-\r
       while ((line = nextLine()) != null)\r
       {\r
         if (line.startsWith("#"))\r
@@ -109,6 +149,15 @@ public class FeaturesFile extends AlignFile
         }\r
 \r
         st = new StringTokenizer(line, "\t");\r
+        if (st.countTokens() == 1)\r
+        {\r
+          if (line.trim().equalsIgnoreCase("GFF"))\r
+          {\r
+            // Start parsing file as if it might be GFF again.\r
+            GFFFile = true;\r
+            continue;\r
+          }\r
+        }\r
         if (st.countTokens() > 1 && st.countTokens() < 4)\r
         {\r
           GFFFile = false;\r
@@ -132,8 +181,205 @@ public class FeaturesFile extends AlignFile
           }\r
           else\r
           {\r
-            UserColourScheme ucs = new UserColourScheme(st.nextToken());\r
-            colours.put(type, ucs.findColour('A'));\r
+            Object colour = null;\r
+            String colscheme = st.nextToken();\r
+            if (colscheme.indexOf("|") > -1\r
+                    || colscheme.trim().equalsIgnoreCase("label"))\r
+            {\r
+              // Parse '|' separated graduated colourscheme fields:\r
+              // [label|][mincolour|maxcolour|[absolute|]minvalue|maxvalue|thresholdtype|thresholdvalue]\r
+              // can either provide 'label' only, first is optional, next two\r
+              // colors are required (but may be\r
+              // left blank), next is optional, nxt two min/max are required.\r
+              // first is either 'label'\r
+              // first/second and third are both hexadecimal or word equivalent\r
+              // colour.\r
+              // next two are values parsed as floats.\r
+              // fifth is either 'above','below', or 'none'.\r
+              // sixth is a float value and only required when fifth is either\r
+              // 'above' or 'below'.\r
+              StringTokenizer gcol = new StringTokenizer(colscheme, "|",\r
+                      true);\r
+              // set defaults\r
+              int threshtype = AnnotationColourGradient.NO_THRESHOLD;\r
+              float min = Float.MIN_VALUE, max = Float.MAX_VALUE, threshval = Float.NaN;\r
+              boolean labelCol = false;\r
+              // Parse spec line\r
+              String mincol = gcol.nextToken();\r
+              if (mincol == "|")\r
+              {\r
+                System.err\r
+                        .println("Expected either 'label' or a colour specification in the line: "\r
+                                + line);\r
+                continue;\r
+              }\r
+              String maxcol = null;\r
+              if (mincol.toLowerCase().indexOf("label") == 0)\r
+              {\r
+                labelCol = true;\r
+                mincol = (gcol.hasMoreTokens() ? gcol.nextToken() : null); // skip\r
+                                                                           // '|'\r
+                mincol = (gcol.hasMoreTokens() ? gcol.nextToken() : null);\r
+              }\r
+              String abso = null, minval, maxval;\r
+              if (mincol != null)\r
+              {\r
+                // at least four more tokens\r
+                if (mincol.equals("|"))\r
+                {\r
+                  mincol = "";\r
+                }\r
+                else\r
+                {\r
+                  gcol.nextToken(); // skip next '|'\r
+                }\r
+                // continue parsing rest of line\r
+                maxcol = gcol.nextToken();\r
+                if (maxcol.equals("|"))\r
+                {\r
+                  maxcol = "";\r
+                }\r
+                else\r
+                {\r
+                  gcol.nextToken(); // skip next '|'\r
+                }\r
+                abso = gcol.nextToken();\r
+                gcol.nextToken(); // skip next '|'\r
+                if (abso.toLowerCase().indexOf("abso") != 0)\r
+                {\r
+                  minval = abso;\r
+                  abso = null;\r
+                }\r
+                else\r
+                {\r
+                  minval = gcol.nextToken();\r
+                  gcol.nextToken(); // skip next '|'\r
+                }\r
+                maxval = gcol.nextToken();\r
+                if (gcol.hasMoreTokens())\r
+                {\r
+                  gcol.nextToken(); // skip next '|'\r
+                }\r
+                try\r
+                {\r
+                  if (minval.length() > 0)\r
+                  {\r
+                    min = new Float(minval).floatValue();\r
+                  }\r
+                } catch (Exception e)\r
+                {\r
+                  System.err\r
+                          .println("Couldn't parse the minimum value for graduated colour for type ("\r
+                                  + colscheme\r
+                                  + ") - did you misspell 'auto' for the optional automatic colour switch ?");\r
+                  e.printStackTrace();\r
+                }\r
+                try\r
+                {\r
+                  if (maxval.length() > 0)\r
+                  {\r
+                    max = new Float(maxval).floatValue();\r
+                  }\r
+                } catch (Exception e)\r
+                {\r
+                  System.err\r
+                          .println("Couldn't parse the maximum value for graduated colour for type ("\r
+                                  + colscheme + ")");\r
+                  e.printStackTrace();\r
+                }\r
+              }\r
+              else\r
+              {\r
+                // add in some dummy min/max colours for the label-only\r
+                // colourscheme.\r
+                mincol = "FFFFFF";\r
+                maxcol = "000000";\r
+              }\r
+              try\r
+              {\r
+                colour = new jalview.schemes.GraduatedColor(\r
+                        new UserColourScheme(mincol).findColour('A'),\r
+                        new UserColourScheme(maxcol).findColour('A'), min,\r
+                        max);\r
+              } catch (Exception e)\r
+              {\r
+                System.err\r
+                        .println("Couldn't parse the graduated colour scheme ("\r
+                                + colscheme + ")");\r
+                e.printStackTrace();\r
+              }\r
+              if (colour != null)\r
+              {\r
+                ((jalview.schemes.GraduatedColor) colour)\r
+                        .setColourByLabel(labelCol);\r
+                ((jalview.schemes.GraduatedColor) colour)\r
+                        .setAutoScaled(abso == null);\r
+                // add in any additional parameters\r
+                String ttype = null, tval = null;\r
+                if (gcol.hasMoreTokens())\r
+                {\r
+                  // threshold type and possibly a threshold value\r
+                  ttype = gcol.nextToken();\r
+                  if (ttype.toLowerCase().startsWith("below"))\r
+                  {\r
+                    ((jalview.schemes.GraduatedColor) colour)\r
+                            .setThreshType(AnnotationColourGradient.BELOW_THRESHOLD);\r
+                  }\r
+                  else if (ttype.toLowerCase().startsWith("above"))\r
+                  {\r
+                    ((jalview.schemes.GraduatedColor) colour)\r
+                            .setThreshType(AnnotationColourGradient.ABOVE_THRESHOLD);\r
+                  }\r
+                  else\r
+                  {\r
+                    ((jalview.schemes.GraduatedColor) colour)\r
+                            .setThreshType(AnnotationColourGradient.NO_THRESHOLD);\r
+                    if (!ttype.toLowerCase().startsWith("no"))\r
+                    {\r
+                      System.err\r
+                              .println("Ignoring unrecognised threshold type : "\r
+                                      + ttype);\r
+                    }\r
+                  }\r
+                }\r
+                if (((GraduatedColor) colour).getThreshType() != AnnotationColourGradient.NO_THRESHOLD)\r
+                {\r
+                  try\r
+                  {\r
+                    gcol.nextToken();\r
+                    tval = gcol.nextToken();\r
+                    ((jalview.schemes.GraduatedColor) colour)\r
+                            .setThresh(new Float(tval).floatValue());\r
+                  } catch (Exception e)\r
+                  {\r
+                    System.err\r
+                            .println("Couldn't parse threshold value as a float: ("\r
+                                    + tval + ")");\r
+                    e.printStackTrace();\r
+                  }\r
+                }\r
+                // parse the thresh-is-min token ?\r
+                if (gcol.hasMoreTokens())\r
+                {\r
+                  System.err\r
+                          .println("Ignoring additional tokens in parameters in graduated colour specification\n");\r
+                  while (gcol.hasMoreTokens())\r
+                  {\r
+                    System.err.println("|" + gcol.nextToken());\r
+                  }\r
+                  System.err.println("\n");\r
+                }\r
+              }\r
+            }\r
+            else\r
+            {\r
+              UserColourScheme ucs = new UserColourScheme(colscheme);\r
+              colour = ucs.findColour('A');\r
+            }\r
+            if (colour != null)\r
+            {\r
+              colours.put(type, colour);\r
+            }\r
             if (st.hasMoreElements())\r
             {\r
               String link = st.nextToken();\r
@@ -144,11 +390,10 @@ public class FeaturesFile extends AlignFile
               }\r
               featureLink.put(type, link);\r
             }\r
-\r
           }\r
           continue;\r
         }\r
-        String seqId="";\r
+        String seqId = "";\r
         while (st.hasMoreElements())\r
         {\r
 \r
@@ -157,24 +402,53 @@ public class FeaturesFile extends AlignFile
             // Still possible this is an old Jalview file,\r
             // which does not have type colours at the beginning\r
             seqId = token = st.nextToken();\r
-            seq = align.findName(seqId, true);\r
+            seq = findName(align, seqId, relaxedIdmatching);\r
             if (seq != null)\r
             {\r
               desc = st.nextToken();\r
+              String group = null;\r
+              if (doGffSource && desc.indexOf(' ') == -1)\r
+              {\r
+                // could also be a source term rather than description line\r
+                group = new String(desc);\r
+              }\r
               type = st.nextToken();\r
               try\r
               {\r
-                start = Integer.parseInt(st.nextToken());\r
+                String stt = st.nextToken();\r
+                if (stt.length() == 0 || stt.equals("-"))\r
+                {\r
+                  start = 0;\r
+                }\r
+                else\r
+                {\r
+                  start = Integer.parseInt(stt);\r
+                }\r
               } catch (NumberFormatException ex)\r
               {\r
                 start = 0;\r
               }\r
               try\r
               {\r
-                end = Integer.parseInt(st.nextToken());\r
+                String stt = st.nextToken();\r
+                if (stt.length() == 0 || stt.equals("-"))\r
+                {\r
+                  end = 0;\r
+                }\r
+                else\r
+                {\r
+                  end = Integer.parseInt(stt);\r
+                }\r
               } catch (NumberFormatException ex)\r
               {\r
-                end = -1;\r
+                end = 0;\r
+              }\r
+              // TODO: decide if non positional feature assertion for input data\r
+              // where end==0 is generally valid\r
+              if (end == 0)\r
+              {\r
+                // treat as non-positional feature, regardless.\r
+                start = 0;\r
               }\r
               try\r
               {\r
@@ -184,7 +458,7 @@ public class FeaturesFile extends AlignFile
                 score = 0;\r
               }\r
 \r
-              sf = new SequenceFeature(type, desc, start, end, score, null);\r
+              sf = new SequenceFeature(type, desc, start, end, score, group);\r
 \r
               try\r
               {\r
@@ -201,11 +475,14 @@ public class FeaturesFile extends AlignFile
                 {\r
                   attributes.append("\t" + st.nextElement());\r
                 }\r
+                // TODO validate and split GFF2 attributes field ? parse out\r
+                // ([A-Za-z][A-Za-z0-9_]*) <value> ; and add as\r
+                // sf.setValue(attrib, val);\r
                 sf.setValue("ATTRIBUTES", attributes.toString());\r
               }\r
 \r
               seq.addSequenceFeature(sf);\r
-              while ((seq=align.findName(seq, seqId, true))!=null)\r
+              while ((seq = align.findName(seq, seqId, true)) != null)\r
               {\r
                 seq.addSequenceFeature(new SequenceFeature(sf));\r
               }\r
@@ -234,12 +511,12 @@ public class FeaturesFile extends AlignFile
 \r
           if (!token.equals("ID_NOT_SPECIFIED"))\r
           {\r
-            seq = align.findName(seqId=token, true);\r
+            seq = findName(align, seqId = token, relaxedIdmatching);\r
             st.nextToken();\r
           }\r
           else\r
           {\r
-            seqId=null;\r
+            seqId = null;\r
             try\r
             {\r
               index = Integer.parseInt(st.nextToken());\r
@@ -267,9 +544,19 @@ public class FeaturesFile extends AlignFile
             UserColourScheme ucs = new UserColourScheme(type);\r
             colours.put(type, ucs.findColour('A'));\r
           }\r
-\r
           sf = new SequenceFeature(type, desc, "", start, end, featureGroup);\r
-\r
+          if (st.hasMoreTokens())\r
+          {\r
+            try\r
+            {\r
+              score = new Float(st.nextToken()).floatValue();\r
+              // update colourgradient bounds if allowed to\r
+            } catch (NumberFormatException ex)\r
+            {\r
+              score = 0;\r
+            }\r
+            sf.setScore(score);\r
+          }\r
           if (groupLink != null && removeHTML)\r
           {\r
             sf.addLink(groupLink);\r
@@ -285,7 +572,8 @@ public class FeaturesFile extends AlignFile
 \r
           seq.addSequenceFeature(sf);\r
 \r
-          while (seqId!=null && (seq=align.findName(seq, seqId, false))!=null)\r
+          while (seqId != null\r
+                  && (seq = align.findName(seq, seqId, false)) != null)\r
           {\r
             seq.addSequenceFeature(new SequenceFeature(sf));\r
           }\r
@@ -293,139 +581,170 @@ public class FeaturesFile extends AlignFile
           GFFFile = false;\r
         }\r
       }\r
+      resetMatcher();\r
     } catch (Exception ex)\r
     {\r
       System.out.println(line);\r
       System.out.println("Error parsing feature file: " + ex + "\n" + line);\r
       ex.printStackTrace(System.err);\r
+      resetMatcher();\r
       return false;\r
     }\r
 \r
     return true;\r
   }\r
 \r
-  public void parseDescriptionHTML(SequenceFeature sf, boolean removeHTML)\r
+  private AlignmentI lastmatchedAl = null;\r
+\r
+  private SequenceIdMatcher matcher = null;\r
+\r
+  /**\r
+   * clear any temporary handles used to speed up ID matching\r
+   */\r
+  private void resetMatcher()\r
   {\r
-    if (sf.getDescription() == null)\r
+    lastmatchedAl = null;\r
+    matcher = null;\r
+  }\r
+\r
+  private SequenceI findName(AlignmentI align, String seqId,\r
+          boolean relaxedIdMatching)\r
+  {\r
+    SequenceI match = null;\r
+    if (relaxedIdMatching)\r
     {\r
-      return;\r
+      if (lastmatchedAl != align)\r
+      {\r
+        matcher = new SequenceIdMatcher(\r
+                (lastmatchedAl = align).getSequencesArray());\r
+      }\r
+      match = matcher.findIdMatch(seqId);\r
     }\r
-\r
-    if (removeHTML\r
-            && sf.getDescription().toUpperCase().indexOf("<HTML>") == -1)\r
+    else\r
     {\r
-      removeHTML = false;\r
+      match = align.findName(seqId, true);\r
     }\r
+    return match;\r
+  }\r
 \r
-    StringBuffer sb = new StringBuffer();\r
-    StringTokenizer st = new StringTokenizer(sf.getDescription(), "<");\r
-    String token, link;\r
-    int startTag;\r
-    String tag = null;\r
-    while (st.hasMoreElements())\r
+  public void parseDescriptionHTML(SequenceFeature sf, boolean removeHTML)\r
+  {\r
+    if (sf.getDescription() == null)\r
     {\r
-      token = st.nextToken("&>");\r
-      if (token.equalsIgnoreCase("html") || token.startsWith("/"))\r
-      {\r
-        continue;\r
-      }\r
-\r
-      tag = null;\r
-      startTag = token.indexOf("<");\r
-\r
-      if (startTag > -1)\r
-      {\r
-        tag = token.substring(startTag + 1);\r
-        token = token.substring(0, startTag);\r
-      }\r
-\r
-      if (tag != null && tag.toUpperCase().startsWith("A HREF="))\r
-      {\r
-        if (token.length() > 0)\r
-        {\r
-          sb.append(token);\r
-        }\r
-        link = tag.substring(tag.indexOf("\"") + 1, tag.length() - 1);\r
-        String label = st.nextToken("<>");\r
-        sf.addLink(label + "|" + link);\r
-        sb.append(label + "%LINK%");\r
-      }\r
-      else if (tag != null && tag.equalsIgnoreCase("br"))\r
-      {\r
-        sb.append("\n");\r
-      }\r
-      else if (token.startsWith("lt;"))\r
-      {\r
-        sb.append("<" + token.substring(3));\r
-      }\r
-      else if (token.startsWith("gt;"))\r
-      {\r
-        sb.append(">" + token.substring(3));\r
-      }\r
-      else if (token.startsWith("amp;"))\r
-      {\r
-        sb.append("&" + token.substring(4));\r
-      }\r
-      else\r
-      {\r
-        sb.append(token);\r
-      }\r
+      return;\r
     }\r
+    jalview.util.ParseHtmlBodyAndLinks parsed = new jalview.util.ParseHtmlBodyAndLinks(sf.getDescription(), removeHTML, newline);\r
 \r
-    if (removeHTML)\r
+    sf.description = (removeHTML) ? parsed.getNonHtmlContent() : sf.description;\r
+    for (String link:parsed.getLinks())\r
     {\r
-      sf.description = sb.toString();\r
+      sf.addLink(link);\r
     }\r
 \r
   }\r
 \r
-/**\r
- * generate a features file for seqs\r
- * @param seqs source of sequence features\r
- * @param visible hash of feature types and colours \r
- * @return features file contents\r
- */\r
+  /**\r
+   * generate a features file for seqs includes non-pos features by default.\r
+   * \r
+   * @param seqs\r
+   *          source of sequence features\r
+   * @param visible\r
+   *          hash of feature types and colours\r
+   * @return features file contents\r
+   */\r
   public String printJalviewFormat(SequenceI[] seqs, Hashtable visible)\r
   {\r
-    return printJalviewFormat(seqs, visible, true);\r
+    return printJalviewFormat(seqs, visible, true, true);\r
   }\r
 \r
   /**\r
    * generate a features file for seqs with colours from visible (if any)\r
-   * @param seqs        source of features\r
-   * @param visible     hash of Colours for each feature type\r
-   * @param visOnly     when true only feature types in 'visible' will be output\r
+   * \r
+   * @param seqs\r
+   *          source of features\r
+   * @param visible\r
+   *          hash of Colours for each feature type\r
+   * @param visOnly\r
+   *          when true only feature types in 'visible' will be output\r
+   * @param nonpos\r
+   *          indicates if non-positional features should be output (regardless\r
+   *          of group or type)\r
    * @return features file contents\r
    */\r
   public String printJalviewFormat(SequenceI[] seqs, Hashtable visible,\r
-          boolean visOnly)\r
+          boolean visOnly, boolean nonpos)\r
   {\r
     StringBuffer out = new StringBuffer();\r
     SequenceFeature[] next;\r
-\r
-    if (visOnly && (visible == null || visible.size() < 1))\r
+    boolean featuresGen = false;\r
+    if (visOnly && !nonpos && (visible == null || visible.size() < 1))\r
     {\r
+      // no point continuing.\r
       return "No Features Visible";\r
     }\r
+\r
     if (visible != null && visOnly)\r
     {\r
-      // write feature colours only if we're given them and we are generating viewed features\r
+      // write feature colours only if we're given them and we are generating\r
+      // viewed features\r
+      // TODO: decide if feature links should also be written here ?\r
       Enumeration en = visible.keys();\r
-      String type;\r
-      int color;\r
+      String type, color;\r
       while (en.hasMoreElements())\r
       {\r
         type = en.nextElement().toString();\r
-        color = Integer.parseInt(visible.get(type).toString());\r
-        out.append(type\r
-                + "\t"\r
-                + jalview.util.Format\r
-                        .getHexString(new java.awt.Color(color)) + "\n");\r
+\r
+        if (visible.get(type) instanceof GraduatedColor)\r
+        {\r
+          GraduatedColor gc = (GraduatedColor) visible.get(type);\r
+          color = (gc.isColourByLabel() ? "label|" : "")\r
+                  + Format.getHexString(gc.getMinColor()) + "|"\r
+                  + Format.getHexString(gc.getMaxColor())\r
+                  + (gc.isAutoScale() ? "|" : "|abso|") + gc.getMin() + "|"\r
+                  + gc.getMax() + "|";\r
+          if (gc.getThreshType() != AnnotationColourGradient.NO_THRESHOLD)\r
+          {\r
+            if (gc.getThreshType() == AnnotationColourGradient.BELOW_THRESHOLD)\r
+            {\r
+              color += "below";\r
+            }\r
+            else\r
+            {\r
+              if (gc.getThreshType() != AnnotationColourGradient.ABOVE_THRESHOLD)\r
+              {\r
+                System.err.println("WARNING: Unsupported threshold type ("\r
+                        + gc.getThreshType() + ") : Assuming 'above'");\r
+              }\r
+              color += "above";\r
+            }\r
+            // add the value\r
+            color += "|" + gc.getThresh();\r
+          }\r
+          else\r
+          {\r
+            color += "none";\r
+          }\r
+        }\r
+        else if (visible.get(type) instanceof java.awt.Color)\r
+        {\r
+          color = Format.getHexString((java.awt.Color) visible.get(type));\r
+        }\r
+        else\r
+        {\r
+          // legacy support for integer objects containing colour triplet values\r
+          color = Format.getHexString(new java.awt.Color(Integer\r
+                  .parseInt(visible.get(type).toString())));\r
+        }\r
+        out.append(type);\r
+        out.append("\t");\r
+        out.append(color);\r
+        out.append(newline);\r
       }\r
     }\r
     // Work out which groups are both present and visible\r
     Vector groups = new Vector();\r
     int groupIndex = 0;\r
+    boolean isnonpos = false;\r
 \r
     for (int i = 0; i < seqs.length; i++)\r
     {\r
@@ -434,7 +753,10 @@ public class FeaturesFile extends AlignFile
       {\r
         for (int j = 0; j < next.length; j++)\r
         {\r
-          if (visOnly && !visible.containsKey(next[j].type))\r
+          isnonpos = next[j].begin == 0 && next[j].end == 0;\r
+          if ((!nonpos && isnonpos)\r
+                  || (!isnonpos && visOnly && !visible\r
+                          .containsKey(next[j].type)))\r
           {\r
             continue;\r
           }\r
@@ -449,14 +771,16 @@ public class FeaturesFile extends AlignFile
     }\r
 \r
     String group = null;\r
-\r
     do\r
     {\r
 \r
       if (groups.size() > 0 && groupIndex < groups.size())\r
       {\r
         group = groups.elementAt(groupIndex).toString();\r
-        out.append("\nSTARTGROUP\t" + group + "\n");\r
+        out.append(newline);\r
+        out.append("STARTGROUP\t");\r
+        out.append(group);\r
+        out.append(newline);\r
       }\r
       else\r
       {\r
@@ -470,8 +794,13 @@ public class FeaturesFile extends AlignFile
         {\r
           for (int j = 0; j < next.length; j++)\r
           {\r
-            if (visOnly && !visible.containsKey(next[j].type))\r
+            isnonpos = next[j].begin == 0 && next[j].end == 0;\r
+            if ((!nonpos && isnonpos)\r
+                    || (!isnonpos && visOnly && !visible\r
+                            .containsKey(next[j].type)))\r
             {\r
+              // skip if feature is nonpos and we ignore them or if we only\r
+              // output visible and it isn't non-pos and it's not visible\r
               continue;\r
             }\r
 \r
@@ -486,7 +815,8 @@ public class FeaturesFile extends AlignFile
             {\r
               continue;\r
             }\r
-\r
+            // we have features to output\r
+            featuresGen = true;\r
             if (next[j].description == null\r
                     || next[j].description.equals(""))\r
             {\r
@@ -511,9 +841,7 @@ public class FeaturesFile extends AlignFile
 \r
                   if (next[j].description.indexOf(href) == -1)\r
                   {\r
-                    out\r
-                            .append("<a href=\"" + href + "\">" + label\r
-                                    + "</a>");\r
+                    out.append("<a href=\"" + href + "\">" + label + "</a>");\r
                   }\r
                 }\r
 \r
@@ -525,16 +853,28 @@ public class FeaturesFile extends AlignFile
 \r
               out.append("\t");\r
             }\r
-\r
-            out.append(seqs[i].getName() + "\t-1\t" + next[j].begin + "\t"\r
-                    + next[j].end + "\t" + next[j].type + "\n");\r
+            out.append(seqs[i].getName());\r
+            out.append("\t-1\t");\r
+            out.append(next[j].begin);\r
+            out.append("\t");\r
+            out.append(next[j].end);\r
+            out.append("\t");\r
+            out.append(next[j].type);\r
+            if (next[j].score != Float.NaN)\r
+            {\r
+              out.append("\t");\r
+              out.append(next[j].score);\r
+            }\r
+            out.append(newline);\r
           }\r
         }\r
       }\r
 \r
       if (group != null)\r
       {\r
-        out.append("ENDGROUP\t" + group + "\n");\r
+        out.append("ENDGROUP\t");\r
+        out.append(group);\r
+        out.append(newline);\r
         groupIndex++;\r
       }\r
       else\r
@@ -544,21 +884,34 @@ public class FeaturesFile extends AlignFile
 \r
     } while (groupIndex < groups.size() + 1);\r
 \r
+    if (!featuresGen)\r
+    {\r
+      return "No Features Visible";\r
+    }\r
+\r
     return out.toString();\r
   }\r
 \r
+  /**\r
+   * generate a gff file for sequence features includes non-pos features by\r
+   * default.\r
+   * \r
+   * @param seqs\r
+   * @param visible\r
+   * @return\r
+   */\r
   public String printGFFFormat(SequenceI[] seqs, Hashtable visible)\r
   {\r
-    return printGFFFormat(seqs, visible, true);\r
+    return printGFFFormat(seqs, visible, true, true);\r
   }\r
 \r
   public String printGFFFormat(SequenceI[] seqs, Hashtable visible,\r
-          boolean visOnly)\r
+          boolean visOnly, boolean nonpos)\r
   {\r
     StringBuffer out = new StringBuffer();\r
     SequenceFeature[] next;\r
     String source;\r
-\r
+    boolean isnonpos;\r
     for (int i = 0; i < seqs.length; i++)\r
     {\r
       if (seqs[i].getSequenceFeatures() != null)\r
@@ -566,7 +919,10 @@ public class FeaturesFile extends AlignFile
         next = seqs[i].getSequenceFeatures();\r
         for (int j = 0; j < next.length; j++)\r
         {\r
-          if (visOnly && !visible.containsKey(next[j].type))\r
+          isnonpos = next[j].begin == 0 && next[j].end == 0;\r
+          if ((!nonpos && isnonpos)\r
+                  || (!isnonpos && visOnly && !visible\r
+                          .containsKey(next[j].type)))\r
           {\r
             continue;\r
           }\r
@@ -577,13 +933,23 @@ public class FeaturesFile extends AlignFile
             source = next[j].getDescription();\r
           }\r
 \r
-          out.append(seqs[i].getName() + "\t" + source + "\t"\r
-                  + next[j].type + "\t" + next[j].begin + "\t"\r
-                  + next[j].end + "\t" + next[j].score + "\t");\r
+          out.append(seqs[i].getName());\r
+          out.append("\t");\r
+          out.append(source);\r
+          out.append("\t");\r
+          out.append(next[j].type);\r
+          out.append("\t");\r
+          out.append(next[j].begin);\r
+          out.append("\t");\r
+          out.append(next[j].end);\r
+          out.append("\t");\r
+          out.append(next[j].score);\r
+          out.append("\t");\r
 \r
           if (next[j].getValue("STRAND") != null)\r
           {\r
-            out.append(next[j].getValue("STRAND") + "\t");\r
+            out.append(next[j].getValue("STRAND"));\r
+            out.append("\t");\r
           }\r
           else\r
           {\r
@@ -598,13 +964,15 @@ public class FeaturesFile extends AlignFile
           {\r
             out.append(".");\r
           }\r
+          // TODO: verify/check GFF - should there be a /t here before attribute\r
+          // output ?\r
 \r
           if (next[j].getValue("ATTRIBUTES") != null)\r
           {\r
             out.append(next[j].getValue("ATTRIBUTES"));\r
           }\r
 \r
-          out.append("\n");\r
+          out.append(newline);\r
 \r
         }\r
       }\r
@@ -630,4 +998,5 @@ public class FeaturesFile extends AlignFile
   {\r
     return "USE printGFFFormat() or printJalviewFormat()";\r
   }\r
+\r
 }\r