src/jalview/io/FeaturesFile.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
   3  * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18 package jalview.io;
  19
  20 import java.io.*;
  21 import java.util.*;
  22
  23 import jalview.analysis.SequenceIdMatcher;
  24 import jalview.datamodel.*;
  25 import jalview.schemes.*;
  26 import jalview.util.Format;
  27
  28 /**
  29  * Parse and create Jalview Features files Detects GFF format features files and
  30  * parses. Does not implement standard print() - call specific printFeatures or
  31  * printGFF. Uses AlignmentI.findSequence(String id) to find the sequence object
  32  * for the features annotation - this normally works on an exact match.
  33  *
  34  * @author AMW
  35  * @version $Revision$
  36  */
  37 public class FeaturesFile extends AlignFile
  38 {
  39   /**
  40    * work around for GFF interpretation bug where source string becomes
  41    * description rather than a group
  42    */
  43   private boolean doGffSource = true;
  44
  45   /**
  46    * Creates a new FeaturesFile object.
  47    */
  48   public FeaturesFile()
  49   {
  50   }
  51
  52   /**
  53    * Creates a new FeaturesFile object.
  54    *
  55    * @param inFile
  56    *          DOCUMENT ME!
  57    * @param type
  58    *          DOCUMENT ME!
  59    *
  60    * @throws IOException
  61    *           DOCUMENT ME!
  62    */
  63   public FeaturesFile(String inFile, String type) throws IOException
  64   {
  65     super(inFile, type);
  66   }
  67
  68   public FeaturesFile(FileParse source) throws IOException
  69   {
  70     super(source);
  71   }
  72
  73   /**
  74    * Parse GFF or sequence features file using case-independent matching,
  75    * discarding URLs
  76    *
  77    * @param align
  78    *          - alignment/dataset containing sequences that are to be annotated
  79    * @param colours
  80    *          - hashtable to store feature colour definitions
  81    * @param removeHTML
  82    *          - process html strings into plain text
  83    * @return true if features were added
  84    */
  85   public boolean parse(AlignmentI align, Hashtable colours,
  86           boolean removeHTML)
  87   {
  88     return parse(align, colours, null, removeHTML, false);
  89   }
  90
  91   /**
  92    * Parse GFF or sequence features file optionally using case-independent
  93    * matching, discarding URLs
  94    *
  95    * @param align
  96    *          - alignment/dataset containing sequences that are to be annotated
  97    * @param colours
  98    *          - hashtable to store feature colour definitions
  99    * @param removeHTML
 100    *          - process html strings into plain text
 101    * @param relaxedIdmatching
 102    *          - when true, ID matches to compound sequence IDs are allowed
 103    * @return true if features were added
 104    */
 105   public boolean parse(AlignmentI align, Map colours, boolean removeHTML,
 106           boolean relaxedIdMatching)
 107   {
 108     return parse(align, colours, null, removeHTML, relaxedIdMatching);
 109   }
 110
 111   /**
 112    * Parse GFF or sequence features file optionally using case-independent
 113    * matching
 114    *
 115    * @param align
 116    *          - alignment/dataset containing sequences that are to be annotated
 117    * @param colours
 118    *          - hashtable to store feature colour definitions
 119    * @param featureLink
 120    *          - hashtable to store associated URLs
 121    * @param removeHTML
 122    *          - process html strings into plain text
 123    * @return true if features were added
 124    */
 125   public boolean parse(AlignmentI align, Map colours, Map featureLink,
 126           boolean removeHTML)
 127   {
 128     return parse(align, colours, featureLink, removeHTML, false);
 129   }
 130
 131   /**
 132    * Parse GFF or sequence features file
 133    *
 134    * @param align
 135    *          - alignment/dataset containing sequences that are to be annotated
 136    * @param colours
 137    *          - hashtable to store feature colour definitions
 138    * @param featureLink
 139    *          - hashtable to store associated URLs
 140    * @param removeHTML
 141    *          - process html strings into plain text
 142    * @param relaxedIdmatching
 143    *          - when true, ID matches to compound sequence IDs are allowed
 144    * @return true if features were added
 145    */
 146   public boolean parse(AlignmentI align, Map colours, Map featureLink,
 147           boolean removeHTML, boolean relaxedIdmatching)
 148   {
 149
 150     String line = null;
 151     try
 152     {
 153       SequenceI seq = null;
 154       String type, desc, token = null;
 155
 156       int index, start, end;
 157       float score;
 158       StringTokenizer st;
 159       SequenceFeature sf;
 160       String featureGroup = null, groupLink = null;
 161       Map typeLink = new Hashtable();
 162       /**
 163        * when true, assume GFF style features rather than Jalview style.
 164        */
 165       boolean GFFFile = true;
 166       while ((line = nextLine()) != null)
 167       {
 168         if (line.startsWith("#"))
 169         {
 170           continue;
 171         }
 172
 173         st = new StringTokenizer(line, "\t");
 174         if (st.countTokens() == 1)
 175         {
 176           if (line.trim().equalsIgnoreCase("GFF"))
 177           {
 178             // Start parsing file as if it might be GFF again.
 179             GFFFile = true;
 180             continue;
 181           }
 182         }
 183         if (st.countTokens() > 1 && st.countTokens() < 4)
 184         {
 185           GFFFile = false;
 186           type = st.nextToken();
 187           if (type.equalsIgnoreCase("startgroup"))
 188           {
 189             featureGroup = st.nextToken();
 190             if (st.hasMoreElements())
 191             {
 192               groupLink = st.nextToken();
 193               featureLink.put(featureGroup, groupLink);
 194             }
 195           }
 196           else if (type.equalsIgnoreCase("endgroup"))
 197           {
 198             // We should check whether this is the current group,
 199             // but at present theres no way of showing more than 1 group
 200             st.nextToken();
 201             featureGroup = null;
 202             groupLink = null;
 203           }
 204           else
 205           {
 206             Object colour = null;
 207             String colscheme = st.nextToken();
 208             if (colscheme.indexOf("|") > -1
 209                     || colscheme.trim().equalsIgnoreCase("label"))
 210             {
 211               // Parse '|' separated graduated colourscheme fields:
 212               // [label|][mincolour|maxcolour|[absolute|]minvalue|maxvalue|thresholdtype|thresholdvalue]
 213               // can either provide 'label' only, first is optional, next two
 214               // colors are required (but may be
 215               // left blank), next is optional, nxt two min/max are required.
 216               // first is either 'label'
 217               // first/second and third are both hexadecimal or word equivalent
 218               // colour.
 219               // next two are values parsed as floats.
 220               // fifth is either 'above','below', or 'none'.
 221               // sixth is a float value and only required when fifth is either
 222               // 'above' or 'below'.
 223               StringTokenizer gcol = new StringTokenizer(colscheme, "|",
 224                       true);
 225               // set defaults
 226               int threshtype = AnnotationColourGradient.NO_THRESHOLD;
 227               float min = Float.MIN_VALUE, max = Float.MAX_VALUE, threshval = Float.NaN;
 228               boolean labelCol = false;
 229               // Parse spec line
 230               String mincol = gcol.nextToken();
 231               if (mincol == "|")
 232               {
 233                 System.err
 234                         .println("Expected either 'label' or a colour specification in the line: "
 235                                 + line);
 236                 continue;
 237               }
 238               String maxcol = null;
 239               if (mincol.toLowerCase().indexOf("label") == 0)
 240               {
 241                 labelCol = true;
 242                 mincol = (gcol.hasMoreTokens() ? gcol.nextToken() : null); // skip
 243                                                                            // '|'
 244                 mincol = (gcol.hasMoreTokens() ? gcol.nextToken() : null);
 245               }
 246               String abso = null, minval, maxval;
 247               if (mincol != null)
 248               {
 249                 // at least four more tokens
 250                 if (mincol.equals("|"))
 251                 {
 252                   mincol = "";
 253                 }
 254                 else
 255                 {
 256                   gcol.nextToken(); // skip next '|'
 257                 }
 258                 // continue parsing rest of line
 259                 maxcol = gcol.nextToken();
 260                 if (maxcol.equals("|"))
 261                 {
 262                   maxcol = "";
 263                 }
 264                 else
 265                 {
 266                   gcol.nextToken(); // skip next '|'
 267                 }
 268                 abso = gcol.nextToken();
 269                 gcol.nextToken(); // skip next '|'
 270                 if (abso.toLowerCase().indexOf("abso") != 0)
 271                 {
 272                   minval = abso;
 273                   abso = null;
 274                 }
 275                 else
 276                 {
 277                   minval = gcol.nextToken();
 278                   gcol.nextToken(); // skip next '|'
 279                 }
 280                 maxval = gcol.nextToken();
 281                 if (gcol.hasMoreTokens())
 282                 {
 283                   gcol.nextToken(); // skip next '|'
 284                 }
 285                 try
 286                 {
 287                   if (minval.length() > 0)
 288                   {
 289                     min = new Float(minval).floatValue();
 290                   }
 291                 } catch (Exception e)
 292                 {
 293                   System.err
 294                           .println("Couldn't parse the minimum value for graduated colour for type ("
 295                                   + colscheme
 296                                   + ") - did you misspell 'auto' for the optional automatic colour switch ?");
 297                   e.printStackTrace();
 298                 }
 299                 try
 300                 {
 301                   if (maxval.length() > 0)
 302                   {
 303                     max = new Float(maxval).floatValue();
 304                   }
 305                 } catch (Exception e)
 306                 {
 307                   System.err
 308                           .println("Couldn't parse the maximum value for graduated colour for type ("
 309                                   + colscheme + ")");
 310                   e.printStackTrace();
 311                 }
 312               }
 313               else
 314               {
 315                 // add in some dummy min/max colours for the label-only
 316                 // colourscheme.
 317                 mincol = "FFFFFF";
 318                 maxcol = "000000";
 319               }
 320               try
 321               {
 322                 colour = new jalview.schemes.GraduatedColor(
 323                         new UserColourScheme(mincol).findColour('A'),
 324                         new UserColourScheme(maxcol).findColour('A'), min,
 325                         max);
 326               } catch (Exception e)
 327               {
 328                 System.err
 329                         .println("Couldn't parse the graduated colour scheme ("
 330                                 + colscheme + ")");
 331                 e.printStackTrace();
 332               }
 333               if (colour != null)
 334               {
 335                 ((jalview.schemes.GraduatedColor) colour)
 336                         .setColourByLabel(labelCol);
 337                 ((jalview.schemes.GraduatedColor) colour)
 338                         .setAutoScaled(abso == null);
 339                 // add in any additional parameters
 340                 String ttype = null, tval = null;
 341                 if (gcol.hasMoreTokens())
 342                 {
 343                   // threshold type and possibly a threshold value
 344                   ttype = gcol.nextToken();
 345                   if (ttype.toLowerCase().startsWith("below"))
 346                   {
 347                     ((jalview.schemes.GraduatedColor) colour)
 348                             .setThreshType(AnnotationColourGradient.BELOW_THRESHOLD);
 349                   }
 350                   else if (ttype.toLowerCase().startsWith("above"))
 351                   {
 352                     ((jalview.schemes.GraduatedColor) colour)
 353                             .setThreshType(AnnotationColourGradient.ABOVE_THRESHOLD);
 354                   }
 355                   else
 356                   {
 357                     ((jalview.schemes.GraduatedColor) colour)
 358                             .setThreshType(AnnotationColourGradient.NO_THRESHOLD);
 359                     if (!ttype.toLowerCase().startsWith("no"))
 360                     {
 361                       System.err
 362                               .println("Ignoring unrecognised threshold type : "
 363                                       + ttype);
 364                     }
 365                   }
 366                 }
 367                 if (((GraduatedColor) colour).getThreshType() != AnnotationColourGradient.NO_THRESHOLD)
 368                 {
 369                   try
 370                   {
 371                     gcol.nextToken();
 372                     tval = gcol.nextToken();
 373                     ((jalview.schemes.GraduatedColor) colour)
 374                             .setThresh(new Float(tval).floatValue());
 375                   } catch (Exception e)
 376                   {
 377                     System.err
 378                             .println("Couldn't parse threshold value as a float: ("
 379                                     + tval + ")");
 380                     e.printStackTrace();
 381                   }
 382                 }
 383                 // parse the thresh-is-min token ?
 384                 if (gcol.hasMoreTokens())
 385                 {
 386                   System.err
 387                           .println("Ignoring additional tokens in parameters in graduated colour specification\n");
 388                   while (gcol.hasMoreTokens())
 389                   {
 390                     System.err.println("|" + gcol.nextToken());
 391                   }
 392                   System.err.println("\n");
 393                 }
 394               }
 395             }
 396             else
 397             {
 398               UserColourScheme ucs = new UserColourScheme(colscheme);
 399               colour = ucs.findColour('A');
 400             }
 401             if (colour != null)
 402             {
 403               colours.put(type, colour);
 404             }
 405             if (st.hasMoreElements())
 406             {
 407               String link = st.nextToken();
 408               typeLink.put(type, link);
 409               if (featureLink == null)
 410               {
 411                 featureLink = new Hashtable();
 412               }
 413               featureLink.put(type, link);
 414             }
 415           }
 416           continue;
 417         }
 418         String seqId = "";
 419         while (st.hasMoreElements())
 420         {
 421
 422           if (GFFFile)
 423           {
 424             // Still possible this is an old Jalview file,
 425             // which does not have type colours at the beginning
 426             seqId = token = st.nextToken();
 427             seq = findName(align, seqId, relaxedIdmatching);
 428             if (seq != null)
 429             {
 430               desc = st.nextToken();
 431               String group = null;
 432               if (doGffSource && desc.indexOf(' ') == -1)
 433               {
 434                 // could also be a source term rather than description line
 435                 group = new String(desc);
 436               }
 437               type = st.nextToken();
 438               try
 439               {
 440                 String stt = st.nextToken();
 441                 if (stt.length() == 0 || stt.equals("-"))
 442                 {
 443                   start = 0;
 444                 }
 445                 else
 446                 {
 447                   start = Integer.parseInt(stt);
 448                 }
 449               } catch (NumberFormatException ex)
 450               {
 451                 start = 0;
 452               }
 453               try
 454               {
 455                 String stt = st.nextToken();
 456                 if (stt.length() == 0 || stt.equals("-"))
 457                 {
 458                   end = 0;
 459                 }
 460                 else
 461                 {
 462                   end = Integer.parseInt(stt);
 463                 }
 464               } catch (NumberFormatException ex)
 465               {
 466                 end = 0;
 467               }
 468               // TODO: decide if non positional feature assertion for input data
 469               // where end==0 is generally valid
 470               if (end == 0)
 471               {
 472                 // treat as non-positional feature, regardless.
 473                 start = 0;
 474               }
 475               try
 476               {
 477                 score = new Float(st.nextToken()).floatValue();
 478               } catch (NumberFormatException ex)
 479               {
 480                 score = 0;
 481               }
 482
 483               sf = new SequenceFeature(type, desc, start, end, score, group);
 484
 485               try
 486               {
 487                 sf.setValue("STRAND", st.nextToken());
 488                 sf.setValue("FRAME", st.nextToken());
 489               } catch (Exception ex)
 490               {
 491               }
 492
 493               if (st.hasMoreTokens())
 494               {
 495                 StringBuffer attributes = new StringBuffer();
 496                 while (st.hasMoreTokens())
 497                 {
 498                   attributes.append("\t" + st.nextElement());
 499                 }
 500                 // TODO validate and split GFF2 attributes field ? parse out
 501                 // ([A-Za-z][A-Za-z0-9_]*) <value> ; and add as
 502                 // sf.setValue(attrib, val);
 503                 sf.setValue("ATTRIBUTES", attributes.toString());
 504               }
 505
 506               seq.addSequenceFeature(sf);
 507               while ((seq = align.findName(seq, seqId, true)) != null)
 508               {
 509                 seq.addSequenceFeature(new SequenceFeature(sf));
 510               }
 511               break;
 512             }
 513           }
 514
 515           if (GFFFile && seq == null)
 516           {
 517             desc = token;
 518           }
 519           else
 520           {
 521             desc = st.nextToken();
 522           }
 523           if (!st.hasMoreTokens())
 524           {
 525             System.err
 526                     .println("DEBUG: Run out of tokens when trying to identify the destination for the feature.. giving up.");
 527             // in all probability, this isn't a file we understand, so bail
 528             // quietly.
 529             return false;
 530           }
 531
 532           token = st.nextToken();
 533
 534           if (!token.equals("ID_NOT_SPECIFIED"))
 535           {
 536             seq = findName(align, seqId = token, relaxedIdmatching);
 537             st.nextToken();
 538           }
 539           else
 540           {
 541             seqId = null;
 542             try
 543             {
 544               index = Integer.parseInt(st.nextToken());
 545               seq = align.getSequenceAt(index);
 546             } catch (NumberFormatException ex)
 547             {
 548               seq = null;
 549             }
 550           }
 551
 552           if (seq == null)
 553           {
 554             System.out.println("Sequence not found: " + line);
 555             break;
 556           }
 557
 558           start = Integer.parseInt(st.nextToken());
 559           end = Integer.parseInt(st.nextToken());
 560
 561           type = st.nextToken();
 562
 563           if (!colours.containsKey(type))
 564           {
 565             // Probably the old style groups file
 566             UserColourScheme ucs = new UserColourScheme(type);
 567             colours.put(type, ucs.findColour('A'));
 568           }
 569           sf = new SequenceFeature(type, desc, "", start, end, featureGroup);
 570           if (st.hasMoreTokens())
 571           {
 572             try
 573             {
 574               score = new Float(st.nextToken()).floatValue();
 575               // update colourgradient bounds if allowed to
 576             } catch (NumberFormatException ex)
 577             {
 578               score = 0;
 579             }
 580             sf.setScore(score);
 581           }
 582           if (groupLink != null && removeHTML)
 583           {
 584             sf.addLink(groupLink);
 585             sf.description += "%LINK%";
 586           }
 587           if (typeLink.containsKey(type) && removeHTML)
 588           {
 589             sf.addLink(typeLink.get(type).toString());
 590             sf.description += "%LINK%";
 591           }
 592
 593           parseDescriptionHTML(sf, removeHTML);
 594
 595           seq.addSequenceFeature(sf);
 596
 597           while (seqId != null
 598                   && (seq = align.findName(seq, seqId, false)) != null)
 599           {
 600             seq.addSequenceFeature(new SequenceFeature(sf));
 601           }
 602           // If we got here, its not a GFFFile
 603           GFFFile = false;
 604         }
 605       }
 606       resetMatcher();
 607     } catch (Exception ex)
 608     {
 609       System.out.println("Error parsing feature file: " + ex + "\n" + line);
 610       ex.printStackTrace(System.err);
 611       resetMatcher();
 612       return false;
 613     }
 614
 615     return true;
 616   }
 617
 618   private AlignmentI lastmatchedAl = null;
 619
 620   private SequenceIdMatcher matcher = null;
 621
 622   /**
 623    * clear any temporary handles used to speed up ID matching
 624    */
 625   private void resetMatcher()
 626   {
 627     lastmatchedAl = null;
 628     matcher = null;
 629   }
 630
 631   private SequenceI findName(AlignmentI align, String seqId,
 632           boolean relaxedIdMatching)
 633   {
 634     SequenceI match = null;
 635     if (relaxedIdMatching)
 636     {
 637       if (lastmatchedAl != align)
 638       {
 639         matcher = new SequenceIdMatcher(
 640                 (lastmatchedAl = align).getSequencesArray());
 641       }
 642       match = matcher.findIdMatch(seqId);
 643     }
 644     else
 645     {
 646       match = align.findName(seqId, true);
 647     }
 648     return match;
 649   }
 650
 651   public void parseDescriptionHTML(SequenceFeature sf, boolean removeHTML)
 652   {
 653     if (sf.getDescription() == null)
 654     {
 655       return;
 656     }
 657     jalview.util.ParseHtmlBodyAndLinks parsed = new jalview.util.ParseHtmlBodyAndLinks(
 658             sf.getDescription(), removeHTML, newline);
 659
 660     sf.description = (removeHTML) ? parsed.getNonHtmlContent()
 661             : sf.description;
 662     for (String link : parsed.getLinks())
 663     {
 664       sf.addLink(link);
 665     }
 666
 667   }
 668
 669   /**
 670    * generate a features file for seqs includes non-pos features by default.
 671    *
 672    * @param seqs
 673    *          source of sequence features
 674    * @param visible
 675    *          hash of feature types and colours
 676    * @return features file contents
 677    */
 678   public String printJalviewFormat(SequenceI[] seqs, Hashtable visible)
 679   {
 680     return printJalviewFormat(seqs, visible, true, true);
 681   }
 682
 683   /**
 684    * generate a features file for seqs with colours from visible (if any)
 685    *
 686    * @param seqs
 687    *          source of features
 688    * @param visible
 689    *          hash of Colours for each feature type
 690    * @param visOnly
 691    *          when true only feature types in 'visible' will be output
 692    * @param nonpos
 693    *          indicates if non-positional features should be output (regardless
 694    *          of group or type)
 695    * @return features file contents
 696    */
 697   public String printJalviewFormat(SequenceI[] seqs, Hashtable visible,
 698           boolean visOnly, boolean nonpos)
 699   {
 700     StringBuffer out = new StringBuffer();
 701     SequenceFeature[] next;
 702     boolean featuresGen = false;
 703     if (visOnly && !nonpos && (visible == null || visible.size() < 1))
 704     {
 705       // no point continuing.
 706       return "No Features Visible";
 707     }
 708
 709     if (visible != null && visOnly)
 710     {
 711       // write feature colours only if we're given them and we are generating
 712       // viewed features
 713       // TODO: decide if feature links should also be written here ?
 714       Enumeration en = visible.keys();
 715       String type, color;
 716       while (en.hasMoreElements())
 717       {
 718         type = en.nextElement().toString();
 719
 720         if (visible.get(type) instanceof GraduatedColor)
 721         {
 722           GraduatedColor gc = (GraduatedColor) visible.get(type);
 723           color = (gc.isColourByLabel() ? "label|" : "")
 724                   + Format.getHexString(gc.getMinColor()) + "|"
 725                   + Format.getHexString(gc.getMaxColor())
 726                   + (gc.isAutoScale() ? "|" : "|abso|") + gc.getMin() + "|"
 727                   + gc.getMax() + "|";
 728           if (gc.getThreshType() != AnnotationColourGradient.NO_THRESHOLD)
 729           {
 730             if (gc.getThreshType() == AnnotationColourGradient.BELOW_THRESHOLD)
 731             {
 732               color += "below";
 733             }
 734             else
 735             {
 736               if (gc.getThreshType() != AnnotationColourGradient.ABOVE_THRESHOLD)
 737               {
 738                 System.err.println("WARNING: Unsupported threshold type ("
 739                         + gc.getThreshType() + ") : Assuming 'above'");
 740               }
 741               color += "above";
 742             }
 743             // add the value
 744             color += "|" + gc.getThresh();
 745           }
 746           else
 747           {
 748             color += "none";
 749           }
 750         }
 751         else if (visible.get(type) instanceof java.awt.Color)
 752         {
 753           color = Format.getHexString((java.awt.Color) visible.get(type));
 754         }
 755         else
 756         {
 757           // legacy support for integer objects containing colour triplet values
 758           color = Format.getHexString(new java.awt.Color(Integer
 759                   .parseInt(visible.get(type).toString())));
 760         }
 761         out.append(type);
 762         out.append("\t");
 763         out.append(color);
 764         out.append(newline);
 765       }
 766     }
 767     // Work out which groups are both present and visible
 768     Vector groups = new Vector();
 769     int groupIndex = 0;
 770     boolean isnonpos = false;
 771
 772     for (int i = 0; i < seqs.length; i++)
 773     {
 774       next = seqs[i].getSequenceFeatures();
 775       if (next != null)
 776       {
 777         for (int j = 0; j < next.length; j++)
 778         {
 779           isnonpos = next[j].begin == 0 && next[j].end == 0;
 780           if ((!nonpos && isnonpos)
 781                   || (!isnonpos && visOnly && !visible
 782                           .containsKey(next[j].type)))
 783           {
 784             continue;
 785           }
 786
 787           if (next[j].featureGroup != null
 788                   && !groups.contains(next[j].featureGroup))
 789           {
 790             groups.addElement(next[j].featureGroup);
 791           }
 792         }
 793       }
 794     }
 795
 796     String group = null;
 797     do
 798     {
 799
 800       if (groups.size() > 0 && groupIndex < groups.size())
 801       {
 802         group = groups.elementAt(groupIndex).toString();
 803         out.append(newline);
 804         out.append("STARTGROUP\t");
 805         out.append(group);
 806         out.append(newline);
 807       }
 808       else
 809       {
 810         group = null;
 811       }
 812
 813       for (int i = 0; i < seqs.length; i++)
 814       {
 815         next = seqs[i].getSequenceFeatures();
 816         if (next != null)
 817         {
 818           for (int j = 0; j < next.length; j++)
 819           {
 820             isnonpos = next[j].begin == 0 && next[j].end == 0;
 821             if ((!nonpos && isnonpos)
 822                     || (!isnonpos && visOnly && !visible
 823                             .containsKey(next[j].type)))
 824             {
 825               // skip if feature is nonpos and we ignore them or if we only
 826               // output visible and it isn't non-pos and it's not visible
 827               continue;
 828             }
 829
 830             if (group != null
 831                     && (next[j].featureGroup == null || !next[j].featureGroup
 832                             .equals(group)))
 833             {
 834               continue;
 835             }
 836
 837             if (group == null && next[j].featureGroup != null)
 838             {
 839               continue;
 840             }
 841             // we have features to output
 842             featuresGen = true;
 843             if (next[j].description == null
 844                     || next[j].description.equals(""))
 845             {
 846               out.append(next[j].type + "\t");
 847             }
 848             else
 849             {
 850               if (next[j].links != null
 851                       && next[j].getDescription().indexOf("<html>") == -1)
 852               {
 853                 out.append("<html>");
 854               }
 855
 856               out.append(next[j].description + " ");
 857               if (next[j].links != null)
 858               {
 859                 for (int l = 0; l < next[j].links.size(); l++)
 860                 {
 861                   String label = next[j].links.elementAt(l).toString();
 862                   String href = label.substring(label.indexOf("|") + 1);
 863                   label = label.substring(0, label.indexOf("|"));
 864
 865                   if (next[j].description.indexOf(href) == -1)
 866                   {
 867                     out.append("<a href=\"" + href + "\">" + label + "</a>");
 868                   }
 869                 }
 870
 871                 if (next[j].getDescription().indexOf("</html>") == -1)
 872                 {
 873                   out.append("</html>");
 874                 }
 875               }
 876
 877               out.append("\t");
 878             }
 879             out.append(seqs[i].getName());
 880             out.append("\t-1\t");
 881             out.append(next[j].begin);
 882             out.append("\t");
 883             out.append(next[j].end);
 884             out.append("\t");
 885             out.append(next[j].type);
 886             if (next[j].score != Float.NaN)
 887             {
 888               out.append("\t");
 889               out.append(next[j].score);
 890             }
 891             out.append(newline);
 892           }
 893         }
 894       }
 895
 896       if (group != null)
 897       {
 898         out.append("ENDGROUP\t");
 899         out.append(group);
 900         out.append(newline);
 901         groupIndex++;
 902       }
 903       else
 904       {
 905         break;
 906       }
 907
 908     } while (groupIndex < groups.size() + 1);
 909
 910     if (!featuresGen)
 911     {
 912       return "No Features Visible";
 913     }
 914
 915     return out.toString();
 916   }
 917
 918   /**
 919    * generate a gff file for sequence features includes non-pos features by
 920    * default.
 921    *
 922    * @param seqs
 923    * @param visible
 924    * @return
 925    */
 926   public String printGFFFormat(SequenceI[] seqs, Hashtable visible)
 927   {
 928     return printGFFFormat(seqs, visible, true, true);
 929   }
 930
 931   public String printGFFFormat(SequenceI[] seqs, Hashtable visible,
 932           boolean visOnly, boolean nonpos)
 933   {
 934     StringBuffer out = new StringBuffer();
 935     SequenceFeature[] next;
 936     String source;
 937     boolean isnonpos;
 938     for (int i = 0; i < seqs.length; i++)
 939     {
 940       if (seqs[i].getSequenceFeatures() != null)
 941       {
 942         next = seqs[i].getSequenceFeatures();
 943         for (int j = 0; j < next.length; j++)
 944         {
 945           isnonpos = next[j].begin == 0 && next[j].end == 0;
 946           if ((!nonpos && isnonpos)
 947                   || (!isnonpos && visOnly && !visible
 948                           .containsKey(next[j].type)))
 949           {
 950             continue;
 951           }
 952
 953           source = next[j].featureGroup;
 954           if (source == null)
 955           {
 956             source = next[j].getDescription();
 957           }
 958
 959           out.append(seqs[i].getName());
 960           out.append("\t");
 961           out.append(source);
 962           out.append("\t");
 963           out.append(next[j].type);
 964           out.append("\t");
 965           out.append(next[j].begin);
 966           out.append("\t");
 967           out.append(next[j].end);
 968           out.append("\t");
 969           out.append(next[j].score);
 970           out.append("\t");
 971
 972           if (next[j].getValue("STRAND") != null)
 973           {
 974             out.append(next[j].getValue("STRAND"));
 975             out.append("\t");
 976           }
 977           else
 978           {
 979             out.append(".\t");
 980           }
 981
 982           if (next[j].getValue("FRAME") != null)
 983           {
 984             out.append(next[j].getValue("FRAME"));
 985           }
 986           else
 987           {
 988             out.append(".");
 989           }
 990           // TODO: verify/check GFF - should there be a /t here before attribute
 991           // output ?
 992
 993           if (next[j].getValue("ATTRIBUTES") != null)
 994           {
 995             out.append(next[j].getValue("ATTRIBUTES"));
 996           }
 997
 998           out.append(newline);
 999
1000         }
1001       }
1002     }
1003
1004     return out.toString();
1005   }
1006
1007   /**
1008    * this is only for the benefit of object polymorphism - method does nothing.
1009    */
1010   public void parse()
1011   {
1012     // IGNORED
1013   }
1014
1015   /**
1016    * this is only for the benefit of object polymorphism - method does nothing.
1017    *
1018    * @return error message
1019    */
1020   public String print()
1021   {
1022     return "USE printGFFFormat() or printJalviewFormat()";
1023   }
1024
1025 }