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 java.util.Locale;
  24
  25 import java.awt.Color;
  26 import java.io.IOException;
  27 import java.util.ArrayList;
  28 import java.util.Arrays;
  29 import java.util.Collections;
  30 import java.util.HashMap;
  31 import java.util.LinkedHashMap;
  32 import java.util.List;
  33 import java.util.Map;
  34 import java.util.Map.Entry;
  35 import java.util.TreeMap;
  36
  37 import jalview.analysis.AlignmentUtils;
  38 import jalview.analysis.SequenceIdMatcher;
  39 import jalview.api.AlignViewportI;
  40 import jalview.api.FeatureColourI;
  41 import jalview.api.FeatureRenderer;
  42 import jalview.api.FeaturesSourceI;
  43 import jalview.datamodel.AlignedCodonFrame;
  44 import jalview.datamodel.Alignment;
  45 import jalview.datamodel.AlignmentI;
  46 import jalview.datamodel.MappedFeatures;
  47 import jalview.datamodel.SequenceDummy;
  48 import jalview.datamodel.SequenceFeature;
  49 import jalview.datamodel.SequenceI;
  50 import jalview.datamodel.features.FeatureMatcherSet;
  51 import jalview.datamodel.features.FeatureMatcherSetI;
  52 import jalview.gui.Desktop;
  53 import jalview.io.gff.GffHelperFactory;
  54 import jalview.io.gff.GffHelperI;
  55 import jalview.schemes.FeatureColour;
  56 import jalview.util.ColorUtils;
  57 import jalview.util.MapList;
  58 import jalview.util.ParseHtmlBodyAndLinks;
  59 import jalview.util.StringUtils;
  60
  61 /**
  62  * Parses and writes features files, which may be in Jalview, GFF2 or GFF3
  63  * format. These are tab-delimited formats but with differences in the use of
  64  * columns.
  65  *
  66  * A Jalview feature file may define feature colours and then declare that the
  67  * remainder of the file is in GFF format with the line 'GFF'.
  68  *
  69  * GFF3 files may include alignment mappings for features, which Jalview will
  70  * attempt to model, and may include sequence data following a ##FASTA line.
  71  *
  72  *
  73  * @author AMW
  74  * @author jbprocter
  75  * @author gmcarstairs
  76  */
  77 public class FeaturesFile extends AlignFile implements FeaturesSourceI
  78 {
  79   private static final String EQUALS = "=";
  80
  81   private static final String TAB_REGEX = "\\t";
  82
  83   private static final String STARTGROUP = "STARTGROUP";
  84
  85   private static final String ENDGROUP = "ENDGROUP";
  86
  87   private static final String STARTFILTERS = "STARTFILTERS";
  88
  89   private static final String ENDFILTERS = "ENDFILTERS";
  90
  91   private static final String ID_NOT_SPECIFIED = "ID_NOT_SPECIFIED";
  92
  93   protected static final String GFF_VERSION = "##gff-version";
  94
  95   private AlignmentI lastmatchedAl = null;
  96
  97   private SequenceIdMatcher matcher = null;
  98
  99   protected AlignmentI dataset;
 100
 101   protected int gffVersion;
 102
 103   /**
 104    * Creates a new FeaturesFile object.
 105    */
 106   public FeaturesFile()
 107   {
 108   }
 109
 110   /**
 111    * Constructor which does not parse the file immediately
 112    *
 113    * @param file
 114    *          File or String filename
 115    * @param paste
 116    * @throws IOException
 117    */
 118   public FeaturesFile(Object file, DataSourceType paste) throws IOException
 119   {
 120     super(false, file, paste);
 121   }
 122
 123   /**
 124    * @param source
 125    * @throws IOException
 126    */
 127   public FeaturesFile(FileParse source) throws IOException
 128   {
 129     super(source);
 130   }
 131
 132   /**
 133    * Constructor that optionally parses the file immediately
 134    *
 135    * @param parseImmediately
 136    * @param file
 137    * @param type
 138    * @throws IOException
 139    */
 140   public FeaturesFile(boolean parseImmediately, Object file,
 141           DataSourceType type) throws IOException
 142   {
 143     super(parseImmediately, file, type);
 144   }
 145
 146   /**
 147    * Parse GFF or sequence features file using case-independent matching,
 148    * discarding URLs
 149    *
 150    * @param align
 151    *          - alignment/dataset containing sequences that are to be annotated
 152    * @param colours
 153    *          - hashtable to store feature colour definitions
 154    * @param removeHTML
 155    *          - process html strings into plain text
 156    * @return true if features were added
 157    */
 158   public boolean parse(AlignmentI align,
 159           Map<String, FeatureColourI> colours, boolean removeHTML)
 160   {
 161     return parse(align, colours, removeHTML, false);
 162   }
 163
 164   /**
 165    * Extends the default addProperties by also adding peptide-to-cDNA mappings
 166    * (if any) derived while parsing a GFF file
 167    */
 168   @Override
 169   public void addProperties(AlignmentI al)
 170   {
 171     super.addProperties(al);
 172     if (dataset != null && dataset.getCodonFrames() != null)
 173     {
 174       AlignmentI ds = (al.getDataset() == null) ? al : al.getDataset();
 175       for (AlignedCodonFrame codons : dataset.getCodonFrames())
 176       {
 177         ds.addCodonFrame(codons);
 178       }
 179     }
 180   }
 181
 182   /**
 183    * Parse GFF or Jalview format sequence features file
 184    *
 185    * @param align
 186    *          - alignment/dataset containing sequences that are to be annotated
 187    * @param colours
 188    *          - map to store feature colour definitions
 189    * @param removeHTML
 190    *          - process html strings into plain text
 191    * @param relaxedIdmatching
 192    *          - when true, ID matches to compound sequence IDs are allowed
 193    * @return true if features were added
 194    */
 195   public boolean parse(AlignmentI align,
 196           Map<String, FeatureColourI> colours, boolean removeHTML,
 197           boolean relaxedIdmatching)
 198   {
 199     return parse(align, colours, null, removeHTML, relaxedIdmatching);
 200   }
 201
 202   /**
 203    * Parse GFF or Jalview format sequence features file
 204    *
 205    * @param align
 206    *          - alignment/dataset containing sequences that are to be annotated
 207    * @param colours
 208    *          - map to store feature colour definitions
 209    * @param filters
 210    *          - map to store feature filter definitions
 211    * @param removeHTML
 212    *          - process html strings into plain text
 213    * @param relaxedIdmatching
 214    *          - when true, ID matches to compound sequence IDs are allowed
 215    * @return true if features were added
 216    */
 217   public boolean parse(AlignmentI align,
 218           Map<String, FeatureColourI> colours,
 219           Map<String, FeatureMatcherSetI> filters, boolean removeHTML,
 220           boolean relaxedIdmatching)
 221   {
 222     Map<String, String> gffProps = new HashMap<>();
 223     /*
 224      * keep track of any sequences we try to create from the data
 225      */
 226     List<SequenceI> newseqs = new ArrayList<>();
 227
 228     String line = null;
 229     try
 230     {
 231       String[] gffColumns;
 232       String featureGroup = null;
 233
 234       while ((line = nextLine()) != null)
 235       {
 236         // skip comments/process pragmas
 237         if (line.length() == 0 || line.startsWith("#"))
 238         {
 239           if (line.toLowerCase(Locale.ROOT).startsWith("##"))
 240           {
 241             processGffPragma(line, gffProps, align, newseqs);
 242           }
 243           continue;
 244         }
 245
 246         gffColumns = line.split(TAB_REGEX);
 247         if (gffColumns.length == 1)
 248         {
 249           if (line.trim().equalsIgnoreCase("GFF"))
 250           {
 251             /*
 252              * Jalview features file with appended GFF
 253              * assume GFF2 (though it may declare ##gff-version 3)
 254              */
 255             gffVersion = 2;
 256             continue;
 257           }
 258         }
 259
 260         if (gffColumns.length > 0 && gffColumns.length < 4)
 261         {
 262           /*
 263            * if 2 or 3 tokens, we anticipate either 'startgroup', 'endgroup' or
 264            * a feature type colour specification
 265            */
 266           String ft = gffColumns[0];
 267           if (ft.equalsIgnoreCase(STARTFILTERS))
 268           {
 269             parseFilters(filters);
 270             continue;
 271           }
 272           if (ft.equalsIgnoreCase(STARTGROUP))
 273           {
 274             featureGroup = gffColumns[1];
 275           }
 276           else if (ft.equalsIgnoreCase(ENDGROUP))
 277           {
 278             // We should check whether this is the current group,
 279             // but at present there's no way of showing more than 1 group
 280             featureGroup = null;
 281           }
 282           else
 283           {
 284             String colscheme = gffColumns[1];
 285             FeatureColourI colour = FeatureColour
 286                     .parseJalviewFeatureColour(colscheme);
 287             if (colour != null)
 288             {
 289               colours.put(ft, colour);
 290             }
 291           }
 292           continue;
 293         }
 294
 295         /*
 296          * if not a comment, GFF pragma, startgroup, endgroup or feature
 297          * colour specification, that just leaves a feature details line
 298          * in either Jalview or GFF format
 299          */
 300         if (gffVersion == 0)
 301         {
 302           parseJalviewFeature(line, gffColumns, align, colours, removeHTML,
 303                   relaxedIdmatching, featureGroup);
 304         }
 305         else
 306         {
 307           parseGff(gffColumns, align, relaxedIdmatching, newseqs);
 308         }
 309       }
 310       resetMatcher();
 311     } catch (Exception ex)
 312     {
 313       // should report somewhere useful for UI if necessary
 314       warningMessage = ((warningMessage == null) ? "" : warningMessage)
 315               + "Parsing error at\n" + line;
 316       System.out.println("Error parsing feature file: " + ex + "\n" + line);
 317       ex.printStackTrace(System.err);
 318       resetMatcher();
 319       return false;
 320     }
 321
 322     /*
 323      * experimental - add any dummy sequences with features to the alignment
 324      * - we need them for Ensembl feature extraction - though maybe not otherwise
 325      */
 326     for (SequenceI newseq : newseqs)
 327     {
 328       if (newseq.getFeatures().hasFeatures())
 329       {
 330         align.addSequence(newseq);
 331       }
 332     }
 333     return true;
 334   }
 335
 336   /**
 337    * Reads input lines from STARTFILTERS to ENDFILTERS and adds a feature type
 338    * filter to the map for each line parsed. After exit from this method,
 339    * nextLine() should return the line after ENDFILTERS (or we are already at
 340    * end of file if ENDFILTERS was missing).
 341    *
 342    * @param filters
 343    * @throws IOException
 344    */
 345   protected void parseFilters(Map<String, FeatureMatcherSetI> filters)
 346           throws IOException
 347   {
 348     String line;
 349     while ((line = nextLine()) != null)
 350     {
 351       if (line.toUpperCase(Locale.ROOT).startsWith(ENDFILTERS))
 352       {
 353         return;
 354       }
 355       String[] tokens = line.split(TAB_REGEX);
 356       if (tokens.length != 2)
 357       {
 358         System.err.println(String.format("Invalid token count %d for %d",
 359                 tokens.length, line));
 360       }
 361       else
 362       {
 363         String featureType = tokens[0];
 364         FeatureMatcherSetI fm = FeatureMatcherSet.fromString(tokens[1]);
 365         if (fm != null && filters != null)
 366         {
 367           filters.put(featureType, fm);
 368         }
 369       }
 370     }
 371   }
 372
 373   /**
 374    * Try to parse a Jalview format feature specification and add it as a
 375    * sequence feature to any matching sequences in the alignment. Returns true
 376    * if successful (a feature was added), or false if not.
 377    *
 378    * @param line
 379    * @param gffColumns
 380    * @param alignment
 381    * @param featureColours
 382    * @param removeHTML
 383    * @param relaxedIdmatching
 384    * @param featureGroup
 385    */
 386   protected boolean parseJalviewFeature(String line, String[] gffColumns,
 387           AlignmentI alignment, Map<String, FeatureColourI> featureColours,
 388           boolean removeHTML, boolean relaxedIdMatching,
 389           String featureGroup)
 390   {
 391     /*
 392      * tokens: description seqid seqIndex start end type [score]
 393      */
 394     if (gffColumns.length < 6)
 395     {
 396       System.err.println("Ignoring feature line '" + line
 397               + "' with too few columns (" + gffColumns.length + ")");
 398       return false;
 399     }
 400     String desc = gffColumns[0];
 401     String seqId = gffColumns[1];
 402     SequenceI seq = findSequence(seqId, alignment, null, relaxedIdMatching);
 403
 404     if (!ID_NOT_SPECIFIED.equals(seqId))
 405     {
 406       seq = findSequence(seqId, alignment, null, relaxedIdMatching);
 407     }
 408     else
 409     {
 410       seqId = null;
 411       seq = null;
 412       String seqIndex = gffColumns[2];
 413       try
 414       {
 415         int idx = Integer.parseInt(seqIndex);
 416         seq = alignment.getSequenceAt(idx);
 417       } catch (NumberFormatException ex)
 418       {
 419         System.err.println("Invalid sequence index: " + seqIndex);
 420       }
 421     }
 422
 423     if (seq == null)
 424     {
 425       System.out.println("Sequence not found: " + line);
 426       return false;
 427     }
 428
 429     int startPos = Integer.parseInt(gffColumns[3]);
 430     int endPos = Integer.parseInt(gffColumns[4]);
 431
 432     String ft = gffColumns[5];
 433
 434     if (!featureColours.containsKey(ft))
 435     {
 436       /*
 437        * Perhaps an old style groups file with no colours -
 438        * synthesize a colour from the feature type
 439        */
 440       Color colour = ColorUtils.createColourFromName(ft);
 441       featureColours.put(ft, new FeatureColour(colour));
 442     }
 443     SequenceFeature sf = null;
 444     if (gffColumns.length > 6)
 445     {
 446       float score = Float.NaN;
 447       try
 448       {
 449         score = Float.valueOf(gffColumns[6]).floatValue();
 450       } catch (NumberFormatException ex)
 451       {
 452         sf = new SequenceFeature(ft, desc, startPos, endPos, featureGroup);
 453       }
 454       sf = new SequenceFeature(ft, desc, startPos, endPos, score,
 455               featureGroup);
 456     }
 457     else
 458     {
 459       sf = new SequenceFeature(ft, desc, startPos, endPos, featureGroup);
 460     }
 461
 462     parseDescriptionHTML(sf, removeHTML);
 463
 464     seq.addSequenceFeature(sf);
 465
 466     while (seqId != null
 467             && (seq = alignment.findName(seq, seqId, false)) != null)
 468     {
 469       seq.addSequenceFeature(new SequenceFeature(sf));
 470     }
 471     return true;
 472   }
 473
 474   /**
 475    * clear any temporary handles used to speed up ID matching
 476    */
 477   protected void resetMatcher()
 478   {
 479     lastmatchedAl = null;
 480     matcher = null;
 481   }
 482
 483   /**
 484    * Returns a sequence matching the given id, as follows
 485    * <ul>
 486    * <li>strict matching is on exact sequence name</li>
 487    * <li>relaxed matching allows matching on a token within the sequence name,
 488    * or a dbxref</li>
 489    * <li>first tries to find a match in the alignment sequences</li>
 490    * <li>else tries to find a match in the new sequences already generated while
 491    * parsing the features file</li>
 492    * <li>else creates a new placeholder sequence, adds it to the new sequences
 493    * list, and returns it</li>
 494    * </ul>
 495    *
 496    * @param seqId
 497    * @param align
 498    * @param newseqs
 499    * @param relaxedIdMatching
 500    *
 501    * @return
 502    */
 503   protected SequenceI findSequence(String seqId, AlignmentI align,
 504           List<SequenceI> newseqs, boolean relaxedIdMatching)
 505   {
 506     // TODO encapsulate in SequenceIdMatcher, share the matcher
 507     // with the GffHelper (removing code duplication)
 508     SequenceI match = null;
 509     if (relaxedIdMatching)
 510     {
 511       if (lastmatchedAl != align)
 512       {
 513         lastmatchedAl = align;
 514         matcher = new SequenceIdMatcher(align.getSequencesArray());
 515         if (newseqs != null)
 516         {
 517           matcher.addAll(newseqs);
 518         }
 519       }
 520       match = matcher.findIdMatch(seqId);
 521     }
 522     else
 523     {
 524       match = align.findName(seqId, true);
 525       if (match == null && newseqs != null)
 526       {
 527         for (SequenceI m : newseqs)
 528         {
 529           if (seqId.equals(m.getName()))
 530           {
 531             return m;
 532           }
 533         }
 534       }
 535
 536     }
 537     if (match == null && newseqs != null)
 538     {
 539       match = new SequenceDummy(seqId);
 540       if (relaxedIdMatching)
 541       {
 542         matcher.addAll(Arrays.asList(new SequenceI[] { match }));
 543       }
 544       // add dummy sequence to the newseqs list
 545       newseqs.add(match);
 546     }
 547     return match;
 548   }
 549
 550   public void parseDescriptionHTML(SequenceFeature sf, boolean removeHTML)
 551   {
 552     if (sf.getDescription() == null)
 553     {
 554       return;
 555     }
 556     ParseHtmlBodyAndLinks parsed = new ParseHtmlBodyAndLinks(
 557             sf.getDescription(), removeHTML, newline);
 558
 559     if (removeHTML)
 560     {
 561       sf.setDescription(parsed.getNonHtmlContent());
 562     }
 563
 564     for (String link : parsed.getLinks())
 565     {
 566       sf.addLink(link);
 567     }
 568   }
 569
 570   /**
 571    * Returns contents of a Jalview format features file, for visible features,
 572    * as filtered by type and group. Features with a null group are displayed if
 573    * their feature type is visible. Non-positional features may optionally be
 574    * included (with no check on type or group).
 575    *
 576    * @param sequences
 577    * @param fr
 578    * @param includeNonPositional
 579    *          if true, include non-positional features (regardless of group or
 580    *          type)
 581    * @param includeComplement
 582    *          if true, include visible complementary (CDS/protein) positional
 583    *          features, with locations converted to local sequence coordinates
 584    * @return
 585    */
 586   public String printJalviewFormat(SequenceI[] sequences,
 587           FeatureRenderer fr, boolean includeNonPositional,
 588           boolean includeComplement)
 589   {
 590     Map<String, FeatureColourI> visibleColours = fr
 591             .getDisplayedFeatureCols();
 592     Map<String, FeatureMatcherSetI> featureFilters = fr.getFeatureFilters();
 593
 594     /*
 595      * write out feature colours (if we know them)
 596      */
 597     // TODO: decide if feature links should also be written here ?
 598     StringBuilder out = new StringBuilder(256);
 599     if (visibleColours != null)
 600     {
 601       for (Entry<String, FeatureColourI> featureColour : visibleColours
 602               .entrySet())
 603       {
 604         FeatureColourI colour = featureColour.getValue();
 605         out.append(colour.toJalviewFormat(featureColour.getKey()))
 606                 .append(newline);
 607       }
 608     }
 609
 610     String[] types = visibleColours == null ? new String[0]
 611             : visibleColours.keySet()
 612                     .toArray(new String[visibleColours.keySet().size()]);
 613
 614     /*
 615      * feature filters if any
 616      */
 617     outputFeatureFilters(out, visibleColours, featureFilters);
 618
 619     /*
 620      * output features within groups
 621      */
 622     int count = outputFeaturesByGroup(out, fr, types, sequences,
 623             includeNonPositional);
 624
 625     if (includeComplement)
 626     {
 627       count += outputComplementFeatures(out, fr, sequences);
 628     }
 629
 630     return count > 0 ? out.toString() : "No Features Visible";
 631   }
 632
 633   /**
 634    * Outputs any visible complementary (CDS/peptide) positional features as
 635    * Jalview format, within feature group. The coordinates of the linked
 636    * features are converted to the corresponding positions of the local
 637    * sequences.
 638    *
 639    * @param out
 640    * @param fr
 641    * @param sequences
 642    * @return
 643    */
 644   private int outputComplementFeatures(StringBuilder out,
 645           FeatureRenderer fr, SequenceI[] sequences)
 646   {
 647     AlignViewportI comp = fr.getViewport().getCodingComplement();
 648     FeatureRenderer fr2 = Desktop.getAlignFrameFor(comp)
 649             .getFeatureRenderer();
 650
 651     /*
 652      * bin features by feature group and sequence
 653      */
 654     Map<String, Map<String, List<SequenceFeature>>> map = new TreeMap<>(
 655             String.CASE_INSENSITIVE_ORDER);
 656     int count = 0;
 657
 658     for (SequenceI seq : sequences)
 659     {
 660       /*
 661        * find complementary features
 662        */
 663       List<SequenceFeature> complementary = findComplementaryFeatures(seq,
 664               fr2);
 665       String seqName = seq.getName();
 666
 667       for (SequenceFeature sf : complementary)
 668       {
 669         String group = sf.getFeatureGroup();
 670         if (!map.containsKey(group))
 671         {
 672           map.put(group, new LinkedHashMap<>()); // preserves sequence order
 673         }
 674         Map<String, List<SequenceFeature>> groupFeatures = map.get(group);
 675         if (!groupFeatures.containsKey(seqName))
 676         {
 677           groupFeatures.put(seqName, new ArrayList<>());
 678         }
 679         List<SequenceFeature> foundFeatures = groupFeatures.get(seqName);
 680         foundFeatures.add(sf);
 681         count++;
 682       }
 683     }
 684
 685     /*
 686      * output features by group
 687      */
 688     for (Entry<String, Map<String, List<SequenceFeature>>> groupFeatures : map
 689             .entrySet())
 690     {
 691       out.append(newline);
 692       String group = groupFeatures.getKey();
 693       if (!"".equals(group))
 694       {
 695         out.append(STARTGROUP).append(TAB).append(group).append(newline);
 696       }
 697       Map<String, List<SequenceFeature>> seqFeaturesMap = groupFeatures
 698               .getValue();
 699       for (Entry<String, List<SequenceFeature>> seqFeatures : seqFeaturesMap
 700               .entrySet())
 701       {
 702         String sequenceName = seqFeatures.getKey();
 703         for (SequenceFeature sf : seqFeatures.getValue())
 704         {
 705           formatJalviewFeature(out, sequenceName, sf);
 706         }
 707       }
 708       if (!"".equals(group))
 709       {
 710         out.append(ENDGROUP).append(TAB).append(group).append(newline);
 711       }
 712     }
 713
 714     return count;
 715   }
 716
 717   /**
 718    * Answers a list of mapped features visible in the (CDS/protein) complement,
 719    * with feature positions translated to local sequence coordinates
 720    *
 721    * @param seq
 722    * @param fr2
 723    * @return
 724    */
 725   protected List<SequenceFeature> findComplementaryFeatures(SequenceI seq,
 726           FeatureRenderer fr2)
 727   {
 728     /*
 729      * avoid duplication of features (e.g. peptide feature
 730      * at all 3 mapped codon positions)
 731      */
 732     List<SequenceFeature> found = new ArrayList<>();
 733     List<SequenceFeature> complementary = new ArrayList<>();
 734
 735     for (int pos = seq.getStart(); pos <= seq.getEnd(); pos++)
 736     {
 737       MappedFeatures mf = fr2.findComplementFeaturesAtResidue(seq, pos);
 738
 739       if (mf != null)
 740       {
 741         for (SequenceFeature sf : mf.features)
 742         {
 743           /*
 744            * make a virtual feature with local coordinates
 745            */
 746           if (!found.contains(sf))
 747           {
 748             String group = sf.getFeatureGroup();
 749             if (group == null)
 750             {
 751               group = "";
 752             }
 753             found.add(sf);
 754             int begin = sf.getBegin();
 755             int end = sf.getEnd();
 756             int[] range = mf.getMappedPositions(begin, end);
 757             SequenceFeature sf2 = new SequenceFeature(sf, range[0],
 758                     range[1], group, sf.getScore());
 759             complementary.add(sf2);
 760           }
 761         }
 762       }
 763     }
 764
 765     return complementary;
 766   }
 767
 768   /**
 769    * Outputs any feature filters defined for visible feature types, sandwiched
 770    * by STARTFILTERS and ENDFILTERS lines
 771    *
 772    * @param out
 773    * @param visible
 774    * @param featureFilters
 775    */
 776   void outputFeatureFilters(StringBuilder out,
 777           Map<String, FeatureColourI> visible,
 778           Map<String, FeatureMatcherSetI> featureFilters)
 779   {
 780     if (visible == null || featureFilters == null
 781             || featureFilters.isEmpty())
 782     {
 783       return;
 784     }
 785
 786     boolean first = true;
 787     for (String featureType : visible.keySet())
 788     {
 789       FeatureMatcherSetI filter = featureFilters.get(featureType);
 790       if (filter != null)
 791       {
 792         if (first)
 793         {
 794           first = false;
 795           out.append(newline).append(STARTFILTERS).append(newline);
 796         }
 797         out.append(featureType).append(TAB).append(filter.toStableString())
 798                 .append(newline);
 799       }
 800     }
 801     if (!first)
 802     {
 803       out.append(ENDFILTERS).append(newline);
 804     }
 805
 806   }
 807
 808   /**
 809    * Appends output of visible sequence features within feature groups to the
 810    * output buffer. Groups other than the null or empty group are sandwiched by
 811    * STARTGROUP and ENDGROUP lines. Answers the number of features written.
 812    *
 813    * @param out
 814    * @param fr
 815    * @param featureTypes
 816    * @param sequences
 817    * @param includeNonPositional
 818    * @return
 819    */
 820   private int outputFeaturesByGroup(StringBuilder out, FeatureRenderer fr,
 821           String[] featureTypes, SequenceI[] sequences,
 822           boolean includeNonPositional)
 823   {
 824     List<String> featureGroups = fr.getFeatureGroups();
 825
 826     /*
 827      * sort groups alphabetically, and ensure that features with a
 828      * null or empty group are output after those in named groups
 829      */
 830     List<String> sortedGroups = new ArrayList<>(featureGroups);
 831     sortedGroups.remove(null);
 832     sortedGroups.remove("");
 833     Collections.sort(sortedGroups);
 834     sortedGroups.add(null);
 835     sortedGroups.add("");
 836
 837     int count = 0;
 838     List<String> visibleGroups = fr.getDisplayedFeatureGroups();
 839
 840     /*
 841      * loop over all groups (may be visible or not);
 842      * non-positional features are output even if group is not visible
 843      */
 844     for (String group : sortedGroups)
 845     {
 846       boolean firstInGroup = true;
 847       boolean isNullGroup = group == null || "".equals(group);
 848
 849       for (int i = 0; i < sequences.length; i++)
 850       {
 851         String sequenceName = sequences[i].getName();
 852         List<SequenceFeature> features = new ArrayList<>();
 853
 854         /*
 855          * get any non-positional features in this group, if wanted
 856          * (for any feature type, whether visible or not)
 857          */
 858         if (includeNonPositional)
 859         {
 860           features.addAll(sequences[i].getFeatures()
 861                   .getFeaturesForGroup(false, group));
 862         }
 863
 864         /*
 865          * add positional features for visible feature types, but
 866          * (for named groups) only if feature group is visible
 867          */
 868         if (featureTypes.length > 0
 869                 && (isNullGroup || visibleGroups.contains(group)))
 870         {
 871           features.addAll(sequences[i].getFeatures()
 872                   .getFeaturesForGroup(true, group, featureTypes));
 873         }
 874
 875         for (SequenceFeature sf : features)
 876         {
 877           if (sf.isNonPositional() || fr.isVisible(sf))
 878           {
 879             count++;
 880             if (firstInGroup)
 881             {
 882               out.append(newline);
 883               if (!isNullGroup)
 884               {
 885                 out.append(STARTGROUP).append(TAB).append(group)
 886                         .append(newline);
 887               }
 888             }
 889             firstInGroup = false;
 890             formatJalviewFeature(out, sequenceName, sf);
 891           }
 892         }
 893       }
 894
 895       if (!isNullGroup && !firstInGroup)
 896       {
 897         out.append(ENDGROUP).append(TAB).append(group).append(newline);
 898       }
 899     }
 900     return count;
 901   }
 902
 903   /**
 904    * Formats one feature in Jalview format and appends to the string buffer
 905    *
 906    * @param out
 907    * @param sequenceName
 908    * @param sequenceFeature
 909    */
 910   protected void formatJalviewFeature(StringBuilder out,
 911           String sequenceName, SequenceFeature sequenceFeature)
 912   {
 913     if (sequenceFeature.description == null
 914             || sequenceFeature.description.equals(""))
 915     {
 916       out.append(sequenceFeature.type).append(TAB);
 917     }
 918     else
 919     {
 920       if (sequenceFeature.links != null
 921               && sequenceFeature.getDescription().indexOf("<html>") == -1)
 922       {
 923         out.append("<html>");
 924       }
 925
 926       out.append(sequenceFeature.description);
 927       if (sequenceFeature.links != null)
 928       {
 929         for (int l = 0; l < sequenceFeature.links.size(); l++)
 930         {
 931           String label = sequenceFeature.links.elementAt(l);
 932           String href = label.substring(label.indexOf("|") + 1);
 933           label = label.substring(0, label.indexOf("|"));
 934
 935           if (sequenceFeature.description.indexOf(href) == -1)
 936           {
 937             out.append(" <a href=\"").append(href).append("\">")
 938                     .append(label).append("</a>");
 939           }
 940         }
 941
 942         if (sequenceFeature.getDescription().indexOf("</html>") == -1)
 943         {
 944           out.append("</html>");
 945         }
 946       }
 947
 948       out.append(TAB);
 949     }
 950     out.append(sequenceName);
 951     out.append("\t-1\t");
 952     out.append(sequenceFeature.begin);
 953     out.append(TAB);
 954     out.append(sequenceFeature.end);
 955     out.append(TAB);
 956     out.append(sequenceFeature.type);
 957     if (!Float.isNaN(sequenceFeature.score))
 958     {
 959       out.append(TAB);
 960       out.append(sequenceFeature.score);
 961     }
 962     out.append(newline);
 963   }
 964
 965   /**
 966    * Parse method that is called when a GFF file is dragged to the desktop
 967    */
 968   @Override
 969   public void parse()
 970   {
 971     AlignViewportI av = getViewport();
 972     if (av != null)
 973     {
 974       if (av.getAlignment() != null)
 975       {
 976         dataset = av.getAlignment().getDataset();
 977       }
 978       if (dataset == null)
 979       {
 980         // working in the applet context ?
 981         dataset = av.getAlignment();
 982       }
 983     }
 984     else
 985     {
 986       dataset = new Alignment(new SequenceI[] {});
 987     }
 988
 989     Map<String, FeatureColourI> featureColours = new HashMap<>();
 990     boolean parseResult = parse(dataset, featureColours, false, true);
 991     if (!parseResult)
 992     {
 993       // pass error up somehow
 994     }
 995     if (av != null)
 996     {
 997       // update viewport with the dataset data ?
 998     }
 999     else
1000     {
1001       setSeqs(dataset.getSequencesArray());
1002     }
1003   }
1004
1005   /**
1006    * Implementation of unused abstract method
1007    *
1008    * @return error message
1009    */
1010   @Override
1011   public String print(SequenceI[] sqs, boolean jvsuffix)
1012   {
1013     System.out.println("Use printGffFormat() or printJalviewFormat()");
1014     return null;
1015   }
1016
1017   /**
1018    * Returns features output in GFF2 format
1019    *
1020    * @param sequences
1021    *          the sequences whose features are to be output
1022    * @param visible
1023    *          a map whose keys are the type names of visible features
1024    * @param visibleFeatureGroups
1025    * @param includeNonPositionalFeatures
1026    * @param includeComplement
1027    * @return
1028    */
1029   public String printGffFormat(SequenceI[] sequences, FeatureRenderer fr,
1030           boolean includeNonPositionalFeatures, boolean includeComplement)
1031   {
1032     FeatureRenderer fr2 = null;
1033     if (includeComplement)
1034     {
1035       AlignViewportI comp = fr.getViewport().getCodingComplement();
1036       fr2 = Desktop.getAlignFrameFor(comp).getFeatureRenderer();
1037     }
1038
1039     Map<String, FeatureColourI> visibleColours = fr
1040             .getDisplayedFeatureCols();
1041
1042     StringBuilder out = new StringBuilder(256);
1043
1044     out.append(String.format("%s %d\n", GFF_VERSION,
1045             gffVersion == 0 ? 2 : gffVersion));
1046
1047     String[] types = visibleColours == null ? new String[0]
1048             : visibleColours.keySet()
1049                     .toArray(new String[visibleColours.keySet().size()]);
1050
1051     for (SequenceI seq : sequences)
1052     {
1053       List<SequenceFeature> seqFeatures = new ArrayList<>();
1054       List<SequenceFeature> features = new ArrayList<>();
1055       if (includeNonPositionalFeatures)
1056       {
1057         features.addAll(seq.getFeatures().getNonPositionalFeatures());
1058       }
1059       if (visibleColours != null && !visibleColours.isEmpty())
1060       {
1061         features.addAll(seq.getFeatures().getPositionalFeatures(types));
1062       }
1063       for (SequenceFeature sf : features)
1064       {
1065         if (sf.isNonPositional() || fr.isVisible(sf))
1066         {
1067           /*
1068            * drop features hidden by group visibility, colour threshold,
1069            * or feature filter condition
1070            */
1071           seqFeatures.add(sf);
1072         }
1073       }
1074
1075       if (includeComplement)
1076       {
1077         seqFeatures.addAll(findComplementaryFeatures(seq, fr2));
1078       }
1079
1080       /*
1081        * sort features here if wanted
1082        */
1083       for (SequenceFeature sf : seqFeatures)
1084       {
1085         formatGffFeature(out, seq, sf);
1086         out.append(newline);
1087       }
1088     }
1089
1090     return out.toString();
1091   }
1092
1093   /**
1094    * Formats one feature as GFF and appends to the string buffer
1095    */
1096   private void formatGffFeature(StringBuilder out, SequenceI seq,
1097           SequenceFeature sf)
1098   {
1099     String source = sf.featureGroup;
1100     if (source == null)
1101     {
1102       source = sf.getDescription();
1103     }
1104
1105     out.append(seq.getName());
1106     out.append(TAB);
1107     out.append(source);
1108     out.append(TAB);
1109     out.append(sf.type);
1110     out.append(TAB);
1111     out.append(sf.begin);
1112     out.append(TAB);
1113     out.append(sf.end);
1114     out.append(TAB);
1115     out.append(sf.score);
1116     out.append(TAB);
1117
1118     int strand = sf.getStrand();
1119     out.append(strand == 1 ? "+" : (strand == -1 ? "-" : "."));
1120     out.append(TAB);
1121
1122     String phase = sf.getPhase();
1123     out.append(phase == null ? "." : phase);
1124
1125     if (sf.otherDetails != null && !sf.otherDetails.isEmpty())
1126     {
1127       Map<String, Object> map = sf.otherDetails;
1128       formatAttributes(out, map);
1129     }
1130   }
1131
1132   /**
1133    * A helper method that outputs attributes stored in the map as
1134    * semicolon-delimited values e.g.
1135    *
1136    * <pre>
1137    * AC_Male=0;AF_NFE=0.00000e 00;Hom_FIN=0;GQ_MEDIAN=9
1138    * </pre>
1139    *
1140    * A map-valued attribute is formatted as a comma-delimited list within
1141    * braces, for example
1142    *
1143    * <pre>
1144    * jvmap_CSQ={ALLELE_NUM=1,UNIPARC=UPI0002841053,Feature=ENST00000585561}
1145    * </pre>
1146    *
1147    * The {@code jvmap_} prefix designates a values map and is removed if the
1148    * value is parsed when read in. (The GFF3 specification allows
1149    * 'semi-structured data' to be represented provided the attribute name begins
1150    * with a lower case letter.)
1151    *
1152    * @param sb
1153    * @param map
1154    * @see http://gmod.org/wiki/GFF3#GFF3_Format
1155    */
1156   void formatAttributes(StringBuilder sb, Map<String, Object> map)
1157   {
1158     sb.append(TAB);
1159     boolean first = true;
1160     for (String key : map.keySet())
1161     {
1162       if (SequenceFeature.STRAND.equals(key)
1163               || SequenceFeature.PHASE.equals(key))
1164       {
1165         /*
1166          * values stashed in map but output to their own columns
1167          */
1168         continue;
1169       }
1170       {
1171         if (!first)
1172         {
1173           sb.append(";");
1174         }
1175       }
1176       first = false;
1177       Object value = map.get(key);
1178       if (value instanceof Map<?, ?>)
1179       {
1180         formatMapAttribute(sb, key, (Map<?, ?>) value);
1181       }
1182       else
1183       {
1184         String formatted = StringUtils.urlEncode(value.toString(),
1185                 GffHelperI.GFF_ENCODABLE);
1186         sb.append(key).append(EQUALS).append(formatted);
1187       }
1188     }
1189   }
1190
1191   /**
1192    * Formats the map entries as
1193    *
1194    * <pre>
1195    * key=key1=value1,key2=value2,...
1196    * </pre>
1197    *
1198    * and appends this to the string buffer
1199    *
1200    * @param sb
1201    * @param key
1202    * @param map
1203    */
1204   private void formatMapAttribute(StringBuilder sb, String key,
1205           Map<?, ?> map)
1206   {
1207     if (map == null || map.isEmpty())
1208     {
1209       return;
1210     }
1211
1212     /*
1213      * AbstractMap.toString would be a shortcut here, but more reliable
1214      * to code the required format in case toString changes in future
1215      */
1216     sb.append(key).append(EQUALS);
1217     boolean first = true;
1218     for (Entry<?, ?> entry : map.entrySet())
1219     {
1220       if (!first)
1221       {
1222         sb.append(",");
1223       }
1224       first = false;
1225       sb.append(entry.getKey().toString()).append(EQUALS);
1226       String formatted = StringUtils.urlEncode(entry.getValue().toString(),
1227               GffHelperI.GFF_ENCODABLE);
1228       sb.append(formatted);
1229     }
1230   }
1231
1232   /**
1233    * Returns a mapping given list of one or more Align descriptors (exonerate
1234    * format)
1235    *
1236    * @param alignedRegions
1237    *          a list of "Align fromStart toStart fromCount"
1238    * @param mapIsFromCdna
1239    *          if true, 'from' is dna, else 'from' is protein
1240    * @param strand
1241    *          either 1 (forward) or -1 (reverse)
1242    * @return
1243    * @throws IOException
1244    */
1245   protected MapList constructCodonMappingFromAlign(
1246           List<String> alignedRegions, boolean mapIsFromCdna, int strand)
1247           throws IOException
1248   {
1249     if (strand == 0)
1250     {
1251       throw new IOException(
1252               "Invalid strand for a codon mapping (cannot be 0)");
1253     }
1254     int regions = alignedRegions.size();
1255     // arrays to hold [start, end] for each aligned region
1256     int[] fromRanges = new int[regions * 2]; // from dna
1257     int[] toRanges = new int[regions * 2]; // to protein
1258     int fromRangesIndex = 0;
1259     int toRangesIndex = 0;
1260
1261     for (String range : alignedRegions)
1262     {
1263       /*
1264        * Align mapFromStart mapToStart mapFromCount
1265        * e.g. if mapIsFromCdna
1266        *     Align 11270 143 120
1267        * means:
1268        *     120 bases from pos 11270 align to pos 143 in peptide
1269        * if !mapIsFromCdna this would instead be
1270        *     Align 143 11270 40
1271        */
1272       String[] tokens = range.split(" ");
1273       if (tokens.length != 3)
1274       {
1275         throw new IOException("Wrong number of fields for Align");
1276       }
1277       int fromStart = 0;
1278       int toStart = 0;
1279       int fromCount = 0;
1280       try
1281       {
1282         fromStart = Integer.parseInt(tokens[0]);
1283         toStart = Integer.parseInt(tokens[1]);
1284         fromCount = Integer.parseInt(tokens[2]);
1285       } catch (NumberFormatException nfe)
1286       {
1287         throw new IOException(
1288                 "Invalid number in Align field: " + nfe.getMessage());
1289       }
1290
1291       /*
1292        * Jalview always models from dna to protein, so adjust values if the
1293        * GFF mapping is from protein to dna
1294        */
1295       if (!mapIsFromCdna)
1296       {
1297         fromCount *= 3;
1298         int temp = fromStart;
1299         fromStart = toStart;
1300         toStart = temp;
1301       }
1302       fromRanges[fromRangesIndex++] = fromStart;
1303       fromRanges[fromRangesIndex++] = fromStart + strand * (fromCount - 1);
1304
1305       /*
1306        * If a codon has an intron gap, there will be contiguous 'toRanges';
1307        * this is handled for us by the MapList constructor.
1308        * (It is not clear that exonerate ever generates this case)
1309        */
1310       toRanges[toRangesIndex++] = toStart;
1311       toRanges[toRangesIndex++] = toStart + (fromCount - 1) / 3;
1312     }
1313
1314     return new MapList(fromRanges, toRanges, 3, 1);
1315   }
1316
1317   /**
1318    * Parse a GFF format feature. This may include creating a 'dummy' sequence to
1319    * hold the feature, or for its mapped sequence, or both, to be resolved
1320    * either later in the GFF file (##FASTA section), or when the user loads
1321    * additional sequences.
1322    *
1323    * @param gffColumns
1324    * @param alignment
1325    * @param relaxedIdMatching
1326    * @param newseqs
1327    * @return
1328    */
1329   protected SequenceI parseGff(String[] gffColumns, AlignmentI alignment,
1330           boolean relaxedIdMatching, List<SequenceI> newseqs)
1331   {
1332     /*
1333      * GFF: seqid source type start end score strand phase [attributes]
1334      */
1335     if (gffColumns.length < 5)
1336     {
1337       System.err.println("Ignoring GFF feature line with too few columns ("
1338               + gffColumns.length + ")");
1339       return null;
1340     }
1341
1342     /*
1343      * locate referenced sequence in alignment _or_
1344      * as a forward or external reference (SequenceDummy)
1345      */
1346     String seqId = gffColumns[0];
1347     SequenceI seq = findSequence(seqId, alignment, newseqs,
1348             relaxedIdMatching);
1349
1350     SequenceFeature sf = null;
1351     GffHelperI helper = GffHelperFactory.getHelper(gffColumns);
1352     if (helper != null)
1353     {
1354       try
1355       {
1356         sf = helper.processGff(seq, gffColumns, alignment, newseqs,
1357                 relaxedIdMatching);
1358         if (sf != null)
1359         {
1360           seq.addSequenceFeature(sf);
1361           while ((seq = alignment.findName(seq, seqId, true)) != null)
1362           {
1363             seq.addSequenceFeature(new SequenceFeature(sf));
1364           }
1365         }
1366       } catch (IOException e)
1367       {
1368         System.err.println("GFF parsing failed with: " + e.getMessage());
1369         return null;
1370       }
1371     }
1372
1373     return seq;
1374   }
1375
1376   /**
1377    * After encountering ##fasta in a GFF3 file, process the remainder of the
1378    * file as FAST sequence data. Any placeholder sequences created during
1379    * feature parsing are updated with the actual sequences.
1380    *
1381    * @param align
1382    * @param newseqs
1383    * @throws IOException
1384    */
1385   protected void processAsFasta(AlignmentI align, List<SequenceI> newseqs)
1386           throws IOException
1387   {
1388     try
1389     {
1390       mark();
1391     } catch (IOException q)
1392     {
1393     }
1394     // Opening a FastaFile object with the remainder of this object's dataIn.
1395     // Tell the constructor to NOT close the dataIn when finished.
1396     FastaFile parser = new FastaFile(this, false);
1397     List<SequenceI> includedseqs = parser.getSeqs();
1398
1399     SequenceIdMatcher smatcher = new SequenceIdMatcher(newseqs);
1400
1401     /*
1402      * iterate over includedseqs, and replacing matching ones with newseqs
1403      * sequences. Generic iterator not used here because we modify
1404      * includedseqs as we go
1405      */
1406     for (int p = 0, pSize = includedseqs.size(); p < pSize; p++)
1407     {
1408       // search for any dummy seqs that this sequence can be used to update
1409       SequenceI includedSeq = includedseqs.get(p);
1410       SequenceI dummyseq = smatcher.findIdMatch(includedSeq);
1411       if (dummyseq != null && dummyseq instanceof SequenceDummy)
1412       {
1413         // probably have the pattern wrong
1414         // idea is that a flyweight proxy for a sequence ID can be created for
1415         // 1. stable reference creation
1416         // 2. addition of annotation
1417         // 3. future replacement by a real sequence
1418         // current pattern is to create SequenceDummy objects - a convenience
1419         // constructor for a Sequence.
1420         // problem is that when promoted to a real sequence, all references
1421         // need to be updated somehow. We avoid that by keeping the same object.
1422         ((SequenceDummy) dummyseq).become(includedSeq);
1423         dummyseq.createDatasetSequence();
1424
1425         /*
1426          * Update mappings so they are now to the dataset sequence
1427          */
1428         for (AlignedCodonFrame mapping : align.getCodonFrames())
1429         {
1430           mapping.updateToDataset(dummyseq);
1431         }
1432
1433         /*
1434          * replace parsed sequence with the realised forward reference
1435          */
1436         includedseqs.set(p, dummyseq);
1437
1438         /*
1439          * and remove from the newseqs list
1440          */
1441         newseqs.remove(dummyseq);
1442       }
1443     }
1444
1445     /*
1446      * finally add sequences to the dataset
1447      */
1448     for (SequenceI seq : includedseqs)
1449     {
1450       // experimental: mapping-based 'alignment' to query sequence
1451       AlignmentUtils.alignSequenceAs(seq, align,
1452               String.valueOf(align.getGapCharacter()), false, true);
1453
1454       // rename sequences if GFF handler requested this
1455       // TODO a more elegant way e.g. gffHelper.postProcess(newseqs) ?
1456       List<SequenceFeature> sfs = seq.getFeatures().getPositionalFeatures();
1457       if (!sfs.isEmpty())
1458       {
1459         String newName = (String) sfs.get(0)
1460                 .getValue(GffHelperI.RENAME_TOKEN);
1461         if (newName != null)
1462         {
1463           seq.setName(newName);
1464         }
1465       }
1466       align.addSequence(seq);
1467     }
1468   }
1469
1470   /**
1471    * Process a ## directive
1472    *
1473    * @param line
1474    * @param gffProps
1475    * @param align
1476    * @param newseqs
1477    * @throws IOException
1478    */
1479   protected void processGffPragma(String line, Map<String, String> gffProps,
1480           AlignmentI align, List<SequenceI> newseqs) throws IOException
1481   {
1482     line = line.trim();
1483     if ("###".equals(line))
1484     {
1485       // close off any open 'forward references'
1486       return;
1487     }
1488
1489     String[] tokens = line.substring(2).split(" ");
1490     String pragma = tokens[0];
1491     String value = tokens.length == 1 ? null : tokens[1];
1492
1493     if ("gff-version".equalsIgnoreCase(pragma))
1494     {
1495       if (value != null)
1496       {
1497         try
1498         {
1499           // value may be e.g. "3.1.2"
1500           gffVersion = Integer.parseInt(value.split("\\.")[0]);
1501         } catch (NumberFormatException e)
1502         {
1503           // ignore
1504         }
1505       }
1506     }
1507     else if ("sequence-region".equalsIgnoreCase(pragma))
1508     {
1509       // could capture <seqid start end> if wanted here
1510     }
1511     else if ("feature-ontology".equalsIgnoreCase(pragma))
1512     {
1513       // should resolve against the specified feature ontology URI
1514     }
1515     else if ("attribute-ontology".equalsIgnoreCase(pragma))
1516     {
1517       // URI of attribute ontology - not currently used in GFF3
1518     }
1519     else if ("source-ontology".equalsIgnoreCase(pragma))
1520     {
1521       // URI of source ontology - not currently used in GFF3
1522     }
1523     else if ("species-build".equalsIgnoreCase(pragma))
1524     {
1525       // save URI of specific NCBI taxon version of annotations
1526       gffProps.put("species-build", value);
1527     }
1528     else if ("fasta".equalsIgnoreCase(pragma))
1529     {
1530       // process the rest of the file as a fasta file and replace any dummy
1531       // sequence IDs
1532       processAsFasta(align, newseqs);
1533     }
1534     else
1535     {
1536       System.err.println("Ignoring unknown pragma: " + line);
1537     }
1538   }
1539 }