src/jalview/urls/IdentifiersUrlProvider.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
  22 package jalview.urls;
  23
  24 import static jalview.util.UrlConstants.DB_ACCESSION;
  25 import static jalview.util.UrlConstants.DELIM;
  26 import static jalview.util.UrlConstants.SEP;
  27
  28 import jalview.util.JSONUtils;
  29 import jalview.util.UrlLink;
  30
  31 import java.io.FileReader;
  32 import java.io.IOException;
  33 import java.util.ArrayList;
  34 import java.util.HashMap;
  35 import java.util.Iterator;
  36 import java.util.List;
  37 import java.util.Map;
  38 import java.util.StringTokenizer;
  39
  40 import org.json.simple.parser.ParseException;
  41
  42 /**
  43  *
  44  * Implements the UrlProviderI interface for a UrlProvider object which serves
  45  * URLs from identifiers.org
  46  *
  47  * @author $author$
  48  * @version $Revision$
  49  */
  50 public class IdentifiersUrlProvider extends UrlProviderImpl
  51 {
  52
  53   private static final String LOCAL_KEY = "Local";
  54
  55   private static final String ID_ORG_KEY = "identifiers.org";
  56
  57   // map of string ids to urls
  58   private HashMap<String, UrlLink> urls;
  59
  60   // list of selected urls
  61   private ArrayList<String> selectedUrls;
  62
  63   public IdentifiersUrlProvider(String cachedUrlList)
  64   {
  65     urls = readIdentifiers(IdOrgSettings.getDownloadLocation());
  66     selectedUrls = new ArrayList<>();
  67     checkSelectionMatchesUrls(cachedUrlList);
  68   }
  69
  70   /**
  71    * Read data from an identifiers.org download file
  72    *
  73    * @param idFileName
  74    *          name of identifiers.org download file
  75    * @return hashmap of identifiers.org data, keyed by MIRIAM id
  76    */
  77   @SuppressWarnings("unchecked")
  78 private HashMap<String, UrlLink> readIdentifiers(String idFileName)
  79   {
  80     // identifiers.org data
  81     HashMap<String, UrlLink> idData = new HashMap<>();
  82
  83     String errorMessage = null;
  84     try
  85     {
  86         // NOTE: THIS WILL FAIL IN SWINGJS BECAUSE IT INVOLVES A FILE READER
  87
  88       FileReader reader = new FileReader(idFileName);
  89       String key = "";
  90       Map<String, Object> obj = (Map<String, Object>) JSONUtils.parse(reader);
  91       if (obj.containsKey(ID_ORG_KEY))
  92       {
  93         key = ID_ORG_KEY;
  94       }
  95       else if (obj.containsKey(LOCAL_KEY))
  96       {
  97         key = LOCAL_KEY;
  98       }
  99       else
 100       {
 101         System.out.println(
 102                 "Unexpected key returned from identifiers jalview service");
 103         return idData;
 104       }
 105
 106       List<Object> jsonarray = (List<Object>) obj.get(key);
 107
 108       // loop over each entry in JSON array and build HashMap entry
 109       for (int i = 0; i < jsonarray.size(); i++)
 110       {
 111         Map<String, Object> item = (Map<String, Object>) jsonarray.get(i);
 112
 113         String url = (String) item.get("url") + "/" + DELIM + DB_ACCESSION
 114                 + DELIM;
 115         UrlLink link = new UrlLink((String) item.get("name"), url,
 116                 (String) item.get("prefix"));
 117         idData.put((String) item.get("id"), link);
 118       }
 119     } catch (IOException | ParseException e)
 120     {
 121       errorMessage = e.toString();
 122       idData.clear();
 123     }
 124     // BH 2018 -- added more valuable report
 125     if (errorMessage != null)
 126     {
 127       System.err.println("IdentifiersUrlProvider: cannot read " + idFileName + ": " + errorMessage);
 128     }
 129     return idData;
 130   }
 131
 132   private void checkSelectionMatchesUrls(String cachedUrlList)
 133   {
 134     StringTokenizer st = new StringTokenizer(cachedUrlList, SEP);
 135     while (st.hasMoreElements())
 136     {
 137       String id = st.nextToken();
 138
 139       if (isMiriamId(id))
 140       {
 141         // this is an identifiers.org MIRIAM id
 142         if (urls.containsKey(id))
 143         {
 144           selectedUrls.add(id);
 145         }
 146       }
 147     }
 148
 149     // reset defaultUrl in case it is no longer selected
 150     setPrimaryUrl(primaryUrl);
 151   }
 152
 153   @Override
 154   public boolean setPrimaryUrl(String id)
 155   {
 156     if (urls.containsKey(id))
 157     {
 158       primaryUrl = id;
 159     }
 160     else
 161     {
 162       primaryUrl = null;
 163     }
 164
 165     return urls.containsKey(id);
 166   }
 167
 168   @Override
 169   public String writeUrlsAsString(boolean selected)
 170   {
 171     if (!selected)
 172     {
 173       return ""; // we don't cache unselected identifiers.org urls
 174     }
 175
 176     StringBuffer links = new StringBuffer();
 177     if (!selectedUrls.isEmpty())
 178     {
 179       for (String k : selectedUrls)
 180       {
 181         links.append(k);
 182         links.append(SEP);
 183       }
 184       // remove last SEP
 185       links.setLength(links.length() - 1);
 186     }
 187     return links.toString();
 188   }
 189
 190   @Override
 191   public List<String> getLinksForMenu()
 192   {
 193     List<String> links = new ArrayList<>();
 194     for (String key : selectedUrls)
 195     {
 196       links.add(urls.get(key).toStringWithTarget());
 197     }
 198     return links;
 199   }
 200
 201   @Override
 202   public List<UrlLinkDisplay> getLinksForTable()
 203   {
 204     return super.getLinksForTable(urls, selectedUrls, false);
 205   }
 206
 207   @Override
 208   public void setUrlData(List<UrlLinkDisplay> links)
 209   {
 210     selectedUrls = new ArrayList<>();
 211
 212     Iterator<UrlLinkDisplay> it = links.iterator();
 213     while (it.hasNext())
 214     {
 215       UrlLinkDisplay link = it.next();
 216
 217       // Handle links with MIRIAM ids only
 218       if (isMiriamId(link.getId()))
 219       {
 220         // select/deselect links accordingly and set default url
 221         if (urls.containsKey(link.getId()))
 222         {
 223           if (link.getIsSelected())
 224           {
 225             selectedUrls.add(link.getId());
 226           }
 227           if (link.getIsPrimary())
 228           {
 229             setPrimaryUrl(link.getId());
 230           }
 231         }
 232       }
 233     }
 234   }
 235
 236   @Override
 237   public String getPrimaryUrl(String seqid)
 238   {
 239     return super.getPrimaryUrl(seqid, urls);
 240   }
 241
 242   @Override
 243   public String getPrimaryUrlId()
 244   {
 245     return primaryUrl;
 246   }
 247
 248   @Override
 249   public String getPrimaryTarget(String seqid)
 250   {
 251     return null;
 252   }
 253
 254   @Override
 255   public String choosePrimaryUrl()
 256   {
 257     return null;
 258   }
 259
 260   @Override
 261   public boolean contains(String id)
 262   {
 263     return (urls.containsKey(id));
 264   }
 265 }