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     Platform.addJ2SDirectDatabaseCall(DEFAULT_PFAM_BASEURL);
  49   }
  50
  51   public Pfam()
  52   {
  53     super();
  54   }
  55
  56   /*
  57    * (non-Javadoc)
  58    *
  59    * @see jalview.ws.DbSourceProxy#getAccessionSeparator()
  60    */
  61   @Override
  62   public String getAccessionSeparator()
  63   {
  64     return null;
  65   }
  66
  67   /*
  68    * (non-Javadoc)
  69    *
  70    * @see jalview.ws.DbSourceProxy#getAccessionValidator()
  71    */
  72   @Override
  73   public Regex getAccessionValidator()
  74   {
  75     return null;
  76   }
  77
  78   /*
  79    * (non-Javadoc)
  80    *
  81    * @see jalview.ws.DbSourceProxy#getDbSource() public String getDbSource() { *
  82    * this doesn't work - DbSource is key for the hash of DbSourceProxy instances
  83    * - 1:many mapping for DbSource to proxy will be lost. * suggest : PFAM is an
  84    * 'alignment' source - means proxy is higher level than a sequence source.
  85    * return jalview.datamodel.DBRefSource.PFAM; }
  86    */
  87
  88   /*
  89    * (non-Javadoc)
  90    *
  91    * @see jalview.ws.DbSourceProxy#getDbSourceProperties() public Hashtable
  92    * getDbSourceProperties() {
  93    *
  94    * return null; }
  95    */
  96
  97   /*
  98    * (non-Javadoc)
  99    *
 100    * @see jalview.ws.DbSourceProxy#getDbVersion()
 101    */
 102   @Override
 103   public String getDbVersion()
 104   {
 105     return null;
 106   }
 107
 108   @Override
 109   protected String getURLPrefix()
 110   {
 111     return Cache.getDefault(PFAM_BASEURL_KEY, DEFAULT_PFAM_BASEURL);
 112   }
 113
 114   /*
 115    * (non-Javadoc)
 116    *
 117    * @see jalview.ws.DbSourceProxy#isValidReference(java.lang.String)
 118    */
 119   @Override
 120   public boolean isValidReference(String accession)
 121   {
 122     return accession.indexOf("PF") == 0;
 123   }
 124
 125   /*
 126    * public String getDbName() { return "PFAM"; // getDbSource(); }
 127    */
 128
 129   @Override
 130   public String getXfamSource()
 131   {
 132     return DBRefSource.PFAM;
 133   }
 134
 135 }