src/jalview/ext/ensembl/EnsemblSymbol.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 java.io.BufferedReader;
  24 import java.io.IOException;
  25 import java.net.MalformedURLException;
  26 import java.net.URL;
  27 import java.util.ArrayList;
  28 import java.util.Iterator;
  29 import java.util.List;
  30
  31 import org.json.simple.JSONArray;
  32 import org.json.simple.JSONObject;
  33 import org.json.simple.parser.JSONParser;
  34 import org.json.simple.parser.ParseException;
  35
  36 /**
  37  * A client for the Ensembl xrefs/symbol REST service;
  38  *
  39  * @see http://rest.ensembl.org/documentation/info/xref_external
  40  * @author gmcarstairs
  41  *
  42  */
  43 public class EnsemblSymbol extends EnsemblXref
  44 {
  45   /**
  46    * Constructor given the target domain to fetch data from
  47    *
  48    * @param domain
  49    * @param dbName
  50    * @param dbVersion
  51    */
  52   public EnsemblSymbol(String domain, String dbName, String dbVersion)
  53   {
  54     super(domain, dbName, dbVersion);
  55   }
  56
  57   /**
  58    * Returns the first "id" value in gene identifier format from the JSON
  59    * response, or null if none found
  60    *
  61    * @param br
  62    * @return
  63    * @throws IOException
  64    */
  65   protected String parseSymbolResponse(BufferedReader br) throws IOException
  66   {
  67     JSONParser jp = new JSONParser();
  68     String result = null;
  69     try
  70     {
  71       JSONArray responses = (JSONArray) jp.parse(br);
  72       Iterator rvals = responses.iterator();
  73       while (rvals.hasNext())
  74       {
  75         JSONObject val = (JSONObject) rvals.next();
  76         String id = val.get("id").toString();
  77         String type = val.get("type").toString();
  78         if (id != null && "gene".equals(type))
  79         {
  80           result = id;
  81           break;
  82         }
  83       }
  84     } catch (ParseException e)
  85     {
  86       // ignore
  87     }
  88     return result;
  89   }
  90
  91   /**
  92    * Constructs the URL for the REST symbol endpoint
  93    *
  94    * @param id
  95    *          the accession id (Ensembl or external)
  96    * @param species
  97    *          a species name recognisable by Ensembl
  98    * @param type
  99    *          an optional type to filter the response (gene, transcript,
 100    *          translation)
 101    * @return
 102    */
 103   protected URL getUrl(String id, Species species, String... type)
 104   {
 105     StringBuilder sb = new StringBuilder();
 106     sb.append(getDomain()).append("/xrefs/symbol/")
 107             .append(species.toString()).append("/").append(id)
 108             .append("?content-type=application/json");
 109     for (String t : type)
 110     {
 111       sb.append("&object_type=").append(t);
 112     }
 113     try
 114     {
 115       String url = sb.toString();
 116       return new URL(url);
 117     } catch (MalformedURLException e)
 118     {
 119       return null;
 120     }
 121   }
 122
 123   /**
 124    * Calls the Ensembl xrefs REST 'symbol' endpoint and retrieves any gene ids
 125    * for the given identifier, for any known model organisms
 126    *
 127    * @param identifier
 128    * @return
 129    */
 130   public List<String> getGeneIds(String identifier)
 131   {
 132     List<String> result = new ArrayList<String>();
 133     List<String> ids = new ArrayList<String>();
 134     ids.add(identifier);
 135
 136     String[] queries = identifier.split(getAccessionSeparator());
 137     BufferedReader br = null;
 138     try
 139     {
 140       for (String query : queries)
 141       {
 142         for (Species taxon : Species.values())
 143         {
 144           if (taxon.isModelOrganism())
 145           {
 146             URL url = getUrl(query, taxon, "gene");
 147             if (url != null)
 148             {
 149               br = getHttpResponse(url, ids);
 150               if (br != null)
 151               {
 152                 String geneId = parseSymbolResponse(br);
 153                 if (geneId != null && !result.contains(geneId))
 154                 {
 155                   result.add(geneId);
 156                 }
 157               }
 158             }
 159           }
 160         }
 161       }
 162     } catch (IOException e)
 163     {
 164       // ignore
 165     } finally
 166     {
 167       if (br != null)
 168       {
 169         try
 170         {
 171           br.close();
 172         } catch (IOException e)
 173         {
 174           // ignore
 175         }
 176       }
 177     }
 178     return result;
 179   }
 180
 181 }