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