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 jalview.bin.Cache;
  24 import jalview.datamodel.DBRefSource;
  25 import jalview.util.Platform;
  26
  27 import com.stevesoft.pat.Regex;
  28
  29 /**
  30  * TODO: later PFAM is a complex datasource - it could return a tree in addition
  31  * to an alignment TODO: create interface to pass alignment properties and tree
  32  * back to sequence fetcher
  33  *
  34  * @author JimP
  35  *
  36  */
  37 abstract public class Pfam extends Xfam
  38 {
  39   /*
  40    * append to URLs to retrieve as a gzipped file
  41    */
  42   protected static final String GZIPPED = "/gzipped";
  43
  44   static final String PFAM_BASEURL_KEY = "PFAM_BASEURL";
  45
  46   private static final String DEFAULT_PFAM_BASEURL = "https://pfam.xfam.org";
  47   static
  48   {
  49     Platform.addJ2SDirectDatabaseCall(DEFAULT_PFAM_BASEURL);
  50   }
  51
  52   public Pfam()
  53   {
  54     super();
  55   }
  56
  57   /*
  58    * (non-Javadoc)
  59    *
  60    * @see jalview.ws.DbSourceProxy#getAccessionSeparator()
  61    */
  62   @Override
  63   public String getAccessionSeparator()
  64   {
  65     return null;
  66   }
  67
  68   /*
  69    * (non-Javadoc)
  70    *
  71    * @see jalview.ws.DbSourceProxy#getAccessionValidator()
  72    */
  73   @Override
  74   public Regex getAccessionValidator()
  75   {
  76     return null;
  77   }
  78
  79   /*
  80    * (non-Javadoc)
  81    *
  82    * @see jalview.ws.DbSourceProxy#getDbSource() public String getDbSource() { *
  83    * this doesn't work - DbSource is key for the hash of DbSourceProxy instances
  84    * - 1:many mapping for DbSource to proxy will be lost. * suggest : PFAM is an
  85    * 'alignment' source - means proxy is higher level than a sequence source.
  86    * return jalview.datamodel.DBRefSource.PFAM; }
  87    */
  88
  89   /*
  90    * (non-Javadoc)
  91    *
  92    * @see jalview.ws.DbSourceProxy#getDbSourceProperties() public Hashtable
  93    * getDbSourceProperties() {
  94    *
  95    * return null; }
  96    */
  97
  98   /*
  99    * (non-Javadoc)
 100    *
 101    * @see jalview.ws.DbSourceProxy#getDbVersion()
 102    */
 103   @Override
 104   public String getDbVersion()
 105   {
 106     return null;
 107   }
 108
 109   @Override
 110   protected String getURLPrefix()
 111   {
 112     return Cache.getDefault(PFAM_BASEURL_KEY, DEFAULT_PFAM_BASEURL);
 113   }
 114
 115   /*
 116    * (non-Javadoc)
 117    *
 118    * @see jalview.ws.DbSourceProxy#isValidReference(java.lang.String)
 119    */
 120   @Override
 121   public boolean isValidReference(String accession)
 122   {
 123     return accession.indexOf("PF") == 0;
 124   }
 125
 126   /*
 127    * public String getDbName() { return "PFAM"; // getDbSource(); }
 128    */
 129
 130   @Override
 131   public String getXfamSource()
 132   {
 133     return DBRefSource.PFAM;
 134   }
 135
 136 }