2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
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
10 * of the License, or (at your option) any later version.
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.
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.
23 import java.util.Arrays;
24 import java.util.Collection;
25 import java.util.Comparator;
26 import java.util.LinkedHashMap;
27 import java.util.List;
30 import jalview.api.FeatureColourI;
31 import jalview.datamodel.DBRefEntry;
32 import jalview.datamodel.DBRefSource;
33 import jalview.datamodel.GeneLociI;
34 import jalview.datamodel.MappedFeatures;
35 import jalview.datamodel.SequenceFeature;
36 import jalview.datamodel.SequenceI;
37 import jalview.util.MessageManager;
38 import jalview.util.StringUtils;
39 import jalview.util.UrlLink;
40 import jalview.viewmodel.seqfeatures.FeatureRendererModel;
43 * generate HTML reports for a sequence
47 public class SequenceAnnotationReport
49 private static final int MAX_DESCRIPTION_LENGTH = 40;
51 private static final String COMMA = ",";
53 private static final String ELLIPSIS = "...";
55 private static final int MAX_REFS_PER_SOURCE = 4;
57 private static final int MAX_SOURCES = 40;
59 private static String linkImageURL;
61 private static final String[][] PRIMARY_SOURCES = new String[][] {
62 DBRefSource.CODINGDBS, DBRefSource.DNACODINGDBS,
63 DBRefSource.PROTEINDBS };
66 * Comparator to order DBRefEntry by Source + accession id (case-insensitive),
67 * with 'Primary' sources placed before others, and 'chromosome' first of all
69 private static Comparator<DBRefEntry> comparator = new Comparator<DBRefEntry>()
73 public int compare(DBRefEntry ref1, DBRefEntry ref2)
75 if (ref1 instanceof GeneLociI)
79 if (ref2 instanceof GeneLociI)
83 String s1 = ref1.getSource();
84 String s2 = ref2.getSource();
85 boolean s1Primary = isPrimarySource(s1);
86 boolean s2Primary = isPrimarySource(s2);
87 if (s1Primary && !s2Primary)
91 if (!s1Primary && s2Primary)
95 int comp = s1 == null ? -1 : (s2 == null ? 1 : s1
96 .compareToIgnoreCase(s2));
99 String a1 = ref1.getAccessionId();
100 String a2 = ref2.getAccessionId();
101 comp = a1 == null ? -1 : (a2 == null ? 1 : a1
102 .compareToIgnoreCase(a2));
107 private boolean isPrimarySource(String source)
109 for (String[] primary : PRIMARY_SOURCES)
111 for (String s : primary)
113 if (source.equals(s))
123 private boolean forTooltip;
126 * Constructor given a flag which affects behaviour
128 * <li>if true, generates feature details suitable to show in a tooltip</li>
129 * <li>if false, generates feature details in a form suitable for the sequence
130 * details report</li>
133 * @param isForTooltip
135 public SequenceAnnotationReport(boolean isForTooltip)
137 this.forTooltip = isForTooltip;
138 if (linkImageURL == null)
140 linkImageURL = getClass().getResource("/images/link.gif").toString();
145 * Append text for the list of features to the tooltip. Returns the number of
146 * features not added if maxlength limit is (or would have been) reached.
154 public int appendFeatures(final StringBuilder sb,
155 int residuePos, List<SequenceFeature> features,
156 FeatureRendererModel fr, int maxlength)
158 for (int i = 0; i < features.size(); i++)
160 SequenceFeature feature = features.get(i);
161 if (appendFeature(sb, residuePos, fr, feature, null, maxlength))
163 return features.size() - i;
170 * Appends text for mapped features (e.g. CDS feature for peptide or vice
171 * versa) Returns number of features left if maxlength limit is (or would have
180 public int appendFeatures(StringBuilder sb, int residuePos,
181 MappedFeatures mf, FeatureRendererModel fr, int maxlength)
183 for (int i = 0; i < mf.features.size(); i++)
185 SequenceFeature feature = mf.features.get(i);
186 if (appendFeature(sb, residuePos, fr, feature, mf, maxlength))
188 return mf.features.size() - i;
195 * Appends the feature at rpos to the given buffer
202 boolean appendFeature(final StringBuilder sb0, int rpos,
203 FeatureRendererModel fr, SequenceFeature feature,
204 MappedFeatures mf, int maxlength)
206 int begin = feature.getBegin();
207 int end = feature.getEnd();
210 * if this is a virtual features, convert begin/end to the
211 * coordinates of the sequence it is mapped to
213 int[] beginRange = null;
214 int[] endRange = null;
217 beginRange = mf.getMappedPositions(begin, begin);
218 endRange = mf.getMappedPositions(end, end);
219 if (beginRange == null || endRange == null)
221 // something went wrong
224 begin = beginRange[0];
225 end = endRange[endRange.length - 1];
228 StringBuilder sb = new StringBuilder();
229 if (feature.isContactFeature())
232 * include if rpos is at start or end position of [mapped] feature
234 boolean showContact = (mf == null) && (rpos == begin || rpos == end);
235 boolean showMappedContact = (mf != null) && ((rpos >= beginRange[0]
236 && rpos <= beginRange[beginRange.length - 1])
237 || (rpos >= endRange[0]
238 && rpos <= endRange[endRange.length - 1]));
239 if (showContact || showMappedContact)
241 if (sb0.length() > 6)
245 sb.append(feature.getType()).append(" ").append(begin).append(":")
248 return appendText(sb0, sb, maxlength);
251 if (sb0.length() > 6)
255 // TODO: remove this hack to display link only features
256 boolean linkOnly = feature.getValue("linkonly") != null;
259 sb.append(feature.getType()).append(" ");
262 // we are marking a positional feature
266 sb.append(" ").append(end);
270 String description = feature.getDescription();
271 if (description != null && !description.equals(feature.getType()))
273 description = StringUtils.stripHtmlTags(description);
276 * truncate overlong descriptions unless they contain an href
277 * before the truncation point (as truncation could leave corrupted html)
279 int linkindex = description.toLowerCase().indexOf("<a ");
280 boolean hasLink = linkindex > -1
281 && linkindex < MAX_DESCRIPTION_LENGTH;
282 if (description.length() > MAX_DESCRIPTION_LENGTH && !hasLink)
284 description = description.substring(0, MAX_DESCRIPTION_LENGTH)
288 sb.append("; ").append(description);
291 if (showScore(feature, fr))
293 sb.append(" Score=").append(String.valueOf(feature.getScore()));
295 String status = (String) feature.getValue("status");
296 if (status != null && status.length() > 0)
298 sb.append("; (").append(status).append(")");
302 * add attribute value if coloured by attribute
306 FeatureColourI fc = fr.getFeatureColours().get(feature.getType());
307 if (fc != null && fc.isColourByAttribute())
309 String[] attName = fc.getAttributeName();
310 String attVal = feature.getValueAsString(attName);
313 sb.append("; ").append(String.join(":", attName)).append("=")
321 String variants = mf.findProteinVariants(feature);
322 if (!variants.isEmpty())
324 sb.append(" ").append(variants);
328 return appendText(sb0, sb, maxlength);
332 * Appends sb to sb0, and returns false, unless maxlength is not zero and
333 * appending would make the result longer than or equal to maxlength, in which
334 * case the append is not done and returns true
341 private static boolean appendText(StringBuilder sb0, StringBuilder sb,
344 if (maxlength == 0 || sb0.length() + sb.length() < maxlength)
353 * Answers true if score should be shown, else false. Score is shown if it is
354 * not NaN, and the feature type has a non-trivial min-max score range
356 boolean showScore(SequenceFeature feature, FeatureRendererModel fr)
358 if (Float.isNaN(feature.getScore()))
366 float[][] minMax = fr.getMinMax().get(feature.getType());
369 * minMax[0] is the [min, max] score range for positional features
371 if (minMax == null || minMax[0] == null || minMax[0][0] == minMax[0][1])
379 * Format and appends any hyperlinks for the sequence feature to the string
385 void appendLinks(final StringBuffer sb, SequenceFeature feature)
387 if (feature.links != null)
389 if (linkImageURL != null)
391 sb.append(" <img src=\"" + linkImageURL + "\">");
395 for (String urlstring : feature.links)
399 for (List<String> urllink : createLinksFrom(null, urlstring))
401 sb.append("<br/> <a href=\""
406 + (urllink.get(0).toLowerCase()
407 .equals(urllink.get(1).toLowerCase()) ? urllink
408 .get(0) : (urllink.get(0) + ":" + urllink
412 } catch (Exception x)
414 System.err.println("problem when creating links from "
428 * @return Collection< List<String> > { List<String> { link target, link
429 * label, dynamic component inserted (if any), url }}
431 Collection<List<String>> createLinksFrom(SequenceI seq, String link)
433 Map<String, List<String>> urlSets = new LinkedHashMap<>();
434 UrlLink urlLink = new UrlLink(link);
435 if (!urlLink.isValid())
437 System.err.println(urlLink.getInvalidMessage());
441 urlLink.createLinksFromSeq(seq, urlSets);
443 return urlSets.values();
446 public void createSequenceAnnotationReport(final StringBuilder tip,
447 SequenceI sequence, boolean showDbRefs, boolean showNpFeats,
448 FeatureRendererModel fr)
450 createSequenceAnnotationReport(tip, sequence, showDbRefs, showNpFeats,
455 * Builds an html formatted report of sequence details and appends it to the
459 * buffer to append report to
461 * the sequence the report is for
463 * whether to include database references for the sequence
465 * whether to include non-positional sequence features
470 int createSequenceAnnotationReport(final StringBuilder sb,
471 SequenceI sequence, boolean showDbRefs, boolean showNpFeats,
472 FeatureRendererModel fr, boolean summary)
478 if (sequence.getDescription() != null)
480 tmp = sequence.getDescription();
482 maxWidth = Math.max(maxWidth, tmp.length());
484 SequenceI ds = sequence;
485 while (ds.getDatasetSequence() != null)
487 ds = ds.getDatasetSequence();
492 maxWidth = Math.max(maxWidth, appendDbRefs(sb, ds, summary));
496 * add non-positional features if wanted
500 for (SequenceFeature sf : sequence.getFeatures()
501 .getNonPositionalFeatures())
503 int sz = -sb.length();
504 appendFeature(sb, 0, fr, sf, null, 0);
506 maxWidth = Math.max(maxWidth, sz);
514 * A helper method that appends any DBRefs, returning the maximum line length
522 protected int appendDbRefs(final StringBuilder sb, SequenceI ds,
525 DBRefEntry[] dbrefs = ds.getDBRefs();
531 // note this sorts the refs held on the sequence!
532 Arrays.sort(dbrefs, comparator);
533 boolean ellipsis = false;
534 String source = null;
535 String lastSource = null;
536 int countForSource = 0;
538 boolean moreSources = false;
539 int maxLineLength = 0;
542 for (DBRefEntry ref : dbrefs)
544 source = ref.getSource();
550 boolean sourceChanged = !source.equals(lastSource);
557 if (sourceCount > MAX_SOURCES && summary)
565 if (countForSource == 1 || !summary)
569 if (countForSource <= MAX_REFS_PER_SOURCE || !summary)
571 String accessionId = ref.getAccessionId();
572 lineLength += accessionId.length() + 1;
573 if (countForSource > 1 && summary)
575 sb.append(", ").append(accessionId);
580 sb.append(source).append(" ").append(accessionId);
581 lineLength += source.length();
583 maxLineLength = Math.max(maxLineLength, lineLength);
585 if (countForSource == MAX_REFS_PER_SOURCE && summary)
587 sb.append(COMMA).append(ELLIPSIS);
593 sb.append("<br/>").append(source).append(COMMA).append(ELLIPSIS);
598 sb.append(MessageManager.getString("label.output_seq_details"));
602 return maxLineLength;
605 public void createTooltipAnnotationReport(final StringBuilder tip,
606 SequenceI sequence, boolean showDbRefs, boolean showNpFeats,
607 FeatureRendererModel fr)
609 int maxWidth = createSequenceAnnotationReport(tip, sequence,
610 showDbRefs, showNpFeats, fr, true);
614 // ? not sure this serves any useful purpose
615 // tip.insert(0, "<table width=350 border=0><tr><td>");
616 // tip.append("</td></tr></table>");