src/jalview/io/FeaturesFile.java

   1 /*\r
   2  * Jalview - A Sequence Alignment Editor and Viewer\r
   3  * Copyright (C) 2007 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
   4  *\r
   5  * This program is free software; you can redistribute it and/or\r
   6  * modify it under the terms of the GNU General Public License\r
   7  * as published by the Free Software Foundation; either version 2\r
   8  * of the License, or (at your option) any later version.\r
   9  *\r
  10  * This program is distributed in the hope that it will be useful,\r
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  13  * GNU General Public License for more details.\r
  14  *\r
  15  * You should have received a copy of the GNU General Public License\r
  16  * along with this program; if not, write to the Free Software\r
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
  18  */\r
  19 package jalview.io;\r
  20 \r
  21 import java.io.*;\r
  22 import java.util.*;\r
  23 \r
  24 import jalview.datamodel.*;\r
  25 import jalview.schemes.*;\r
  26 \r
  27 /**\r
  28  * Parse and create Jalview Features files\r
  29  * Detects GFF format features files and parses.\r
  30  * Does not implement standard print() - call specific printFeatures or printGFF.\r
  31  * Uses AlignmentI.findSequence(String id) to find the sequence object for the features annotation - this normally works on an exact match.\r
  32  * @author AMW\r
  33  * @version $Revision$\r
  34  */\r
  35 public class FeaturesFile\r
  36     extends AlignFile\r
  37 {\r
  38   /**\r
  39    * Creates a new FeaturesFile object.\r
  40    */\r
  41   public FeaturesFile()\r
  42   {\r
  43   }\r
  44 \r
  45   /**\r
  46    * Creates a new FeaturesFile object.\r
  47    *\r
  48    * @param inFile DOCUMENT ME!\r
  49    * @param type DOCUMENT ME!\r
  50    *\r
  51    * @throws IOException DOCUMENT ME!\r
  52    */\r
  53   public FeaturesFile(String inFile, String type)\r
  54       throws IOException\r
  55   {\r
  56     super(inFile, type);\r
  57   }\r
  58 \r
  59   /**\r
  60    * The Application can render HTML, but the applet will\r
  61    * remove HTML tags and replace links with %LINK%\r
  62    * Both need to read links in HTML however\r
  63    *\r
  64    * @throws IOException DOCUMENT ME!\r
  65    */\r
  66   public boolean parse(AlignmentI align,\r
  67                        Hashtable colours,\r
  68                        boolean removeHTML)\r
  69   {\r
  70     return parse(align, colours, null, removeHTML);\r
  71   }\r
  72 \r
  73   /**\r
  74    * The Application can render HTML, but the applet will\r
  75    * remove HTML tags and replace links with %LINK%\r
  76    * Both need to read links in HTML however\r
  77    *\r
  78    * @throws IOException DOCUMENT ME!\r
  79    */\r
  80   public boolean parse(AlignmentI align,\r
  81                        Hashtable colours,\r
  82                        Hashtable featureLink,\r
  83                        boolean removeHTML)\r
  84   {\r
  85     String line = null;\r
  86     try\r
  87     {\r
  88       SequenceI seq = null;\r
  89       String type, desc, token = null;\r
  90 \r
  91       int index, start, end;\r
  92       float score;\r
  93       StringTokenizer st;\r
  94       SequenceFeature sf;\r
  95       String featureGroup = null, groupLink = null;\r
  96       Hashtable typeLink = new Hashtable();\r
  97 \r
  98       boolean GFFFile = true;\r
  99 \r
 100       while ( (line = nextLine()) != null)\r
 101       {\r
 102         if (line.startsWith("#"))\r
 103         {\r
 104           continue;\r
 105         }\r
 106 \r
 107         st = new StringTokenizer(line, "\t");\r
 108         if (st.countTokens() > 1 && st.countTokens() < 4)\r
 109         {\r
 110           GFFFile = false;\r
 111           type = st.nextToken();\r
 112           if (type.equalsIgnoreCase("startgroup"))\r
 113           {\r
 114             featureGroup = st.nextToken();\r
 115             if (st.hasMoreElements())\r
 116             {\r
 117               groupLink = st.nextToken();\r
 118               featureLink.put(featureGroup, groupLink);\r
 119             }\r
 120           }\r
 121           else if (type.equalsIgnoreCase("endgroup"))\r
 122           {\r
 123             //We should check whether this is the current group,\r
 124             //but at present theres no way of showing more than 1 group\r
 125             st.nextToken();\r
 126             featureGroup = null;\r
 127             groupLink = null;\r
 128           }\r
 129           else\r
 130           {\r
 131             UserColourScheme ucs = new UserColourScheme(st.nextToken());\r
 132             colours.put(type, ucs.findColour('A'));\r
 133             if (st.hasMoreElements())\r
 134             {\r
 135               String link = st.nextToken();\r
 136               typeLink.put(type, link);\r
 137               if (featureLink == null)\r
 138               {\r
 139                 featureLink = new Hashtable();\r
 140               }\r
 141               featureLink.put(type, link);\r
 142             }\r
 143 \r
 144           }\r
 145           continue;\r
 146         }\r
 147 \r
 148         while (st.hasMoreElements())\r
 149         {\r
 150 \r
 151           if (GFFFile)\r
 152           {\r
 153             // Still possible this is an old Jalview file,\r
 154             // which does not have type colours at the beginning\r
 155             token = st.nextToken();\r
 156             seq = align.findName(token, true);\r
 157             if (seq != null)\r
 158             {\r
 159               desc = st.nextToken();\r
 160               type = st.nextToken();\r
 161               try {\r
 162               start = Integer.parseInt(st.nextToken());\r
 163               } catch (NumberFormatException ex)\r
 164               {\r
 165                 start=0;\r
 166               }\r
 167               try {\r
 168                 end = Integer.parseInt(st.nextToken());\r
 169               }\r
 170               catch (NumberFormatException ex)\r
 171               {\r
 172                 end=-1;\r
 173               } \r
 174               try\r
 175               {\r
 176                 score = new Float(st.nextToken()).floatValue();\r
 177               }\r
 178               catch (NumberFormatException ex)\r
 179               {\r
 180                 score = 0;\r
 181               }\r
 182 \r
 183               sf = new SequenceFeature(type, desc, start, end, score, null);\r
 184 \r
 185               try\r
 186               {\r
 187                 sf.setValue("STRAND", st.nextToken());\r
 188                 sf.setValue("FRAME", st.nextToken());\r
 189               }\r
 190               catch (Exception ex)\r
 191               {}\r
 192 \r
 193               if (st.hasMoreTokens())\r
 194               {\r
 195                 StringBuffer attributes = new StringBuffer();\r
 196                 while (st.hasMoreTokens())\r
 197                 {\r
 198                   attributes.append("\t" + st.nextElement());\r
 199                 }\r
 200                 sf.setValue("ATTRIBUTES", attributes.toString());\r
 201               }\r
 202 \r
 203               seq.addSequenceFeature(sf);\r
 204 \r
 205               break;\r
 206             }\r
 207           }\r
 208 \r
 209           if (GFFFile && seq == null)\r
 210           {\r
 211             desc = token;\r
 212           }\r
 213           else\r
 214           {\r
 215             desc = st.nextToken();\r
 216           }\r
 217           if (!st.hasMoreTokens())\r
 218           {\r
 219             System.err.println("DEBUG: Run out of tokens when trying to identify the destination for the feature.. giving up.");\r
 220             // in all probability, this isn't a file we understand, so bail quietly.\r
 221             return false;\r
 222           }\r
 223           \r
 224           token = st.nextToken();\r
 225           \r
 226           if (!token.equals("ID_NOT_SPECIFIED"))\r
 227           {\r
 228             seq = align.findName(token, true);\r
 229             st.nextToken();\r
 230           }\r
 231           else\r
 232           {\r
 233             try\r
 234             {\r
 235               index = Integer.parseInt(st.nextToken());\r
 236               seq = align.getSequenceAt(index);\r
 237             }\r
 238             catch (NumberFormatException ex)\r
 239             {\r
 240               seq = null;\r
 241             }\r
 242           }\r
 243 \r
 244           if (seq == null)\r
 245           {\r
 246             System.out.println("Sequence not found: " + line);\r
 247             break;\r
 248           }\r
 249 \r
 250           start = Integer.parseInt(st.nextToken());\r
 251           end = Integer.parseInt(st.nextToken());\r
 252 \r
 253           type = st.nextToken();\r
 254 \r
 255           if (!colours.containsKey(type))\r
 256           {\r
 257             // Probably the old style groups file\r
 258             UserColourScheme ucs = new UserColourScheme(type);\r
 259             colours.put(type, ucs.findColour('A'));\r
 260           }\r
 261 \r
 262           sf = new SequenceFeature(type, desc, "", start, end, featureGroup);\r
 263 \r
 264           seq.addSequenceFeature(sf);\r
 265 \r
 266           if (groupLink != null && removeHTML)\r
 267           {\r
 268             sf.addLink(groupLink);\r
 269             sf.description += "%LINK%";\r
 270           }\r
 271           if (typeLink.containsKey(type) && removeHTML)\r
 272           {\r
 273             sf.addLink(typeLink.get(type).toString());\r
 274             sf.description += "%LINK%";\r
 275           }\r
 276 \r
 277           parseDescriptionHTML(sf, removeHTML);\r
 278 \r
 279           //If we got here, its not a GFFFile\r
 280           GFFFile = false;\r
 281         }\r
 282       }\r
 283     }\r
 284     catch (Exception ex)\r
 285     {\r
 286       System.out.println(line);\r
 287       System.out.println("Error parsing feature file: " + ex + "\n" + line);\r
 288       ex.printStackTrace(System.err);\r
 289       return false;\r
 290     }\r
 291 \r
 292     return true;\r
 293   }\r
 294 \r
 295   public void parseDescriptionHTML(SequenceFeature sf, boolean removeHTML)\r
 296   {\r
 297     if (sf.getDescription() == null)\r
 298     {\r
 299       return;\r
 300     }\r
 301 \r
 302     if (removeHTML && sf.getDescription().toUpperCase().indexOf("<HTML>") == -1)\r
 303     {\r
 304       removeHTML = false;\r
 305     }\r
 306 \r
 307     StringBuffer sb = new StringBuffer();\r
 308     StringTokenizer st = new StringTokenizer(sf.getDescription(), "<");\r
 309     String token, link;\r
 310     int startTag;\r
 311     String tag = null;\r
 312     while (st.hasMoreElements())\r
 313     {\r
 314       token = st.nextToken("&>");\r
 315       if (token.equalsIgnoreCase("html") || token.startsWith("/"))\r
 316       {\r
 317         continue;\r
 318       }\r
 319 \r
 320       tag = null;\r
 321       startTag = token.indexOf("<");\r
 322 \r
 323       if (startTag > -1)\r
 324       {\r
 325         tag = token.substring(startTag + 1);\r
 326         token = token.substring(0, startTag);\r
 327       }\r
 328 \r
 329       if (tag != null && tag.toUpperCase().startsWith("A HREF="))\r
 330       {\r
 331         if (token.length() > 0)\r
 332         {\r
 333           sb.append(token);\r
 334         }\r
 335         link = tag.substring(tag.indexOf("\"") + 1, tag.length() - 1);\r
 336         String label = st.nextToken("<>");\r
 337         sf.addLink(label + "|" + link);\r
 338         sb.append(label + "%LINK%");\r
 339       }\r
 340       else if (tag != null && tag.equalsIgnoreCase("br"))\r
 341       {\r
 342         sb.append("\n");\r
 343       }\r
 344       else if (token.startsWith("lt;"))\r
 345       {\r
 346         sb.append("<" + token.substring(3));\r
 347       }\r
 348       else if (token.startsWith("gt;"))\r
 349       {\r
 350         sb.append(">" + token.substring(3));\r
 351       }\r
 352       else if (token.startsWith("amp;"))\r
 353       {\r
 354         sb.append("&" + token.substring(4));\r
 355       }\r
 356       else\r
 357       {\r
 358         sb.append(token);\r
 359       }\r
 360     }\r
 361 \r
 362     if (removeHTML)\r
 363     {\r
 364       sf.description = sb.toString();\r
 365     }\r
 366 \r
 367   }\r
 368 \r
 369   /**\r
 370    * DOCUMENT ME!\r
 371    *\r
 372    * @param s DOCUMENT ME!\r
 373    * @param len DOCUMENT ME!\r
 374    * @param gaps DOCUMENT ME!\r
 375    * @param displayId DOCUMENT ME!\r
 376    *\r
 377    * @return DOCUMENT ME!\r
 378    */\r
 379   public String printJalviewFormat(SequenceI[] seqs,\r
 380                                    Hashtable visible)\r
 381   {\r
 382     StringBuffer out = new StringBuffer();\r
 383     SequenceFeature[] next;\r
 384 \r
 385     if (visible == null || visible.size() < 1)\r
 386     {\r
 387       return "No Features Visible";\r
 388     }\r
 389 \r
 390     Enumeration en = visible.keys();\r
 391     String type;\r
 392     int color;\r
 393     while (en.hasMoreElements())\r
 394     {\r
 395       type = en.nextElement().toString();\r
 396       color = Integer.parseInt(visible.get(type).toString());\r
 397       out.append(type + "\t"\r
 398                  + jalview.util.Format.getHexString(\r
 399                      new java.awt.Color(color))\r
 400                  + "\n");\r
 401     }\r
 402 \r
 403     //Work out which groups are both present and visible\r
 404     Vector groups = new Vector();\r
 405     int groupIndex = 0;\r
 406 \r
 407     for (int i = 0; i < seqs.length; i++)\r
 408     {\r
 409       next = seqs[i].getSequenceFeatures();\r
 410       if (next != null)\r
 411       {\r
 412         for (int j = 0; j < next.length; j++)\r
 413         {\r
 414           if (!visible.containsKey(next[j].type))\r
 415           {\r
 416             continue;\r
 417           }\r
 418 \r
 419           if (next[j].featureGroup != null\r
 420               && !groups.contains(next[j].featureGroup))\r
 421           {\r
 422             groups.addElement(next[j].featureGroup);\r
 423           }\r
 424         }\r
 425       }\r
 426     }\r
 427 \r
 428     String group = null;\r
 429 \r
 430     do\r
 431     {\r
 432 \r
 433       if (groups.size() > 0 && groupIndex < groups.size())\r
 434       {\r
 435         group = groups.elementAt(groupIndex).toString();\r
 436         out.append("\nSTARTGROUP\t" + group + "\n");\r
 437       }\r
 438       else\r
 439       {\r
 440         group = null;\r
 441       }\r
 442 \r
 443       for (int i = 0; i < seqs.length; i++)\r
 444       {\r
 445         next = seqs[i].getSequenceFeatures();\r
 446         if (next != null)\r
 447         {\r
 448           for (int j = 0; j < next.length; j++)\r
 449           {\r
 450             if (!visible.containsKey(next[j].type))\r
 451             {\r
 452               continue;\r
 453             }\r
 454 \r
 455             if (group != null\r
 456                 && (next[j].featureGroup == null\r
 457                     || !next[j].featureGroup.equals(group))\r
 458                 )\r
 459             {\r
 460               continue;\r
 461             }\r
 462 \r
 463             if (group == null && next[j].featureGroup != null)\r
 464             {\r
 465               continue;\r
 466             }\r
 467 \r
 468             if (next[j].description == null || next[j].description.equals(""))\r
 469             {\r
 470               out.append(next[j].type + "\t");\r
 471             }\r
 472             else\r
 473             {\r
 474               if (next[j].links != null\r
 475                   && next[j].getDescription().indexOf("<html>") == -1)\r
 476               {\r
 477                 out.append("<html>");\r
 478               }\r
 479 \r
 480               out.append(next[j].description + " ");\r
 481               if (next[j].links != null)\r
 482               {\r
 483                 for (int l = 0; l < next[j].links.size(); l++)\r
 484                 {\r
 485                   String label = next[j].links.elementAt(l).toString();\r
 486                   String href = label.substring(label.indexOf("|") + 1);\r
 487                   label = label.substring(0, label.indexOf("|"));\r
 488 \r
 489                   if (next[j].description.indexOf(href) == -1)\r
 490                   {\r
 491                     out.append("<a href=\""\r
 492                                + href\r
 493                                + "\">"\r
 494                                + label\r
 495                                + "</a>");\r
 496                   }\r
 497                 }\r
 498 \r
 499                 if (next[j].getDescription().indexOf("</html>") == -1)\r
 500                 {\r
 501                   out.append("</html>");\r
 502                 }\r
 503               }\r
 504 \r
 505               out.append("\t");\r
 506             }\r
 507 \r
 508             out.append(seqs[i].getName() + "\t-1\t"\r
 509                        + next[j].begin + "\t"\r
 510                        + next[j].end + "\t"\r
 511                        + next[j].type + "\n"\r
 512                 );\r
 513           }\r
 514         }\r
 515       }\r
 516 \r
 517       if (group != null)\r
 518       {\r
 519         out.append("ENDGROUP\t" + group + "\n");\r
 520         groupIndex++;\r
 521       }\r
 522       else\r
 523       {\r
 524         break;\r
 525       }\r
 526 \r
 527     }\r
 528     while (groupIndex < groups.size() + 1);\r
 529 \r
 530     return out.toString();\r
 531   }\r
 532 \r
 533   public String printGFFFormat(SequenceI[] seqs, Hashtable visible)\r
 534   {\r
 535     StringBuffer out = new StringBuffer();\r
 536     SequenceFeature[] next;\r
 537     String source;\r
 538 \r
 539     for (int i = 0; i < seqs.length; i++)\r
 540     {\r
 541       if (seqs[i].getSequenceFeatures() != null)\r
 542       {\r
 543         next = seqs[i].getSequenceFeatures();\r
 544         for (int j = 0; j < next.length; j++)\r
 545         {\r
 546           if (!visible.containsKey(next[j].type))\r
 547           {\r
 548             continue;\r
 549           }\r
 550 \r
 551           source = next[j].featureGroup;\r
 552           if (source == null)\r
 553           {\r
 554             source = next[j].getDescription();\r
 555           }\r
 556 \r
 557           out.append(seqs[i].getName() + "\t"\r
 558                      + source + "\t"\r
 559                      + next[j].type + "\t"\r
 560                      + next[j].begin + "\t"\r
 561                      + next[j].end + "\t"\r
 562                      + next[j].score + "\t"\r
 563               );\r
 564 \r
 565           if (next[j].getValue("STRAND") != null)\r
 566           {\r
 567             out.append(next[j].getValue("STRAND") + "\t");\r
 568           }\r
 569           else\r
 570           {\r
 571             out.append(".\t");\r
 572           }\r
 573 \r
 574           if (next[j].getValue("FRAME") != null)\r
 575           {\r
 576             out.append(next[j].getValue("FRAME"));\r
 577           }\r
 578           else\r
 579           {\r
 580             out.append(".");\r
 581           }\r
 582 \r
 583           if (next[j].getValue("ATTRIBUTES") != null)\r
 584           {\r
 585             out.append(next[j].getValue("ATTRIBUTES"));\r
 586           }\r
 587 \r
 588           out.append("\n");\r
 589 \r
 590         }\r
 591       }\r
 592     }\r
 593 \r
 594     return out.toString();\r
 595   }\r
 596 \r
 597   public void parse()\r
 598   {\r
 599     //IGNORED\r
 600   }\r
 601 \r
 602   /**\r
 603    * DOCUMENT ME!\r
 604    *\r
 605    * @return DOCUMENT ME!\r
 606    */\r
 607   public String print()\r
 608   {\r
 609     return "USE printGFFFormat() or printJalviewFormat()";\r
 610   }\r
 611 }\r