src/jalview/ext/ensembl/EnsemblSeqProxy.java

   1 package jalview.ext.ensembl;
   2
   3 import jalview.analysis.AlignmentUtils;
   4 import jalview.datamodel.Alignment;
   5 import jalview.datamodel.AlignmentI;
   6 import jalview.datamodel.DBRefEntry;
   7 import jalview.datamodel.DBRefSource;
   8 import jalview.datamodel.Mapping;
   9 import jalview.datamodel.SequenceFeature;
  10 import jalview.datamodel.SequenceI;
  11 import jalview.exceptions.JalviewException;
  12 import jalview.io.FastaFile;
  13 import jalview.io.FileParse;
  14 import jalview.io.gff.SequenceOntologyFactory;
  15 import jalview.io.gff.SequenceOntologyI;
  16 import jalview.schemes.ResidueProperties;
  17 import jalview.util.DBRefUtils;
  18 import jalview.util.MapList;
  19 import jalview.util.MappingUtils;
  20 import jalview.util.StringUtils;
  21
  22 import java.io.IOException;
  23 import java.net.MalformedURLException;
  24 import java.net.URL;
  25 import java.util.ArrayList;
  26 import java.util.Arrays;
  27 import java.util.Collections;
  28 import java.util.Comparator;
  29 import java.util.LinkedHashMap;
  30 import java.util.List;
  31 import java.util.Map.Entry;
  32
  33 /**
  34  * Base class for Ensembl sequence fetchers
  35  *
  36  * @author gmcarstairs
  37  */
  38 public abstract class EnsemblSeqProxy extends EnsemblRestClient
  39 {
  40   private static final List<String> CROSS_REFERENCES = Arrays
  41           .asList(new String[] { "CCDS" });
  42
  43   protected static final String CONSEQUENCE_TYPE = "consequence_type";
  44
  45   protected static final String PARENT = "Parent";
  46
  47   protected static final String ID = "ID";
  48
  49   protected static final String NAME = "Name";
  50
  51   /*
  52    * enum for 'type' parameter to the /sequence REST service
  53    */
  54   public enum EnsemblSeqType
  55   {
  56     /**
  57      * type=genomic to fetch full dna including introns
  58      */
  59     GENOMIC("genomic"),
  60
  61     /**
  62      * type=cdna to fetch dna including UTRs
  63      */
  64     CDNA("cdna"),
  65
  66     /**
  67      * type=cds to fetch coding dna excluding UTRs
  68      */
  69     CDS("cds"),
  70
  71     /**
  72      * type=protein to fetch peptide product sequence
  73      */
  74     PROTEIN("protein");
  75
  76     /*
  77      * the value of the 'type' parameter to fetch this version of
  78      * an Ensembl sequence
  79      */
  80     private String type;
  81
  82     EnsemblSeqType(String t)
  83     {
  84       type = t;
  85     }
  86
  87     public String getType()
  88     {
  89       return type;
  90     }
  91
  92   }
  93
  94   /**
  95    * A comparator to sort ranges into ascending start position order
  96    */
  97   private class RangeSorter implements Comparator<int[]>
  98   {
  99     boolean forwards;
 100
 101     RangeSorter(boolean forward)
 102     {
 103       forwards = forward;
 104     }
 105
 106     @Override
 107     public int compare(int[] o1, int[] o2)
 108     {
 109       return (forwards ? 1 : -1) * Integer.compare(o1[0], o2[0]);
 110     }
 111
 112   }
 113
 114   /**
 115    * Constructor
 116    */
 117   public EnsemblSeqProxy()
 118   {
 119   }
 120
 121   /**
 122    * Makes the sequence queries to Ensembl's REST service and returns an
 123    * alignment consisting of the returned sequences.
 124    */
 125   @Override
 126   public AlignmentI getSequenceRecords(String query) throws Exception
 127   {
 128     // TODO use a String... query vararg instead?
 129
 130     // danger: accession separator used as a regex here, a string elsewhere
 131     // in this case it is ok (it is just a space), but (e.g.) '\' would not be
 132     List<String> allIds = Arrays.asList(query
 133             .split(getAccessionSeparator()));
 134     AlignmentI alignment = null;
 135     inProgress = true;
 136
 137     /*
 138      * execute queries, if necessary in batches of the
 139      * maximum allowed number of ids
 140      */
 141     int maxQueryCount = getMaximumQueryCount();
 142     for (int v = 0, vSize = allIds.size(); v < vSize; v += maxQueryCount)
 143     {
 144       int p = Math.min(vSize, v + maxQueryCount);
 145       List<String> ids = allIds.subList(v, p);
 146       try
 147       {
 148         alignment = fetchSequences(ids, alignment);
 149       } catch (Throwable r)
 150       {
 151         inProgress = false;
 152         String msg = "Aborting ID retrieval after " + v
 153                 + " chunks. Unexpected problem (" + r.getLocalizedMessage()
 154                 + ")";
 155         System.err.println(msg);
 156         break;
 157         // if (alignment != null)
 158         // {
 159         // break; // return what we got
 160         // }
 161         // else
 162         // {
 163         // throw new JalviewException(msg, r);
 164         // }
 165       }
 166     }
 167
 168     /*
 169      * fetch and transfer genomic sequence features,
 170      * fetch protein product and add as cross-reference
 171      */
 172     for (String accId : allIds)
 173     {
 174       addFeaturesAndProduct(accId, alignment);
 175     }
 176
 177     for (SequenceI seq : alignment.getSequences())
 178     {
 179       getCrossReferences(seq);
 180     }
 181
 182     return alignment;
 183   }
 184
 185   /**
 186    * Fetches Ensembl features using the /overlap REST endpoint, and adds them to
 187    * the sequence in the alignment. Also fetches the protein product, maps it
 188    * from the CDS features of the sequence, and saves it as a cross-reference of
 189    * the dna sequence.
 190    *
 191    * @param accId
 192    * @param alignment
 193    */
 194   protected void addFeaturesAndProduct(String accId, AlignmentI alignment)
 195   {
 196     if (alignment == null)
 197     {
 198       return;
 199     }
 200
 201     try
 202     {
 203       /*
 204        * get 'dummy' genomic sequence with exon, cds and variation features
 205        */
 206       SequenceI genomicSequence = null;
 207       EnsemblFeatures gffFetcher = new EnsemblFeatures();
 208       EnsemblFeatureType[] features = getFeaturesToFetch();
 209       AlignmentI geneFeatures = gffFetcher.getSequenceRecords(accId,
 210               features);
 211       if (geneFeatures.getHeight() > 0)
 212       {
 213         genomicSequence = geneFeatures.getSequenceAt(0);
 214       }
 215       if (genomicSequence != null)
 216       {
 217         /*
 218          * transfer features to the query sequence
 219          */
 220         SequenceI querySeq = alignment.findName(accId);
 221         if (transferFeatures(accId, genomicSequence, querySeq))
 222         {
 223
 224           /*
 225            * fetch and map protein product, and add it as a cross-reference
 226            * of the retrieved sequence
 227            */
 228           addProteinProduct(querySeq);
 229         }
 230       }
 231     } catch (IOException e)
 232     {
 233       System.err.println("Error transferring Ensembl features: "
 234               + e.getMessage());
 235     }
 236   }
 237
 238   /**
 239    * Returns those sequence feature types to fetch from Ensembl. We may want
 240    * features either because they are of interest to the user, or as means to
 241    * identify the locations of the sequence on the genomic sequence (CDS
 242    * features identify CDS, exon features identify cDNA etc).
 243    *
 244    * @return
 245    */
 246   protected abstract EnsemblFeatureType[] getFeaturesToFetch();
 247
 248   /**
 249    * Fetches and maps the protein product, and adds it as a cross-reference of
 250    * the retrieved sequence
 251    */
 252   protected void addProteinProduct(SequenceI querySeq)
 253   {
 254     String accId = querySeq.getName();
 255     try
 256     {
 257       AlignmentI protein = new EnsemblProtein().getSequenceRecords(accId);
 258       if (protein == null || protein.getHeight() == 0)
 259       {
 260         System.out.println("Failed to retrieve protein for " + accId);
 261         return;
 262       }
 263       SequenceI proteinSeq = protein.getSequenceAt(0);
 264
 265       /*
 266        * need dataset sequences (to be the subject of mappings)
 267        */
 268       proteinSeq.createDatasetSequence();
 269       querySeq.createDatasetSequence();
 270
 271       MapList mapList = mapCdsToProtein(querySeq, proteinSeq);
 272       if (mapList != null)
 273       {
 274         // clunky: ensure Uniprot xref if we have one is on mapped sequence
 275         SequenceI ds = proteinSeq.getDatasetSequence();
 276         ds.setSourceDBRef(proteinSeq.getSourceDBRef());
 277         Mapping map = new Mapping(ds, mapList);
 278         DBRefEntry dbr = new DBRefEntry(getDbSource(), getDbVersion(),
 279                 accId, map);
 280         querySeq.getDatasetSequence().addDBRef(dbr);
 281
 282         /*
 283          * compute peptide variants from dna variants and add as
 284          * sequence features on the protein sequence ta-da
 285          */
 286         computeProteinFeatures(querySeq, proteinSeq, mapList);
 287       }
 288     } catch (Exception e)
 289     {
 290       System.err
 291               .println(String.format("Error retrieving protein for %s: %s",
 292                       accId, e.getMessage()));
 293     }
 294   }
 295
 296   /**
 297    * Get Uniprot and PDB xrefs from Ensembl, and attach them to the protein
 298    * sequence
 299    *
 300    * @param seq
 301    */
 302   protected void getCrossReferences(SequenceI seq)
 303   {
 304     while (seq.getDatasetSequence() != null)
 305     {
 306       seq = seq.getDatasetSequence();
 307     }
 308
 309     EnsemblXref xrefFetcher = new EnsemblXref();
 310     List<DBRefEntry> xrefs = xrefFetcher.getCrossReferences(seq.getName(),
 311             getCrossReferenceDatabases());
 312     for (DBRefEntry xref : xrefs)
 313     {
 314       seq.addDBRef(xref);
 315       /*
 316        * Save any Uniprot xref to be the reference for SIFTS mapping
 317        */
 318       if (DBRefSource.UNIPROT.equals(xref.getSource()))
 319       {
 320         seq.setSourceDBRef(xref);
 321       }
 322     }
 323   }
 324
 325   /**
 326    * Returns a list of database names to be used when fetching cross-references.
 327    *
 328    * @return
 329    */
 330   protected List<String> getCrossReferenceDatabases()
 331   {
 332     return CROSS_REFERENCES;
 333   }
 334
 335   /**
 336    * Returns a mapping from dna to protein by inspecting sequence features of
 337    * type "CDS" on the dna.
 338    *
 339    * @param dnaSeq
 340    * @param proteinSeq
 341    * @return
 342    */
 343   protected MapList mapCdsToProtein(SequenceI dnaSeq, SequenceI proteinSeq)
 344   {
 345     List<int[]> ranges = new ArrayList<int[]>(50);
 346
 347     int mappedDnaLength = getCdsRanges(dnaSeq, ranges);
 348
 349     int proteinLength = proteinSeq.getLength();
 350     List<int[]> proteinRange = new ArrayList<int[]>();
 351     int proteinStart = 1;
 352
 353     /*
 354      * incomplete start codon may mean X at start of peptide
 355      * we ignore both for mapping purposes
 356      */
 357     if (proteinSeq.getCharAt(0) == 'X')
 358     {
 359       proteinStart = 2;
 360       proteinLength--;
 361     }
 362     proteinRange.add(new int[] { proteinStart, proteinLength });
 363
 364     /*
 365      * dna length should map to protein (or protein plus stop codon)
 366      */
 367     int codesForResidues = mappedDnaLength / 3;
 368     if (codesForResidues == proteinLength
 369             || codesForResidues == (proteinLength + 1))
 370     {
 371       return new MapList(ranges, proteinRange, 3, 1);
 372     }
 373     return null;
 374   }
 375
 376   /**
 377    * Adds CDS ranges to the ranges list, and returns the total length mapped
 378    * from.
 379    *
 380    * No need to worry about reverse strand dna, here since the retrieved
 381    * sequence is as transcribed (reverse complement for reverse strand), i.e in
 382    * the same sense as the peptide.
 383    *
 384    * @param dnaSeq
 385    * @param ranges
 386    * @return
 387    */
 388   protected int getCdsRanges(SequenceI dnaSeq, List<int[]> ranges)
 389   {
 390     SequenceFeature[] sfs = dnaSeq.getSequenceFeatures();
 391     if (sfs == null)
 392     {
 393       return 0;
 394     }
 395     int mappedDnaLength = 0;
 396     for (SequenceFeature sf : sfs)
 397     {
 398       /*
 399        * process a CDS feature (or a sub-type of CDS)
 400        */
 401       if (SequenceOntologyFactory.getInstance().isA(sf.getType(),
 402               SequenceOntologyI.CDS))
 403       {
 404         int phase = 0;
 405         try {
 406           phase = Integer.parseInt(sf.getPhase());
 407         } catch (NumberFormatException e)
 408         {
 409           // ignore
 410         }
 411         /*
 412          * phase > 0 on first codon means 5' incomplete - skip to the start
 413          * of the next codon; example ENST00000496384
 414          */
 415         int begin = sf.getBegin();
 416         int end = sf.getEnd();
 417         if (ranges.isEmpty() && phase > 0)
 418         {
 419           begin += phase;
 420           if (begin > end)
 421           {
 422             continue; // shouldn't happen?
 423           }
 424         }
 425         ranges.add(new int[] { begin, end });
 426         mappedDnaLength += Math.abs(end - begin) + 1;
 427       }
 428     }
 429     return mappedDnaLength;
 430   }
 431
 432   /**
 433    * Fetches sequences for the list of accession ids and adds them to the
 434    * alignment. Returns the extended (or created) alignment.
 435    *
 436    * @param ids
 437    * @param alignment
 438    * @return
 439    * @throws JalviewException
 440    * @throws IOException
 441    */
 442   protected AlignmentI fetchSequences(List<String> ids, AlignmentI alignment)
 443           throws JalviewException, IOException
 444   {
 445     if (!isEnsemblAvailable())
 446     {
 447       inProgress = false;
 448       throw new JalviewException("ENSEMBL Rest API not available.");
 449     }
 450     FileParse fp = getSequenceReader(ids);
 451     FastaFile fr = new FastaFile(fp);
 452     if (fr.hasWarningMessage())
 453     {
 454       System.out.println(String.format(
 455               "Warning when retrieving %d ids %s\n%s", ids.size(),
 456               ids.toString(), fr.getWarningMessage()));
 457     }
 458     else if (fr.getSeqs().size() != ids.size())
 459     {
 460       System.out.println(String.format(
 461               "Only retrieved %d sequences for %d query strings", fr
 462                       .getSeqs().size(), ids.size()));
 463     }
 464
 465     if (fr.getSeqs().size() == 1 && fr.getSeqs().get(0).getLength() == 0)
 466     {
 467       /*
 468        * POST request has returned an empty FASTA file e.g. for invalid id
 469        */
 470       throw new IOException("No data returned for " + ids);
 471     }
 472
 473     if (fr.getSeqs().size() > 0)
 474     {
 475       AlignmentI seqal = new Alignment(
 476               fr.getSeqsAsArray());
 477       for (SequenceI sq:seqal.getSequences())
 478       {
 479         if (sq.getDescription() == null)
 480         {
 481           sq.setDescription(getDbName());
 482         }
 483         String name = sq.getName();
 484         if (ids.contains(name)
 485                 || ids.contains(name.replace("ENSP", "ENST")))
 486         {
 487           DBRefUtils.parseToDbRef(sq, DBRefSource.ENSEMBL, "0", name);
 488         }
 489       }
 490       if (alignment == null)
 491       {
 492         alignment = seqal;
 493       }
 494       else
 495       {
 496         alignment.append(seqal);
 497       }
 498     }
 499     return alignment;
 500   }
 501
 502   /**
 503    * Returns the URL for the REST call
 504    *
 505    * @return
 506    * @throws MalformedURLException
 507    */
 508   @Override
 509   protected URL getUrl(List<String> ids) throws MalformedURLException
 510   {
 511     /*
 512      * a single id is included in the URL path
 513      * multiple ids go in the POST body instead
 514      */
 515     StringBuffer urlstring = new StringBuffer(128);
 516     urlstring.append(SEQUENCE_ID_URL);
 517     if (ids.size() == 1)
 518     {
 519       urlstring.append("/").append(ids.get(0));
 520     }
 521     // @see https://github.com/Ensembl/ensembl-rest/wiki/Output-formats
 522     urlstring.append("?type=").append(getSourceEnsemblType().getType());
 523     urlstring.append(("&Accept=text/x-fasta"));
 524
 525     URL url = new URL(urlstring.toString());
 526     return url;
 527   }
 528
 529   /**
 530    * A sequence/id POST request currently allows up to 50 queries
 531    *
 532    * @see http://rest.ensembl.org/documentation/info/sequence_id_post
 533    */
 534   @Override
 535   public int getMaximumQueryCount()
 536   {
 537     return 50;
 538   }
 539
 540   @Override
 541   protected boolean useGetRequest()
 542   {
 543     return false;
 544   }
 545
 546   @Override
 547   protected String getRequestMimeType(boolean multipleIds)
 548   {
 549     return multipleIds ? "application/json" : "text/x-fasta";
 550   }
 551
 552   @Override
 553   protected String getResponseMimeType()
 554   {
 555     return "text/x-fasta";
 556   }
 557
 558   /**
 559    *
 560    * @return the configured sequence return type for this source
 561    */
 562   protected abstract EnsemblSeqType getSourceEnsemblType();
 563
 564   /**
 565    * Returns a list of [start, end] genomic ranges corresponding to the sequence
 566    * being retrieved.
 567    *
 568    * The correspondence between the frames of reference is made by locating
 569    * those features on the genomic sequence which identify the retrieved
 570    * sequence. Specifically
 571    * <ul>
 572    * <li>genomic sequence is identified by "transcript" features with
 573    * ID=transcript:transcriptId</li>
 574    * <li>cdna sequence is identified by "exon" features with
 575    * Parent=transcript:transcriptId</li>
 576    * <li>cds sequence is identified by "CDS" features with
 577    * Parent=transcript:transcriptId</li>
 578    * </ul>
 579    *
 580    * The returned ranges are sorted to run forwards (for positive strand) or
 581    * backwards (for negative strand). Aborts and returns null if both positive
 582    * and negative strand are found (this should not normally happen).
 583    *
 584    * @param sourceSequence
 585    * @param accId
 586    * @param start
 587    *          the start position of the sequence we are mapping to
 588    * @return
 589    */
 590   protected MapList getGenomicRangesFromFeatures(SequenceI sourceSequence,
 591           String accId, int start)
 592   {
 593     SequenceFeature[] sfs = sourceSequence.getSequenceFeatures();
 594     if (sfs == null)
 595     {
 596       return null;
 597     }
 598
 599     /*
 600      * generously initial size for number of cds regions
 601      * (worst case titin Q8WZ42 has c. 313 exons)
 602      */
 603     List<int[]> regions = new ArrayList<int[]>(100);
 604     int mappedLength = 0;
 605     int direction = 1; // forward
 606     boolean directionSet = false;
 607
 608     for (SequenceFeature sf : sfs)
 609     {
 610       /*
 611        * accept the target feature type or a specialisation of it
 612        * (e.g. coding_exon for exon)
 613        */
 614       if (identifiesSequence(sf, accId))
 615       {
 616         int strand = sf.getStrand();
 617         strand = strand == 0 ? 1 : strand; // treat unknown as forward
 618
 619         if (directionSet && strand != direction)
 620         {
 621           // abort - mix of forward and backward
 622           System.err.println("Error: forward and backward strand for "
 623                   + accId);
 624             return null;
 625           }
 626           direction = strand;
 627           directionSet = true;
 628
 629           /*
 630            * add to CDS ranges, semi-sorted forwards/backwards
 631            */
 632           if (strand < 0)
 633           {
 634             regions.add(0, new int[] { sf.getEnd(), sf.getBegin() });
 635           }
 636           else
 637           {
 638           regions.add(new int[] { sf.getBegin(), sf.getEnd() });
 639         }
 640         mappedLength += Math.abs(sf.getEnd() - sf.getBegin() + 1);
 641
 642         if (!isSpliceable())
 643         {
 644           /*
 645            * 'gene' sequence is contiguous so we can stop as soon as its
 646            * identifying feature has been found
 647            */
 648           break;
 649         }
 650       }
 651     }
 652
 653     if (regions.isEmpty())
 654     {
 655       System.out.println("Failed to identify target sequence for " + accId
 656               + " from genomic features");
 657       return null;
 658     }
 659
 660     /*
 661      * a final sort is needed since Ensembl returns CDS sorted within source
 662      * (havana / ensembl_havana)
 663      */
 664     Collections.sort(regions, new RangeSorter(direction == 1));
 665
 666     List<int[]> to = Arrays.asList(new int[] { start,
 667         start + mappedLength - 1 });
 668
 669     return new MapList(regions, to, 1, 1);
 670   }
 671
 672   /**
 673    * Answers true if the sequence being retrieved may occupy discontiguous
 674    * regions on the genomic sequence.
 675    */
 676   protected boolean isSpliceable()
 677   {
 678     return true;
 679   }
 680
 681   /**
 682    * Returns true if the sequence feature marks positions of the genomic
 683    * sequence feature which are within the sequence being retrieved. For
 684    * example, an 'exon' feature whose parent is the target transcript marks the
 685    * cdna positions of the transcript.
 686    *
 687    * @param sf
 688    * @param accId
 689    * @return
 690    */
 691   protected abstract boolean identifiesSequence(SequenceFeature sf,
 692           String accId);
 693
 694   /**
 695    * Transfers the sequence feature to the target sequence, locating its start
 696    * and end range based on the mapping. Features which do not overlap the
 697    * target sequence are ignored.
 698    *
 699    * @param sf
 700    * @param targetSequence
 701    * @param mapping
 702    *          mapping from the sequence feature's coordinates to the target
 703    *          sequence
 704    */
 705   protected void transferFeature(SequenceFeature sf,
 706           SequenceI targetSequence, MapList mapping)
 707   {
 708     int start = sf.getBegin();
 709     int end = sf.getEnd();
 710     int[] mappedRange = mapping.locateInTo(start, end);
 711
 712     if (mappedRange != null)
 713     {
 714       SequenceFeature copy = new SequenceFeature(sf);
 715       copy.setBegin(Math.min(mappedRange[0], mappedRange[1]));
 716       copy.setEnd(Math.max(mappedRange[0], mappedRange[1]));
 717       targetSequence.addSequenceFeature(copy);
 718
 719       /*
 720        * for sequence_variant, make an additional feature with consequence
 721        */
 722       if (SequenceOntologyFactory.getInstance().isA(sf.getType(),
 723               SequenceOntologyI.SEQUENCE_VARIANT))
 724       {
 725         String consequence = (String) sf.getValue(CONSEQUENCE_TYPE);
 726         if (consequence != null)
 727         {
 728           SequenceFeature sf2 = new SequenceFeature("consequence",
 729                   consequence, copy.getBegin(), copy.getEnd(), 0f,
 730                   null);
 731           targetSequence.addSequenceFeature(sf2);
 732         }
 733       }
 734     }
 735   }
 736
 737   /**
 738    * Transfers features from sourceSequence to targetSequence
 739    *
 740    * @param accessionId
 741    * @param sourceSequence
 742    * @param targetSequence
 743    * @return true if any features were transferred, else false
 744    */
 745   protected boolean transferFeatures(String accessionId,
 746           SequenceI sourceSequence, SequenceI targetSequence)
 747   {
 748     if (sourceSequence == null || targetSequence == null)
 749     {
 750       return false;
 751     }
 752
 753     SequenceFeature[] sfs = sourceSequence.getSequenceFeatures();
 754     MapList mapping = getGenomicRangesFromFeatures(sourceSequence, accessionId,
 755             targetSequence.getStart());
 756     if (mapping == null)
 757     {
 758       return false;
 759     }
 760
 761     return transferFeatures(sfs, targetSequence, mapping, accessionId);
 762   }
 763
 764   /**
 765    * Transfer features to the target sequence. The start/end positions are
 766    * converted using the mapping. Features which do not overlap are ignored.
 767    * Features whose parent is not the specified identifier are also ignored.
 768    *
 769    * @param features
 770    * @param targetSequence
 771    * @param mapping
 772    * @param parentId
 773    * @return
 774    */
 775   protected boolean transferFeatures(SequenceFeature[] features,
 776           SequenceI targetSequence, MapList mapping, String parentId)
 777   {
 778     final boolean forwardStrand = mapping.isFromForwardStrand();
 779
 780     /*
 781      * sort features by start position (descending if reverse strand)
 782      * before transferring (in forwards order) to the target sequence
 783      */
 784     Arrays.sort(features, new Comparator<SequenceFeature>()
 785     {
 786       @Override
 787       public int compare(SequenceFeature o1, SequenceFeature o2)
 788       {
 789         int c = Integer.compare(o1.getBegin(), o2.getBegin());
 790         return forwardStrand ? c : -c;
 791       }
 792     });
 793
 794     boolean transferred = false;
 795     for (SequenceFeature sf : features)
 796     {
 797       if (retainFeature(sf, parentId))
 798       {
 799         transferFeature(sf, targetSequence, mapping);
 800         transferred = true;
 801       }
 802     }
 803     return transferred;
 804   }
 805
 806   /**
 807    * Answers true if the feature type is one we want to keep for the sequence.
 808    * Some features are only retrieved in order to identify the sequence range,
 809    * and may then be discarded as redundant information (e.g. "CDS" feature for
 810    * a CDS sequence).
 811    */
 812   @SuppressWarnings("unused")
 813   protected boolean retainFeature(SequenceFeature sf, String accessionId)
 814   {
 815     return true; // override as required
 816   }
 817
 818   /**
 819    * Answers true if the feature has a Parent which refers to the given
 820    * accession id, or if the feature has no parent. Answers false if the
 821    * feature's Parent is for a different accession id.
 822    *
 823    * @param sf
 824    * @param identifier
 825    * @return
 826    */
 827   protected boolean featureMayBelong(SequenceFeature sf, String identifier)
 828   {
 829     String parent = (String) sf.getValue(PARENT);
 830     // using contains to allow for prefix "gene:", "transcript:" etc
 831     if (parent != null && !parent.contains(identifier))
 832     {
 833       // this genomic feature belongs to a different transcript
 834       return false;
 835     }
 836     return true;
 837   }
 838
 839   @Override
 840   public String getDescription()
 841   {
 842     return "Ensembl " + getSourceEnsemblType().getType()
 843             + " sequence with variant features";
 844   }
 845
 846   /**
 847    * Returns a (possibly empty) list of features on the sequence which have the
 848    * specified sequence ontology type (or a sub-type of it), and the given
 849    * identifier as parent
 850    *
 851    * @param sequence
 852    * @param type
 853    * @param parentId
 854    * @return
 855    */
 856   protected List<SequenceFeature> findFeatures(SequenceI sequence,
 857           String type, String parentId)
 858   {
 859     List<SequenceFeature> result = new ArrayList<SequenceFeature>();
 860
 861     SequenceFeature[] sfs = sequence.getSequenceFeatures();
 862     if (sfs != null) {
 863       SequenceOntologyI so = SequenceOntologyFactory.getInstance();
 864       for (SequenceFeature sf :sfs) {
 865         if (so.isA(sf.getType(), type))
 866         {
 867           String parent = (String) sf.getValue(PARENT);
 868           if (parent.equals(parentId))
 869           {
 870             result.add(sf);
 871           }
 872         }
 873       }
 874     }
 875     return result;
 876   }
 877
 878   /**
 879    * Maps exon features from dna to protein, and computes variants in peptide
 880    * product generated by variants in dna, and adds them as sequence_variant
 881    * features on the protein sequence. Returns the number of variant features
 882    * added.
 883    *
 884    * @param dnaSeq
 885    * @param peptide
 886    * @param dnaToProtein
 887    */
 888   static int computeProteinFeatures(SequenceI dnaSeq,
 889           SequenceI peptide, MapList dnaToProtein)
 890   {
 891     while (dnaSeq.getDatasetSequence() != null)
 892     {
 893       dnaSeq = dnaSeq.getDatasetSequence();
 894     }
 895     while (peptide.getDatasetSequence() != null)
 896     {
 897       peptide = peptide.getDatasetSequence();
 898     }
 899
 900     AlignmentUtils.transferFeatures(dnaSeq, peptide, dnaToProtein,
 901             SequenceOntologyI.EXON);
 902
 903     LinkedHashMap<Integer, String[][]> variants = buildDnaVariantsMap(
 904             dnaSeq, dnaToProtein);
 905
 906     /*
 907      * scan codon variations, compute peptide variants and add to peptide sequence
 908      */
 909     int count = 0;
 910     for (Entry<Integer, String[][]> variant : variants.entrySet())
 911     {
 912       int peptidePos = variant.getKey();
 913       String[][] codonVariants = variant.getValue();
 914       String residue = String.valueOf(peptide.getCharAt(peptidePos - 1)); // 0-based
 915       List<String> peptideVariants = computePeptideVariants(codonVariants,
 916               residue);
 917       if (!peptideVariants.isEmpty())
 918       {
 919         String desc = StringUtils.listToDelimitedString(peptideVariants,
 920                 ", ");
 921         SequenceFeature sf = new SequenceFeature(
 922                 SequenceOntologyI.SEQUENCE_VARIANT, desc, peptidePos,
 923                 peptidePos, 0f, null);
 924         peptide.addSequenceFeature(sf);
 925         count++;
 926       }
 927     }
 928
 929     /*
 930      * ugly sort to get sequence features in start position order
 931      * - would be better to store in Sequence as a TreeSet instead?
 932      */
 933     Arrays.sort(peptide.getSequenceFeatures(),
 934             new Comparator<SequenceFeature>()
 935             {
 936               @Override
 937               public int compare(SequenceFeature o1, SequenceFeature o2)
 938               {
 939                 int c = Integer.compare(o1.getBegin(), o2.getBegin());
 940                 return c == 0 ? Integer.compare(o1.getEnd(), o2.getEnd())
 941                         : c;
 942               }
 943             });
 944     return count;
 945   }
 946
 947   /**
 948    * Builds a map whose key is position in the protein sequence, and value is an
 949    * array of all variants for the coding codon positions
 950    *
 951    * @param dnaSeq
 952    * @param dnaToProtein
 953    * @return
 954    */
 955   static LinkedHashMap<Integer, String[][]> buildDnaVariantsMap(
 956           SequenceI dnaSeq, MapList dnaToProtein)
 957   {
 958     /*
 959      * map from peptide position to all variant features of the codon for it
 960      * LinkedHashMap ensures we add the peptide features in sequence order
 961      */
 962     LinkedHashMap<Integer, String[][]> variants = new LinkedHashMap<Integer, String[][]>();
 963     SequenceOntologyI so = SequenceOntologyFactory.getInstance();
 964
 965     SequenceFeature[] dnaFeatures = dnaSeq.getSequenceFeatures();
 966     if (dnaFeatures == null)
 967     {
 968       return variants;
 969     }
 970
 971     int dnaStart = dnaSeq.getStart();
 972     int[] lastCodon = null;
 973     int lastPeptidePostion = 0;
 974
 975     /*
 976      * build a map of codon variations for peptides
 977      */
 978     for (SequenceFeature sf : dnaFeatures)
 979     {
 980       int dnaCol = sf.getBegin();
 981       if (dnaCol != sf.getEnd())
 982       {
 983         // not handling multi-locus variant features
 984         continue;
 985       }
 986       if (so.isA(sf.getType(), SequenceOntologyI.SEQUENCE_VARIANT))
 987       {
 988         int[] mapsTo = dnaToProtein.locateInTo(dnaCol, dnaCol);
 989         if (mapsTo == null)
 990         {
 991           // feature doesn't lie within coding region
 992           continue;
 993         }
 994         int peptidePosition = mapsTo[0];
 995         String[][] codonVariants = variants.get(peptidePosition);
 996         if (codonVariants == null)
 997         {
 998           codonVariants = new String[3][];
 999           variants.put(peptidePosition, codonVariants);
1000         }
1001
1002         /*
1003          * extract dna variants to a string array
1004          */
1005         String alls = (String) sf.getValue("alleles");
1006         if (alls == null)
1007         {
1008           continue;
1009         }
1010         String[] alleles = alls.split(",");
1011
1012         /*
1013          * get this peptides codon positions e.g. [3, 4, 5] or [4, 7, 10]
1014          */
1015         int[] codon = peptidePosition == lastPeptidePostion ? lastCodon
1016                 : MappingUtils.flattenRanges(dnaToProtein.locateInFrom(
1017                         peptidePosition, peptidePosition));
1018         lastPeptidePostion = peptidePosition;
1019         lastCodon = codon;
1020
1021         /*
1022          * save nucleotide (and this variant) for each codon position
1023          */
1024         for (int codonPos = 0; codonPos < 3; codonPos++)
1025         {
1026           String nucleotide = String.valueOf(dnaSeq
1027                   .getCharAt(codon[codonPos] - dnaStart));
1028           if (codon[codonPos] == dnaCol)
1029           {
1030             /*
1031              * record current dna base and its alleles
1032              */
1033             String[] dnaVariants = new String[alleles.length + 1];
1034             dnaVariants[0] = nucleotide;
1035             System.arraycopy(alleles, 0, dnaVariants, 1, alleles.length);
1036             codonVariants[codonPos] = dnaVariants;
1037           }
1038           else if (codonVariants[codonPos] == null)
1039           {
1040             /*
1041              * record current dna base only
1042              * (at least until we find any variation and overwrite it)
1043              */
1044             codonVariants[codonPos] = new String[] { nucleotide };
1045           }
1046         }
1047       }
1048     }
1049     return variants;
1050   }
1051
1052   /**
1053    * Returns a sorted, non-redundant list of all peptide translations generated
1054    * by the given dna variants, excluding the current residue value
1055    *
1056    * @param codonVariants
1057    *          an array of base values (acgtACGT) for codon positions 1, 2, 3
1058    * @param residue
1059    *          the current residue translation
1060    * @return
1061    */
1062   static List<String> computePeptideVariants(
1063           String[][] codonVariants, String residue)
1064   {
1065     List<String> result = new ArrayList<String>();
1066     for (String base1 : codonVariants[0])
1067     {
1068       for (String base2 : codonVariants[1])
1069       {
1070         for (String base3 : codonVariants[2])
1071         {
1072           String codon = base1 + base2 + base3;
1073           // TODO: report frameshift/insertion/deletion
1074           // and multiple-base variants?!
1075           String peptide = codon.contains("-") ? "-" : ResidueProperties
1076                   .codonTranslate(codon);
1077           if (peptide != null && !result.contains(peptide)
1078                   && !peptide.equalsIgnoreCase(residue))
1079           {
1080             result.add(peptide);
1081           }
1082         }
1083       }
1084     }
1085
1086     /*
1087      * sort alphabetically with STOP at the end
1088      */
1089     Collections.sort(result, new Comparator<String>()
1090     {
1091
1092       @Override
1093       public int compare(String o1, String o2)
1094       {
1095         if ("STOP".equals(o1))
1096         {
1097           return 1;
1098         }
1099         else if ("STOP".equals(o2))
1100         {
1101           return -1;
1102         }
1103         else
1104         {
1105           return o1.compareTo(o2);
1106         }
1107       }
1108     });
1109     return result;
1110   }
1111
1112   /**
1113    * Answers true if the feature type is either 'NMD_transcript_variant' or
1114    * 'transcript' or one of its sub-types in the Sequence Ontology. This is
1115    * needed because NMD_transcript_variant behaves like 'transcript' in Ensembl
1116    * although strictly speaking it is not (it is a sub-type of
1117    * sequence_variant).
1118    *
1119    * @param featureType
1120    * @return
1121    */
1122   public static boolean isTranscript(String featureType)
1123   {
1124     return SequenceOntologyI.NMD_TRANSCRIPT_VARIANT.equals(featureType)
1125             || SequenceOntologyFactory.getInstance().isA(featureType,
1126                     SequenceOntologyI.TRANSCRIPT);
1127   }
1128 }