src/jalview/ext/ensembl/EnsemblFeatures.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.Alignment;
  24 import jalview.datamodel.AlignmentI;
  25 import jalview.datamodel.Sequence;
  26 import jalview.datamodel.SequenceFeature;
  27 import jalview.datamodel.SequenceI;
  28 import jalview.io.gff.SequenceOntologyI;
  29 import jalview.util.JSONUtils;
  30
  31 import java.io.BufferedReader;
  32 import java.io.IOException;
  33 import java.net.MalformedURLException;
  34 import java.net.URL;
  35 import java.util.ArrayList;
  36 import java.util.Iterator;
  37 import java.util.List;
  38
  39 import org.json.simple.JSONArray;
  40 import org.json.simple.JSONObject;
  41 import org.json.simple.parser.JSONParser;
  42 import org.json.simple.parser.ParseException;
  43
  44 /**
  45  * A client for fetching and processing Ensembl feature data in GFF format by
  46  * calling the overlap REST service
  47  *
  48  * @author gmcarstairs
  49  * @see http://rest.ensembl.org/documentation/info/overlap_id
  50  */
  51 class EnsemblFeatures extends EnsemblRestClient
  52 {
  53   /*
  54    * The default features to retrieve from Ensembl
  55    * can override in getSequenceRecords parameter
  56    */
  57   private EnsemblFeatureType[] featuresWanted = { EnsemblFeatureType.cds,
  58       EnsemblFeatureType.exon, EnsemblFeatureType.variation };
  59
  60   /**
  61    * Default constructor (to use rest.ensembl.org)
  62    */
  63   public EnsemblFeatures()
  64   {
  65     super();
  66   }
  67
  68   /**
  69    * Constructor given the target domain to fetch data from
  70    *
  71    * @param d
  72    */
  73   public EnsemblFeatures(String d)
  74   {
  75     super(d);
  76   }
  77
  78   @Override
  79   public String getDbName()
  80   {
  81     return "ENSEMBL (features)";
  82   }
  83
  84   /**
  85    * Makes a query to the REST overlap endpoint for the given sequence
  86    * identifier. This returns an 'alignment' consisting of one 'dummy sequence'
  87    * (the genomic sequence for which overlap features are returned by the
  88    * service). This sequence will have on it sequence features which are the
  89    * real information of interest, such as CDS regions or sequence variations.
  90    */
  91   @Override
  92   public AlignmentI getSequenceRecords(String query) throws IOException
  93   {
  94     // TODO: use a vararg String... for getSequenceRecords instead?
  95     List<String> queries = new ArrayList<>();
  96     queries.add(query);
  97     BufferedReader fp = getSequenceReader(queries);
  98     if (fp == null)
  99     {
 100       return null;
 101     }
 102
 103     SequenceI seq = parseFeaturesJson(fp);
 104     return new Alignment(new SequenceI[] { seq });
 105   }
 106
 107   /**
 108    * Parses the JSON response into Jalview sequence features and attaches them
 109    * to a dummy sequence
 110    *
 111    * @param br
 112    * @return
 113    */
 114   private SequenceI parseFeaturesJson(BufferedReader br)
 115   {
 116     SequenceI seq = new Sequence("Dummy", "");
 117
 118     JSONParser jp = new JSONParser();
 119     try
 120     {
 121       JSONArray responses = (JSONArray) jp.parse(br);
 122       Iterator rvals = responses.iterator();
 123       while (rvals.hasNext())
 124       {
 125         try
 126         {
 127           JSONObject obj = (JSONObject) rvals.next();
 128           String type = obj.get("feature_type").toString();
 129           int start = Integer.parseInt(obj.get("start").toString());
 130           int end = Integer.parseInt(obj.get("end").toString());
 131           String source = obj.get("source").toString();
 132           String strand = obj.get("strand").toString();
 133           String alleles = JSONUtils
 134                   .arrayToList((JSONArray) obj.get("alleles"));
 135           String clinSig = JSONUtils
 136                   .arrayToList(
 137                           (JSONArray) obj.get("clinical_significance"));
 138
 139           /*
 140            * convert 'variation' to 'sequence_variant', and 'cds' to 'CDS'
 141            * so as to have a valid SO term for the feature type
 142            * ('gene', 'exon', 'transcript' don't need any conversion)
 143            */
 144           if ("variation".equals(type))
 145           {
 146             type = SequenceOntologyI.SEQUENCE_VARIANT;
 147           }
 148           else if (SequenceOntologyI.CDS.equalsIgnoreCase((type)))
 149           {
 150             type = SequenceOntologyI.CDS;
 151           }
 152
 153           String desc = getFirstNotNull(obj, "alleles", "external_name",
 154                   JSON_ID);
 155           SequenceFeature sf = new SequenceFeature(type, desc, start, end,
 156                   source);
 157           sf.setStrand("1".equals(strand) ? "+" : "-");
 158           setFeatureAttribute(sf, obj, "id");
 159           setFeatureAttribute(sf, obj, "Parent");
 160           setFeatureAttribute(sf, obj, "consequence_type");
 161           sf.setValue("alleles", alleles);
 162           sf.setValue("clinical_significance", clinSig);
 163
 164           seq.addSequenceFeature(sf);
 165         } catch (Throwable t)
 166         {
 167           // ignore - keep trying other features
 168         }
 169       }
 170     } catch (ParseException | IOException e)
 171     {
 172       // ignore
 173     }
 174
 175     return seq;
 176   }
 177
 178   /**
 179    * Returns the first non-null attribute found (if any) as a string, formatted
 180    * suitably for display as feature description or tooltip. Answers null if
 181    * none of the attribute keys is present.
 182    *
 183    * @param obj
 184    * @param keys
 185    * @return
 186    */
 187   protected String getFirstNotNull(JSONObject obj, String... keys)
 188   {
 189     String desc = null;
 190
 191     for (String key : keys)
 192     {
 193       Object val = obj.get(key);
 194       if (val != null)
 195       {
 196         String s = val instanceof JSONArray
 197                 ? JSONUtils.arrayToList((JSONArray) val)
 198                 : val.toString();
 199         if (!s.isEmpty())
 200         {
 201           return s;
 202         }
 203       }
 204     }
 205     return desc;
 206   }
 207
 208   /**
 209    * A helper method that reads the 'key' entry in the JSON object, and if not
 210    * null, sets its string value as an attribute on the sequence feature
 211    *
 212    * @param sf
 213    * @param obj
 214    * @param key
 215    */
 216   protected void setFeatureAttribute(SequenceFeature sf, JSONObject obj,
 217           String key)
 218   {
 219     Object object = obj.get(key);
 220     if (object != null)
 221     {
 222       sf.setValue(key, object.toString());
 223     }
 224   }
 225
 226   /**
 227    * Returns a URL for the REST overlap endpoint
 228    *
 229    * @param ids
 230    * @return
 231    */
 232   @Override
 233   protected URL getUrl(List<String> ids) throws MalformedURLException
 234   {
 235     StringBuffer urlstring = new StringBuffer(128);
 236     urlstring.append(getDomain()).append("/overlap/id/").append(ids.get(0));
 237
 238     // @see https://github.com/Ensembl/ensembl-rest/wiki/Output-formats
 239     urlstring.append("?content-type=" + getResponseMimeType());
 240
 241     /*
 242      * specify object_type=gene in case is shared by transcript and/or protein;
 243      * currently only fetching features for gene sequences;
 244      * refactor in future if needed to fetch for transcripts
 245      */
 246     urlstring.append("&").append(OBJECT_TYPE).append("=")
 247             .append(OBJECT_TYPE_GENE);
 248
 249     /*
 250      * specify  features to retrieve
 251      * @see http://rest.ensembl.org/documentation/info/overlap_id
 252      * could make the list a configurable entry in .jalview_properties
 253      */
 254     for (EnsemblFeatureType feature : featuresWanted)
 255     {
 256       urlstring.append("&feature=").append(feature.name());
 257     }
 258
 259     return new URL(urlstring.toString());
 260   }
 261
 262   @Override
 263   protected boolean useGetRequest()
 264   {
 265     return true;
 266   }
 267
 268   /**
 269    * Returns the MIME type for GFF3. For GET requests the Content-type header
 270    * describes the required encoding of the response.
 271    */
 272   @Override
 273   protected String getRequestMimeType()
 274   {
 275     return "application/json";
 276   }
 277
 278   /**
 279    * Returns the MIME type wanted for the response
 280    */
 281   @Override
 282   protected String getResponseMimeType()
 283   {
 284     return "application/json";
 285   }
 286
 287   /**
 288    * Overloaded method that allows a list of features to retrieve to be
 289    * specified
 290    *
 291    * @param accId
 292    * @param features
 293    * @return
 294    * @throws IOException
 295    */
 296   protected AlignmentI getSequenceRecords(String accId,
 297           EnsemblFeatureType[] features) throws IOException
 298   {
 299     featuresWanted = features;
 300     return getSequenceRecords(accId);
 301   }
 302 }