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 jalview.api.FeatureColourI;
  24 import jalview.datamodel.DBRefEntry;
  25 import jalview.datamodel.DBRefSource;
  26 import jalview.datamodel.SequenceFeature;
  27 import jalview.datamodel.SequenceI;
  28 import jalview.util.MessageManager;
  29 import jalview.util.StringUtils;
  30 import jalview.util.UrlLink;
  31 import jalview.viewmodel.seqfeatures.FeatureRendererModel;
  32
  33 import java.util.Arrays;
  34 import java.util.Collection;
  35 import java.util.Comparator;
  36 import java.util.LinkedHashMap;
  37 import java.util.List;
  38 import java.util.Map;
  39
  40 /**
  41  * generate HTML reports for a sequence
  42  *
  43  * @author jimp
  44  */
  45 public class SequenceAnnotationReport
  46 {
  47   private static final String COMMA = ",";
  48
  49   private static final String ELLIPSIS = "...";
  50
  51   private static final int MAX_REFS_PER_SOURCE = 4;
  52
  53   private static final int MAX_SOURCES = 40;
  54
  55   private static final String[][] PRIMARY_SOURCES = new String[][] {
  56       DBRefSource.CODINGDBS, DBRefSource.DNACODINGDBS,
  57       DBRefSource.PROTEINDBS };
  58
  59   final String linkImageURL;
  60
  61   /*
  62    * Comparator to order DBRefEntry by Source + accession id (case-insensitive),
  63    * with 'Primary' sources placed before others, and 'chromosome' first of all
  64    */
  65   private static Comparator<DBRefEntry> comparator = new Comparator<DBRefEntry>()
  66   {
  67
  68     @Override
  69     public int compare(DBRefEntry ref1, DBRefEntry ref2)
  70     {
  71       if (ref1.isChromosome())
  72       {
  73         return -1;
  74       }
  75       if (ref2.isChromosome())
  76       {
  77         return 1;
  78       }
  79       String s1 = ref1.getSource();
  80       String s2 = ref2.getSource();
  81       boolean s1Primary = isPrimarySource(s1);
  82       boolean s2Primary = isPrimarySource(s2);
  83       if (s1Primary && !s2Primary)
  84       {
  85         return -1;
  86       }
  87       if (!s1Primary && s2Primary)
  88       {
  89         return 1;
  90       }
  91       int comp = s1 == null ? -1 : (s2 == null ? 1 : s1
  92               .compareToIgnoreCase(s2));
  93       if (comp == 0)
  94       {
  95         String a1 = ref1.getAccessionId();
  96         String a2 = ref2.getAccessionId();
  97         comp = a1 == null ? -1 : (a2 == null ? 1 : a1
  98                 .compareToIgnoreCase(a2));
  99       }
 100       return comp;
 101     }
 102
 103     private boolean isPrimarySource(String source)
 104     {
 105       for (String[] primary : PRIMARY_SOURCES)
 106       {
 107         for (String s : primary)
 108         {
 109           if (source.equals(s))
 110           {
 111             return true;
 112           }
 113         }
 114       }
 115       return false;
 116     }
 117   };
 118
 119   public SequenceAnnotationReport(String linkURL)
 120   {
 121     this.linkImageURL = linkURL;
 122   }
 123
 124   /**
 125    * Append text for the list of features to the tooltip
 126    *
 127    * @param sb
 128    * @param rpos
 129    * @param features
 130    * @param minmax
 131    */
 132   public void appendFeatures(final StringBuilder sb, int rpos,
 133           List<SequenceFeature> features, FeatureRendererModel fr)
 134   {
 135     if (features != null)
 136     {
 137       for (SequenceFeature feature : features)
 138       {
 139         appendFeature(sb, rpos, fr, feature);
 140       }
 141     }
 142   }
 143
 144   /**
 145    * Appends the feature at rpos to the given buffer
 146    *
 147    * @param sb
 148    * @param rpos
 149    * @param minmax
 150    * @param feature
 151    */
 152   void appendFeature(final StringBuilder sb, int rpos,
 153           FeatureRendererModel fr, SequenceFeature feature)
 154   {
 155     if (feature.isContactFeature())
 156     {
 157       if (feature.getBegin() == rpos || feature.getEnd() == rpos)
 158       {
 159         if (sb.length() > 6)
 160         {
 161           sb.append("<br>");
 162         }
 163         sb.append(feature.getType()).append(" ").append(feature.getBegin())
 164                 .append(":").append(feature.getEnd());
 165       }
 166       return;
 167     }
 168
 169     if (sb.length() > 6)
 170     {
 171       sb.append("<br>");
 172     }
 173     // TODO: remove this hack to display link only features
 174     boolean linkOnly = feature.getValue("linkonly") != null;
 175     if (!linkOnly)
 176     {
 177       sb.append(feature.getType()).append(" ");
 178       if (rpos != 0)
 179       {
 180         // we are marking a positional feature
 181         sb.append(feature.begin);
 182       }
 183       if (feature.begin != feature.end)
 184       {
 185         sb.append(" ").append(feature.end);
 186       }
 187
 188       String description = feature.getDescription();
 189       if (description != null && !description.equals(feature.getType()))
 190       {
 191         description = StringUtils.stripHtmlTags(description);
 192         sb.append("; ").append(description);
 193       }
 194
 195       if (showScore(feature, fr))
 196       {
 197         sb.append(" Score=").append(String.valueOf(feature.getScore()));
 198       }
 199       String status = (String) feature.getValue("status");
 200       if (status != null && status.length() > 0)
 201       {
 202         sb.append("; (").append(status).append(")");
 203       }
 204
 205       /*
 206        * add attribute value if coloured by attribute
 207        */
 208       if (fr != null)
 209       {
 210         FeatureColourI fc = fr.getFeatureColours().get(feature.getType());
 211         if (fc != null && fc.isColourByAttribute())
 212         {
 213           String attName = fc.getAttributeName();
 214           String attVal = feature.getValueAsString(attName);
 215           if (attVal != null)
 216           {
 217             sb.append("; ").append(attName).append("=").append(attVal);
 218           }
 219         }
 220       }
 221     }
 222   }
 223
 224   /**
 225    * Answers true if score should be shown, else false. Score is shown if it is
 226    * not NaN, and the feature type has a non-trivial min-max score range
 227    */
 228   boolean showScore(SequenceFeature feature, FeatureRendererModel fr)
 229   {
 230     if (Float.isNaN(feature.getScore()))
 231     {
 232       return false;
 233     }
 234     if (fr == null)
 235     {
 236       return true;
 237     }
 238     float[][] minMax = fr.getMinMax().get(feature.getType());
 239
 240     /*
 241      * minMax[0] is the [min, max] score range for positional features
 242      */
 243     if (minMax == null || minMax[0] == null || minMax[0][0] == minMax[0][1])
 244     {
 245       return false;
 246     }
 247     return true;
 248   }
 249
 250   /**
 251    * Format and appends any hyperlinks for the sequence feature to the string
 252    * buffer
 253    *
 254    * @param sb
 255    * @param feature
 256    */
 257   void appendLinks(final StringBuffer sb, SequenceFeature feature)
 258   {
 259     if (feature.links != null)
 260     {
 261       if (linkImageURL != null)
 262       {
 263         sb.append(" <img src=\"" + linkImageURL + "\">");
 264       }
 265       else
 266       {
 267         for (String urlstring : feature.links)
 268         {
 269           try
 270           {
 271             for (List<String> urllink : createLinksFrom(null, urlstring))
 272             {
 273               sb.append("<br/> <a href=\""
 274                       + urllink.get(3)
 275                       + "\" target=\""
 276                       + urllink.get(0)
 277                       + "\">"
 278                       + (urllink.get(0).toLowerCase()
 279                               .equals(urllink.get(1).toLowerCase()) ? urllink
 280                               .get(0) : (urllink.get(0) + ":" + urllink
 281                               .get(1))) + "</a></br>");
 282             }
 283           } catch (Exception x)
 284           {
 285             System.err.println("problem when creating links from "
 286                     + urlstring);
 287             x.printStackTrace();
 288           }
 289         }
 290       }
 291
 292     }
 293   }
 294
 295   /**
 296    *
 297    * @param seq
 298    * @param link
 299    * @return Collection< List<String> > { List<String> { link target, link
 300    *         label, dynamic component inserted (if any), url }}
 301    */
 302   Collection<List<String>> createLinksFrom(SequenceI seq, String link)
 303   {
 304     Map<String, List<String>> urlSets = new LinkedHashMap<String, List<String>>();
 305     UrlLink urlLink = new UrlLink(link);
 306     if (!urlLink.isValid())
 307     {
 308       System.err.println(urlLink.getInvalidMessage());
 309       return null;
 310     }
 311
 312     urlLink.createLinksFromSeq(seq, urlSets);
 313
 314     return urlSets.values();
 315   }
 316
 317   public void createSequenceAnnotationReport(final StringBuilder tip,
 318           SequenceI sequence, boolean showDbRefs, boolean showNpFeats,
 319           FeatureRendererModel fr)
 320   {
 321     createSequenceAnnotationReport(tip, sequence, showDbRefs, showNpFeats,
 322             fr, false);
 323   }
 324
 325   /**
 326    * Builds an html formatted report of sequence details and appends it to the
 327    * provided buffer.
 328    *
 329    * @param sb
 330    *          buffer to append report to
 331    * @param sequence
 332    *          the sequence the report is for
 333    * @param showDbRefs
 334    *          whether to include database references for the sequence
 335    * @param showNpFeats
 336    *          whether to include non-positional sequence features
 337    * @param fr
 338    * @param summary
 339    * @return
 340    */
 341   int createSequenceAnnotationReport(final StringBuilder sb,
 342           SequenceI sequence, boolean showDbRefs, boolean showNpFeats,
 343           FeatureRendererModel fr, boolean summary)
 344   {
 345     String tmp;
 346     sb.append("<i>");
 347
 348     int maxWidth = 0;
 349     if (sequence.getDescription() != null)
 350     {
 351       tmp = sequence.getDescription();
 352       sb.append("<br>").append(tmp);
 353       maxWidth = Math.max(maxWidth, tmp.length());
 354     }
 355     SequenceI ds = sequence;
 356     while (ds.getDatasetSequence() != null)
 357     {
 358       ds = ds.getDatasetSequence();
 359     }
 360
 361     if (showDbRefs)
 362     {
 363       maxWidth = Math.max(maxWidth, appendDbRefs(sb, ds, summary));
 364     }
 365
 366     /*
 367      * add non-positional features if wanted
 368      */
 369     if (showNpFeats)
 370     {
 371       for (SequenceFeature sf : sequence.getFeatures()
 372               .getNonPositionalFeatures())
 373       {
 374         int sz = -sb.length();
 375         appendFeature(sb, 0, fr, sf);
 376         sz += sb.length();
 377         maxWidth = Math.max(maxWidth, sz);
 378       }
 379     }
 380     sb.append("</i>");
 381     return maxWidth;
 382   }
 383
 384   /**
 385    * A helper method that appends any DBRefs, returning the maximum line length
 386    * added
 387    *
 388    * @param sb
 389    * @param ds
 390    * @param summary
 391    * @return
 392    */
 393   protected int appendDbRefs(final StringBuilder sb, SequenceI ds,
 394           boolean summary)
 395   {
 396     DBRefEntry[] dbrefs = ds.getDBRefs();
 397     if (dbrefs == null)
 398     {
 399       return 0;
 400     }
 401
 402     // note this sorts the refs held on the sequence!
 403     Arrays.sort(dbrefs, comparator);
 404     boolean ellipsis = false;
 405     String source = null;
 406     String lastSource = null;
 407     int countForSource = 0;
 408     int sourceCount = 0;
 409     boolean moreSources = false;
 410     int maxLineLength = 0;
 411     int lineLength = 0;
 412
 413     for (DBRefEntry ref : dbrefs)
 414     {
 415       source = ref.getSource();
 416       if (source == null)
 417       {
 418         // shouldn't happen
 419         continue;
 420       }
 421       boolean sourceChanged = !source.equals(lastSource);
 422       if (sourceChanged)
 423       {
 424         lineLength = 0;
 425         countForSource = 0;
 426         sourceCount++;
 427       }
 428       if (sourceCount > MAX_SOURCES && summary)
 429       {
 430         ellipsis = true;
 431         moreSources = true;
 432         break;
 433       }
 434       lastSource = source;
 435       countForSource++;
 436       if (countForSource == 1 || !summary)
 437       {
 438         sb.append("<br>");
 439       }
 440       if (countForSource <= MAX_REFS_PER_SOURCE || !summary)
 441       {
 442         String accessionId = ref.getAccessionId();
 443         lineLength += accessionId.length() + 1;
 444         if (countForSource > 1 && summary)
 445         {
 446           sb.append(", ").append(accessionId);
 447           lineLength++;
 448         }
 449         else
 450         {
 451           sb.append(source).append(" ").append(accessionId);
 452           lineLength += source.length();
 453         }
 454         maxLineLength = Math.max(maxLineLength, lineLength);
 455       }
 456       if (countForSource == MAX_REFS_PER_SOURCE && summary)
 457       {
 458         sb.append(COMMA).append(ELLIPSIS);
 459         ellipsis = true;
 460       }
 461     }
 462     if (moreSources)
 463     {
 464       sb.append("<br>").append(source).append(COMMA).append(ELLIPSIS);
 465     }
 466     if (ellipsis)
 467     {
 468       sb.append("<br>(");
 469       sb.append(MessageManager.getString("label.output_seq_details"));
 470       sb.append(")");
 471     }
 472
 473     return maxLineLength;
 474   }
 475
 476   public void createTooltipAnnotationReport(final StringBuilder tip,
 477           SequenceI sequence, boolean showDbRefs, boolean showNpFeats,
 478           FeatureRendererModel fr)
 479   {
 480     int maxWidth = createSequenceAnnotationReport(tip, sequence,
 481             showDbRefs, showNpFeats, fr, true);
 482
 483     if (maxWidth > 60)
 484     {
 485       // ? not sure this serves any useful purpose
 486       // tip.insert(0, "<table width=350 border=0><tr><td>");
 487       // tip.append("</td></tr></table>");
 488     }
 489   }
 490 }