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