src/jalview/ext/ensembl/EnsemblSequenceFetcher.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.bin.Cache;
  24 import jalview.datamodel.DBRefSource;
  25 import jalview.ws.seqfetcher.DbSourceProxyImpl;
  26
  27 import com.stevesoft.pat.Regex;
  28
  29 /**
  30  * A base class for Ensembl sequence fetchers
  31  *
  32  * @author gmcarstairs
  33  */
  34 abstract class EnsemblSequenceFetcher extends DbSourceProxyImpl
  35 {
  36   // domain properties lookup keys:
  37   protected static final String ENSEMBL_BASEURL = "ENSEMBL_BASEURL";
  38
  39   protected static final String ENSEMBL_GENOMES_BASEURL = "ENSEMBL_GENOMES_BASEURL";
  40
  41   // domain properties default values:
  42   protected static final String DEFAULT_ENSEMBL_BASEURL = "http://rest.ensembl.org";
  43
  44   protected static final String DEFAULT_ENSEMBL_GENOMES_BASEURL = "http://rest.ensemblgenomes.org";
  45
  46   /*
  47    * accepts ENSG/T/E/P with 11 digits
  48    * or ENSMUSP or similar for other species
  49    * or CCDSnnnnn.nn with at least 3 digits
  50    */
  51   private static final Regex ACCESSION_REGEX = new Regex(
  52           "(ENS([A-Z]{3}|)[GTEP]{1}[0-9]{11}$)" + "|"
  53                   + "(CCDS[0-9.]{3,}$)");
  54
  55   protected final String ensemblGenomesDomain;
  56
  57   protected final String ensemblDomain;
  58
  59   /*
  60    * possible values for the 'feature' parameter of the /overlap REST service
  61    * @see http://rest.ensembl.org/documentation/info/overlap_id
  62    */
  63   protected enum EnsemblFeatureType
  64   {
  65     gene, transcript, cds, exon, repeat, simple, misc, variation,
  66     somatic_variation, structural_variation, somatic_structural_variation,
  67     constrained, regulatory
  68   }
  69
  70   private String domain;
  71
  72   /**
  73    * Constructor
  74    */
  75   public EnsemblSequenceFetcher()
  76   {
  77     /*
  78      * the default domain names may be overridden in .jalview_properties;
  79      * this allows an easy change from http to https in future if needed
  80      */
  81     ensemblDomain = Cache.getDefault(ENSEMBL_BASEURL,
  82             DEFAULT_ENSEMBL_BASEURL);
  83     ensemblGenomesDomain = Cache.getDefault(ENSEMBL_GENOMES_BASEURL,
  84             DEFAULT_ENSEMBL_GENOMES_BASEURL);
  85     domain = ensemblDomain;
  86   }
  87
  88   @Override
  89   public String getDbSource()
  90   {
  91     // NB ensure Uniprot xrefs are canonicalised from "Ensembl" to "ENSEMBL"
  92     if (ensemblGenomesDomain.equals(getDomain()))
  93     {
  94       return DBRefSource.ENSEMBLGENOMES;
  95     }
  96     return DBRefSource.ENSEMBL;
  97   }
  98
  99   @Override
 100   public String getAccessionSeparator()
 101   {
 102     return " ";
 103   }
 104
 105   /**
 106    * Ensembl accession are ENST + 11 digits for human transcript, ENSG for human
 107    * gene. Other species insert 3 letters e.g. ENSMUST..., ENSMUSG...
 108    *
 109    * @see http://www.ensembl.org/Help/View?id=151
 110    */
 111   @Override
 112   public Regex getAccessionValidator()
 113   {
 114     return ACCESSION_REGEX;
 115   }
 116
 117   @Override
 118   public boolean isValidReference(String accession)
 119   {
 120     return getAccessionValidator().search(accession);
 121   }
 122
 123   @Override
 124   public int getTier()
 125   {
 126     return 0;
 127   }
 128
 129   /**
 130    * Default test query is a transcript
 131    */
 132   @Override
 133   public String getTestQuery()
 134   {
 135     // has CDS on reverse strand:
 136     return "ENST00000288602";
 137     // ENST00000461457 // forward strand
 138   }
 139
 140   @Override
 141   public boolean isDnaCoding()
 142   {
 143     return true;
 144   }
 145
 146   /**
 147    * Returns the domain name to query e.g. http://rest.ensembl.org or
 148    * http://rest.ensemblgenomes.org
 149    *
 150    * @return
 151    */
 152   protected String getDomain()
 153   {
 154     return domain;
 155   }
 156
 157   protected void setDomain(String d)
 158   {
 159     domain = d;
 160   }
 161 }