src/jalview/io/FeaturesFile.java

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