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