src/jalview/ws/dbsources/Pfam.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.ws.dbsources;
  22
  23 import java.util.Locale;
  24
  25 import com.stevesoft.pat.Regex;
  26
  27 import jalview.bin.Cache;
  28 import jalview.datamodel.DBRefSource;
  29 import jalview.util.Platform;
  30
  31 /**
  32  * TODO: later PFAM is a complex datasource - it could return a tree in addition
  33  * to an alignment TODO: create interface to pass alignment properties and tree
  34  * back to sequence fetcher
  35  *
  36  * @author JimP
  37  *
  38  */
  39 abstract public class Pfam extends Xfam
  40 {
  41   public static final String FULL = "full", RP35 = "rp35", RP15 = "rp15",
  42           RP75 = "rp75", RP55 = "rp55", SEED = "seed";
  43
  44   public String getPfamDownloadURL(String id, String alType)
  45   {
  46     String url = Cache.getDefault(PFAM_BASEURL_KEY, DEFAULT_PFAM_BASEURL);
  47     url = url.replace("$PFAMID$", id);
  48     url = url.replace("$ALTYPE$", alType);
  49     return url;
  50   }
  51
  52   static final String PFAM_BASEURL_KEY = "PFAM_INTERPRO_URL_TEMPLATE";
  53
  54   protected String alignmentType;
  55
  56   private static final String DEFAULT_PFAM_BASEURL = "https://www.ebi.ac.uk/interpro/wwwapi/entry/pfam/$PFAMID$/?annotation=alignment:$ALTYPE$&download";
  57
  58   static
  59   {
  60     Platform.addJ2SDirectDatabaseCall(DEFAULT_PFAM_BASEURL);
  61   }
  62
  63   public Pfam()
  64   {
  65     super();
  66   }
  67
  68   @Override
  69   String getURL(String queries)
  70   {
  71     return getPfamDownloadURL(queries.trim().toUpperCase(Locale.ROOT),
  72             alignmentType);
  73   }
  74
  75   /*
  76    * (non-Javadoc)
  77    *
  78    * @see jalview.ws.DbSourceProxy#getAccessionSeparator()
  79    */
  80   @Override
  81   public String getAccessionSeparator()
  82   {
  83     return null;
  84   }
  85
  86   /*
  87    * (non-Javadoc)
  88    *
  89    * @see jalview.ws.DbSourceProxy#getAccessionValidator()
  90    */
  91   @Override
  92   public Regex getAccessionValidator()
  93   {
  94     return null;
  95   }
  96
  97   /*
  98    * (non-Javadoc)
  99    *
 100    * @see jalview.ws.DbSourceProxy#getDbSource() public String getDbSource() { *
 101    * this doesn't work - DbSource is key for the hash of DbSourceProxy instances
 102    * - 1:many mapping for DbSource to proxy will be lost. * suggest : PFAM is an
 103    * 'alignment' source - means proxy is higher level than a sequence source.
 104    * return jalview.datamodel.DBRefSource.PFAM; }
 105    */
 106
 107   /*
 108    * (non-Javadoc)
 109    *
 110    * @see jalview.ws.DbSourceProxy#getDbSourceProperties() public Hashtable
 111    * getDbSourceProperties() {
 112    *
 113    * return null; }
 114    */
 115
 116   /*
 117    * (non-Javadoc)
 118    *
 119    * @see jalview.ws.DbSourceProxy#getDbVersion()
 120    */
 121   @Override
 122   public String getDbVersion()
 123   {
 124     return null;
 125   }
 126
 127   @Override
 128   protected String getURLPrefix()
 129   {
 130     return Cache.getDefault(PFAM_BASEURL_KEY, DEFAULT_PFAM_BASEURL);
 131   }
 132
 133   /*
 134    * (non-Javadoc)
 135    *
 136    * @see jalview.ws.DbSourceProxy#isValidReference(java.lang.String)
 137    */
 138   @Override
 139   public boolean isValidReference(String accession)
 140   {
 141     return accession.indexOf("PF") == 0;
 142   }
 143
 144   /*
 145    * public String getDbName() { return "PFAM"; // getDbSource(); }
 146    */
 147
 148   @Override
 149   public String getXfamSource()
 150   {
 151     return DBRefSource.PFAM;
 152   }
 153 }