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