src/jalview/io/FeaturesFile.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ 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
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.io;
  22
  23 import jalview.analysis.AlignmentUtils;
  24 import jalview.analysis.SequenceIdMatcher;
  25 import jalview.api.AlignViewportI;
  26 import jalview.api.FeatureColourI;
  27 import jalview.api.FeaturesSourceI;
  28 import jalview.datamodel.AlignedCodonFrame;
  29 import jalview.datamodel.Alignment;
  30 import jalview.datamodel.AlignmentI;
  31 import jalview.datamodel.SequenceDummy;
  32 import jalview.datamodel.SequenceFeature;
  33 import jalview.datamodel.SequenceI;
  34 import jalview.io.gff.GffHelperBase;
  35 import jalview.io.gff.GffHelperFactory;
  36 import jalview.io.gff.GffHelperI;
  37 import jalview.schemes.FeatureColour;
  38 import jalview.util.ColorUtils;
  39 import jalview.util.MapList;
  40 import jalview.util.ParseHtmlBodyAndLinks;
  41 import jalview.util.StringUtils;
  42
  43 import java.awt.Color;
  44 import java.io.IOException;
  45 import java.util.ArrayList;
  46 import java.util.Arrays;
  47 import java.util.HashMap;
  48 import java.util.Iterator;
  49 import java.util.List;
  50 import java.util.Map;
  51 import java.util.Map.Entry;
  52
  53 /**
  54  * Parses and writes features files, which may be in Jalview, GFF2 or GFF3
  55  * format. These are tab-delimited formats but with differences in the use of
  56  * columns.
  57  *
  58  * A Jalview feature file may define feature colours and then declare that the
  59  * remainder of the file is in GFF format with the line 'GFF'.
  60  *
  61  * GFF3 files may include alignment mappings for features, which Jalview will
  62  * attempt to model, and may include sequence data following a ##FASTA line.
  63  *
  64  *
  65  * @author AMW
  66  * @author jbprocter
  67  * @author gmcarstairs
  68  */
  69 public class FeaturesFile extends AlignFile implements FeaturesSourceI
  70 {
  71   private static final String ID_NOT_SPECIFIED = "ID_NOT_SPECIFIED";
  72
  73   private static final String NOTE = "Note";
  74
  75   protected static final String TAB = "\t";
  76
  77   protected static final String GFF_VERSION = "##gff-version";
  78
  79   private AlignmentI lastmatchedAl = null;
  80
  81   private SequenceIdMatcher matcher = null;
  82
  83   protected AlignmentI dataset;
  84
  85   protected int gffVersion;
  86
  87   /**
  88    * Creates a new FeaturesFile object.
  89    */
  90   public FeaturesFile()
  91   {
  92   }
  93
  94   /**
  95    * Constructor which does not parse the file immediately
  96    *
  97    * @param inFile
  98    * @param paste
  99    * @throws IOException
 100    */
 101   public FeaturesFile(String inFile, DataSourceType paste)
 102           throws IOException
 103   {
 104     super(false, inFile, paste);
 105   }
 106
 107   /**
 108    * @param source
 109    * @throws IOException
 110    */
 111   public FeaturesFile(FileParse source) throws IOException
 112   {
 113     super(source);
 114   }
 115
 116   /**
 117    * Constructor that optionally parses the file immediately
 118    *
 119    * @param parseImmediately
 120    * @param inFile
 121    * @param type
 122    * @throws IOException
 123    */
 124   public FeaturesFile(boolean parseImmediately, String inFile,
 125           DataSourceType type)
 126           throws IOException
 127   {
 128     super(parseImmediately, inFile, type);
 129   }
 130
 131   /**
 132    * Parse GFF or sequence features file using case-independent matching,
 133    * discarding URLs
 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 removeHTML
 140    *          - process html strings into plain text
 141    * @return true if features were added
 142    */
 143   public boolean parse(AlignmentI align,
 144           Map<String, FeatureColourI> colours, boolean removeHTML)
 145   {
 146     return parse(align, colours, removeHTML, false);
 147   }
 148
 149   /**
 150    * Extends the default addProperties by also adding peptide-to-cDNA mappings
 151    * (if any) derived while parsing a GFF file
 152    */
 153   @Override
 154   public void addProperties(AlignmentI al)
 155   {
 156     super.addProperties(al);
 157     if (dataset != null && dataset.getCodonFrames() != null)
 158     {
 159       AlignmentI ds = (al.getDataset() == null) ? al : al.getDataset();
 160       for (AlignedCodonFrame codons : dataset.getCodonFrames())
 161       {
 162         ds.addCodonFrame(codons);
 163       }
 164     }
 165   }
 166
 167   /**
 168    * Parse GFF or Jalview format sequence features file
 169    *
 170    * @param align
 171    *          - alignment/dataset containing sequences that are to be annotated
 172    * @param colours
 173    *          - hashtable to store feature colour definitions
 174    * @param removeHTML
 175    *          - process html strings into plain text
 176    * @param relaxedIdmatching
 177    *          - when true, ID matches to compound sequence IDs are allowed
 178    * @return true if features were added
 179    */
 180   public boolean parse(AlignmentI align,
 181           Map<String, FeatureColourI> colours, boolean removeHTML,
 182           boolean relaxedIdmatching)
 183   {
 184     Map<String, String> gffProps = new HashMap<String, String>();
 185     /*
 186      * keep track of any sequences we try to create from the data
 187      */
 188     List<SequenceI> newseqs = new ArrayList<SequenceI>();
 189
 190     String line = null;
 191     try
 192     {
 193       String[] gffColumns;
 194       String featureGroup = null;
 195
 196       while ((line = nextLine()) != null)
 197       {
 198         // skip comments/process pragmas
 199         if (line.length() == 0 || line.startsWith("#"))
 200         {
 201           if (line.toLowerCase().startsWith("##"))
 202           {
 203             processGffPragma(line, gffProps, align, newseqs);
 204           }
 205           continue;
 206         }
 207
 208         gffColumns = line.split("\\t"); // tab as regex
 209         if (gffColumns.length == 1)
 210         {
 211           if (line.trim().equalsIgnoreCase("GFF"))
 212           {
 213             /*
 214              * Jalview features file with appended GFF
 215              * assume GFF2 (though it may declare ##gff-version 3)
 216              */
 217             gffVersion = 2;
 218             continue;
 219           }
 220         }
 221
 222         if (gffColumns.length > 1 && gffColumns.length < 4)
 223         {
 224           /*
 225            * if 2 or 3 tokens, we anticipate either 'startgroup', 'endgroup' or
 226            * a feature type colour specification
 227            */
 228           String ft = gffColumns[0];
 229           if (ft.equalsIgnoreCase("startgroup"))
 230           {
 231             featureGroup = gffColumns[1];
 232           }
 233           else if (ft.equalsIgnoreCase("endgroup"))
 234           {
 235             // We should check whether this is the current group,
 236             // but at present there's no way of showing more than 1 group
 237             featureGroup = null;
 238           }
 239           else
 240           {
 241             String colscheme = gffColumns[1];
 242             FeatureColourI colour = FeatureColour
 243                     .parseJalviewFeatureColour(colscheme);
 244             if (colour != null)
 245             {
 246               colours.put(ft, colour);
 247             }
 248           }
 249           continue;
 250         }
 251
 252         /*
 253          * if not a comment, GFF pragma, startgroup, endgroup or feature
 254          * colour specification, that just leaves a feature details line
 255          * in either Jalview or GFF format
 256          */
 257         if (gffVersion == 0)
 258         {
 259           parseJalviewFeature(line, gffColumns, align, colours, removeHTML,
 260                   relaxedIdmatching, featureGroup);
 261         }
 262         else
 263         {
 264           parseGff(gffColumns, align, relaxedIdmatching, newseqs);
 265         }
 266       }
 267       resetMatcher();
 268     } catch (Exception ex)
 269     {
 270       // should report somewhere useful for UI if necessary
 271       warningMessage = ((warningMessage == null) ? "" : warningMessage)
 272               + "Parsing error at\n" + line;
 273       System.out.println("Error parsing feature file: " + ex + "\n" + line);
 274       ex.printStackTrace(System.err);
 275       resetMatcher();
 276       return false;
 277     }
 278
 279     /*
 280      * experimental - add any dummy sequences with features to the alignment
 281      * - we need them for Ensembl feature extraction - though maybe not otherwise
 282      */
 283     for (SequenceI newseq : newseqs)
 284     {
 285       if (newseq.getFeatures().hasFeatures())
 286       {
 287         align.addSequence(newseq);
 288       }
 289     }
 290     return true;
 291   }
 292
 293   /**
 294    * Try to parse a Jalview format feature specification and add it as a
 295    * sequence feature to any matching sequences in the alignment. Returns true
 296    * if successful (a feature was added), or false if not.
 297    *
 298    * @param line
 299    * @param gffColumns
 300    * @param alignment
 301    * @param featureColours
 302    * @param removeHTML
 303    * @param relaxedIdmatching
 304    * @param featureGroup
 305    */
 306   protected boolean parseJalviewFeature(String line, String[] gffColumns,
 307           AlignmentI alignment, Map<String, FeatureColourI> featureColours,
 308           boolean removeHTML, boolean relaxedIdMatching, String featureGroup)
 309   {
 310     /*
 311      * tokens: description seqid seqIndex start end type [score]
 312      */
 313     if (gffColumns.length < 6)
 314     {
 315       System.err.println("Ignoring feature line '" + line
 316               + "' with too few columns (" + gffColumns.length + ")");
 317       return false;
 318     }
 319     String desc = gffColumns[0];
 320     String seqId = gffColumns[1];
 321     SequenceI seq = findSequence(seqId, alignment, null, relaxedIdMatching);
 322
 323     if (!ID_NOT_SPECIFIED.equals(seqId))
 324     {
 325       seq = findSequence(seqId, alignment, null, relaxedIdMatching);
 326     }
 327     else
 328     {
 329       seqId = null;
 330       seq = null;
 331       String seqIndex = gffColumns[2];
 332       try
 333       {
 334         int idx = Integer.parseInt(seqIndex);
 335         seq = alignment.getSequenceAt(idx);
 336       } catch (NumberFormatException ex)
 337       {
 338         System.err.println("Invalid sequence index: " + seqIndex);
 339       }
 340     }
 341
 342     if (seq == null)
 343     {
 344       System.out.println("Sequence not found: " + line);
 345       return false;
 346     }
 347
 348     int startPos = Integer.parseInt(gffColumns[3]);
 349     int endPos = Integer.parseInt(gffColumns[4]);
 350
 351     String ft = gffColumns[5];
 352
 353     if (!featureColours.containsKey(ft))
 354     {
 355       /*
 356        * Perhaps an old style groups file with no colours -
 357        * synthesize a colour from the feature type
 358        */
 359       Color colour = ColorUtils.createColourFromName(ft);
 360       featureColours.put(ft, new FeatureColour(colour));
 361     }
 362     SequenceFeature sf = new SequenceFeature(ft, desc, "", startPos,
 363             endPos, featureGroup);
 364     if (gffColumns.length > 6)
 365     {
 366       float score = Float.NaN;
 367       try
 368       {
 369         score = new Float(gffColumns[6]).floatValue();
 370         // update colourgradient bounds if allowed to
 371       } catch (NumberFormatException ex)
 372       {
 373         // leave as NaN
 374       }
 375       sf.setScore(score);
 376     }
 377
 378     parseDescriptionHTML(sf, removeHTML);
 379
 380     seq.addSequenceFeature(sf);
 381
 382     while (seqId != null
 383             && (seq = alignment.findName(seq, seqId, false)) != null)
 384     {
 385       seq.addSequenceFeature(new SequenceFeature(sf));
 386     }
 387     return true;
 388   }
 389
 390   /**
 391    * clear any temporary handles used to speed up ID matching
 392    */
 393   protected void resetMatcher()
 394   {
 395     lastmatchedAl = null;
 396     matcher = null;
 397   }
 398
 399   /**
 400    * Returns a sequence matching the given id, as follows
 401    * <ul>
 402    * <li>strict matching is on exact sequence name</li>
 403    * <li>relaxed matching allows matching on a token within the sequence name,
 404    * or a dbxref</li>
 405    * <li>first tries to find a match in the alignment sequences</li>
 406    * <li>else tries to find a match in the new sequences already generated while
 407    * parsing the features file</li>
 408    * <li>else creates a new placeholder sequence, adds it to the new sequences
 409    * list, and returns it</li>
 410    * </ul>
 411    *
 412    * @param seqId
 413    * @param align
 414    * @param newseqs
 415    * @param relaxedIdMatching
 416    *
 417    * @return
 418    */
 419   protected SequenceI findSequence(String seqId, AlignmentI align,
 420           List<SequenceI> newseqs, boolean relaxedIdMatching)
 421   {
 422     // TODO encapsulate in SequenceIdMatcher, share the matcher
 423     // with the GffHelper (removing code duplication)
 424     SequenceI match = null;
 425     if (relaxedIdMatching)
 426     {
 427       if (lastmatchedAl != align)
 428       {
 429         lastmatchedAl = align;
 430         matcher = new SequenceIdMatcher(align.getSequencesArray());
 431         if (newseqs != null)
 432         {
 433           matcher.addAll(newseqs);
 434         }
 435       }
 436       match = matcher.findIdMatch(seqId);
 437     }
 438     else
 439     {
 440       match = align.findName(seqId, true);
 441       if (match == null && newseqs != null)
 442       {
 443         for (SequenceI m : newseqs)
 444         {
 445           if (seqId.equals(m.getName()))
 446           {
 447             return m;
 448           }
 449         }
 450       }
 451
 452     }
 453     if (match == null && newseqs != null)
 454     {
 455       match = new SequenceDummy(seqId);
 456       if (relaxedIdMatching)
 457       {
 458         matcher.addAll(Arrays.asList(new SequenceI[] { match }));
 459       }
 460       // add dummy sequence to the newseqs list
 461       newseqs.add(match);
 462     }
 463     return match;
 464   }
 465
 466   public void parseDescriptionHTML(SequenceFeature sf, boolean removeHTML)
 467   {
 468     if (sf.getDescription() == null)
 469     {
 470       return;
 471     }
 472     ParseHtmlBodyAndLinks parsed = new ParseHtmlBodyAndLinks(
 473             sf.getDescription(), removeHTML, newline);
 474
 475     sf.description = (removeHTML) ? parsed.getNonHtmlContent()
 476             : sf.description;
 477     for (String link : parsed.getLinks())
 478     {
 479       sf.addLink(link);
 480     }
 481
 482   }
 483
 484   /**
 485    * generate a features file for seqs includes non-pos features by default.
 486    *
 487    * @param sequences
 488    *          source of sequence features
 489    * @param visible
 490    *          hash of feature types and colours
 491    * @return features file contents
 492    */
 493   public String printJalviewFormat(SequenceI[] sequences,
 494           Map<String, FeatureColourI> visible)
 495   {
 496     return printJalviewFormat(sequences, visible, true, true);
 497   }
 498
 499   /**
 500    * generate a features file for seqs with colours from visible (if any)
 501    *
 502    * @param sequences
 503    *          source of features
 504    * @param visible
 505    *          hash of Colours for each feature type
 506    * @param visOnly
 507    *          when true only feature types in 'visible' will be output
 508    * @param nonpos
 509    *          indicates if non-positional features should be output (regardless
 510    *          of group or type)
 511    * @return features file contents
 512    */
 513   public String printJalviewFormat(SequenceI[] sequences,
 514           Map<String, FeatureColourI> visible, boolean visOnly,
 515           boolean nonpos)
 516   {
 517     StringBuilder out = new StringBuilder(256);
 518     boolean featuresGen = false;
 519     if (visOnly && !nonpos && (visible == null || visible.size() < 1))
 520     {
 521       // no point continuing.
 522       return "No Features Visible";
 523     }
 524
 525     if (visible != null && visOnly)
 526     {
 527       // write feature colours only if we're given them and we are generating
 528       // viewed features
 529       // TODO: decide if feature links should also be written here ?
 530       Iterator<String> en = visible.keySet().iterator();
 531       while (en.hasNext())
 532       {
 533         String featureType = en.next().toString();
 534         FeatureColourI colour = visible.get(featureType);
 535         out.append(colour.toJalviewFormat(featureType)).append(newline);
 536       }
 537     }
 538
 539     // Work out which groups are both present and visible
 540     List<String> groups = new ArrayList<String>();
 541     int groupIndex = 0;
 542     boolean isnonpos = false;
 543
 544     SequenceFeature[] features;
 545     for (int i = 0; i < sequences.length; i++)
 546     {
 547       features = sequences[i].getSequenceFeatures();
 548       if (features != null)
 549       {
 550         for (int j = 0; j < features.length; j++)
 551         {
 552           isnonpos = features[j].begin == 0 && features[j].end == 0;
 553           if ((!nonpos && isnonpos)
 554                   || (!isnonpos && visOnly && !visible
 555                           .containsKey(features[j].type)))
 556           {
 557             continue;
 558           }
 559
 560           if (features[j].featureGroup != null
 561                   && !groups.contains(features[j].featureGroup))
 562           {
 563             groups.add(features[j].featureGroup);
 564           }
 565         }
 566       }
 567     }
 568
 569     String group = null;
 570     do
 571     {
 572       if (groups.size() > 0 && groupIndex < groups.size())
 573       {
 574         group = groups.get(groupIndex);
 575         out.append(newline);
 576         out.append("STARTGROUP").append(TAB);
 577         out.append(group);
 578         out.append(newline);
 579       }
 580       else
 581       {
 582         group = null;
 583       }
 584
 585       for (int i = 0; i < sequences.length; i++)
 586       {
 587         features = sequences[i].getSequenceFeatures();
 588         if (features != null)
 589         {
 590           for (SequenceFeature sequenceFeature : features)
 591           {
 592             isnonpos = sequenceFeature.begin == 0
 593                     && sequenceFeature.end == 0;
 594             if ((!nonpos && isnonpos)
 595                     || (!isnonpos && visOnly && !visible
 596                             .containsKey(sequenceFeature.type)))
 597             {
 598               // skip if feature is nonpos and we ignore them or if we only
 599               // output visible and it isn't non-pos and it's not visible
 600               continue;
 601             }
 602
 603             if (group != null
 604                     && (sequenceFeature.featureGroup == null || !sequenceFeature.featureGroup
 605                             .equals(group)))
 606             {
 607               continue;
 608             }
 609
 610             if (group == null && sequenceFeature.featureGroup != null)
 611             {
 612               continue;
 613             }
 614             // we have features to output
 615             featuresGen = true;
 616             if (sequenceFeature.description == null
 617                     || sequenceFeature.description.equals(""))
 618             {
 619               out.append(sequenceFeature.type).append(TAB);
 620             }
 621             else
 622             {
 623               if (sequenceFeature.links != null
 624                       && sequenceFeature.getDescription().indexOf("<html>") == -1)
 625               {
 626                 out.append("<html>");
 627               }
 628
 629               out.append(sequenceFeature.description);
 630               if (sequenceFeature.links != null)
 631               {
 632                 for (int l = 0; l < sequenceFeature.links.size(); l++)
 633                 {
 634                   String label = sequenceFeature.links.elementAt(l);
 635                   String href = label.substring(label.indexOf("|") + 1);
 636                   label = label.substring(0, label.indexOf("|"));
 637
 638                   if (sequenceFeature.description.indexOf(href) == -1)
 639                   {
 640                     out.append(" <a href=\"" + href + "\">" + label
 641                             + "</a>");
 642                   }
 643                 }
 644
 645                 if (sequenceFeature.getDescription().indexOf("</html>") == -1)
 646                 {
 647                   out.append("</html>");
 648                 }
 649               }
 650
 651               out.append(TAB);
 652             }
 653             out.append(sequences[i].getName());
 654             out.append("\t-1\t");
 655             out.append(sequenceFeature.begin);
 656             out.append(TAB);
 657             out.append(sequenceFeature.end);
 658             out.append(TAB);
 659             out.append(sequenceFeature.type);
 660             if (!Float.isNaN(sequenceFeature.score))
 661             {
 662               out.append(TAB);
 663               out.append(sequenceFeature.score);
 664             }
 665             out.append(newline);
 666           }
 667         }
 668       }
 669
 670       if (group != null)
 671       {
 672         out.append("ENDGROUP").append(TAB);
 673         out.append(group);
 674         out.append(newline);
 675         groupIndex++;
 676       }
 677       else
 678       {
 679         break;
 680       }
 681
 682     } while (groupIndex < groups.size() + 1);
 683
 684     if (!featuresGen)
 685     {
 686       return "No Features Visible";
 687     }
 688
 689     return out.toString();
 690   }
 691
 692   /**
 693    * Parse method that is called when a GFF file is dragged to the desktop
 694    */
 695   @Override
 696   public void parse()
 697   {
 698     AlignViewportI av = getViewport();
 699     if (av != null)
 700     {
 701       if (av.getAlignment() != null)
 702       {
 703         dataset = av.getAlignment().getDataset();
 704       }
 705       if (dataset == null)
 706       {
 707         // working in the applet context ?
 708         dataset = av.getAlignment();
 709       }
 710     }
 711     else
 712     {
 713       dataset = new Alignment(new SequenceI[] {});
 714     }
 715
 716     Map<String, FeatureColourI> featureColours = new HashMap<String, FeatureColourI>();
 717     boolean parseResult = parse(dataset, featureColours, false, true);
 718     if (!parseResult)
 719     {
 720       // pass error up somehow
 721     }
 722     if (av != null)
 723     {
 724       // update viewport with the dataset data ?
 725     }
 726     else
 727     {
 728       setSeqs(dataset.getSequencesArray());
 729     }
 730   }
 731
 732   /**
 733    * Implementation of unused abstract method
 734    *
 735    * @return error message
 736    */
 737   @Override
 738   public String print(SequenceI[] sqs, boolean jvsuffix)
 739   {
 740     System.out.println("Use printGffFormat() or printJalviewFormat()");
 741     return null;
 742   }
 743
 744   /**
 745    * Returns features output in GFF2 format, including hidden and non-positional
 746    * features
 747    *
 748    * @param sequences
 749    *          the sequences whose features are to be output
 750    * @param visible
 751    *          a map whose keys are the type names of visible features
 752    * @return
 753    */
 754   public String printGffFormat(SequenceI[] sequences,
 755           Map<String, FeatureColourI> visible)
 756   {
 757     return printGffFormat(sequences, visible, true, true);
 758   }
 759
 760   /**
 761    * Returns features output in GFF2 format
 762    *
 763    * @param sequences
 764    *          the sequences whose features are to be output
 765    * @param visible
 766    *          a map whose keys are the type names of visible features
 767    * @param outputVisibleOnly
 768    * @param includeNonPositionalFeatures
 769    * @return
 770    */
 771   public String printGffFormat(SequenceI[] sequences,
 772           Map<String, FeatureColourI> visible, boolean outputVisibleOnly,
 773           boolean includeNonPositionalFeatures)
 774   {
 775     StringBuilder out = new StringBuilder(256);
 776     int version = gffVersion == 0 ? 2 : gffVersion;
 777     out.append(String.format("%s %d\n", GFF_VERSION, version));
 778     String source;
 779     boolean isnonpos;
 780     for (SequenceI seq : sequences)
 781     {
 782       SequenceFeature[] features = seq.getSequenceFeatures();
 783       if (features != null)
 784       {
 785         for (SequenceFeature sf : features)
 786         {
 787           isnonpos = sf.begin == 0 && sf.end == 0;
 788           if (!includeNonPositionalFeatures && isnonpos)
 789           {
 790             /*
 791              * ignore non-positional features if not wanted
 792              */
 793             continue;
 794           }
 795           // TODO why the test !isnonpos here?
 796           // what about not visible non-positional features?
 797           if (!isnonpos && outputVisibleOnly
 798                   && !visible.containsKey(sf.type))
 799           {
 800             /*
 801              * ignore not visible features if not wanted
 802              */
 803             continue;
 804           }
 805
 806           source = sf.featureGroup;
 807           if (source == null)
 808           {
 809             source = sf.getDescription();
 810           }
 811
 812           out.append(seq.getName());
 813           out.append(TAB);
 814           out.append(source);
 815           out.append(TAB);
 816           out.append(sf.type);
 817           out.append(TAB);
 818           out.append(sf.begin);
 819           out.append(TAB);
 820           out.append(sf.end);
 821           out.append(TAB);
 822           out.append(sf.score);
 823           out.append(TAB);
 824
 825           int strand = sf.getStrand();
 826           out.append(strand == 1 ? "+" : (strand == -1 ? "-" : "."));
 827           out.append(TAB);
 828
 829           String phase = sf.getPhase();
 830           out.append(phase == null ? "." : phase);
 831
 832           // miscellaneous key-values (GFF column 9)
 833           String attributes = sf.getAttributes();
 834           if (attributes != null)
 835           {
 836             out.append(TAB).append(attributes);
 837           }
 838
 839           out.append(newline);
 840         }
 841       }
 842     }
 843
 844     return out.toString();
 845   }
 846
 847   /**
 848    * Returns a mapping given list of one or more Align descriptors (exonerate
 849    * format)
 850    *
 851    * @param alignedRegions
 852    *          a list of "Align fromStart toStart fromCount"
 853    * @param mapIsFromCdna
 854    *          if true, 'from' is dna, else 'from' is protein
 855    * @param strand
 856    *          either 1 (forward) or -1 (reverse)
 857    * @return
 858    * @throws IOException
 859    */
 860   protected MapList constructCodonMappingFromAlign(
 861           List<String> alignedRegions, boolean mapIsFromCdna, int strand)
 862           throws IOException
 863   {
 864     if (strand == 0)
 865     {
 866       throw new IOException(
 867               "Invalid strand for a codon mapping (cannot be 0)");
 868     }
 869     int regions = alignedRegions.size();
 870     // arrays to hold [start, end] for each aligned region
 871     int[] fromRanges = new int[regions * 2]; // from dna
 872     int[] toRanges = new int[regions * 2]; // to protein
 873     int fromRangesIndex = 0;
 874     int toRangesIndex = 0;
 875
 876     for (String range : alignedRegions)
 877     {
 878       /*
 879        * Align mapFromStart mapToStart mapFromCount
 880        * e.g. if mapIsFromCdna
 881        *     Align 11270 143 120
 882        * means:
 883        *     120 bases from pos 11270 align to pos 143 in peptide
 884        * if !mapIsFromCdna this would instead be
 885        *     Align 143 11270 40
 886        */
 887       String[] tokens = range.split(" ");
 888       if (tokens.length != 3)
 889       {
 890         throw new IOException("Wrong number of fields for Align");
 891       }
 892       int fromStart = 0;
 893       int toStart = 0;
 894       int fromCount = 0;
 895       try
 896       {
 897         fromStart = Integer.parseInt(tokens[0]);
 898         toStart = Integer.parseInt(tokens[1]);
 899         fromCount = Integer.parseInt(tokens[2]);
 900       } catch (NumberFormatException nfe)
 901       {
 902         throw new IOException("Invalid number in Align field: "
 903                 + nfe.getMessage());
 904       }
 905
 906       /*
 907        * Jalview always models from dna to protein, so adjust values if the
 908        * GFF mapping is from protein to dna
 909        */
 910       if (!mapIsFromCdna)
 911       {
 912         fromCount *= 3;
 913         int temp = fromStart;
 914         fromStart = toStart;
 915         toStart = temp;
 916       }
 917       fromRanges[fromRangesIndex++] = fromStart;
 918       fromRanges[fromRangesIndex++] = fromStart + strand * (fromCount - 1);
 919
 920       /*
 921        * If a codon has an intron gap, there will be contiguous 'toRanges';
 922        * this is handled for us by the MapList constructor.
 923        * (It is not clear that exonerate ever generates this case)
 924        */
 925       toRanges[toRangesIndex++] = toStart;
 926       toRanges[toRangesIndex++] = toStart + (fromCount - 1) / 3;
 927     }
 928
 929     return new MapList(fromRanges, toRanges, 3, 1);
 930   }
 931
 932   /**
 933    * Parse a GFF format feature. This may include creating a 'dummy' sequence to
 934    * hold the feature, or for its mapped sequence, or both, to be resolved
 935    * either later in the GFF file (##FASTA section), or when the user loads
 936    * additional sequences.
 937    *
 938    * @param gffColumns
 939    * @param alignment
 940    * @param relaxedIdMatching
 941    * @param newseqs
 942    * @return
 943    */
 944   protected SequenceI parseGff(String[] gffColumns, AlignmentI alignment,
 945           boolean relaxedIdMatching, List<SequenceI> newseqs)
 946   {
 947     /*
 948      * GFF: seqid source type start end score strand phase [attributes]
 949      */
 950     if (gffColumns.length < 5)
 951     {
 952       System.err.println("Ignoring GFF feature line with too few columns ("
 953               + gffColumns.length + ")");
 954       return null;
 955     }
 956
 957     /*
 958      * locate referenced sequence in alignment _or_
 959      * as a forward or external reference (SequenceDummy)
 960      */
 961     String seqId = gffColumns[0];
 962     SequenceI seq = findSequence(seqId, alignment, newseqs,
 963             relaxedIdMatching);
 964
 965     SequenceFeature sf = null;
 966     GffHelperI helper = GffHelperFactory.getHelper(gffColumns);
 967     if (helper != null)
 968     {
 969       try
 970       {
 971         sf = helper.processGff(seq, gffColumns, alignment, newseqs,
 972                 relaxedIdMatching);
 973         if (sf != null)
 974         {
 975           seq.addSequenceFeature(sf);
 976           while ((seq = alignment.findName(seq, seqId, true)) != null)
 977           {
 978             seq.addSequenceFeature(new SequenceFeature(sf));
 979           }
 980         }
 981       } catch (IOException e)
 982       {
 983         System.err.println("GFF parsing failed with: " + e.getMessage());
 984         return null;
 985       }
 986     }
 987
 988     return seq;
 989   }
 990
 991   /**
 992    * Process the 'column 9' data of the GFF file. This is less formally defined,
 993    * and its interpretation will vary depending on the tool that has generated
 994    * it.
 995    *
 996    * @param attributes
 997    * @param sf
 998    */
 999   protected void processGffColumnNine(String attributes, SequenceFeature sf)
1000   {
1001     sf.setAttributes(attributes);
1002
1003     /*
1004      * Parse attributes in column 9 and add them to the sequence feature's
1005      * 'otherData' table; use Note as a best proxy for description
1006      */
1007     char nameValueSeparator = gffVersion == 3 ? '=' : ' ';
1008     // TODO check we don't break GFF2 values which include commas here
1009     Map<String, List<String>> nameValues = GffHelperBase
1010             .parseNameValuePairs(attributes, ";", nameValueSeparator, ",");
1011     for (Entry<String, List<String>> attr : nameValues.entrySet())
1012     {
1013       String values = StringUtils.listToDelimitedString(attr.getValue(),
1014               "; ");
1015       sf.setValue(attr.getKey(), values);
1016       if (NOTE.equals(attr.getKey()))
1017       {
1018         sf.setDescription(values);
1019       }
1020     }
1021   }
1022
1023   /**
1024    * After encountering ##fasta in a GFF3 file, process the remainder of the
1025    * file as FAST sequence data. Any placeholder sequences created during
1026    * feature parsing are updated with the actual sequences.
1027    *
1028    * @param align
1029    * @param newseqs
1030    * @throws IOException
1031    */
1032   protected void processAsFasta(AlignmentI align, List<SequenceI> newseqs)
1033           throws IOException
1034   {
1035     try
1036     {
1037       mark();
1038     } catch (IOException q)
1039     {
1040     }
1041     FastaFile parser = new FastaFile(this);
1042     List<SequenceI> includedseqs = parser.getSeqs();
1043
1044     SequenceIdMatcher smatcher = new SequenceIdMatcher(newseqs);
1045
1046     /*
1047      * iterate over includedseqs, and replacing matching ones with newseqs
1048      * sequences. Generic iterator not used here because we modify
1049      * includedseqs as we go
1050      */
1051     for (int p = 0, pSize = includedseqs.size(); p < pSize; p++)
1052     {
1053       // search for any dummy seqs that this sequence can be used to update
1054       SequenceI includedSeq = includedseqs.get(p);
1055       SequenceI dummyseq = smatcher.findIdMatch(includedSeq);
1056       if (dummyseq != null && dummyseq instanceof SequenceDummy)
1057       {
1058         // probably have the pattern wrong
1059         // idea is that a flyweight proxy for a sequence ID can be created for
1060         // 1. stable reference creation
1061         // 2. addition of annotation
1062         // 3. future replacement by a real sequence
1063         // current pattern is to create SequenceDummy objects - a convenience
1064         // constructor for a Sequence.
1065         // problem is that when promoted to a real sequence, all references
1066         // need to be updated somehow. We avoid that by keeping the same object.
1067         ((SequenceDummy) dummyseq).become(includedSeq);
1068         dummyseq.createDatasetSequence();
1069
1070         /*
1071          * Update mappings so they are now to the dataset sequence
1072          */
1073         for (AlignedCodonFrame mapping : align.getCodonFrames())
1074         {
1075           mapping.updateToDataset(dummyseq);
1076         }
1077
1078         /*
1079          * replace parsed sequence with the realised forward reference
1080          */
1081         includedseqs.set(p, dummyseq);
1082
1083         /*
1084          * and remove from the newseqs list
1085          */
1086         newseqs.remove(dummyseq);
1087       }
1088     }
1089
1090     /*
1091      * finally add sequences to the dataset
1092      */
1093     for (SequenceI seq : includedseqs)
1094     {
1095       // experimental: mapping-based 'alignment' to query sequence
1096       AlignmentUtils.alignSequenceAs(seq, align,
1097               String.valueOf(align.getGapCharacter()), false, true);
1098
1099       // rename sequences if GFF handler requested this
1100       // TODO a more elegant way e.g. gffHelper.postProcess(newseqs) ?
1101       SequenceFeature[] sfs = seq.getSequenceFeatures();
1102       if (sfs != null)
1103       {
1104         String newName = (String) sfs[0].getValue(GffHelperI.RENAME_TOKEN);
1105         if (newName != null)
1106         {
1107           seq.setName(newName);
1108         }
1109       }
1110       align.addSequence(seq);
1111     }
1112   }
1113
1114   /**
1115    * Process a ## directive
1116    *
1117    * @param line
1118    * @param gffProps
1119    * @param align
1120    * @param newseqs
1121    * @throws IOException
1122    */
1123   protected void processGffPragma(String line,
1124           Map<String, String> gffProps, AlignmentI align,
1125           List<SequenceI> newseqs) throws IOException
1126   {
1127     line = line.trim();
1128     if ("###".equals(line))
1129     {
1130       // close off any open 'forward references'
1131       return;
1132     }
1133
1134     String[] tokens = line.substring(2).split(" ");
1135     String pragma = tokens[0];
1136     String value = tokens.length == 1 ? null : tokens[1];
1137
1138     if ("gff-version".equalsIgnoreCase(pragma))
1139     {
1140       if (value != null)
1141       {
1142         try
1143         {
1144           // value may be e.g. "3.1.2"
1145           gffVersion = Integer.parseInt(value.split("\\.")[0]);
1146         } catch (NumberFormatException e)
1147         {
1148           // ignore
1149         }
1150       }
1151     }
1152     else if ("sequence-region".equalsIgnoreCase(pragma))
1153     {
1154       // could capture <seqid start end> if wanted here
1155     }
1156     else if ("feature-ontology".equalsIgnoreCase(pragma))
1157     {
1158       // should resolve against the specified feature ontology URI
1159     }
1160     else if ("attribute-ontology".equalsIgnoreCase(pragma))
1161     {
1162       // URI of attribute ontology - not currently used in GFF3
1163     }
1164     else if ("source-ontology".equalsIgnoreCase(pragma))
1165     {
1166       // URI of source ontology - not currently used in GFF3
1167     }
1168     else if ("species-build".equalsIgnoreCase(pragma))
1169     {
1170       // save URI of specific NCBI taxon version of annotations
1171       gffProps.put("species-build", value);
1172     }
1173     else if ("fasta".equalsIgnoreCase(pragma))
1174     {
1175       // process the rest of the file as a fasta file and replace any dummy
1176       // sequence IDs
1177       processAsFasta(align, newseqs);
1178     }
1179     else
1180     {
1181       System.err.println("Ignoring unknown pragma: " + line);
1182     }
1183   }
1184 }