src/jalview/ext/ensembl/EnsemblLookup.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.AlignmentI;
  25 import jalview.datamodel.GeneLociI;
  26 import jalview.util.MapList;
  27
  28 import java.io.BufferedReader;
  29 import java.io.IOException;
  30 import java.net.MalformedURLException;
  31 import java.net.URL;
  32 import java.util.Arrays;
  33 import java.util.Collections;
  34 import java.util.List;
  35
  36 import org.json.simple.JSONObject;
  37 import org.json.simple.parser.JSONParser;
  38 import org.json.simple.parser.ParseException;
  39
  40 /**
  41  * A client for the Ensembl /lookup REST endpoint, used to find the gene
  42  * identifier given a gene, transcript or protein identifier, or to extract the
  43  * species or chromosomal coordinates from the same service response
  44  *
  45  * @author gmcarstairs
  46  */
  47 public class EnsemblLookup extends EnsemblRestClient
  48 {
  49   private static final String SPECIES = "species";
  50
  51   /**
  52    * Default constructor (to use rest.ensembl.org)
  53    */
  54   public EnsemblLookup()
  55   {
  56     super();
  57   }
  58
  59   /**
  60    * Constructor given the target domain to fetch data from
  61    *
  62    * @param
  63    */
  64   public EnsemblLookup(String d)
  65   {
  66     super(d);
  67   }
  68
  69   @Override
  70   public String getDbName()
  71   {
  72     return "ENSEMBL";
  73   }
  74
  75   @Override
  76   public AlignmentI getSequenceRecords(String queries) throws Exception
  77   {
  78     return null;
  79   }
  80
  81   @Override
  82   protected URL getUrl(List<String> ids) throws MalformedURLException
  83   {
  84     String identifier = ids.get(0);
  85     return getUrl(identifier, null);
  86   }
  87
  88   /**
  89    * Gets the url for lookup of the given identifier, optionally with objectType
  90    * also specified in the request
  91    *
  92    * @param identifier
  93    * @param objectType
  94    * @return
  95    */
  96   protected URL getUrl(String identifier, String objectType)
  97   {
  98     String url = getDomain() + "/lookup/id/" + identifier
  99             + CONTENT_TYPE_JSON;
 100     if (objectType != null)
 101     {
 102       url += "&" + OBJECT_TYPE + "=" + objectType;
 103     }
 104
 105     try
 106     {
 107       return new URL(url);
 108     } catch (MalformedURLException e)
 109     {
 110       return null;
 111     }
 112   }
 113
 114   @Override
 115   protected boolean useGetRequest()
 116   {
 117     return true;
 118   }
 119
 120   @Override
 121   protected String getRequestMimeType(boolean multipleIds)
 122   {
 123     return "application/json";
 124   }
 125
 126   @Override
 127   protected String getResponseMimeType()
 128   {
 129     return "application/json";
 130   }
 131
 132   /**
 133    * Returns the gene id related to the given identifier (which may be for a
 134    * gene, transcript or protein)
 135    *
 136    * @param identifier
 137    * @return
 138    */
 139   public String getGeneId(String identifier)
 140   {
 141     return parseGeneId(getResult(identifier, null));
 142   }
 143
 144   /**
 145    * Calls the Ensembl lookup REST endpoint and retrieves the 'species' for the
 146    * given identifier, or null if not found
 147    *
 148    * @param identifier
 149    * @return
 150    */
 151   public String getSpecies(String identifier)
 152   {
 153     String species = null;
 154     JSONObject json = getResult(identifier, null);
 155     if (json != null)
 156     {
 157       Object o = json.get(SPECIES);
 158       if (o != null)
 159       {
 160         species = o.toString();
 161       }
 162     }
 163     return species;
 164   }
 165
 166   /**
 167    * Calls the /lookup/id rest service and returns the response as a JSONObject,
 168    * or null if any error
 169    *
 170    * @param identifier
 171    * @param objectType
 172    *          (optional)
 173    * @return
 174    */
 175   protected JSONObject getResult(String identifier, String objectType)
 176   {
 177     List<String> ids = Arrays.asList(new String[] { identifier });
 178
 179     BufferedReader br = null;
 180     try
 181     {
 182       URL url = getUrl(identifier, objectType);
 183       if (url != null)
 184       {
 185         br = getHttpResponse(url, ids);
 186       }
 187       return br == null ? null : (JSONObject) (new JSONParser().parse(br));
 188     } catch (IOException | ParseException e)
 189     {
 190       System.err.println("Error parsing " + identifier + " lookup response "
 191               + e.getMessage());
 192       return null;
 193     } finally
 194     {
 195       if (br != null)
 196       {
 197         try
 198         {
 199           br.close();
 200         } catch (IOException e)
 201         {
 202           // ignore
 203         }
 204       }
 205     }
 206   }
 207
 208   /**
 209    * Parses the JSON response and returns the gene identifier, or null if not
 210    * found. If the returned object_type is Gene, returns the id, if Transcript
 211    * returns the Parent. If it is Translation (peptide identifier), then the
 212    * Parent is the transcript identifier, so we redo the search with this value,
 213    * specifying that object_type should be Transcript.
 214    *
 215    * @param jsonObject
 216    * @return
 217    */
 218   protected String parseGeneId(JSONObject json)
 219   {
 220     if (json == null)
 221     {
 222       // e.g. lookup failed with 404 not found
 223       return null;
 224     }
 225
 226     String geneId = null;
 227     String type = json.get(OBJECT_TYPE).toString();
 228     if (OBJECT_TYPE_GENE.equalsIgnoreCase(type))
 229     {
 230       // got the gene - just returns its id
 231       geneId = json.get(JSON_ID).toString();
 232     }
 233     else if (OBJECT_TYPE_TRANSCRIPT.equalsIgnoreCase(type))
 234     {
 235       // got the transcript - return its (Gene) Parent
 236       geneId = json.get(PARENT).toString();
 237     }
 238     else if (OBJECT_TYPE_TRANSLATION.equalsIgnoreCase(type))
 239     {
 240       // got the protein - look up its Parent, restricted to type Transcript
 241       String transcriptId = json.get(PARENT).toString();
 242       geneId = parseGeneId(getResult(transcriptId, OBJECT_TYPE_TRANSCRIPT));
 243     }
 244
 245     return geneId;
 246   }
 247
 248   /**
 249    * Calls the /lookup/id rest service for the given id, and if successful,
 250    * parses and returns the gene's chromosomal coordinates
 251    *
 252    * @param geneId
 253    * @return
 254    */
 255   public GeneLociI getGeneLoci(String geneId)
 256   {
 257     return parseGeneLoci(getResult(geneId, OBJECT_TYPE_GENE));
 258   }
 259
 260   /**
 261    * Parses the /lookup/id response for species, asssembly_name,
 262    * seq_region_name, start, end and returns an object that wraps them, or null
 263    * if unsuccessful
 264    *
 265    * @param json
 266    * @return
 267    */
 268   GeneLociI parseGeneLoci(JSONObject json)
 269   {
 270     if (json == null)
 271     {
 272       return null;
 273     }
 274
 275     try
 276     {
 277       final String species = json.get("species").toString();
 278       final String assembly = json.get("assembly_name").toString();
 279       final String chromosome = json.get("seq_region_name").toString();
 280       String strand = json.get("strand").toString();
 281       int start = Integer.parseInt(json.get("start").toString());
 282       int end = Integer.parseInt(json.get("end").toString());
 283       int fromEnd = end - start + 1;
 284       boolean reverseStrand = "-1".equals(strand);
 285       int toStart = reverseStrand ? end : start;
 286       int toEnd = reverseStrand ? start : end;
 287       List<int[]> fromRange = Collections.singletonList(new int[] { 1,
 288           fromEnd });
 289       List<int[]> toRange = Collections.singletonList(new int[] { toStart,
 290           toEnd });
 291       final MapList map = new MapList(fromRange, toRange, 1, 1);
 292       return new GeneLociI()
 293       {
 294
 295         @Override
 296         public String getSpeciesId()
 297         {
 298           return species == null ? "" : species;
 299         }
 300
 301         @Override
 302         public String getAssemblyId()
 303         {
 304           return assembly;
 305         }
 306
 307         @Override
 308         public String getChromosomeId()
 309         {
 310           return chromosome;
 311         }
 312
 313         @Override
 314         public MapList getMap()
 315         {
 316           return map;
 317         }
 318       };
 319     } catch (NullPointerException | NumberFormatException e)
 320     {
 321       Cache.log.error("Error looking up gene loci: " + e.getMessage());
 322       e.printStackTrace();
 323     }
 324     return null;
 325   }
 326
 327 }