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