src/jalview/io/SequenceAnnotationReport.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.Collection;
  24 import java.util.Comparator;
  25 import java.util.LinkedHashMap;
  26 import java.util.List;
  27 import java.util.Map;
  28
  29 import jalview.api.FeatureColourI;
  30 import jalview.datamodel.AlignmentAnnotation;
  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;
  41
  42 /**
  43  * generate HTML reports for a sequence
  44  *
  45  * @author jimp
  46  */
  47 public class SequenceAnnotationReport
  48 {
  49   private static final int MAX_DESCRIPTION_LENGTH = 40;
  50
  51   private static final String COMMA = ",";
  52
  53   private static final String ELLIPSIS = "...";
  54
  55   private static final int MAX_REFS_PER_SOURCE = 4;
  56
  57   private static final int MAX_SOURCES = 40;
  58
  59   private static String linkImageURL;
  60
  61  // public static final String[][] PRIMARY_SOURCES  moved to DBRefSource.java
  62
  63   /*
  64    * Comparator to order DBRefEntry by Source + accession id (case-insensitive),
  65    * with 'Primary' sources placed before others, and 'chromosome' first of all
  66    */
  67   private static Comparator<DBRefEntry> comparator = new Comparator<DBRefEntry>()
  68   {
  69
  70     @Override
  71     public int compare(DBRefEntry ref1, DBRefEntry ref2)
  72     {
  73       if (ref1 instanceof GeneLociI)
  74       {
  75         return -1;
  76       }
  77       if (ref2 instanceof GeneLociI)
  78       {
  79         return 1;
  80       }
  81       String s1 = ref1.getSource();
  82       String s2 = ref2.getSource();
  83       boolean s1Primary = DBRefSource.isPrimarySource(s1);
  84       boolean s2Primary = DBRefSource.isPrimarySource(s2);
  85       if (s1Primary && !s2Primary)
  86       {
  87         return -1;
  88       }
  89       if (!s1Primary && s2Primary)
  90       {
  91         return 1;
  92       }
  93       int comp = s1 == null ? -1 : (s2 == null ? 1 : s1
  94               .compareToIgnoreCase(s2));
  95       if (comp == 0)
  96       {
  97         String a1 = ref1.getAccessionId();
  98         String a2 = ref2.getAccessionId();
  99         comp = a1 == null ? -1 : (a2 == null ? 1 : a1
 100                 .compareToIgnoreCase(a2));
 101       }
 102       return comp;
 103     }
 104
 105 //    private boolean isPrimarySource(String source)
 106 //    {
 107 //      for (String[] primary : DBRefSource.PRIMARY_SOURCES)
 108 //      {
 109 //        for (String s : primary)
 110 //        {
 111 //          if (source.equals(s))
 112 //          {
 113 //            return true;
 114 //          }
 115 //        }
 116 //      }
 117 //      return false;
 118 //    }
 119   };
 120
 121   private boolean forTooltip;
 122
 123   /**
 124    * Constructor given a flag which affects behaviour
 125    * <ul>
 126    * <li>if true, generates feature details suitable to show in a tooltip</li>
 127    * <li>if false, generates feature details in a form suitable for the sequence
 128    * details report</li>
 129    * </ul>
 130    *
 131    * @param isForTooltip
 132    */
 133   public SequenceAnnotationReport(boolean isForTooltip)
 134   {
 135     this.forTooltip = isForTooltip;
 136     if (linkImageURL == null)
 137     {
 138       linkImageURL = getClass().getResource("/images/link.gif").toString();
 139     }
 140   }
 141
 142   /**
 143    * Append text for the list of features to the tooltip. Returns the number of
 144    * features not added if maxlength limit is (or would have been) reached.
 145    *
 146    * @param sb
 147    * @param residuePos
 148    * @param features
 149    * @param minmax
 150    * @param maxlength
 151    */
 152   public int appendFeatures(final StringBuilder sb,
 153           int residuePos, List<SequenceFeature> features,
 154           FeatureRendererModel fr, int maxlength)
 155   {
 156     for (int i = 0; i < features.size(); i++)
 157     {
 158       SequenceFeature feature = features.get(i);
 159       if (appendFeature(sb, residuePos, fr, feature, null, maxlength))
 160       {
 161         return features.size() - i;
 162       }
 163     }
 164     return 0;
 165   }
 166
 167   /**
 168    * Appends text for mapped features (e.g. CDS feature for peptide or vice
 169    * versa) Returns number of features left if maxlength limit is (or would have
 170    * been) reached.
 171    *
 172    * @param sb
 173    * @param residuePos
 174    * @param mf
 175    * @param fr
 176    * @param maxlength
 177    */
 178   public int appendFeatures(StringBuilder sb, int residuePos,
 179           MappedFeatures mf, FeatureRendererModel fr, int maxlength)
 180   {
 181     for (int i = 0; i < mf.features.size(); i++)
 182     {
 183       SequenceFeature feature = mf.features.get(i);
 184       if (appendFeature(sb, residuePos, fr, feature, mf, maxlength))
 185       {
 186         return mf.features.size() - i;
 187       }
 188     }
 189     return 0;
 190   }
 191
 192   /**
 193    * Appends the feature at rpos to the given buffer
 194    *
 195    * @param sb
 196    * @param rpos
 197    * @param minmax
 198    * @param feature
 199    */
 200   boolean appendFeature(final StringBuilder sb0, int rpos,
 201           FeatureRendererModel fr, SequenceFeature feature,
 202           MappedFeatures mf, int maxlength)
 203   {
 204     int begin = feature.getBegin();
 205     int end = feature.getEnd();
 206
 207     /*
 208      * if this is a virtual features, convert begin/end to the
 209      * coordinates of the sequence it is mapped to
 210      */
 211     int[] beginRange = null;
 212     int[] endRange = null;
 213     if (mf != null)
 214     {
 215       beginRange = mf.getMappedPositions(begin, begin);
 216       endRange = mf.getMappedPositions(end, end);
 217       if (beginRange == null || endRange == null)
 218       {
 219         // something went wrong
 220         return false;
 221       }
 222       begin = beginRange[0];
 223       end = endRange[endRange.length - 1];
 224     }
 225
 226     StringBuilder sb = new StringBuilder();
 227     if (feature.isContactFeature())
 228     {
 229       /*
 230        * include if rpos is at start or end position of [mapped] feature
 231        */
 232       boolean showContact = (mf == null) && (rpos == begin || rpos == end);
 233       boolean showMappedContact = (mf != null) && ((rpos >= beginRange[0]
 234               && rpos <= beginRange[beginRange.length - 1])
 235               || (rpos >= endRange[0]
 236                       && rpos <= endRange[endRange.length - 1]));
 237       if (showContact || showMappedContact)
 238       {
 239         if (sb0.length() > 6)
 240         {
 241           sb.append("<br/>");
 242         }
 243         sb.append(feature.getType()).append(" ").append(begin).append(":")
 244                 .append(end);
 245       }
 246       return appendText(sb0, sb, maxlength);
 247     }
 248
 249     if (sb0.length() > 6)
 250     {
 251       sb.append("<br/>");
 252     }
 253     // TODO: remove this hack to display link only features
 254     boolean linkOnly = feature.getValue("linkonly") != null;
 255     if (!linkOnly)
 256     {
 257       sb.append(feature.getType()).append(" ");
 258       if (rpos != 0)
 259       {
 260         // we are marking a positional feature
 261         sb.append(begin);
 262         if (begin != end)
 263         {
 264           sb.append(" ").append(end);
 265         }
 266       }
 267
 268       String description = feature.getDescription();
 269       if (description != null && !description.equals(feature.getType()))
 270       {
 271         description = StringUtils.stripHtmlTags(description);
 272
 273         /*
 274          * truncate overlong descriptions unless they contain an href
 275          * before the truncation point (as truncation could leave corrupted html)
 276          */
 277         int linkindex = description.toLowerCase().indexOf("<a ");
 278         boolean hasLink = linkindex > -1
 279                 && linkindex < MAX_DESCRIPTION_LENGTH;
 280         if (description.length() > MAX_DESCRIPTION_LENGTH && !hasLink)
 281         {
 282           description = description.substring(0, MAX_DESCRIPTION_LENGTH)
 283                   + ELLIPSIS;
 284         }
 285
 286         sb.append("; ").append(description);
 287       }
 288
 289       if (showScore(feature, fr))
 290       {
 291         sb.append(" Score=").append(String.valueOf(feature.getScore()));
 292       }
 293       String status = (String) feature.getValue("status");
 294       if (status != null && status.length() > 0)
 295       {
 296         sb.append("; (").append(status).append(")");
 297       }
 298
 299       /*
 300        * add attribute value if coloured by attribute
 301        */
 302       if (fr != null)
 303       {
 304         FeatureColourI fc = fr.getFeatureColours().get(feature.getType());
 305         if (fc != null && fc.isColourByAttribute())
 306         {
 307           String[] attName = fc.getAttributeName();
 308           String attVal = feature.getValueAsString(attName);
 309           if (attVal != null)
 310           {
 311             sb.append("; ").append(String.join(":", attName)).append("=")
 312                     .append(attVal);
 313           }
 314         }
 315       }
 316
 317       if (mf != null)
 318       {
 319         String variants = mf.findProteinVariants(feature);
 320         if (!variants.isEmpty())
 321         {
 322           sb.append(" ").append(variants);
 323         }
 324       }
 325     }
 326     return appendText(sb0, sb, maxlength);
 327   }
 328
 329   /**
 330    * Appends sb to sb0, and returns false, unless maxlength is not zero and
 331    * appending would make the result longer than or equal to maxlength, in which
 332    * case the append is not done and returns true
 333    *
 334    * @param sb0
 335    * @param sb
 336    * @param maxlength
 337    * @return
 338    */
 339   private static boolean appendText(StringBuilder sb0, StringBuilder sb,
 340           int maxlength)
 341   {
 342     if (maxlength == 0 || sb0.length() + sb.length() < maxlength)
 343     {
 344       sb0.append(sb);
 345       return false;
 346     }
 347     return true;
 348   }
 349
 350   /**
 351    * Answers true if score should be shown, else false. Score is shown if it is
 352    * not NaN, and the feature type has a non-trivial min-max score range
 353    */
 354   boolean showScore(SequenceFeature feature, FeatureRendererModel fr)
 355   {
 356     if (Float.isNaN(feature.getScore()))
 357     {
 358       return false;
 359     }
 360     if (fr == null)
 361     {
 362       return true;
 363     }
 364     float[][] minMax = fr.getMinMax().get(feature.getType());
 365
 366     /*
 367      * minMax[0] is the [min, max] score range for positional features
 368      */
 369     if (minMax == null || minMax[0] == null || minMax[0][0] == minMax[0][1])
 370     {
 371       return false;
 372     }
 373     return true;
 374   }
 375
 376   /**
 377    * Format and appends any hyperlinks for the sequence feature to the string
 378    * buffer
 379    *
 380    * @param sb
 381    * @param feature
 382    */
 383   void appendLinks(final StringBuffer sb, SequenceFeature feature)
 384   {
 385     if (feature.links != null)
 386     {
 387       if (linkImageURL != null)
 388       {
 389         sb.append(" <img src=\"" + linkImageURL + "\">");
 390       }
 391       else
 392       {
 393         for (String urlstring : feature.links)
 394         {
 395           try
 396           {
 397             for (List<String> urllink : createLinksFrom(null, urlstring))
 398             {
 399               sb.append("<br/> <a href=\""
 400                       + urllink.get(3)
 401                       + "\" target=\""
 402                       + urllink.get(0)
 403                       + "\">"
 404                       + (urllink.get(0).toLowerCase()
 405                               .equals(urllink.get(1).toLowerCase()) ? urllink
 406                               .get(0) : (urllink.get(0) + ":" + urllink
 407                                               .get(1)))
 408                       + "</a><br/>");
 409             }
 410           } catch (Exception x)
 411           {
 412             System.err.println("problem when creating links from "
 413                     + urlstring);
 414             x.printStackTrace();
 415           }
 416         }
 417       }
 418
 419     }
 420   }
 421
 422   /**
 423    *
 424    * @param seq
 425    * @param link
 426    * @return Collection< List<String> > { List<String> { link target, link
 427    *         label, dynamic component inserted (if any), url }}
 428    */
 429   Collection<List<String>> createLinksFrom(SequenceI seq, String link)
 430   {
 431     Map<String, List<String>> urlSets = new LinkedHashMap<>();
 432     UrlLink urlLink = new UrlLink(link);
 433     if (!urlLink.isValid())
 434     {
 435       System.err.println(urlLink.getInvalidMessage());
 436       return null;
 437     }
 438
 439     urlLink.createLinksFromSeq(seq, urlSets);
 440
 441     return urlSets.values();
 442   }
 443
 444   public void createSequenceAnnotationReport(final StringBuilder tip,
 445           SequenceI sequence, boolean showDbRefs, boolean showNpFeats,
 446           FeatureRendererModel fr)
 447   {
 448     createSequenceAnnotationReport(tip, sequence, showDbRefs, showNpFeats,
 449             fr, false);
 450   }
 451
 452   /**
 453    * Builds an html formatted report of sequence details and appends it to the
 454    * provided buffer.
 455    *
 456    * @param sb
 457    *          buffer to append report to
 458    * @param sequence
 459    *          the sequence the report is for
 460    * @param showDbRefs
 461    *          whether to include database references for the sequence
 462    * @param showNpFeats
 463    *          whether to include non-positional sequence features
 464    * @param fr
 465    * @param summary
 466    * @return
 467    */
 468   int createSequenceAnnotationReport(final StringBuilder sb,
 469           SequenceI sequence, boolean showDbRefs, boolean showNpFeats,
 470           FeatureRendererModel fr, boolean summary)
 471   {
 472     String tmp;
 473     sb.append("<i>");
 474
 475     int maxWidth = 0;
 476     if (sequence.getDescription() != null)
 477     {
 478       tmp = sequence.getDescription();
 479       sb.append(tmp);
 480       maxWidth = Math.max(maxWidth, tmp.length());
 481     }
 482
 483     SequenceI ds = sequence;
 484     while (ds.getDatasetSequence() != null)
 485     {
 486       ds = ds.getDatasetSequence();
 487     }
 488
 489     /*
 490      * add any annotation scores
 491      */
 492     AlignmentAnnotation[] anns = ds.getAnnotation();
 493     for (int i = 0; anns != null && i < anns.length; i++)
 494     {
 495       AlignmentAnnotation aa = anns[i];
 496       if (aa != null && aa.hasScore() && aa.sequenceRef != null)
 497       {
 498         sb.append("<br>").append(aa.label).append(": ")
 499                 .append(aa.getScore());
 500       }
 501     }
 502
 503     if (showDbRefs)
 504     {
 505       maxWidth = Math.max(maxWidth, appendDbRefs(sb, ds, summary));
 506     }
 507
 508     /*
 509      * add non-positional features if wanted
 510      */
 511     if (showNpFeats)
 512     {
 513       for (SequenceFeature sf : sequence.getFeatures()
 514               .getNonPositionalFeatures())
 515       {
 516         int sz = -sb.length();
 517         appendFeature(sb, 0, fr, sf, null, 0);
 518         sz += sb.length();
 519         maxWidth = Math.max(maxWidth, sz);
 520       }
 521     }
 522
 523
 524     if (sequence.getAnnotation("Search Scores") != null)
 525     {
 526       sb.append("<br>");
 527       String eValue = " E-Value: "
 528               + sequence.getAnnotation("Search Scores")[0].getEValue();
 529       String bitScore = " Bit Score: "
 530               + sequence.getAnnotation("Search Scores")[0].getBitScore();
 531       sb.append(eValue);
 532       sb.append("<br>");
 533       sb.append(bitScore);
 534       maxWidth = Math.max(maxWidth, eValue.length());
 535       maxWidth = Math.max(maxWidth, bitScore.length());
 536     }
 537     sb.append("<br>");
 538     sb.append("</i>");
 539
 540     return maxWidth;
 541   }
 542
 543   /**
 544    * A helper method that appends any DBRefs, returning the maximum line length
 545    * added
 546    *
 547    * @param sb
 548    * @param ds
 549    * @param summary
 550    * @return
 551    */
 552   protected int appendDbRefs(final StringBuilder sb, SequenceI ds,
 553           boolean summary)
 554   {
 555     List<DBRefEntry> dbrefs = ds.getDBRefs();
 556     if (dbrefs == null)
 557     {
 558       return 0;
 559     }
 560
 561     // note this sorts the refs held on the sequence!
 562     dbrefs.sort(comparator);
 563     boolean ellipsis = false;
 564     String source = null;
 565     String lastSource = null;
 566     int countForSource = 0;
 567     int sourceCount = 0;
 568     boolean moreSources = false;
 569     int maxLineLength = 0;
 570     int lineLength = 0;
 571
 572     for (DBRefEntry ref : dbrefs)
 573     {
 574       source = ref.getSource();
 575       if (source == null)
 576       {
 577         // shouldn't happen
 578         continue;
 579       }
 580       boolean sourceChanged = !source.equals(lastSource);
 581       if (sourceChanged)
 582       {
 583         lineLength = 0;
 584         countForSource = 0;
 585         sourceCount++;
 586       }
 587       if (sourceCount > MAX_SOURCES && summary)
 588       {
 589         ellipsis = true;
 590         moreSources = true;
 591         break;
 592       }
 593       lastSource = source;
 594       countForSource++;
 595       if (countForSource == 1 || !summary)
 596       {
 597         sb.append("<br/>");
 598       }
 599       if (countForSource <= MAX_REFS_PER_SOURCE || !summary)
 600       {
 601         String accessionId = ref.getAccessionId();
 602         lineLength += accessionId.length() + 1;
 603         if (countForSource > 1 && summary)
 604         {
 605           sb.append(", ").append(accessionId);
 606           lineLength++;
 607         }
 608         else
 609         {
 610           sb.append(source).append(" ").append(accessionId);
 611           lineLength += source.length();
 612         }
 613         maxLineLength = Math.max(maxLineLength, lineLength);
 614       }
 615       if (countForSource == MAX_REFS_PER_SOURCE && summary)
 616       {
 617         sb.append(COMMA).append(ELLIPSIS);
 618         ellipsis = true;
 619       }
 620     }
 621     if (moreSources)
 622     {
 623       sb.append("<br/>").append(source).append(COMMA).append(ELLIPSIS);
 624     }
 625     if (ellipsis)
 626     {
 627       sb.append("<br/>(");
 628       sb.append(MessageManager.getString("label.output_seq_details"));
 629       sb.append(")");
 630     }
 631
 632     return maxLineLength;
 633   }
 634
 635   public void createTooltipAnnotationReport(final StringBuilder tip,
 636           SequenceI sequence, boolean showDbRefs, boolean showNpFeats,
 637           FeatureRendererModel fr)
 638   {
 639     int maxWidth = createSequenceAnnotationReport(tip, sequence,
 640             showDbRefs, showNpFeats, fr, true);
 641
 642     if (maxWidth > 60)
 643     {
 644       // ? not sure this serves any useful purpose
 645       // tip.insert(0, "<table width=350 border=0><tr><td>");
 646       // tip.append("</td></tr></table>");
 647     }
 648   }
 649 }