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