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.datamodel.AlignmentI;
  24
  25 import java.io.BufferedReader;
  26 import java.io.IOException;
  27 import java.net.MalformedURLException;
  28 import java.net.URL;
  29 import java.util.Arrays;
  30 import java.util.List;
  31 import java.util.function.Function;
  32
  33 import org.json.simple.JSONObject;
  34 import org.json.simple.parser.JSONParser;
  35 import org.json.simple.parser.ParseException;
  36
  37 /**
  38  * A client for the Ensembl lookup REST endpoint
  39  *
  40  * @author gmcarstairs
  41  */
  42 public class EnsemblLookup extends EnsemblRestClient
  43 {
  44   private static final String SPECIES = "species";
  45
  46   private static final String PARENT = "Parent";
  47
  48   private static final String OBJECT_TYPE_TRANSLATION = "Translation";
  49   private static final String OBJECT_TYPE_TRANSCRIPT = "Transcript";
  50   private static final String ID = "id";
  51   private static final String OBJECT_TYPE_GENE = "Gene";
  52   private static final String OBJECT_TYPE = "object_type";
  53
  54   /**
  55    * Default constructor (to use rest.ensembl.org)
  56    */
  57   public EnsemblLookup()
  58   {
  59     super();
  60   }
  61
  62   /**
  63    * Constructor given the target domain to fetch data from
  64    *
  65    * @param
  66    */
  67   public EnsemblLookup(String d)
  68   {
  69     super(d);
  70   }
  71
  72   @Override
  73   public String getDbName()
  74   {
  75     return "ENSEMBL";
  76   }
  77
  78   @Override
  79   public AlignmentI getSequenceRecords(String queries) throws Exception
  80   {
  81     return null;
  82   }
  83
  84   @Override
  85   protected URL getUrl(List<String> ids) throws MalformedURLException
  86   {
  87     String identifier = ids.get(0);
  88     return getUrl(identifier);
  89   }
  90
  91   /**
  92    * @param identifier
  93    * @return
  94    */
  95   protected URL getUrl(String identifier)
  96   {
  97     String url = getDomain() + "/lookup/id/" + identifier
  98             + CONTENT_TYPE_JSON;
  99     try
 100     {
 101       return new URL(url);
 102     } catch (MalformedURLException e)
 103     {
 104       return null;
 105     }
 106   }
 107
 108   @Override
 109   protected boolean useGetRequest()
 110   {
 111     return true;
 112   }
 113
 114   @Override
 115   protected String getRequestMimeType(boolean multipleIds)
 116   {
 117     return "application/json";
 118   }
 119
 120   @Override
 121   protected String getResponseMimeType()
 122   {
 123     return "application/json";
 124   }
 125
 126   /**
 127    * Calls the Ensembl lookup REST endpoint and retrieves the 'Parent' for the
 128    * given identifier, or null if not found
 129    *
 130    * @param identifier
 131    * @return
 132    */
 133   public String getGeneId(String identifier)
 134   {
 135     return getResult(identifier, br -> parseGeneId(br));
 136   }
 137
 138   /**
 139    * Calls the Ensembl lookup REST endpoint and retrieves the 'species' for the
 140    * given identifier, or null if not found
 141    *
 142    * @param identifier
 143    * @return
 144    */
 145   public String getSpecies(String identifier)
 146   {
 147     return getResult(identifier, br -> getAttribute(br, SPECIES));
 148   }
 149
 150   /**
 151    * @param identifier
 152    * @param attribute
 153    * @return
 154    */
 155   protected String getResult(String identifier,
 156           Function<BufferedReader, String> parser)
 157   {
 158     List<String> ids = Arrays.asList(new String[] { identifier });
 159
 160     BufferedReader br = null;
 161     try
 162     {
 163       URL url = getUrl(identifier);
 164       if (url != null)
 165       {
 166         br = getHttpResponse(url, ids);
 167       }
 168       return br == null ? null : parser.apply(br);
 169     } catch (IOException e)
 170     {
 171       // ignore
 172       return null;
 173     } finally
 174     {
 175       if (br != null)
 176       {
 177         try
 178         {
 179           br.close();
 180         } catch (IOException e)
 181         {
 182           // ignore
 183         }
 184       }
 185     }
 186   }
 187
 188   /**
 189    * Answers the value of 'attribute' from the JSON response, or null if not
 190    * found
 191    *
 192    * @param br
 193    * @param attribute
 194    * @return
 195    */
 196   protected String getAttribute(BufferedReader br, String attribute)
 197   {
 198     String value = null;
 199     JSONParser jp = new JSONParser();
 200     try
 201     {
 202       JSONObject val = (JSONObject) jp.parse(br);
 203       value = val.get(attribute).toString();
 204     } catch (ParseException | NullPointerException | IOException e)
 205     {
 206       // ignore
 207     }
 208     return value;
 209   }
 210
 211   /**
 212    * Parses the JSON response and returns the gene identifier, or null if not
 213    * found. If the returned object_type is Gene, returns the id, if Transcript
 214    * returns the Parent. If it is Translation (peptide identifier), then the
 215    * Parent is the transcript identifier, so we redo the search with this value.
 216    *
 217    * @param br
 218    * @return
 219    */
 220   protected String parseGeneId(BufferedReader br)
 221   {
 222     String geneId = null;
 223     JSONParser jp = new JSONParser();
 224     try
 225     {
 226       JSONObject val = (JSONObject) jp.parse(br);
 227       String type = val.get(OBJECT_TYPE).toString();
 228       if (OBJECT_TYPE_GENE.equalsIgnoreCase(type))
 229       {
 230         geneId = val.get(ID).toString();
 231       }
 232       else if (OBJECT_TYPE_TRANSCRIPT.equalsIgnoreCase(type))
 233       {
 234         geneId = val.get(PARENT).toString();
 235       }
 236       else if (OBJECT_TYPE_TRANSLATION.equalsIgnoreCase(type))
 237       {
 238         String transcriptId = val.get(PARENT).toString();
 239         try
 240         {
 241           geneId = getGeneId(transcriptId);
 242         } catch (StackOverflowError e)
 243         {
 244           /*
 245            * unlikely data condition error!
 246            */
 247           System.err
 248                   .println("** Ensembl lookup "
 249                           + getUrl(transcriptId).toString()
 250                           + " looping on Parent!");
 251         }
 252       }
 253     } catch (ParseException | IOException e)
 254     {
 255       // ignore
 256     }
 257     return geneId;
 258   }
 259
 260 }