X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fio%2FFeaturesFile.java;h=6b9ee6737e4b594944ca93f4fec6201f28668a9b;hb=452ccbd713789eaa4ce2b74cfebbfd45f49aebb4;hp=a83dff8665787cf6bd93546f4624f5068b48904b;hpb=9922c9eec14599f6b141a8db8a3859cab7227ce0;p=jalview.git

diff --git a/src/jalview/io/FeaturesFile.java b/src/jalview/io/FeaturesFile.java
index a83dff8..6b9ee67 100755
--- a/src/jalview/io/FeaturesFile.java
+++ b/src/jalview/io/FeaturesFile.java
@@ -1,29 +1,28 @@
 /*
-* Jalview - A Sequence Alignment Editor and Viewer
-* Copyright (C) 2005 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
-*/
+ * Jalview - A Sequence Alignment Editor and Viewer
+ * Copyright (C) 2007 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 jalview.datamodel.*;
-
 import java.io.*;
 import java.util.*;
-import jalview.schemes.UserColourScheme;
 
+import jalview.datamodel.*;
+import jalview.schemes.*;
 
 /**
  * DOCUMENT ME!
@@ -31,351 +30,561 @@ import jalview.schemes.UserColourScheme;
  * @author $author$
  * @version $Revision$
  */
-public class FeaturesFile extends AlignFile
+public class FeaturesFile
+    extends AlignFile
 {
-    /**
-     * Creates a new FeaturesFile object.
-     */
-    public FeaturesFile()
+  /**
+   * Creates a new FeaturesFile object.
+   */
+  public FeaturesFile()
+  {
+  }
+
+  /**
+   * Creates a new FeaturesFile object.
+   *
+   * @param inFile DOCUMENT ME!
+   * @param type DOCUMENT ME!
+   *
+   * @throws IOException DOCUMENT ME!
+   */
+  public FeaturesFile(String inFile, String type)
+      throws IOException
+  {
+    super(inFile, type);
+  }
+
+  /**
+   * The Application can render HTML, but the applet will
+   * remove HTML tags and replace links with %LINK%
+   * Both need to read links in HTML however
+   *
+   * @throws IOException DOCUMENT ME!
+   */
+  public boolean parse(AlignmentI align,
+                       Hashtable colours,
+                       boolean removeHTML)
+  {
+    return parse(align, colours, null, removeHTML);
+  }
+
+  /**
+   * The Application can render HTML, but the applet will
+   * remove HTML tags and replace links with %LINK%
+   * Both need to read links in HTML however
+   *
+   * @throws IOException DOCUMENT ME!
+   */
+  public boolean parse(AlignmentI align,
+                       Hashtable colours,
+                       Hashtable featureLink,
+                       boolean removeHTML)
+  {
+    String line = null;
+    try
     {
-    }
+      SequenceI seq = null;
+      String type, desc, token = null;
 
-    /**
-     * Creates a new FeaturesFile object.
-     *
-     * @param inStr DOCUMENT ME!
-     */
-    public FeaturesFile(String inStr)
-    {
-        super(inStr);
-    }
+      int index, start, end;
+      float score;
+      StringTokenizer st;
+      SequenceFeature sf;
+      String featureGroup = null, groupLink = null;
+      Hashtable typeLink = new Hashtable();
 
-    /**
-     * Creates a new FeaturesFile object.
-     *
-     * @param inFile DOCUMENT ME!
-     * @param type DOCUMENT ME!
-     *
-     * @throws IOException DOCUMENT ME!
-     */
-    public FeaturesFile(String inFile, String type)
-       throws IOException
-    {
-        super(inFile, type);
-    }
+      boolean GFFFile = true;
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @throws IOException DOCUMENT ME!
-     */
-    public boolean parse(AlignmentI align,  Hashtable colours)
-        throws IOException
-    {
-      String line = null;
-      try
+      while ( (line = nextLine()) != null)
       {
-        SequenceI seq = null;
-        String type, desc, token=null;
-
-        int index, start, end;
-        float score;
-        StringTokenizer st;
-        SequenceFeature sf;
-        String featureGroup = null;
-
-        boolean GFFFile = true;
-
-        while ( (line = nextLine()) != null)
+        if (line.startsWith("#"))
         {
-          if(line.startsWith("#"))
-            continue;
+          continue;
+        }
 
-          st = new StringTokenizer(line, "\t");
-          if (st.countTokens()>1 && st.countTokens() < 4 )
+        st = new StringTokenizer(line, "\t");
+        if (st.countTokens() > 1 && st.countTokens() < 4)
+        {
+          GFFFile = false;
+          type = st.nextToken();
+          if (type.equalsIgnoreCase("startgroup"))
           {
-            GFFFile = false;
-            type = st.nextToken();
-            if (type.equalsIgnoreCase("startgroup"))
+            featureGroup = st.nextToken();
+            if (st.hasMoreElements())
             {
-              featureGroup = st.nextToken();
+              groupLink = st.nextToken();
+              featureLink.put(featureGroup, groupLink);
             }
-            else if (type.equalsIgnoreCase("endgroup"))
-            {
-              //We should check whether this is the current group,
-              //but at present theres no way of showing more than 1 group
-              st.nextToken();
-              featureGroup = null;
-            }
-            else
+          }
+          else if (type.equalsIgnoreCase("endgroup"))
+          {
+            //We should check whether this is the current group,
+            //but at present theres no way of showing more than 1 group
+            st.nextToken();
+            featureGroup = null;
+            groupLink = null;
+          }
+          else
+          {
+            UserColourScheme ucs = new UserColourScheme(st.nextToken());
+            colours.put(type, ucs.findColour('A'));
+            if (st.hasMoreElements())
             {
-              UserColourScheme ucs = new UserColourScheme(st.nextToken());
-              colours.put(type, ucs.findColour("A"));
+              String link = st.nextToken();
+              typeLink.put(type, link);
+              if (featureLink == null)
+              {
+                featureLink = new Hashtable();
+              }
+              featureLink.put(type, link);
             }
-            continue;
+
           }
+          continue;
+        }
 
-          while (st.hasMoreElements())
-          {
+        while (st.hasMoreElements())
+        {
 
-            if(GFFFile)
+          if (GFFFile)
+          {
+            // Still possible this is an old Jalview file,
+            // which does not have type colours at the beginning
+            token = st.nextToken();
+            seq = align.findName(token);
+            if (seq != null)
             {
-              // Still possible this is an old Jalview file,
-              // which does not have type colours at the beginning
-              token = st.nextToken();
-              seq = align.findName(token);
-              if(seq != null)
+              desc = st.nextToken();
+              type = st.nextToken();
+              start = Integer.parseInt(st.nextToken());
+              end = Integer.parseInt(st.nextToken());
+              try
               {
-                desc = st.nextToken();
-                type = st.nextToken();
-                start = Integer.parseInt(st.nextToken());
-                end = Integer.parseInt(st.nextToken());
-                try
-                {
-                  score = Float.parseFloat(st.nextToken());
-                }
-                catch (NumberFormatException ex)
-                {
-                  score = 0;
-                }
+                score = new Float(st.nextToken()).floatValue();
+              }
+              catch (NumberFormatException ex)
+              {
+                score = 0;
+              }
+
+              sf = new SequenceFeature(type, desc, start, end, score, null);
 
-                sf = new SequenceFeature(type, desc, start, end, score, null);
+              try
+              {
+                sf.setValue("STRAND", st.nextToken());
+                sf.setValue("FRAME", st.nextToken());
+              }
+              catch (Exception ex)
+              {}
 
-                try
+              if (st.hasMoreTokens())
+              {
+                StringBuffer attributes = new StringBuffer();
+                while (st.hasMoreTokens())
                 {
-                  sf.setValue("STRAND", st.nextToken());
-                  sf.setValue("FRAME", st.nextToken());
+                  attributes.append("\t" + st.nextElement());
                 }
-                catch (Exception ex)
-                {}
-
-                seq.getDatasetSequence().addSequenceFeature(sf);
-
-                break;
+                sf.setValue("ATTRIBUTES", attributes.toString());
               }
-            }
 
-            if(GFFFile && seq==null)
-            {
-              desc = token;
+              seq.addSequenceFeature(sf);
+
+              break;
             }
-            else
-              desc = st.nextToken();
+          }
 
+          if (GFFFile && seq == null)
+          {
+            desc = token;
+          }
+          else
+          {
+            desc = st.nextToken();
+          }
 
-            token = st.nextToken();
-            if (!token.equals("ID_NOT_SPECIFIED"))
+          token = st.nextToken();
+          if (!token.equals("ID_NOT_SPECIFIED"))
+          {
+            seq = align.findName(token);
+            st.nextToken();
+          }
+          else
+          {
+            try
             {
-              seq = align.findName(token);
-              st.nextToken();
+              index = Integer.parseInt(st.nextToken());
+              seq = align.getSequenceAt(index);
             }
-            else
+            catch (NumberFormatException ex)
             {
-              try{
-                index = Integer.parseInt(st.nextToken());
-                seq = align.getSequenceAt(index);
-              }
-              catch(NumberFormatException ex)
-              {
-                seq = null;
-              }
+              seq = null;
             }
+          }
 
-            if(seq==null)
-            {
-              System.out.println("Sequence not found: "+line);
-              break;
-            }
+          if (seq == null)
+          {
+            System.out.println("Sequence not found: " + line);
+            break;
+          }
 
-            start = Integer.parseInt(st.nextToken());
-            end = Integer.parseInt(st.nextToken());
+          start = Integer.parseInt(st.nextToken());
+          end = Integer.parseInt(st.nextToken());
 
-            type = st.nextToken();
+          type = st.nextToken();
 
-            if (!colours.containsKey(type))
-            {
-              // Probably the old style groups file
-              UserColourScheme ucs = new UserColourScheme(type);
-              colours.put(type, ucs.findColour("A"));
-            }
+          if (!colours.containsKey(type))
+          {
+            // Probably the old style groups file
+            UserColourScheme ucs = new UserColourScheme(type);
+            colours.put(type, ucs.findColour('A'));
+          }
 
-            sf = new SequenceFeature(type, desc, "", start, end, featureGroup);
+          sf = new SequenceFeature(type, desc, "", start, end, featureGroup);
 
-            seq.getDatasetSequence().addSequenceFeature(sf);
+          seq.addSequenceFeature(sf);
 
-            //If we got here, its not a GFFFile
-            GFFFile = false;
+          if (groupLink != null && removeHTML)
+          {
+            sf.addLink(groupLink);
+            sf.description += "%LINK%";
+          }
+          if (typeLink.containsKey(type) && removeHTML)
+          {
+            sf.addLink(typeLink.get(type).toString());
+            sf.description += "%LINK%";
           }
+
+          parseDescriptionHTML(sf, removeHTML);
+
+          //If we got here, its not a GFFFile
+          GFFFile = false;
         }
       }
-      catch (Exception ex)
-      {
-        System.out.println(line);
-        ex.printStackTrace();
-        System.out.println("Error parsing groups file: " + ex +"\n"+line);
-        return false;
-      }
+    }
+    catch (Exception ex)
+    {
+      System.out.println(line);
+      System.out.println("Error parsing feature file: " + ex + "\n" + line);
+      return false;
+    }
 
-      return true;
+    return true;
+  }
 
+  public void parseDescriptionHTML(SequenceFeature sf, boolean removeHTML)
+  {
+    if (sf.getDescription() == null)
+    {
+      return;
     }
 
+    if (removeHTML && sf.getDescription().toUpperCase().indexOf("<HTML>") == -1)
+    {
+      removeHTML = false;
+    }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @param s DOCUMENT ME!
-     * @param len DOCUMENT ME!
-     * @param gaps DOCUMENT ME!
-     * @param displayId DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
-    public String printJalviewFormat(SequenceI [] seqs,
-                                     Hashtable visible)
+    StringBuffer sb = new StringBuffer();
+    StringTokenizer st = new StringTokenizer(sf.getDescription(), "<");
+    String token, link;
+    int startTag;
+    String tag = null;
+    while (st.hasMoreElements())
     {
-        StringBuffer out = new StringBuffer();
-        SequenceFeature [] next;
+      token = st.nextToken("&>");
+      if (token.equalsIgnoreCase("html") || token.startsWith("/"))
+      {
+        continue;
+      }
 
-        if(visible==null || visible.size()<1)
-          return "No Features Visible";
+      tag = null;
+      startTag = token.indexOf("<");
 
-        Enumeration en = visible.keys();
-        String type;
-        int color;
-        while( en.hasMoreElements() )
+      if (startTag > -1)
+      {
+        tag = token.substring(startTag + 1);
+        token = token.substring(0, startTag);
+      }
+
+      if (tag != null && tag.toUpperCase().startsWith("A HREF="))
+      {
+        if (token.length() > 0)
         {
-          type = en.nextElement().toString();
-          color = Integer.parseInt( visible.get(type).toString() );
-          out.append(type + "\t"
-                     + jalview.util.Format.getHexString(
-                         new java.awt.Color(color)  )
-                     +"\n");
+          sb.append(token);
         }
+        link = tag.substring(tag.indexOf("\"") + 1, tag.length() - 1);
+        String label = st.nextToken("<>");
+        sf.addLink(label + "|" + link);
+        sb.append(label + "%LINK%");
+      }
+      else if (tag != null && tag.equalsIgnoreCase("br"))
+      {
+        sb.append("\n");
+      }
+      else if (token.startsWith("lt;"))
+      {
+        sb.append("<" + token.substring(3));
+      }
+      else if (token.startsWith("gt;"))
+      {
+        sb.append(">" + token.substring(3));
+      }
+      else if (token.startsWith("amp;"))
+      {
+        sb.append("&" + token.substring(4));
+      }
+      else
+      {
+        sb.append(token);
+      }
+    }
 
-        //Work out which groups are both present and visible
-        Vector groups = new Vector();
-        int groupIndex = 0;
+    if (removeHTML)
+    {
+      sf.description = sb.toString();
+    }
 
-        for(int i=0; i<seqs.length; i++)
+  }
+
+  /**
+   * DOCUMENT ME!
+   *
+   * @param s DOCUMENT ME!
+   * @param len DOCUMENT ME!
+   * @param gaps DOCUMENT ME!
+   * @param displayId DOCUMENT ME!
+   *
+   * @return DOCUMENT ME!
+   */
+  public String printJalviewFormat(SequenceI[] seqs,
+                                   Hashtable visible)
+  {
+    StringBuffer out = new StringBuffer();
+    SequenceFeature[] next;
+
+    if (visible == null || visible.size() < 1)
+    {
+      return "No Features Visible";
+    }
+
+    Enumeration en = visible.keys();
+    String type;
+    int color;
+    while (en.hasMoreElements())
+    {
+      type = en.nextElement().toString();
+      color = Integer.parseInt(visible.get(type).toString());
+      out.append(type + "\t"
+                 + jalview.util.Format.getHexString(
+                     new java.awt.Color(color))
+                 + "\n");
+    }
+
+    //Work out which groups are both present and visible
+    Vector groups = new Vector();
+    int groupIndex = 0;
+
+    for (int i = 0; i < seqs.length; i++)
+    {
+      next = seqs[i].getSequenceFeatures();
+      if (next != null)
+      {
+        for (int j = 0; j < next.length; j++)
         {
-          next = seqs[i].getSequenceFeatures();
-          if(next!=null)
+          if (!visible.containsKey(next[j].type))
           {
-            for(int j=0; j<next.length; j++)
-            {
-              if (!visible.containsKey(next[j].type))
-                continue;
+            continue;
+          }
 
-              if (    next[j].featureGroup != null
-                  && !groups.contains(next[j].featureGroup))
-                groups.addElement(next[j].featureGroup);
-            }
+          if (next[j].featureGroup != null
+              && !groups.contains(next[j].featureGroup))
+          {
+            groups.addElement(next[j].featureGroup);
           }
         }
+      }
+    }
 
-        String group = null;
+    String group = null;
 
-        do
+    do
+    {
+
+      if (groups.size() > 0 && groupIndex < groups.size())
+      {
+        group = groups.elementAt(groupIndex).toString();
+        out.append("\nSTARTGROUP\t" + group + "\n");
+      }
+      else
+      {
+        group = null;
+      }
+
+      for (int i = 0; i < seqs.length; i++)
+      {
+        next = seqs[i].getSequenceFeatures();
+        if (next != null)
         {
-          if (groups.size() > 0)
+          for (int j = 0; j < next.length; j++)
           {
-            group = groups.elementAt(groupIndex).toString();
-            out.append("\nSTARTGROUP\t" + group + "\n");
-          }
+            if (!visible.containsKey(next[j].type))
+            {
+              continue;
+            }
 
+            if (group != null
+                && (next[j].featureGroup == null
+                    || !next[j].featureGroup.equals(group))
+                )
+            {
+              continue;
+            }
 
-          for (int i = 0; i < seqs.length; i++)
-          {
-            next = seqs[i].getSequenceFeatures();
-            if (next != null)
+            if (group == null && next[j].featureGroup != null)
             {
-              for (int j = 0; j < next.length; j++)
+              continue;
+            }
+
+            if (next[j].description == null || next[j].description.equals(""))
+            {
+              out.append(next[j].type + "\t");
+            }
+            else
+            {
+              if (next[j].links != null
+                  && next[j].getDescription().indexOf("<html>") == -1)
               {
-                if (!visible.containsKey(next[j].type))
-                  continue;
-
-                if (group != null && !next[j].featureGroup.equals(group))
-                  continue;
-
-                if(next[j].description==null || next[j].description.equals(""))
-                  out.append(next[j].type+"\t");
-                else
-                  out.append(next[j].description + "\t");
-
-                out.append(  seqs[i].getName() + "\t-1\t"
-                           + next[j].begin + "\t"
-                           + next[j].end + "\t"
-                           + next[j].type + "\n"
-                    );
+                out.append("<html>");
               }
+
+              out.append(next[j].description + " ");
+              if (next[j].links != null)
+              {
+                for (int l = 0; l < next[j].links.size(); l++)
+                {
+                  String label = next[j].links.elementAt(l).toString();
+                  String href = label.substring(label.indexOf("|") + 1);
+                  label = label.substring(0, label.indexOf("|"));
+
+                  if (next[j].description.indexOf(href) == -1)
+                  {
+                    out.append("<a href=\""
+                               + href
+                               + "\">"
+                               + label
+                               + "</a>");
+                  }
+                }
+
+                if (next[j].getDescription().indexOf("</html>") == -1)
+                {
+                  out.append("</html>");
+                }
+              }
+
+              out.append("\t");
             }
-          }
 
-          if(groups.size()>0)
-          {
-            out.append("ENDGROUP\t"+group+"\n");
+            out.append(seqs[i].getName() + "\t-1\t"
+                       + next[j].begin + "\t"
+                       + next[j].end + "\t"
+                       + next[j].type + "\n"
+                );
           }
-
-          groupIndex++;
         }
-        while(groupIndex < groups.size());
+      }
 
+      if (group != null)
+      {
+        out.append("ENDGROUP\t" + group + "\n");
+        groupIndex++;
+      }
+      else
+      {
+        break;
+      }
 
-      return out.toString();
     }
+    while (groupIndex < groups.size() + 1);
 
-    public String printGFFFormat(SequenceI [] seqs, Hashtable visible)
-    {
-      StringBuffer out = new StringBuffer();
-      SequenceFeature [] next;
+    return out.toString();
+  }
+
+  public String printGFFFormat(SequenceI[] seqs, Hashtable visible)
+  {
+    StringBuffer out = new StringBuffer();
+    SequenceFeature[] next;
+    String source;
 
-      for(int i=0; i<seqs.length; i++)
+    for (int i = 0; i < seqs.length; i++)
+    {
+      if (seqs[i].getSequenceFeatures() != null)
       {
-        if(seqs[i].getSequenceFeatures()!=null)
+        next = seqs[i].getSequenceFeatures();
+        for (int j = 0; j < next.length; j++)
         {
-          next = seqs[i].getSequenceFeatures();
-          for(int j=0; j<next.length; j++)
+          if (!visible.containsKey(next[j].type))
           {
-            if(!visible.containsKey(next[j].type))
-              continue;
+            continue;
+          }
 
-            out.append(seqs[i].getName() + "\t"
-                       + next[j].description + "\t"
-                       + next[j].type  + "\t"
-                       + next[j].begin + "\t"
-                       + next[j].end   + "\t"
-                       + next[j].score + "\t"
-                      );
+          source = next[j].featureGroup;
+          if (source == null)
+          {
+            source = next[j].getDescription();
+          }
 
-            if(next[j].getValue("STRAND")!=null)
-              out.append(next[j].getValue("STRAND")+"\t");
-            else
-              out.append(".\t");
-            if(next[j].getValue("FRAME")!=null)
-              out.append(next[j].getValue("FRAME")+"\n");
-            else
-              out.append(".\n");
+          out.append(seqs[i].getName() + "\t"
+                     + source + "\t"
+                     + next[j].type + "\t"
+                     + next[j].begin + "\t"
+                     + next[j].end + "\t"
+                     + next[j].score + "\t"
+              );
 
+          if (next[j].getValue("STRAND") != null)
+          {
+            out.append(next[j].getValue("STRAND") + "\t");
+          }
+          else
+          {
+            out.append(".\t");
           }
-        }
-      }
 
-      return out.toString();
-    }
+          if (next[j].getValue("FRAME") != null)
+          {
+            out.append(next[j].getValue("FRAME"));
+          }
+          else
+          {
+            out.append(".");
+          }
 
-    public void parse()
-    {
-      //IGNORED
-    }
+          if (next[j].getValue("ATTRIBUTES") != null)
+          {
+            out.append(next[j].getValue("ATTRIBUTES"));
+          }
 
-    /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
-    public String print()
-    {
-        return "USE printGFFFormat() or printJalviewFormat()";
+          out.append("\n");
+
+        }
+      }
     }
+
+    return out.toString();
+  }
+
+  public void parse()
+  {
+    //IGNORED
+  }
+
+  /**
+   * DOCUMENT ME!
+   *
+   * @return DOCUMENT ME!
+   */
+  public String print()
+  {
+    return "USE printGFFFormat() or printJalviewFormat()";
+  }
 }