X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fext%2Fensembl%2FEnsemblXref.java;h=77768a6fa94243a7b354545010333b6547370e36;hb=da31d3e5aebfcdbb1ae7084bbc75bbc3539ee2e6;hp=514e44a98d86a296cee3fdff83d68a9956faa0b3;hpb=e24933a537e0f640c75d4685c468615872bc77fc;p=jalview.git diff --git a/src/jalview/ext/ensembl/EnsemblXref.java b/src/jalview/ext/ensembl/EnsemblXref.java index 514e44a..77768a6 100644 --- a/src/jalview/ext/ensembl/EnsemblXref.java +++ b/src/jalview/ext/ensembl/EnsemblXref.java @@ -1,3 +1,23 @@ +/* + * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$) + * Copyright (C) $$Year-Rel$$ The Jalview Authors + * + * This file is part of Jalview. + * + * Jalview is free software: you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation, either version 3 + * of the License, or (at your option) any later version. + * + * Jalview is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty + * of MERCHANTABILITY or FITNESS FOR A PARTICULAR + * PURPOSE. See the GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with Jalview. If not, see . + * The Jalview Authors are detailed in the 'AUTHORS' file. + */ package jalview.ext.ensembl; import jalview.datamodel.AlignmentI; @@ -27,10 +47,27 @@ import org.json.simple.parser.ParseException; class EnsemblXref extends EnsemblRestClient { + private static final String GO_GENE_ONTOLOGY = "GO"; + + private String dbName = "ENSEMBL (xref)"; + + /** + * Constructor given the target domain to fetch data from + * + * @param d + */ + public EnsemblXref(String d, String dbSource, String version) + { + super(d); + dbName = dbSource; + xrefVersion = dbSource + ":" + version; + + } + @Override public String getDbName() { - return "ENSEMBL (xref)"; + return dbName; } @Override @@ -51,45 +88,35 @@ class EnsemblXref extends EnsemblRestClient return true; } - @Override - protected String getRequestMimeType(boolean multipleIds) - { - return "application/json"; - } - - @Override - protected String getResponseMimeType() - { - return "application/json"; - } - /** * Calls the Ensembl xrefs REST endpoint and retrieves any cross-references * ("primary_id") for the given identifier (Ensembl accession id) and database * names. The "dbname" returned by Ensembl is canonicalised to Jalview's - * standard version, and a DBRefEntry constructed. If no databases are - * specified, all available cross-references are retrieved. + * standard version, and a DBRefEntry constructed. Currently takes all + * identifiers apart from GO terms and synonyms. * * @param identifier - * @param databases + * an Ensembl stable identifier * @return */ - public List getCrossReferences(String identifier, - List databases) + public List getCrossReferences(String identifier) { - List result = new ArrayList(); - List ids = new ArrayList(); + List result = new ArrayList<>(); + List ids = new ArrayList<>(); ids.add(identifier); BufferedReader br = null; try { URL url = getUrl(identifier); - if (url != null) + if (url != null) + { + br = getHttpResponse(url, ids); + if (br != null) { - br = getHttpResponse(url, ids); + result = parseResponse(br); } - return (parseResponse(br, databases)); + } } catch (IOException e) { // ignore @@ -112,20 +139,19 @@ class EnsemblXref extends EnsemblRestClient /** * Parses "primary_id" and "dbname" values from the JSON response and - * constructs a DBRefEntry if the dbname is in the list supplied. Returns a - * list of DBRefEntry created. + * constructs a DBRefEntry. Returns a list of the DBRefEntry created. Note we + * don't parse "synonyms" as they appear to be either redirected or obsolete + * in Uniprot. * * @param br - * @param databases * @return * @throws IOException */ - protected List parseResponse(BufferedReader br, - List databases) + protected List parseResponse(BufferedReader br) throws IOException { JSONParser jp = new JSONParser(); - List result = new ArrayList(); + List result = new ArrayList<>(); try { JSONArray responses = (JSONArray) jp.parse(br); @@ -133,17 +159,13 @@ class EnsemblXref extends EnsemblRestClient while (rvals.hasNext()) { JSONObject val = (JSONObject) rvals.next(); - String dbName = val.get("dbname").toString(); - if (databases != null && !databases.isEmpty() - && !databases.contains(dbName)) - { - continue; - } + String db = val.get("dbname").toString(); String id = val.get("primary_id").toString(); - if (dbName != null && id != null) + if (db != null && id != null + && !GO_GENE_ONTOLOGY.equals(db)) { - dbName = DBRefUtils.getCanonicalName(dbName); - DBRefEntry dbref = new DBRefEntry(dbName, "0", id); + db = DBRefUtils.getCanonicalName(db); + DBRefEntry dbref = new DBRefEntry(db, getXRefVersion(), id); result.add(dbref); } } @@ -154,6 +176,18 @@ class EnsemblXref extends EnsemblRestClient return result; } + private String xrefVersion = "ENSEMBL:0"; + + /** + * version string for Xrefs - for 2.10, hardwired for ENSEMBL:0 + * + * @return + */ + public String getXRefVersion() + { + return xrefVersion; + } + /** * Returns the URL for the REST endpoint to fetch all cross-references for an * identifier. Note this may return protein cross-references for nucleotide. @@ -164,8 +198,8 @@ class EnsemblXref extends EnsemblRestClient */ protected URL getUrl(String identifier) { - String url = ENSEMBL_REST + "/xrefs/id/" + identifier - + "?content-type=application/json&all_levels=1"; + String url = getDomain() + "/xrefs/id/" + identifier + + CONTENT_TYPE_JSON + "&all_levels=1"; try { return new URL(url);