src/jalview/ext/ensembl/EnsemblSeqProxy.java

   1 package jalview.ext.ensembl;
   2
   3 import jalview.analysis.AlignmentUtils;
   4 import jalview.analysis.Dna;
   5 import jalview.datamodel.Alignment;
   6 import jalview.datamodel.AlignmentI;
   7 import jalview.datamodel.DBRefEntry;
   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.util.Comparison;
  17 import jalview.util.DBRefUtils;
  18 import jalview.util.MapList;
  19
  20 import java.io.IOException;
  21 import java.net.MalformedURLException;
  22 import java.net.URL;
  23 import java.util.ArrayList;
  24 import java.util.Arrays;
  25 import java.util.Collections;
  26 import java.util.Comparator;
  27 import java.util.List;
  28
  29 /**
  30  * Base class for Ensembl sequence fetchers
  31  *
  32  * @see http://rest.ensembl.org/documentation/info/sequence_id
  33  * @author gmcarstairs
  34  */
  35 public abstract class EnsemblSeqProxy extends EnsemblRestClient
  36 {
  37   private static final String ALLELES = "alleles";
  38
  39   protected static final String PARENT = "Parent";
  40
  41   protected static final String ID = "ID";
  42
  43   protected static final String NAME = "Name";
  44
  45   protected static final String DESCRIPTION = "description";
  46
  47   /*
  48    * enum for 'type' parameter to the /sequence REST service
  49    */
  50   public enum EnsemblSeqType
  51   {
  52     /**
  53      * type=genomic to fetch full dna including introns
  54      */
  55     GENOMIC("genomic"),
  56
  57     /**
  58      * type=cdna to fetch coding dna including UTRs
  59      */
  60     CDNA("cdna"),
  61
  62     /**
  63      * type=cds to fetch coding dna excluding UTRs
  64      */
  65     CDS("cds"),
  66
  67     /**
  68      * type=protein to fetch peptide product sequence
  69      */
  70     PROTEIN("protein");
  71
  72     /*
  73      * the value of the 'type' parameter to fetch this version of
  74      * an Ensembl sequence
  75      */
  76     private String type;
  77
  78     EnsemblSeqType(String t)
  79     {
  80       type = t;
  81     }
  82
  83     public String getType()
  84     {
  85       return type;
  86     }
  87
  88   }
  89
  90   /**
  91    * A comparator to sort ranges into ascending start position order
  92    */
  93   private class RangeSorter implements Comparator<int[]>
  94   {
  95     boolean forwards;
  96
  97     RangeSorter(boolean forward)
  98     {
  99       forwards = forward;
 100     }
 101
 102     @Override
 103     public int compare(int[] o1, int[] o2)
 104     {
 105       return (forwards ? 1 : -1) * Integer.compare(o1[0], o2[0]);
 106     }
 107
 108   }
 109
 110   /**
 111    * Default constructor (to use rest.ensembl.org)
 112    */
 113   public EnsemblSeqProxy()
 114   {
 115     super();
 116   }
 117
 118   /**
 119    * Constructor given the target domain to fetch data from
 120    */
 121   public EnsemblSeqProxy(String d)
 122   {
 123     super(d);
 124   }
 125
 126   /**
 127    * Makes the sequence queries to Ensembl's REST service and returns an
 128    * alignment consisting of the returned sequences.
 129    */
 130   @Override
 131   public AlignmentI getSequenceRecords(String query) throws Exception
 132   {
 133     // TODO use a String... query vararg instead?
 134
 135     // danger: accession separator used as a regex here, a string elsewhere
 136     // in this case it is ok (it is just a space), but (e.g.) '\' would not be
 137     List<String> allIds = Arrays.asList(query
 138             .split(getAccessionSeparator()));
 139     AlignmentI alignment = null;
 140     inProgress = true;
 141
 142     /*
 143      * execute queries, if necessary in batches of the
 144      * maximum allowed number of ids
 145      */
 146     int maxQueryCount = getMaximumQueryCount();
 147     for (int v = 0, vSize = allIds.size(); v < vSize; v += maxQueryCount)
 148     {
 149       int p = Math.min(vSize, v + maxQueryCount);
 150       List<String> ids = allIds.subList(v, p);
 151       try
 152       {
 153         alignment = fetchSequences(ids, alignment);
 154       } catch (Throwable r)
 155       {
 156         inProgress = false;
 157         String msg = "Aborting ID retrieval after " + v
 158                 + " chunks. Unexpected problem (" + r.getLocalizedMessage()
 159                 + ")";
 160         System.err.println(msg);
 161         break;
 162       }
 163     }
 164
 165     if (alignment == null)
 166     {
 167       return null;
 168     }
 169
 170     /*
 171      * fetch and transfer genomic sequence features,
 172      * fetch protein product and add as cross-reference
 173      */
 174     for (String accId : allIds)
 175     {
 176       addFeaturesAndProduct(accId, alignment);
 177     }
 178
 179     for (SequenceI seq : alignment.getSequences())
 180     {
 181       getCrossReferences(seq);
 182     }
 183
 184     return alignment;
 185   }
 186
 187   /**
 188    * Fetches Ensembl features using the /overlap REST endpoint, and adds them to
 189    * the sequence in the alignment. Also fetches the protein product, maps it
 190    * from the CDS features of the sequence, and saves it as a cross-reference of
 191    * the dna sequence.
 192    *
 193    * @param accId
 194    * @param alignment
 195    */
 196   protected void addFeaturesAndProduct(String accId, AlignmentI alignment)
 197   {
 198     if (alignment == null)
 199     {
 200       return;
 201     }
 202
 203     try
 204     {
 205       /*
 206        * get 'dummy' genomic sequence with exon, cds and variation features
 207        */
 208       SequenceI genomicSequence = null;
 209       EnsemblFeatures gffFetcher = new EnsemblFeatures(getDomain());
 210       EnsemblFeatureType[] features = getFeaturesToFetch();
 211       AlignmentI geneFeatures = gffFetcher.getSequenceRecords(accId,
 212               features);
 213       if (geneFeatures.getHeight() > 0)
 214       {
 215         genomicSequence = geneFeatures.getSequenceAt(0);
 216       }
 217       if (genomicSequence != null)
 218       {
 219         /*
 220          * transfer features to the query sequence
 221          */
 222         SequenceI querySeq = alignment.findName(accId);
 223         if (transferFeatures(accId, genomicSequence, querySeq))
 224         {
 225
 226           /*
 227            * fetch and map protein product, and add it as a cross-reference
 228            * of the retrieved sequence
 229            */
 230           addProteinProduct(querySeq);
 231         }
 232       }
 233     } catch (IOException e)
 234     {
 235       System.err.println("Error transferring Ensembl features: "
 236               + e.getMessage());
 237     }
 238   }
 239
 240   /**
 241    * Returns those sequence feature types to fetch from Ensembl. We may want
 242    * features either because they are of interest to the user, or as means to
 243    * identify the locations of the sequence on the genomic sequence (CDS
 244    * features identify CDS, exon features identify cDNA etc).
 245    *
 246    * @return
 247    */
 248   protected abstract EnsemblFeatureType[] getFeaturesToFetch();
 249
 250   /**
 251    * Fetches and maps the protein product, and adds it as a cross-reference of
 252    * the retrieved sequence
 253    */
 254   protected void addProteinProduct(SequenceI querySeq)
 255   {
 256     String accId = querySeq.getName();
 257     try
 258     {
 259       AlignmentI protein = new EnsemblProtein(getDomain())
 260               .getSequenceRecords(accId);
 261       if (protein == null || protein.getHeight() == 0)
 262       {
 263         System.out.println("No protein product found for " + accId);
 264         return;
 265       }
 266       SequenceI proteinSeq = protein.getSequenceAt(0);
 267
 268       /*
 269        * need dataset sequences (to be the subject of mappings)
 270        */
 271       proteinSeq.createDatasetSequence();
 272       querySeq.createDatasetSequence();
 273
 274       MapList mapList = AlignmentUtils.mapCdsToProtein(querySeq, proteinSeq);
 275       if (mapList != null)
 276       {
 277         // clunky: ensure Uniprot xref if we have one is on mapped sequence
 278         SequenceI ds = proteinSeq.getDatasetSequence();
 279         // TODO: Verify ensp primary ref is on proteinSeq.getDatasetSequence()
 280         Mapping map = new Mapping(ds, mapList);
 281         DBRefEntry dbr = new DBRefEntry(getDbSource(),
 282                 getEnsemblDataVersion(), proteinSeq.getName(), map);
 283         querySeq.getDatasetSequence().addDBRef(dbr);
 284
 285         /*
 286          * copy exon features to protein, compute peptide variants from dna
 287          * variants and add as features on the protein sequence ta-da
 288          */
 289         AlignmentUtils.computeProteinFeatures(querySeq, proteinSeq, mapList);
 290       }
 291     } catch (Exception e)
 292     {
 293       System.err
 294               .println(String.format("Error retrieving protein for %s: %s",
 295                       accId, e.getMessage()));
 296     }
 297   }
 298
 299   /**
 300    * Get database xrefs from Ensembl, and attach them to the sequence
 301    *
 302    * @param seq
 303    */
 304   protected void getCrossReferences(SequenceI seq)
 305   {
 306     while (seq.getDatasetSequence() != null)
 307     {
 308       seq = seq.getDatasetSequence();
 309     }
 310
 311     EnsemblXref xrefFetcher = new EnsemblXref(getDomain(), getDbSource(),
 312             getEnsemblDataVersion());
 313     List<DBRefEntry> xrefs = xrefFetcher.getCrossReferences(seq.getName());
 314     for (DBRefEntry xref : xrefs)
 315     {
 316       seq.addDBRef(xref);
 317     }
 318
 319     /*
 320      * and add a reference to itself
 321      */
 322     DBRefEntry self = new DBRefEntry(getDbSource(),
 323             getEnsemblDataVersion(), seq.getName());
 324     seq.addDBRef(self);
 325   }
 326
 327   /**
 328    * Fetches sequences for the list of accession ids and adds them to the
 329    * alignment. Returns the extended (or created) alignment.
 330    *
 331    * @param ids
 332    * @param alignment
 333    * @return
 334    * @throws JalviewException
 335    * @throws IOException
 336    */
 337   protected AlignmentI fetchSequences(List<String> ids, AlignmentI alignment)
 338           throws JalviewException, IOException
 339   {
 340     if (!isEnsemblAvailable())
 341     {
 342       inProgress = false;
 343       throw new JalviewException("ENSEMBL Rest API not available.");
 344     }
 345     FileParse fp = getSequenceReader(ids);
 346     FastaFile fr = new FastaFile(fp);
 347     if (fr.hasWarningMessage())
 348     {
 349       System.out.println(String.format(
 350               "Warning when retrieving %d ids %s\n%s", ids.size(),
 351               ids.toString(), fr.getWarningMessage()));
 352     }
 353     else if (fr.getSeqs().size() != ids.size())
 354     {
 355       System.out.println(String.format(
 356               "Only retrieved %d sequences for %d query strings", fr
 357                       .getSeqs().size(), ids.size()));
 358     }
 359
 360     if (fr.getSeqs().size() == 1 && fr.getSeqs().get(0).getLength() == 0)
 361     {
 362       /*
 363        * POST request has returned an empty FASTA file e.g. for invalid id
 364        */
 365       throw new IOException("No data returned for " + ids);
 366     }
 367
 368     if (fr.getSeqs().size() > 0)
 369     {
 370       AlignmentI seqal = new Alignment(
 371               fr.getSeqsAsArray());
 372       for (SequenceI sq:seqal.getSequences())
 373       {
 374         if (sq.getDescription() == null)
 375         {
 376           sq.setDescription(getDbName());
 377         }
 378         String name = sq.getName();
 379         if (ids.contains(name)
 380                 || ids.contains(name.replace("ENSP", "ENST")))
 381         {
 382           DBRefEntry dbref = DBRefUtils.parseToDbRef(sq, getDbSource(),
 383                   getEnsemblDataVersion(), name);
 384           sq.addDBRef(dbref);
 385         }
 386       }
 387       if (alignment == null)
 388       {
 389         alignment = seqal;
 390       }
 391       else
 392       {
 393         alignment.append(seqal);
 394       }
 395     }
 396     return alignment;
 397   }
 398
 399   /**
 400    * Returns the URL for the REST call
 401    *
 402    * @return
 403    * @throws MalformedURLException
 404    */
 405   @Override
 406   protected URL getUrl(List<String> ids) throws MalformedURLException
 407   {
 408     /*
 409      * a single id is included in the URL path
 410      * multiple ids go in the POST body instead
 411      */
 412     StringBuffer urlstring = new StringBuffer(128);
 413     urlstring.append(getDomain() + "/sequence/id");
 414     if (ids.size() == 1)
 415     {
 416       urlstring.append("/").append(ids.get(0));
 417     }
 418     // @see https://github.com/Ensembl/ensembl-rest/wiki/Output-formats
 419     urlstring.append("?type=").append(getSourceEnsemblType().getType());
 420     urlstring.append(("&Accept=text/x-fasta"));
 421
 422     URL url = new URL(urlstring.toString());
 423     return url;
 424   }
 425
 426   /**
 427    * A sequence/id POST request currently allows up to 50 queries
 428    *
 429    * @see http://rest.ensembl.org/documentation/info/sequence_id_post
 430    */
 431   @Override
 432   public int getMaximumQueryCount()
 433   {
 434     return 50;
 435   }
 436
 437   @Override
 438   protected boolean useGetRequest()
 439   {
 440     return false;
 441   }
 442
 443   @Override
 444   protected String getRequestMimeType(boolean multipleIds)
 445   {
 446     return multipleIds ? "application/json" : "text/x-fasta";
 447   }
 448
 449   @Override
 450   protected String getResponseMimeType()
 451   {
 452     return "text/x-fasta";
 453   }
 454
 455   /**
 456    *
 457    * @return the configured sequence return type for this source
 458    */
 459   protected abstract EnsemblSeqType getSourceEnsemblType();
 460
 461   /**
 462    * Returns a list of [start, end] genomic ranges corresponding to the sequence
 463    * being retrieved.
 464    *
 465    * The correspondence between the frames of reference is made by locating
 466    * those features on the genomic sequence which identify the retrieved
 467    * sequence. Specifically
 468    * <ul>
 469    * <li>genomic sequence is identified by "transcript" features with
 470    * ID=transcript:transcriptId</li>
 471    * <li>cdna sequence is identified by "exon" features with
 472    * Parent=transcript:transcriptId</li>
 473    * <li>cds sequence is identified by "CDS" features with
 474    * Parent=transcript:transcriptId</li>
 475    * </ul>
 476    *
 477    * The returned ranges are sorted to run forwards (for positive strand) or
 478    * backwards (for negative strand). Aborts and returns null if both positive
 479    * and negative strand are found (this should not normally happen).
 480    *
 481    * @param sourceSequence
 482    * @param accId
 483    * @param start
 484    *          the start position of the sequence we are mapping to
 485    * @return
 486    */
 487   protected MapList getGenomicRangesFromFeatures(SequenceI sourceSequence,
 488           String accId, int start)
 489   {
 490     SequenceFeature[] sfs = sourceSequence.getSequenceFeatures();
 491     if (sfs == null)
 492     {
 493       return null;
 494     }
 495
 496     /*
 497      * generously initial size for number of cds regions
 498      * (worst case titin Q8WZ42 has c. 313 exons)
 499      */
 500     List<int[]> regions = new ArrayList<int[]>(100);
 501     int mappedLength = 0;
 502     int direction = 1; // forward
 503     boolean directionSet = false;
 504
 505     for (SequenceFeature sf : sfs)
 506     {
 507       /*
 508        * accept the target feature type or a specialisation of it
 509        * (e.g. coding_exon for exon)
 510        */
 511       if (identifiesSequence(sf, accId))
 512       {
 513         int strand = sf.getStrand();
 514         strand = strand == 0 ? 1 : strand; // treat unknown as forward
 515
 516         if (directionSet && strand != direction)
 517         {
 518           // abort - mix of forward and backward
 519           System.err.println("Error: forward and backward strand for "
 520                   + accId);
 521             return null;
 522           }
 523           direction = strand;
 524           directionSet = true;
 525
 526           /*
 527            * add to CDS ranges, semi-sorted forwards/backwards
 528            */
 529           if (strand < 0)
 530           {
 531             regions.add(0, new int[] { sf.getEnd(), sf.getBegin() });
 532           }
 533           else
 534           {
 535           regions.add(new int[] { sf.getBegin(), sf.getEnd() });
 536         }
 537         mappedLength += Math.abs(sf.getEnd() - sf.getBegin() + 1);
 538
 539         if (!isSpliceable())
 540         {
 541           /*
 542            * 'gene' sequence is contiguous so we can stop as soon as its
 543            * identifying feature has been found
 544            */
 545           break;
 546         }
 547       }
 548     }
 549
 550     if (regions.isEmpty())
 551     {
 552       System.out.println("Failed to identify target sequence for " + accId
 553               + " from genomic features");
 554       return null;
 555     }
 556
 557     /*
 558      * a final sort is needed since Ensembl returns CDS sorted within source
 559      * (havana / ensembl_havana)
 560      */
 561     Collections.sort(regions, new RangeSorter(direction == 1));
 562
 563     List<int[]> to = Arrays.asList(new int[] { start,
 564         start + mappedLength - 1 });
 565
 566     return new MapList(regions, to, 1, 1);
 567   }
 568
 569   /**
 570    * Answers true if the sequence being retrieved may occupy discontiguous
 571    * regions on the genomic sequence.
 572    */
 573   protected boolean isSpliceable()
 574   {
 575     return true;
 576   }
 577
 578   /**
 579    * Returns true if the sequence feature marks positions of the genomic
 580    * sequence feature which are within the sequence being retrieved. For
 581    * example, an 'exon' feature whose parent is the target transcript marks the
 582    * cdna positions of the transcript.
 583    *
 584    * @param sf
 585    * @param accId
 586    * @return
 587    */
 588   protected abstract boolean identifiesSequence(SequenceFeature sf,
 589           String accId);
 590
 591   /**
 592    * Transfers the sequence feature to the target sequence, locating its start
 593    * and end range based on the mapping. Features which do not overlap the
 594    * target sequence are ignored.
 595    *
 596    * @param sf
 597    * @param targetSequence
 598    * @param mapping
 599    *          mapping from the sequence feature's coordinates to the target
 600    *          sequence
 601    * @param forwardStrand
 602    */
 603   protected void transferFeature(SequenceFeature sf,
 604           SequenceI targetSequence, MapList mapping, boolean forwardStrand)
 605   {
 606     int start = sf.getBegin();
 607     int end = sf.getEnd();
 608     int[] mappedRange = mapping.locateInTo(start, end);
 609
 610     if (mappedRange != null)
 611     {
 612       SequenceFeature copy = new SequenceFeature(sf);
 613       copy.setBegin(Math.min(mappedRange[0], mappedRange[1]));
 614       copy.setEnd(Math.max(mappedRange[0], mappedRange[1]));
 615       targetSequence.addSequenceFeature(copy);
 616
 617       /*
 618        * for sequence_variant on reverse strand, have to convert the allele
 619        * values to their complements
 620        */
 621       if (!forwardStrand
 622               && SequenceOntologyFactory.getInstance().isA(sf.getType(),
 623                       SequenceOntologyI.SEQUENCE_VARIANT))
 624       {
 625         reverseComplementAlleles(copy);
 626       }
 627     }
 628   }
 629
 630   /**
 631    * Change the 'alleles' value of a feature by converting to complementary
 632    * bases, and also update the feature description to match
 633    *
 634    * @param sf
 635    */
 636   static void reverseComplementAlleles(SequenceFeature sf)
 637   {
 638     final String alleles = (String) sf.getValue(ALLELES);
 639     if (alleles == null)
 640     {
 641       return;
 642     }
 643     StringBuilder complement = new StringBuilder(alleles.length());
 644     for (String allele : alleles.split(","))
 645     {
 646       reverseComplementAllele(complement, allele);
 647     }
 648     String comp = complement.toString();
 649     sf.setValue(ALLELES, comp);
 650     sf.setDescription(comp);
 651
 652     /*
 653      * replace value of "alleles=" in sf.ATTRIBUTES as well
 654      * so 'output as GFF' shows reverse complement alleles
 655      */
 656     String atts = sf.getAttributes();
 657     if (atts != null)
 658     {
 659       atts = atts.replace(ALLELES + "=" + alleles, ALLELES + "=" + comp);
 660       sf.setAttributes(atts);
 661     }
 662   }
 663
 664   /**
 665    * Makes the 'reverse complement' of the given allele and appends it to the
 666    * buffer, after a comma separator if not the first
 667    *
 668    * @param complement
 669    * @param allele
 670    */
 671   static void reverseComplementAllele(StringBuilder complement,
 672           String allele)
 673   {
 674     if (complement.length() > 0)
 675     {
 676       complement.append(",");
 677     }
 678
 679     /*
 680      * some 'alleles' are actually descriptive terms
 681      * e.g. HGMD_MUTATION, PhenCode_variation
 682      * - we don't want to 'reverse complement' these
 683      */
 684     if (!Comparison.isNucleotideSequence(allele, true))
 685     {
 686       complement.append(allele);
 687     }
 688     else
 689     {
 690       for (int i = allele.length() - 1; i >= 0; i--)
 691       {
 692         complement.append(Dna.getComplement(allele.charAt(i)));
 693       }
 694     }
 695   }
 696
 697   /**
 698    * Transfers features from sourceSequence to targetSequence
 699    *
 700    * @param accessionId
 701    * @param sourceSequence
 702    * @param targetSequence
 703    * @return true if any features were transferred, else false
 704    */
 705   protected boolean transferFeatures(String accessionId,
 706           SequenceI sourceSequence, SequenceI targetSequence)
 707   {
 708     if (sourceSequence == null || targetSequence == null)
 709     {
 710       return false;
 711     }
 712
 713     // long start = System.currentTimeMillis();
 714     SequenceFeature[] sfs = sourceSequence.getSequenceFeatures();
 715     MapList mapping = getGenomicRangesFromFeatures(sourceSequence, accessionId,
 716             targetSequence.getStart());
 717     if (mapping == null)
 718     {
 719       return false;
 720     }
 721
 722     boolean result = transferFeatures(sfs, targetSequence, mapping,
 723             accessionId);
 724     // System.out.println("transferFeatures (" + (sfs.length) + " --> "
 725     // + targetSequence.getSequenceFeatures().length + ") to "
 726     // + targetSequence.getName()
 727     // + " took " + (System.currentTimeMillis() - start) + "ms");
 728     return result;
 729   }
 730
 731   /**
 732    * Transfer features to the target sequence. The start/end positions are
 733    * converted using the mapping. Features which do not overlap are ignored.
 734    * Features whose parent is not the specified identifier are also ignored.
 735    *
 736    * @param features
 737    * @param targetSequence
 738    * @param mapping
 739    * @param parentId
 740    * @return
 741    */
 742   protected boolean transferFeatures(SequenceFeature[] features,
 743           SequenceI targetSequence, MapList mapping, String parentId)
 744   {
 745     final boolean forwardStrand = mapping.isFromForwardStrand();
 746
 747     /*
 748      * sort features by start position (which corresponds to end
 749      * position descending if reverse strand) so as to add them in
 750      * 'forwards' order to the target sequence
 751      */
 752     sortFeatures(features, forwardStrand);
 753
 754     boolean transferred = false;
 755     for (SequenceFeature sf : features)
 756     {
 757       if (retainFeature(sf, parentId))
 758       {
 759         transferFeature(sf, targetSequence, mapping, forwardStrand);
 760         transferred = true;
 761       }
 762     }
 763     return transferred;
 764   }
 765
 766   /**
 767    * Sort features by start position ascending (if on forward strand), or end
 768    * position descending (if on reverse strand)
 769    *
 770    * @param features
 771    * @param forwardStrand
 772    */
 773   protected static void sortFeatures(SequenceFeature[] features,
 774           final boolean forwardStrand)
 775   {
 776     Arrays.sort(features, new Comparator<SequenceFeature>()
 777     {
 778       @Override
 779       public int compare(SequenceFeature o1, SequenceFeature o2)
 780       {
 781         if (forwardStrand)
 782         {
 783           return Integer.compare(o1.getBegin(), o2.getBegin());
 784         }
 785         else
 786         {
 787           return Integer.compare(o2.getEnd(), o1.getEnd());
 788         }
 789       }
 790     });
 791   }
 792
 793   /**
 794    * Answers true if the feature type is one we want to keep for the sequence.
 795    * Some features are only retrieved in order to identify the sequence range,
 796    * and may then be discarded as redundant information (e.g. "CDS" feature for
 797    * a CDS sequence).
 798    */
 799   @SuppressWarnings("unused")
 800   protected boolean retainFeature(SequenceFeature sf, String accessionId)
 801   {
 802     return true; // override as required
 803   }
 804
 805   /**
 806    * Answers true if the feature has a Parent which refers to the given
 807    * accession id, or if the feature has no parent. Answers false if the
 808    * feature's Parent is for a different accession id.
 809    *
 810    * @param sf
 811    * @param identifier
 812    * @return
 813    */
 814   protected boolean featureMayBelong(SequenceFeature sf, String identifier)
 815   {
 816     String parent = (String) sf.getValue(PARENT);
 817     // using contains to allow for prefix "gene:", "transcript:" etc
 818     if (parent != null && !parent.contains(identifier))
 819     {
 820       // this genomic feature belongs to a different transcript
 821       return false;
 822     }
 823     return true;
 824   }
 825
 826   @Override
 827   public String getDescription()
 828   {
 829     return "Ensembl " + getSourceEnsemblType().getType()
 830             + " sequence with variant features";
 831   }
 832
 833   /**
 834    * Returns a (possibly empty) list of features on the sequence which have the
 835    * specified sequence ontology type (or a sub-type of it), and the given
 836    * identifier as parent
 837    *
 838    * @param sequence
 839    * @param type
 840    * @param parentId
 841    * @return
 842    */
 843   protected List<SequenceFeature> findFeatures(SequenceI sequence,
 844           String type, String parentId)
 845   {
 846     List<SequenceFeature> result = new ArrayList<SequenceFeature>();
 847
 848     SequenceFeature[] sfs = sequence.getSequenceFeatures();
 849     if (sfs != null) {
 850       SequenceOntologyI so = SequenceOntologyFactory.getInstance();
 851       for (SequenceFeature sf :sfs) {
 852         if (so.isA(sf.getType(), type))
 853         {
 854           String parent = (String) sf.getValue(PARENT);
 855           if (parent.equals(parentId))
 856           {
 857             result.add(sf);
 858           }
 859         }
 860       }
 861     }
 862     return result;
 863   }
 864
 865   /**
 866    * Answers true if the feature type is either 'NMD_transcript_variant' or
 867    * 'transcript' or one of its sub-types in the Sequence Ontology. This is
 868    * needed because NMD_transcript_variant behaves like 'transcript' in Ensembl
 869    * although strictly speaking it is not (it is a sub-type of
 870    * sequence_variant).
 871    *
 872    * @param featureType
 873    * @return
 874    */
 875   public static boolean isTranscript(String featureType)
 876   {
 877     return SequenceOntologyI.NMD_TRANSCRIPT_VARIANT.equals(featureType)
 878             || SequenceOntologyFactory.getInstance().isA(featureType,
 879                     SequenceOntologyI.TRANSCRIPT);
 880   }
 881 }