2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
3 * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
5 * This file is part of Jalview.
7 * Jalview is free software: you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
11 * Jalview is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty
13 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
14 * PURPOSE. See the GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along with Jalview. If not, see <http://www.gnu.org/licenses/>.
23 import jalview.analysis.SequenceIdMatcher;
24 import jalview.datamodel.*;
25 import jalview.schemes.*;
26 import jalview.util.Format;
29 * Parse and create Jalview Features files Detects GFF format features files and
30 * parses. Does not implement standard print() - call specific printFeatures or
31 * printGFF. Uses AlignmentI.findSequence(String id) to find the sequence object
32 * for the features annotation - this normally works on an exact match.
37 public class FeaturesFile extends AlignFile
40 * work around for GFF interpretation bug where source string becomes
41 * description rather than a group
43 private boolean doGffSource = true;
46 * Creates a new FeaturesFile object.
53 * Creates a new FeaturesFile object.
63 public FeaturesFile(String inFile, String type) throws IOException
68 public FeaturesFile(FileParse source) throws IOException
74 * Parse GFF or sequence features file using case-independent matching,
78 * - alignment/dataset containing sequences that are to be annotated
80 * - hashtable to store feature colour definitions
82 * - process html strings into plain text
83 * @return true if features were added
85 public boolean parse(AlignmentI align, Hashtable colours,
88 return parse(align, colours, null, removeHTML, false);
92 * Parse GFF or sequence features file optionally using case-independent
93 * matching, discarding URLs
96 * - alignment/dataset containing sequences that are to be annotated
98 * - hashtable to store feature colour definitions
100 * - process html strings into plain text
101 * @param relaxedIdmatching
102 * - when true, ID matches to compound sequence IDs are allowed
103 * @return true if features were added
105 public boolean parse(AlignmentI align, Map colours, boolean removeHTML,
106 boolean relaxedIdMatching)
108 return parse(align, colours, null, removeHTML, relaxedIdMatching);
112 * Parse GFF or sequence features file optionally using case-independent
116 * - alignment/dataset containing sequences that are to be annotated
118 * - hashtable to store feature colour definitions
120 * - hashtable to store associated URLs
122 * - process html strings into plain text
123 * @return true if features were added
125 public boolean parse(AlignmentI align, Map colours, Map featureLink,
128 return parse(align, colours, featureLink, removeHTML, false);
132 * /** Parse GFF or sequence features file
135 * - alignment/dataset containing sequences that are to be annotated
137 * - hashtable to store feature colour definitions
139 * - hashtable to store associated URLs
141 * - process html strings into plain text
142 * @param relaxedIdmatching
143 * - when true, ID matches to compound sequence IDs are allowed
144 * @return true if features were added
146 public boolean parse(AlignmentI align, Map colours, Map featureLink,
147 boolean removeHTML, boolean relaxedIdmatching)
153 SequenceI seq = null;
154 String type, desc, token = null;
156 int index, start, end;
160 String featureGroup = null, groupLink = null;
161 Map typeLink = new Hashtable();
163 * when true, assume GFF style features rather than Jalview style.
165 boolean GFFFile = true;
166 while ((line = nextLine()) != null)
168 if (line.startsWith("#"))
173 st = new StringTokenizer(line, "\t");
174 if (st.countTokens() == 1)
176 if (line.trim().equalsIgnoreCase("GFF"))
178 // Start parsing file as if it might be GFF again.
183 if (st.countTokens() > 1 && st.countTokens() < 4)
186 type = st.nextToken();
187 if (type.equalsIgnoreCase("startgroup"))
189 featureGroup = st.nextToken();
190 if (st.hasMoreElements())
192 groupLink = st.nextToken();
193 featureLink.put(featureGroup, groupLink);
196 else if (type.equalsIgnoreCase("endgroup"))
198 // We should check whether this is the current group,
199 // but at present theres no way of showing more than 1 group
206 Object colour = null;
207 String colscheme = st.nextToken();
208 if (colscheme.indexOf("|") > -1
209 || colscheme.trim().equalsIgnoreCase("label"))
211 // Parse '|' separated graduated colourscheme fields:
212 // [label|][mincolour|maxcolour|[absolute|]minvalue|maxvalue|thresholdtype|thresholdvalue]
213 // can either provide 'label' only, first is optional, next two
214 // colors are required (but may be
215 // left blank), next is optional, nxt two min/max are required.
216 // first is either 'label'
217 // first/second and third are both hexadecimal or word equivalent
219 // next two are values parsed as floats.
220 // fifth is either 'above','below', or 'none'.
221 // sixth is a float value and only required when fifth is either
222 // 'above' or 'below'.
223 StringTokenizer gcol = new StringTokenizer(colscheme, "|",
226 int threshtype = AnnotationColourGradient.NO_THRESHOLD;
227 float min = Float.MIN_VALUE, max = Float.MAX_VALUE, threshval = Float.NaN;
228 boolean labelCol = false;
230 String mincol = gcol.nextToken();
234 .println("Expected either 'label' or a colour specification in the line: "
238 String maxcol = null;
239 if (mincol.toLowerCase().indexOf("label") == 0)
242 mincol = (gcol.hasMoreTokens() ? gcol.nextToken() : null); // skip
244 mincol = (gcol.hasMoreTokens() ? gcol.nextToken() : null);
246 String abso = null, minval, maxval;
249 // at least four more tokens
250 if (mincol.equals("|"))
256 gcol.nextToken(); // skip next '|'
258 // continue parsing rest of line
259 maxcol = gcol.nextToken();
260 if (maxcol.equals("|"))
266 gcol.nextToken(); // skip next '|'
268 abso = gcol.nextToken();
269 gcol.nextToken(); // skip next '|'
270 if (abso.toLowerCase().indexOf("abso") != 0)
277 minval = gcol.nextToken();
278 gcol.nextToken(); // skip next '|'
280 maxval = gcol.nextToken();
281 if (gcol.hasMoreTokens())
283 gcol.nextToken(); // skip next '|'
287 if (minval.length() > 0)
289 min = new Float(minval).floatValue();
291 } catch (Exception e)
294 .println("Couldn't parse the minimum value for graduated colour for type ("
296 + ") - did you misspell 'auto' for the optional automatic colour switch ?");
301 if (maxval.length() > 0)
303 max = new Float(maxval).floatValue();
305 } catch (Exception e)
308 .println("Couldn't parse the maximum value for graduated colour for type ("
315 // add in some dummy min/max colours for the label-only
322 colour = new jalview.schemes.GraduatedColor(
323 new UserColourScheme(mincol).findColour('A'),
324 new UserColourScheme(maxcol).findColour('A'), min,
326 } catch (Exception e)
329 .println("Couldn't parse the graduated colour scheme ("
335 ((jalview.schemes.GraduatedColor) colour)
336 .setColourByLabel(labelCol);
337 ((jalview.schemes.GraduatedColor) colour)
338 .setAutoScaled(abso == null);
339 // add in any additional parameters
340 String ttype = null, tval = null;
341 if (gcol.hasMoreTokens())
343 // threshold type and possibly a threshold value
344 ttype = gcol.nextToken();
345 if (ttype.toLowerCase().startsWith("below"))
347 ((jalview.schemes.GraduatedColor) colour)
348 .setThreshType(AnnotationColourGradient.BELOW_THRESHOLD);
350 else if (ttype.toLowerCase().startsWith("above"))
352 ((jalview.schemes.GraduatedColor) colour)
353 .setThreshType(AnnotationColourGradient.ABOVE_THRESHOLD);
357 ((jalview.schemes.GraduatedColor) colour)
358 .setThreshType(AnnotationColourGradient.NO_THRESHOLD);
359 if (!ttype.toLowerCase().startsWith("no"))
362 .println("Ignoring unrecognised threshold type : "
367 if (((GraduatedColor) colour).getThreshType() != AnnotationColourGradient.NO_THRESHOLD)
372 tval = gcol.nextToken();
373 ((jalview.schemes.GraduatedColor) colour)
374 .setThresh(new Float(tval).floatValue());
375 } catch (Exception e)
378 .println("Couldn't parse threshold value as a float: ("
383 // parse the thresh-is-min token ?
384 if (gcol.hasMoreTokens())
387 .println("Ignoring additional tokens in parameters in graduated colour specification\n");
388 while (gcol.hasMoreTokens())
390 System.err.println("|" + gcol.nextToken());
392 System.err.println("\n");
398 UserColourScheme ucs = new UserColourScheme(colscheme);
399 colour = ucs.findColour('A');
403 colours.put(type, colour);
405 if (st.hasMoreElements())
407 String link = st.nextToken();
408 typeLink.put(type, link);
409 if (featureLink == null)
411 featureLink = new Hashtable();
413 featureLink.put(type, link);
419 while (st.hasMoreElements())
424 // Still possible this is an old Jalview file,
425 // which does not have type colours at the beginning
426 seqId = token = st.nextToken();
427 seq = findName(align, seqId, relaxedIdmatching);
430 desc = st.nextToken();
432 if (doGffSource && desc.indexOf(' ') == -1)
434 // could also be a source term rather than description line
435 group = new String(desc);
437 type = st.nextToken();
440 String stt = st.nextToken();
441 if (stt.length() == 0 || stt.equals("-"))
447 start = Integer.parseInt(stt);
449 } catch (NumberFormatException ex)
455 String stt = st.nextToken();
456 if (stt.length() == 0 || stt.equals("-"))
462 end = Integer.parseInt(stt);
464 } catch (NumberFormatException ex)
468 // TODO: decide if non positional feature assertion for input data
469 // where end==0 is generally valid
472 // treat as non-positional feature, regardless.
477 score = new Float(st.nextToken()).floatValue();
478 } catch (NumberFormatException ex)
483 sf = new SequenceFeature(type, desc, start, end, score, group);
487 sf.setValue("STRAND", st.nextToken());
488 sf.setValue("FRAME", st.nextToken());
489 } catch (Exception ex)
493 if (st.hasMoreTokens())
495 StringBuffer attributes = new StringBuffer();
496 while (st.hasMoreTokens())
498 attributes.append("\t" + st.nextElement());
500 // TODO validate and split GFF2 attributes field ? parse out
501 // ([A-Za-z][A-Za-z0-9_]*) <value> ; and add as
502 // sf.setValue(attrib, val);
503 sf.setValue("ATTRIBUTES", attributes.toString());
506 seq.addSequenceFeature(sf);
507 while ((seq = align.findName(seq, seqId, true)) != null)
509 seq.addSequenceFeature(new SequenceFeature(sf));
515 if (GFFFile && seq == null)
521 desc = st.nextToken();
523 if (!st.hasMoreTokens())
526 .println("DEBUG: Run out of tokens when trying to identify the destination for the feature.. giving up.");
527 // in all probability, this isn't a file we understand, so bail
532 token = st.nextToken();
534 if (!token.equals("ID_NOT_SPECIFIED"))
536 seq = findName(align, seqId = token, relaxedIdmatching);
544 index = Integer.parseInt(st.nextToken());
545 seq = align.getSequenceAt(index);
546 } catch (NumberFormatException ex)
554 System.out.println("Sequence not found: " + line);
558 start = Integer.parseInt(st.nextToken());
559 end = Integer.parseInt(st.nextToken());
561 type = st.nextToken();
563 if (!colours.containsKey(type))
565 // Probably the old style groups file
566 UserColourScheme ucs = new UserColourScheme(type);
567 colours.put(type, ucs.findColour('A'));
569 sf = new SequenceFeature(type, desc, "", start, end, featureGroup);
570 if (st.hasMoreTokens())
574 score = new Float(st.nextToken()).floatValue();
575 // update colourgradient bounds if allowed to
576 } catch (NumberFormatException ex)
582 if (groupLink != null && removeHTML)
584 sf.addLink(groupLink);
585 sf.description += "%LINK%";
587 if (typeLink.containsKey(type) && removeHTML)
589 sf.addLink(typeLink.get(type).toString());
590 sf.description += "%LINK%";
593 parseDescriptionHTML(sf, removeHTML);
595 seq.addSequenceFeature(sf);
598 && (seq = align.findName(seq, seqId, false)) != null)
600 seq.addSequenceFeature(new SequenceFeature(sf));
602 // If we got here, its not a GFFFile
607 } catch (Exception ex)
609 System.out.println(line);
610 System.out.println("Error parsing feature file: " + ex + "\n" + line);
611 ex.printStackTrace(System.err);
619 private AlignmentI lastmatchedAl = null;
621 private SequenceIdMatcher matcher = null;
624 * clear any temporary handles used to speed up ID matching
626 private void resetMatcher()
628 lastmatchedAl = null;
632 private SequenceI findName(AlignmentI align, String seqId,
633 boolean relaxedIdMatching)
635 SequenceI match = null;
636 if (relaxedIdMatching)
638 if (lastmatchedAl != align)
640 matcher = new SequenceIdMatcher(
641 (lastmatchedAl = align).getSequencesArray());
643 match = matcher.findIdMatch(seqId);
647 match = align.findName(seqId, true);
652 public void parseDescriptionHTML(SequenceFeature sf, boolean removeHTML)
654 if (sf.getDescription() == null)
658 jalview.util.ParseHtmlBodyAndLinks parsed = new jalview.util.ParseHtmlBodyAndLinks(
659 sf.getDescription(), removeHTML, newline);
661 sf.description = (removeHTML) ? parsed.getNonHtmlContent()
663 for (String link : parsed.getLinks())
671 * generate a features file for seqs includes non-pos features by default.
674 * source of sequence features
676 * hash of feature types and colours
677 * @return features file contents
679 public String printJalviewFormat(SequenceI[] seqs, Hashtable visible)
681 return printJalviewFormat(seqs, visible, true, true);
685 * generate a features file for seqs with colours from visible (if any)
690 * hash of Colours for each feature type
692 * when true only feature types in 'visible' will be output
694 * indicates if non-positional features should be output (regardless
696 * @return features file contents
698 public String printJalviewFormat(SequenceI[] seqs, Hashtable visible,
699 boolean visOnly, boolean nonpos)
701 StringBuffer out = new StringBuffer();
702 SequenceFeature[] next;
703 boolean featuresGen = false;
704 if (visOnly && !nonpos && (visible == null || visible.size() < 1))
706 // no point continuing.
707 return "No Features Visible";
710 if (visible != null && visOnly)
712 // write feature colours only if we're given them and we are generating
714 // TODO: decide if feature links should also be written here ?
715 Enumeration en = visible.keys();
717 while (en.hasMoreElements())
719 type = en.nextElement().toString();
721 if (visible.get(type) instanceof GraduatedColor)
723 GraduatedColor gc = (GraduatedColor) visible.get(type);
724 color = (gc.isColourByLabel() ? "label|" : "")
725 + Format.getHexString(gc.getMinColor()) + "|"
726 + Format.getHexString(gc.getMaxColor())
727 + (gc.isAutoScale() ? "|" : "|abso|") + gc.getMin() + "|"
729 if (gc.getThreshType() != AnnotationColourGradient.NO_THRESHOLD)
731 if (gc.getThreshType() == AnnotationColourGradient.BELOW_THRESHOLD)
737 if (gc.getThreshType() != AnnotationColourGradient.ABOVE_THRESHOLD)
739 System.err.println("WARNING: Unsupported threshold type ("
740 + gc.getThreshType() + ") : Assuming 'above'");
745 color += "|" + gc.getThresh();
752 else if (visible.get(type) instanceof java.awt.Color)
754 color = Format.getHexString((java.awt.Color) visible.get(type));
758 // legacy support for integer objects containing colour triplet values
759 color = Format.getHexString(new java.awt.Color(Integer
760 .parseInt(visible.get(type).toString())));
768 // Work out which groups are both present and visible
769 Vector groups = new Vector();
771 boolean isnonpos = false;
773 for (int i = 0; i < seqs.length; i++)
775 next = seqs[i].getSequenceFeatures();
778 for (int j = 0; j < next.length; j++)
780 isnonpos = next[j].begin == 0 && next[j].end == 0;
781 if ((!nonpos && isnonpos)
782 || (!isnonpos && visOnly && !visible
783 .containsKey(next[j].type)))
788 if (next[j].featureGroup != null
789 && !groups.contains(next[j].featureGroup))
791 groups.addElement(next[j].featureGroup);
801 if (groups.size() > 0 && groupIndex < groups.size())
803 group = groups.elementAt(groupIndex).toString();
805 out.append("STARTGROUP\t");
814 for (int i = 0; i < seqs.length; i++)
816 next = seqs[i].getSequenceFeatures();
819 for (int j = 0; j < next.length; j++)
821 isnonpos = next[j].begin == 0 && next[j].end == 0;
822 if ((!nonpos && isnonpos)
823 || (!isnonpos && visOnly && !visible
824 .containsKey(next[j].type)))
826 // skip if feature is nonpos and we ignore them or if we only
827 // output visible and it isn't non-pos and it's not visible
832 && (next[j].featureGroup == null || !next[j].featureGroup
838 if (group == null && next[j].featureGroup != null)
842 // we have features to output
844 if (next[j].description == null
845 || next[j].description.equals(""))
847 out.append(next[j].type + "\t");
851 if (next[j].links != null
852 && next[j].getDescription().indexOf("<html>") == -1)
854 out.append("<html>");
857 out.append(next[j].description + " ");
858 if (next[j].links != null)
860 for (int l = 0; l < next[j].links.size(); l++)
862 String label = next[j].links.elementAt(l).toString();
863 String href = label.substring(label.indexOf("|") + 1);
864 label = label.substring(0, label.indexOf("|"));
866 if (next[j].description.indexOf(href) == -1)
868 out.append("<a href=\"" + href + "\">" + label + "</a>");
872 if (next[j].getDescription().indexOf("</html>") == -1)
874 out.append("</html>");
880 out.append(seqs[i].getName());
881 out.append("\t-1\t");
882 out.append(next[j].begin);
884 out.append(next[j].end);
886 out.append(next[j].type);
887 if (next[j].score != Float.NaN)
890 out.append(next[j].score);
899 out.append("ENDGROUP\t");
909 } while (groupIndex < groups.size() + 1);
913 return "No Features Visible";
916 return out.toString();
920 * generate a gff file for sequence features includes non-pos features by
927 public String printGFFFormat(SequenceI[] seqs, Hashtable visible)
929 return printGFFFormat(seqs, visible, true, true);
932 public String printGFFFormat(SequenceI[] seqs, Hashtable visible,
933 boolean visOnly, boolean nonpos)
935 StringBuffer out = new StringBuffer();
936 SequenceFeature[] next;
939 for (int i = 0; i < seqs.length; i++)
941 if (seqs[i].getSequenceFeatures() != null)
943 next = seqs[i].getSequenceFeatures();
944 for (int j = 0; j < next.length; j++)
946 isnonpos = next[j].begin == 0 && next[j].end == 0;
947 if ((!nonpos && isnonpos)
948 || (!isnonpos && visOnly && !visible
949 .containsKey(next[j].type)))
954 source = next[j].featureGroup;
957 source = next[j].getDescription();
960 out.append(seqs[i].getName());
964 out.append(next[j].type);
966 out.append(next[j].begin);
968 out.append(next[j].end);
970 out.append(next[j].score);
973 if (next[j].getValue("STRAND") != null)
975 out.append(next[j].getValue("STRAND"));
983 if (next[j].getValue("FRAME") != null)
985 out.append(next[j].getValue("FRAME"));
991 // TODO: verify/check GFF - should there be a /t here before attribute
994 if (next[j].getValue("ATTRIBUTES") != null)
996 out.append(next[j].getValue("ATTRIBUTES"));
1005 return out.toString();
1009 * this is only for the benefit of object polymorphism - method does nothing.
1017 * this is only for the benefit of object polymorphism - method does nothing.
1019 * @return error message
1021 public String print()
1023 return "USE printGFFFormat() or printJalviewFormat()";