JAL-2321 ensure default is ‘parseImmediately=true’
[jalview.git] / src / jalview / ext / ensembl / EnsemblGene.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.ext.ensembl;
22
23 import jalview.api.FeatureColourI;
24 import jalview.api.FeatureSettingsModelI;
25 import jalview.datamodel.AlignmentI;
26 import jalview.datamodel.Sequence;
27 import jalview.datamodel.SequenceFeature;
28 import jalview.datamodel.SequenceI;
29 import jalview.datamodel.features.SequenceFeatures;
30 import jalview.io.gff.SequenceOntologyFactory;
31 import jalview.io.gff.SequenceOntologyI;
32 import jalview.schemes.FeatureColour;
33 import jalview.schemes.FeatureSettingsAdapter;
34 import jalview.util.MapList;
35
36 import java.awt.Color;
37 import java.io.UnsupportedEncodingException;
38 import java.net.URLDecoder;
39 import java.util.ArrayList;
40 import java.util.Arrays;
41 import java.util.List;
42
43 import com.stevesoft.pat.Regex;
44
45 /**
46  * A class that fetches genomic sequence and all transcripts for an Ensembl gene
47  * 
48  * @author gmcarstairs
49  */
50 public class EnsemblGene extends EnsemblSeqProxy
51 {
52   private static final String GENE_PREFIX = "gene:";
53
54   /*
55    * accepts anything as we will attempt lookup of gene or 
56    * transcript id or gene name
57    */
58   private static final Regex ACCESSION_REGEX = new Regex(".*");
59
60   private static final EnsemblFeatureType[] FEATURES_TO_FETCH = {
61       EnsemblFeatureType.gene, EnsemblFeatureType.transcript,
62       EnsemblFeatureType.exon, EnsemblFeatureType.cds,
63       EnsemblFeatureType.variation };
64
65   /**
66    * Default constructor (to use rest.ensembl.org)
67    */
68   public EnsemblGene()
69   {
70     super();
71   }
72
73   /**
74    * Constructor given the target domain to fetch data from
75    * 
76    * @param d
77    */
78   public EnsemblGene(String d)
79   {
80     super(d);
81   }
82
83   @Override
84   public String getDbName()
85   {
86     return "ENSEMBL";
87   }
88
89   @Override
90   protected EnsemblFeatureType[] getFeaturesToFetch()
91   {
92     return FEATURES_TO_FETCH;
93   }
94
95   @Override
96   protected EnsemblSeqType getSourceEnsemblType()
97   {
98     return EnsemblSeqType.GENOMIC;
99   }
100
101   @Override
102   protected String getObjectType()
103   {
104     return OBJECT_TYPE_GENE;
105   }
106
107   /**
108    * Returns an alignment containing the gene(s) for the given gene or
109    * transcript identifier, or external identifier (e.g. Uniprot id). If given a
110    * gene name or external identifier, returns any related gene sequences found
111    * for model organisms. If only a single gene is queried for, then its
112    * transcripts are also retrieved and added to the alignment. <br>
113    * Method:
114    * <ul>
115    * <li>resolves a transcript identifier by looking up its parent gene id</li>
116    * <li>resolves an external identifier by looking up xref-ed gene ids</li>
117    * <li>fetches the gene sequence</li>
118    * <li>fetches features on the sequence</li>
119    * <li>identifies "transcript" features whose Parent is the requested
120    * gene</li>
121    * <li>fetches the transcript sequence for each transcript</li>
122    * <li>makes a mapping from the gene to each transcript</li>
123    * <li>copies features from gene to transcript sequences</li>
124    * <li>fetches the protein sequence for each transcript, maps and saves it as
125    * a cross-reference</li>
126    * <li>aligns each transcript against the gene sequence based on the position
127    * mappings</li>
128    * </ul>
129    * 
130    * @param query
131    *          a single gene or transcript identifier or gene name
132    * @return an alignment containing a gene, and possibly transcripts, or null
133    */
134   @Override
135   public AlignmentI getSequenceRecords(String query) throws Exception
136   {
137     /*
138      * convert to a non-duplicated list of gene identifiers
139      */
140     List<String> geneIds = getGeneIds(query);
141
142     AlignmentI al = null;
143     for (String geneId : geneIds)
144     {
145       /*
146        * fetch the gene sequence(s) with features and xrefs
147        */
148       AlignmentI geneAlignment = super.getSequenceRecords(geneId);
149       if (geneAlignment == null)
150       {
151         continue;
152       }
153       if (geneAlignment.getHeight() == 1)
154       {
155         // ensure id has 'correct' case for the Ensembl identifier
156         geneId = geneAlignment.getSequenceAt(0).getName();
157         getTranscripts(geneAlignment, geneId);
158       }
159       if (al == null)
160       {
161         al = geneAlignment;
162       }
163       else
164       {
165         al.append(geneAlignment);
166       }
167     }
168     return al;
169   }
170
171   /**
172    * Converts a query, which may contain one or more gene, transcript, or
173    * external (to Ensembl) identifiers, into a non-redundant list of gene
174    * identifiers.
175    * 
176    * @param accessions
177    * @return
178    */
179   List<String> getGeneIds(String accessions)
180   {
181     List<String> geneIds = new ArrayList<>();
182
183     for (String acc : accessions.split(getAccessionSeparator()))
184     {
185       /*
186        * First try lookup as an Ensembl (gene or transcript) identifier
187        */
188       String geneId = new EnsemblLookup(getDomain()).getGeneId(acc);
189       if (geneId != null)
190       {
191         if (!geneIds.contains(geneId))
192         {
193           geneIds.add(geneId);
194         }
195       }
196       else
197       {
198         /*
199          * if given a gene or other external name, lookup and fetch 
200          * the corresponding gene for all model organisms 
201          */
202         List<String> ids = new EnsemblSymbol(getDomain(), getDbSource(),
203                 getDbVersion()).getGeneIds(acc);
204         for (String id : ids)
205         {
206           if (!geneIds.contains(id))
207           {
208             geneIds.add(id);
209           }
210         }
211       }
212     }
213     return geneIds;
214   }
215
216   /**
217    * Constructs all transcripts for the gene, as identified by "transcript"
218    * features whose Parent is the requested gene. The coding transcript
219    * sequences (i.e. with introns omitted) are added to the alignment.
220    * 
221    * @param al
222    * @param accId
223    * @throws Exception
224    */
225   protected void getTranscripts(AlignmentI al, String accId)
226           throws Exception
227   {
228     SequenceI gene = al.getSequenceAt(0);
229     List<SequenceFeature> transcriptFeatures = getTranscriptFeatures(accId,
230             gene);
231
232     for (SequenceFeature transcriptFeature : transcriptFeatures)
233     {
234       makeTranscript(transcriptFeature, al, gene);
235     }
236
237     clearGeneFeatures(gene);
238   }
239
240   /**
241    * Remove unwanted features (transcript, exon, CDS) from the gene sequence
242    * after we have used them to derive transcripts and transfer features
243    * 
244    * @param gene
245    */
246   protected void clearGeneFeatures(SequenceI gene)
247   {
248     /*
249      * Note we include NMD_transcript_variant here because it behaves like 
250      * 'transcript' in Ensembl, although strictly speaking it is not 
251      * (it is a sub-type of sequence_variant)    
252      */
253     String[] soTerms = new String[] {
254         SequenceOntologyI.NMD_TRANSCRIPT_VARIANT,
255         SequenceOntologyI.TRANSCRIPT, SequenceOntologyI.EXON,
256         SequenceOntologyI.CDS };
257     List<SequenceFeature> sfs = gene.getFeatures().getFeaturesByOntology(
258             soTerms);
259     for (SequenceFeature sf : sfs)
260     {
261       gene.deleteFeature(sf);
262     }
263   }
264
265   /**
266    * Constructs a spliced transcript sequence by finding 'exon' features for the
267    * given id (or failing that 'CDS'). Copies features on to the new sequence.
268    * 'Aligns' the new sequence against the gene sequence by padding with gaps,
269    * and adds it to the alignment.
270    * 
271    * @param transcriptFeature
272    * @param al
273    *          the alignment to which to add the new sequence
274    * @param gene
275    *          the parent gene sequence, with features
276    * @return
277    */
278   SequenceI makeTranscript(SequenceFeature transcriptFeature, AlignmentI al,
279           SequenceI gene)
280   {
281     String accId = getTranscriptId(transcriptFeature);
282     if (accId == null)
283     {
284       return null;
285     }
286
287     /*
288      * NB we are mapping from gene sequence (not genome), so do not
289      * need to check for reverse strand (gene and transcript sequences 
290      * are in forward sense)
291      */
292
293     /*
294      * make a gene-length sequence filled with gaps
295      * we will fill in the bases for transcript regions
296      */
297     char[] seqChars = new char[gene.getLength()];
298     Arrays.fill(seqChars, al.getGapCharacter());
299
300     /*
301      * look for exon features of the transcript, failing that for CDS
302      * (for example ENSG00000124610 has 1 CDS but no exon features)
303      */
304     String parentId = "transcript:" + accId;
305     List<SequenceFeature> splices = findFeatures(gene,
306             SequenceOntologyI.EXON, parentId);
307     if (splices.isEmpty())
308     {
309       splices = findFeatures(gene, SequenceOntologyI.CDS, parentId);
310     }
311     SequenceFeatures.sortFeatures(splices, true);
312
313     int transcriptLength = 0;
314     final char[] geneChars = gene.getSequence();
315     int offset = gene.getStart(); // to convert to 0-based positions
316     List<int[]> mappedFrom = new ArrayList<>();
317
318     for (SequenceFeature sf : splices)
319     {
320       int start = sf.getBegin() - offset;
321       int end = sf.getEnd() - offset;
322       int spliceLength = end - start + 1;
323       System.arraycopy(geneChars, start, seqChars, start, spliceLength);
324       transcriptLength += spliceLength;
325       mappedFrom.add(new int[] { sf.getBegin(), sf.getEnd() });
326     }
327
328     Sequence transcript = new Sequence(accId, seqChars, 1,
329             transcriptLength);
330
331     /*
332      * Ensembl has gene name as transcript Name
333      * EnsemblGenomes doesn't, but has a url-encoded description field
334      */
335     String description = (String) transcriptFeature.getValue(NAME);
336     if (description == null)
337     {
338       description = (String) transcriptFeature.getValue(DESCRIPTION);
339     }
340     if (description != null)
341     {
342       try
343       {
344         transcript.setDescription(URLDecoder.decode(description, "UTF-8"));
345       } catch (UnsupportedEncodingException e)
346       {
347         e.printStackTrace(); // as if
348       }
349     }
350     transcript.createDatasetSequence();
351
352     al.addSequence(transcript);
353
354     /*
355      * transfer features to the new sequence; we use EnsemblCdna to do this,
356      * to filter out unwanted features types (see method retainFeature)
357      */
358     List<int[]> mapTo = new ArrayList<>();
359     mapTo.add(new int[] { 1, transcriptLength });
360     MapList mapping = new MapList(mappedFrom, mapTo, 1, 1);
361     EnsemblCdna cdna = new EnsemblCdna(getDomain());
362     cdna.transferFeatures(gene.getFeatures().getPositionalFeatures(),
363             transcript.getDatasetSequence(), mapping, parentId);
364
365     /*
366      * fetch and save cross-references
367      */
368     cdna.getCrossReferences(transcript);
369
370     /*
371      * and finally fetch the protein product and save as a cross-reference
372      */
373     cdna.addProteinProduct(transcript);
374
375     return transcript;
376   }
377
378   /**
379    * Returns the 'transcript_id' property of the sequence feature (or null)
380    * 
381    * @param feature
382    * @return
383    */
384   protected String getTranscriptId(SequenceFeature feature)
385   {
386     return (String) feature.getValue("transcript_id");
387   }
388
389   /**
390    * Returns a list of the transcript features on the sequence whose Parent is
391    * the gene for the accession id.
392    * <p>
393    * Transcript features are those of type "transcript", or any of its sub-types
394    * in the Sequence Ontology e.g. "mRNA", "processed_transcript". We also
395    * include "NMD_transcript_variant", because this type behaves like a
396    * transcript identifier in Ensembl, although strictly speaking it is not in
397    * the SO.
398    * 
399    * @param accId
400    * @param geneSequence
401    * @return
402    */
403   protected List<SequenceFeature> getTranscriptFeatures(String accId,
404           SequenceI geneSequence)
405   {
406     List<SequenceFeature> transcriptFeatures = new ArrayList<>();
407
408     String parentIdentifier = GENE_PREFIX + accId;
409
410     List<SequenceFeature> sfs = geneSequence.getFeatures()
411             .getFeaturesByOntology(SequenceOntologyI.TRANSCRIPT);
412     sfs.addAll(geneSequence.getFeatures().getPositionalFeatures(
413             SequenceOntologyI.NMD_TRANSCRIPT_VARIANT));
414
415     for (SequenceFeature sf : sfs)
416     {
417       String parent = (String) sf.getValue(PARENT);
418       if (parentIdentifier.equalsIgnoreCase(parent))
419       {
420         transcriptFeatures.add(sf);
421       }
422     }
423
424     return transcriptFeatures;
425   }
426
427   @Override
428   public String getDescription()
429   {
430     return "Fetches all transcripts and variant features for a gene or transcript";
431   }
432
433   /**
434    * Default test query is a gene id (can also enter a transcript id)
435    */
436   @Override
437   public String getTestQuery()
438   {
439     return "ENSG00000157764"; // BRAF, 5 transcripts, reverse strand
440     // ENSG00000090266 // NDUFB2, 15 transcripts, forward strand
441     // ENSG00000101812 // H2BFM histone, 3 transcripts, forward strand
442     // ENSG00000123569 // H2BFWT histone, 2 transcripts, reverse strand
443   }
444
445   /**
446    * Answers true for a feature of type 'gene' (or a sub-type of gene in the
447    * Sequence Ontology), whose ID is the accession we are retrieving
448    */
449   @Override
450   protected boolean identifiesSequence(SequenceFeature sf, String accId)
451   {
452     if (SequenceOntologyFactory.getInstance().isA(sf.getType(),
453             SequenceOntologyI.GENE))
454     {
455       // NB features as gff use 'ID'; rest services return as 'id'
456       String id = (String) sf.getValue("ID");
457       if ((GENE_PREFIX + accId).equalsIgnoreCase(id))
458       {
459         return true;
460       }
461     }
462     return false;
463   }
464
465   /**
466    * Answers true unless feature type is 'gene', or 'transcript' with a parent
467    * which is a different gene. We need the gene features to identify the range,
468    * but it is redundant information on the gene sequence. Checking the parent
469    * allows us to drop transcript features which belong to different
470    * (overlapping) genes.
471    */
472   @Override
473   protected boolean retainFeature(SequenceFeature sf, String accessionId)
474   {
475     SequenceOntologyI so = SequenceOntologyFactory.getInstance();
476     String type = sf.getType();
477     if (so.isA(type, SequenceOntologyI.GENE))
478     {
479       return false;
480     }
481     if (isTranscript(type))
482     {
483       String parent = (String) sf.getValue(PARENT);
484       if (!(GENE_PREFIX + accessionId).equalsIgnoreCase(parent))
485       {
486         return false;
487       }
488     }
489     return true;
490   }
491
492   /**
493    * Answers false. This allows an optimisation - a single 'gene' feature is all
494    * that is needed to identify the positions of the gene on the genomic
495    * sequence.
496    */
497   @Override
498   protected boolean isSpliceable()
499   {
500     return false;
501   }
502
503   /**
504    * Override to do nothing as Ensembl doesn't return a protein sequence for a
505    * gene identifier
506    */
507   @Override
508   protected void addProteinProduct(SequenceI querySeq)
509   {
510   }
511
512   @Override
513   public Regex getAccessionValidator()
514   {
515     return ACCESSION_REGEX;
516   }
517
518   /**
519    * Returns a descriptor for suitable feature display settings with
520    * <ul>
521    * <li>only exon or sequence_variant features (or their subtypes in the
522    * Sequence Ontology) visible</li>
523    * <li>variant features coloured red</li>
524    * <li>exon features coloured by label (exon name)</li>
525    * <li>variants displayed above (on top of) exons</li>
526    * </ul>
527    */
528   @Override
529   public FeatureSettingsModelI getFeatureColourScheme()
530   {
531     return new FeatureSettingsAdapter()
532     {
533       SequenceOntologyI so = SequenceOntologyFactory.getInstance();
534
535       @Override
536       public boolean isFeatureDisplayed(String type)
537       {
538         return (so.isA(type, SequenceOntologyI.EXON)
539                 || so.isA(type, SequenceOntologyI.SEQUENCE_VARIANT));
540       }
541
542       @Override
543       public FeatureColourI getFeatureColour(String type)
544       {
545         if (so.isA(type, SequenceOntologyI.EXON))
546         {
547           return new FeatureColour()
548           {
549             @Override
550             public boolean isColourByLabel()
551             {
552               return true;
553             }
554           };
555         }
556         if (so.isA(type, SequenceOntologyI.SEQUENCE_VARIANT))
557         {
558           return new FeatureColour()
559           {
560
561             @Override
562             public Color getColour()
563             {
564               return Color.RED;
565             }
566           };
567         }
568         return null;
569       }
570
571       /**
572        * order to render sequence_variant after exon after the rest
573        */
574       @Override
575       public int compare(String feature1, String feature2)
576       {
577         if (so.isA(feature1, SequenceOntologyI.SEQUENCE_VARIANT))
578         {
579           return +1;
580         }
581         if (so.isA(feature2, SequenceOntologyI.SEQUENCE_VARIANT))
582         {
583           return -1;
584         }
585         if (so.isA(feature1, SequenceOntologyI.EXON))
586         {
587           return +1;
588         }
589         if (so.isA(feature2, SequenceOntologyI.EXON))
590         {
591           return -1;
592         }
593         return 0;
594       }
595     };
596   }
597
598 }