JAL-1941 added test URL and notes about PyRNA restclient
[jalview.git] / src / jalview / ext / ensembl / EnsemblXref.java
index f19b4d4..fa86865 100644 (file)
@@ -27,6 +27,8 @@ import org.json.simple.parser.ParseException;
 class EnsemblXref extends EnsemblRestClient
 {
 
+  private static final String GO_GENE_ONTOLOGY = "GO";
+
   /**
    * Constructor given the target domain to fetch data from
    * 
@@ -77,15 +79,14 @@ class EnsemblXref extends EnsemblRestClient
    * 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<DBRefEntry> getCrossReferences(String identifier,
-          List<String> databases)
+  public List<DBRefEntry> getCrossReferences(String identifier)
   {
     List<DBRefEntry> result = new ArrayList<DBRefEntry>();
     List<String> ids = new ArrayList<String>();
@@ -95,11 +96,11 @@ class EnsemblXref extends EnsemblRestClient
     try
     {
       URL url = getUrl(identifier);
-        if (url != null)
-        {
-          br = getHttpResponse(url, ids);
-        }
-      return (parseResponse(br, databases));
+      if (url != null)
+      {
+        br = getHttpResponse(url, ids);
+      }
+      return (parseResponse(br));
     } catch (IOException e)
     {
       // ignore
@@ -122,16 +123,15 @@ 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<DBRefEntry> parseResponse(BufferedReader br,
-          List<String> databases)
+  protected List<DBRefEntry> parseResponse(BufferedReader br)
           throws IOException
   {
     JSONParser jp = new JSONParser();
@@ -144,8 +144,7 @@ class EnsemblXref extends EnsemblRestClient
       {
         JSONObject val = (JSONObject) rvals.next();
         String dbName = val.get("dbname").toString();
-        if (databases != null && !databases.isEmpty()
-                && !databases.contains(dbName))
+        if (dbName.equals(GO_GENE_ONTOLOGY))
         {
           continue;
         }