src/jalview/datamodel/SequenceFeature.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.datamodel;
  22
  23 import jalview.datamodel.features.FeatureAttributeType;
  24 import jalview.datamodel.features.FeatureAttributes;
  25 import jalview.datamodel.features.FeatureLocationI;
  26 import jalview.datamodel.features.FeatureSourceI;
  27 import jalview.datamodel.features.FeatureSources;
  28 import jalview.util.StringUtils;
  29
  30 import java.util.Comparator;
  31 import java.util.HashMap;
  32 import java.util.Map;
  33 import java.util.Map.Entry;
  34 import java.util.SortedMap;
  35 import java.util.TreeMap;
  36 import java.util.Vector;
  37
  38 /**
  39  * A class that models a single contiguous feature on a sequence. If flag
  40  * 'contactFeature' is true, the start and end positions are interpreted instead
  41  * as two contact points.
  42  */
  43 public class SequenceFeature implements FeatureLocationI
  44 {
  45   /*
  46    * score value if none is set; preferably Float.Nan, but see
  47    * JAL-2060 and JAL-2554 for a couple of blockers to that
  48    */
  49   private static final float NO_SCORE = 0f;
  50
  51   private static final String STATUS = "status";
  52
  53   private static final String STRAND = "STRAND";
  54
  55   // private key for Phase designed not to conflict with real GFF data
  56   private static final String PHASE = "!Phase";
  57
  58   // private key for ENA location designed not to conflict with real GFF data
  59   private static final String LOCATION = "!Location";
  60
  61   private static final String ROW_DATA = "<tr><td>%s</td><td>%s</td><td>%s</td></tr>";
  62
  63   /*
  64    * ATTRIBUTES is reserved for the GFF 'column 9' data, formatted as
  65    * name1=value1;name2=value2,value3;...etc
  66    */
  67   private static final String ATTRIBUTES = "ATTRIBUTES";
  68
  69   /*
  70    * type, begin, end, featureGroup, score and contactFeature are final
  71    * to ensure that the integrity of SequenceFeatures data store
  72    * can't be broken by direct update of these fields
  73    */
  74   public final String type;
  75
  76   public final int begin;
  77
  78   public final int end;
  79
  80   public final String featureGroup;
  81
  82   public final float score;
  83
  84   private final boolean contactFeature;
  85
  86   public String description;
  87
  88   /*
  89    * a map of key-value pairs; may be populated from GFF 'column 9' data,
  90    * other data sources (e.g. GenBank file), or programmatically
  91    */
  92   public Map<String, Object> otherDetails;
  93
  94   public Vector<String> links;
  95
  96   /*
  97    * the identifier (if known) for the FeatureSource held in FeatureSources,
  98    * as a provider of metadata about feature attributes
  99    */
 100   private String source;
 101
 102   /**
 103    * Constructs a duplicate feature. Note: Uses makes a shallow copy of the
 104    * otherDetails map, so the new and original SequenceFeature may reference the
 105    * same objects in the map.
 106    *
 107    * @param cpy
 108    */
 109   public SequenceFeature(SequenceFeature cpy)
 110   {
 111     this(cpy, cpy.getBegin(), cpy.getEnd(), cpy.getFeatureGroup(), cpy
 112             .getScore());
 113   }
 114
 115   /**
 116    * Constructor
 117    *
 118    * @param theType
 119    * @param theDesc
 120    * @param theBegin
 121    * @param theEnd
 122    * @param group
 123    */
 124   public SequenceFeature(String theType, String theDesc, int theBegin,
 125           int theEnd, String group)
 126   {
 127     this(theType, theDesc, theBegin, theEnd, NO_SCORE, group);
 128   }
 129
 130   /**
 131    * Constructor including a score value
 132    *
 133    * @param theType
 134    * @param theDesc
 135    * @param theBegin
 136    * @param theEnd
 137    * @param theScore
 138    * @param group
 139    */
 140   public SequenceFeature(String theType, String theDesc, int theBegin,
 141           int theEnd, float theScore, String group)
 142   {
 143     this.type = theType;
 144     this.description = theDesc;
 145     this.begin = theBegin;
 146     this.end = theEnd;
 147     this.featureGroup = group;
 148     this.score = theScore;
 149
 150     /*
 151      * for now, only "Disulfide/disulphide bond" is treated as a contact feature
 152      */
 153     this.contactFeature = "disulfide bond".equalsIgnoreCase(type)
 154             || "disulphide bond".equalsIgnoreCase(type);
 155   }
 156
 157   /**
 158    * A copy constructor that allows the value of final fields to be 'modified'
 159    *
 160    * @param sf
 161    * @param newType
 162    * @param newBegin
 163    * @param newEnd
 164    * @param newGroup
 165    * @param newScore
 166    */
 167   public SequenceFeature(SequenceFeature sf, String newType, int newBegin,
 168           int newEnd, String newGroup, float newScore)
 169   {
 170     this(newType, sf.getDescription(), newBegin, newEnd, newScore,
 171             newGroup);
 172
 173     this.source = sf.source;
 174
 175     if (sf.otherDetails != null)
 176     {
 177       otherDetails = new HashMap<>();
 178       for (Entry<String, Object> entry : sf.otherDetails.entrySet())
 179       {
 180         otherDetails.put(entry.getKey(), entry.getValue());
 181       }
 182     }
 183     if (sf.links != null && sf.links.size() > 0)
 184     {
 185       links = new Vector<>();
 186       for (int i = 0, iSize = sf.links.size(); i < iSize; i++)
 187       {
 188         links.addElement(sf.links.elementAt(i));
 189       }
 190     }
 191   }
 192
 193   /**
 194    * A copy constructor that allows the value of final fields to be 'modified'
 195    *
 196    * @param sf
 197    * @param newBegin
 198    * @param newEnd
 199    * @param newGroup
 200    * @param newScore
 201    */
 202   public SequenceFeature(SequenceFeature sf, int newBegin, int newEnd,
 203           String newGroup, float newScore)
 204   {
 205     this(sf, sf.getType(), newBegin, newEnd, newGroup, newScore);
 206   }
 207
 208   /**
 209    * Two features are considered equal if they have the same type, group,
 210    * description, start, end, phase, strand, and (if present) 'Name', ID' and
 211    * 'Parent' attributes.
 212    *
 213    * Note we need to check Parent to distinguish the same exon occurring in
 214    * different transcripts (in Ensembl GFF). This allows assembly of transcript
 215    * sequences from their component exon regions.
 216    */
 217   @Override
 218   public boolean equals(Object o)
 219   {
 220     return equals(o, false);
 221   }
 222
 223   /**
 224    * Overloaded method allows the equality test to optionally ignore the
 225    * 'Parent' attribute of a feature. This supports avoiding adding many
 226    * superficially duplicate 'exon' or CDS features to genomic or protein
 227    * sequence.
 228    *
 229    * @param o
 230    * @param ignoreParent
 231    * @return
 232    */
 233   public boolean equals(Object o, boolean ignoreParent)
 234   {
 235     if (o == null || !(o instanceof SequenceFeature))
 236     {
 237       return false;
 238     }
 239
 240     SequenceFeature sf = (SequenceFeature) o;
 241     boolean sameScore = Float.isNaN(score) ? Float.isNaN(sf.score)
 242             : score == sf.score;
 243     if (begin != sf.begin || end != sf.end || !sameScore)
 244     {
 245       return false;
 246     }
 247
 248     if (getStrand() != sf.getStrand())
 249     {
 250       return false;
 251     }
 252
 253     if (!(type + description + featureGroup + getPhase()).equals(
 254             sf.type + sf.description + sf.featureGroup + sf.getPhase()))
 255     {
 256       return false;
 257     }
 258     if (!equalAttribute(getValue("ID"), sf.getValue("ID")))
 259     {
 260       return false;
 261     }
 262     if (!equalAttribute(getValue("Name"), sf.getValue("Name")))
 263     {
 264       return false;
 265     }
 266     if (!ignoreParent)
 267     {
 268       if (!equalAttribute(getValue("Parent"), sf.getValue("Parent")))
 269       {
 270         return false;
 271       }
 272     }
 273     return true;
 274   }
 275
 276   /**
 277    * Returns true if both values are null, are both non-null and equal
 278    *
 279    * @param att1
 280    * @param att2
 281    * @return
 282    */
 283   protected static boolean equalAttribute(Object att1, Object att2)
 284   {
 285     if (att1 == null && att2 == null)
 286     {
 287       return true;
 288     }
 289     if (att1 != null)
 290     {
 291       return att1.equals(att2);
 292     }
 293     return att2.equals(att1);
 294   }
 295
 296   /**
 297    * DOCUMENT ME!
 298    *
 299    * @return DOCUMENT ME!
 300    */
 301   @Override
 302   public int getBegin()
 303   {
 304     return begin;
 305   }
 306
 307   /**
 308    * DOCUMENT ME!
 309    *
 310    * @return DOCUMENT ME!
 311    */
 312   @Override
 313   public int getEnd()
 314   {
 315     return end;
 316   }
 317
 318   /**
 319    * DOCUMENT ME!
 320    *
 321    * @return DOCUMENT ME!
 322    */
 323   public String getType()
 324   {
 325     return type;
 326   }
 327
 328   /**
 329    * DOCUMENT ME!
 330    *
 331    * @return DOCUMENT ME!
 332    */
 333   public String getDescription()
 334   {
 335     return description;
 336   }
 337
 338   public void setDescription(String desc)
 339   {
 340     description = desc;
 341   }
 342
 343   public String getFeatureGroup()
 344   {
 345     return featureGroup;
 346   }
 347
 348   /**
 349    * Adds a hyperlink for the feature. This should have the format label|url.
 350    *
 351    * @param labelLink
 352    */
 353   public void addLink(String labelLink)
 354   {
 355     if (links == null)
 356     {
 357       links = new Vector<>();
 358     }
 359
 360     if (!links.contains(labelLink))
 361     {
 362       links.insertElementAt(labelLink, 0);
 363     }
 364   }
 365
 366   public float getScore()
 367   {
 368     return score;
 369   }
 370
 371   /**
 372    * Used for getting values which are not in the basic set. eg STRAND, PHASE
 373    * for GFF file
 374    *
 375    * @param key
 376    *          String
 377    */
 378   public Object getValue(String key)
 379   {
 380     if (otherDetails == null)
 381     {
 382       return null;
 383     }
 384     else
 385     {
 386       return otherDetails.get(key);
 387     }
 388   }
 389
 390   /**
 391    * Answers the value of the specified attribute as string, or null if no such
 392    * value. If more than one attribute name is provided, tries to resolve as keys
 393    * to nested maps. For example, if attribute "CSQ" holds a map of key-value
 394    * pairs, then getValueAsString("CSQ", "Allele") returns the value of "Allele"
 395    * in that map.
 396    *
 397    * @param key
 398    * @return
 399    */
 400   public String getValueAsString(String... key)
 401   {
 402     if (otherDetails == null)
 403     {
 404       return null;
 405     }
 406     Object value = otherDetails.get(key[0]);
 407     if (key.length > 1 && value instanceof Map<?, ?>)
 408     {
 409       value = ((Map) value).get(key[1]);
 410     }
 411     return value == null ? null : value.toString();
 412   }
 413
 414   /**
 415    * Returns a property value for the given key if known, else the specified
 416    * default value
 417    *
 418    * @param key
 419    * @param defaultValue
 420    * @return
 421    */
 422   public Object getValue(String key, Object defaultValue)
 423   {
 424     Object value = getValue(key);
 425     return value == null ? defaultValue : value;
 426   }
 427
 428   /**
 429    * Used for setting values which are not in the basic set. eg STRAND, FRAME
 430    * for GFF file
 431    *
 432    * @param key
 433    *          eg STRAND
 434    * @param value
 435    *          eg +
 436    */
 437   public void setValue(String key, Object value)
 438   {
 439     if (value != null)
 440     {
 441       if (otherDetails == null)
 442       {
 443         otherDetails = new HashMap<>();
 444       }
 445
 446       otherDetails.put(key, value);
 447       recordAttribute(key, value);
 448     }
 449   }
 450
 451   /**
 452    * Notifies the addition of a feature attribute. This lets us keep track of
 453    * which attributes are present on each feature type, and also the range of
 454    * numerical-valued attributes.
 455    *
 456    * @param key
 457    * @param value
 458    */
 459   protected void recordAttribute(String key, Object value)
 460   {
 461     String attDesc = null;
 462     if (source != null)
 463     {
 464       attDesc = FeatureSources.getInstance().getSource(source)
 465               .getAttributeName(key);
 466     }
 467
 468     FeatureAttributes.getInstance().addAttribute(this.type, attDesc, value,
 469             key);
 470   }
 471
 472   /*
 473    * The following methods are added to maintain the castor Uniprot mapping file
 474    * for the moment.
 475    */
 476   public void setStatus(String status)
 477   {
 478     setValue(STATUS, status);
 479   }
 480
 481   public String getStatus()
 482   {
 483     return (String) getValue(STATUS);
 484   }
 485
 486   public void setAttributes(String attr)
 487   {
 488     setValue(ATTRIBUTES, attr);
 489   }
 490
 491   public String getAttributes()
 492   {
 493     return (String) getValue(ATTRIBUTES);
 494   }
 495
 496   /**
 497    * Return 1 for forward strand ('+' in GFF), -1 for reverse strand ('-' in
 498    * GFF), and 0 for unknown or not (validly) specified
 499    *
 500    * @return
 501    */
 502   public int getStrand()
 503   {
 504     int strand = 0;
 505     if (otherDetails != null)
 506     {
 507       Object str = otherDetails.get(STRAND);
 508       if ("-".equals(str))
 509       {
 510         strand = -1;
 511       }
 512       else if ("+".equals(str))
 513       {
 514         strand = 1;
 515       }
 516     }
 517     return strand;
 518   }
 519
 520   /**
 521    * Set the value of strand
 522    *
 523    * @param strand
 524    *          should be "+" for forward, or "-" for reverse
 525    */
 526   public void setStrand(String strand)
 527   {
 528     setValue(STRAND, strand);
 529   }
 530
 531   public void setPhase(String phase)
 532   {
 533     setValue(PHASE, phase);
 534   }
 535
 536   public String getPhase()
 537   {
 538     return (String) getValue(PHASE);
 539   }
 540
 541   /**
 542    * Sets the 'raw' ENA format location specifier e.g. join(12..45,89..121)
 543    *
 544    * @param loc
 545    */
 546   public void setEnaLocation(String loc)
 547   {
 548     setValue(LOCATION, loc);
 549   }
 550
 551   /**
 552    * Gets the 'raw' ENA format location specifier e.g. join(12..45,89..121)
 553    *
 554    * @param loc
 555    */
 556   public String getEnaLocation()
 557   {
 558     return (String) getValue(LOCATION);
 559   }
 560
 561   /**
 562    * Readable representation, for debug only, not guaranteed not to change
 563    * between versions
 564    */
 565   @Override
 566   public String toString()
 567   {
 568     return String.format("%d %d %s %s", getBegin(), getEnd(), getType(),
 569             getDescription());
 570   }
 571
 572   /**
 573    * Overridden to ensure that whenever two objects are equal, they have the
 574    * same hashCode
 575    */
 576   @Override
 577   public int hashCode()
 578   {
 579     String s = getType() + getDescription() + getFeatureGroup()
 580             + getValue("ID") + getValue("Name") + getValue("Parent")
 581             + getPhase();
 582     return s.hashCode() + getBegin() + getEnd() + (int) getScore()
 583             + getStrand();
 584   }
 585
 586   /**
 587    * Answers true if the feature's start/end values represent two related
 588    * positions, rather than ends of a range. Such features may be visualised or
 589    * reported differently to features on a range.
 590    */
 591   @Override
 592   public boolean isContactFeature()
 593   {
 594     return contactFeature;
 595   }
 596
 597   /**
 598    * Answers true if the sequence has zero start and end position
 599    *
 600    * @return
 601    */
 602   public boolean isNonPositional()
 603   {
 604     return begin == 0 && end == 0;
 605   }
 606
 607   /**
 608    * Answers an html-formatted report of feature details
 609    *
 610    * @param sequence
 611    *
 612    * @return
 613    */
 614   public String getDetailsReport(SequenceI sequence)
 615   {
 616     FeatureSourceI metadata = FeatureSources.getInstance()
 617             .getSource(source);
 618
 619     StringBuilder sb = new StringBuilder(128);
 620     sb.append("<br>");
 621     sb.append("<table>");
 622     sb.append(String.format(ROW_DATA, "Location", sequence.getName(),
 623             begin == end ? begin
 624                     : begin + (isContactFeature() ? ":" : "-") + end));
 625     sb.append(String.format(ROW_DATA, "Type", type, ""));
 626     String desc = StringUtils.stripHtmlTags(description);
 627     sb.append(String.format(ROW_DATA, "Description", desc, ""));
 628     if (!Float.isNaN(score) && score != 0f)
 629     {
 630       sb.append(String.format(ROW_DATA, "Score", score, ""));
 631     }
 632     if (featureGroup != null)
 633     {
 634       sb.append(String.format(ROW_DATA, "Group", featureGroup, ""));
 635     }
 636
 637     if (otherDetails != null)
 638     {
 639       TreeMap<String, Object> ordered = new TreeMap<>(
 640               String.CASE_INSENSITIVE_ORDER);
 641       ordered.putAll(otherDetails);
 642
 643       for (Entry<String, Object> entry : ordered.entrySet())
 644       {
 645         String key = entry.getKey();
 646         if (ATTRIBUTES.equals(key))
 647         {
 648           continue; // to avoid double reporting
 649         }
 650
 651         Object value = entry.getValue();
 652         if (value instanceof Map<?, ?>)
 653         {
 654           /*
 655            * expand values in a Map attribute across separate lines
 656            * copy to a TreeMap for alphabetical ordering
 657            */
 658           Map<String, Object> values = (Map<String, Object>) value;
 659           SortedMap<String, Object> sm = new TreeMap<>(
 660                   String.CASE_INSENSITIVE_ORDER);
 661           sm.putAll(values);
 662           for (Entry<?, ?> e : sm.entrySet())
 663           {
 664             sb.append(String.format(ROW_DATA, key, e.getKey().toString(), e
 665                     .getValue().toString()));
 666           }
 667         }
 668         else
 669         {
 670           // tried <td title="key"> but it failed to provide a tooltip :-(
 671           String attDesc = null;
 672           if (metadata != null)
 673           {
 674             attDesc = metadata.getAttributeName(key);
 675           }
 676           String s = entry.getValue().toString();
 677           if (isValueInteresting(key, s, metadata))
 678           {
 679             sb.append(String.format(ROW_DATA, key, attDesc == null ? ""
 680                     : attDesc, s));
 681           }
 682         }
 683       }
 684     }
 685     sb.append("</table>");
 686
 687     String text = sb.toString();
 688     return text;
 689   }
 690
 691   /**
 692    * Answers true if we judge the value is worth displaying, by some heuristic
 693    * rules, else false
 694    *
 695    * @param key
 696    * @param value
 697    * @param metadata
 698    * @return
 699    */
 700   boolean isValueInteresting(String key, String value,
 701           FeatureSourceI metadata)
 702   {
 703     /*
 704      * currently suppressing zero values as well as null or empty
 705      */
 706     if (value == null || "".equals(value) || ".".equals(value)
 707             || "0".equals(value))
 708     {
 709       return false;
 710     }
 711
 712     if (metadata == null)
 713     {
 714       return true;
 715     }
 716
 717     FeatureAttributeType attType = metadata.getAttributeType(key);
 718     if (attType != null
 719             && (attType == FeatureAttributeType.Float || attType
 720                     .equals(FeatureAttributeType.Integer)))
 721     {
 722       try
 723       {
 724         float fval = Float.valueOf(value);
 725         if (fval == 0f)
 726         {
 727           return false;
 728         }
 729       } catch (NumberFormatException e)
 730       {
 731         // ignore
 732       }
 733     }
 734
 735     return true; // default to interesting
 736   }
 737
 738   /**
 739    * Sets the feature source identifier
 740    *
 741    * @param theSource
 742    */
 743   public void setSource(String theSource)
 744   {
 745     source = theSource;
 746   }
 747 }
 748
 749 class SFSortByEnd implements Comparator<SequenceFeature>
 750 {
 751   @Override
 752   public int compare(SequenceFeature a, SequenceFeature b)
 753   {
 754     return a.getEnd() - b.getEnd();
 755   }
 756 }
 757
 758 class SFSortByBegin implements Comparator<SequenceFeature>
 759 {
 760   @Override
 761   public int compare(SequenceFeature a, SequenceFeature b)
 762   {
 763     return a.getBegin() - b.getBegin();
 764   }
 765 }