src/jalview/ws/dbsources/Rfam.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.datamodel.DBRefSource;
  24 import jalview.ws.seqfetcher.DbSourceProxy;
  25
  26 import com.stevesoft.pat.Regex;
  27
  28 /**
  29  * Contains methods for fetching sequences from Rfam database
  30  *
  31  * @author Lauren Michelle Lui
  32  */
  33 abstract public class Rfam extends Xfam implements DbSourceProxy
  34 {
  35
  36   public Rfam()
  37   {
  38     super();
  39     // all extensions of this RFAM source base class are DOMAINDB sources
  40     addDbSourceProperty(DBRefSource.DOMAINDB);
  41     addDbSourceProperty(DBRefSource.ALIGNMENTDB);
  42   }
  43
  44   /*
  45    * (non-Javadoc)
  46    *
  47    * @see jalview.ws.DbSourceProxy#getAccessionSeparator() Left here for
  48    * consistency with Pfam class
  49    */
  50   public String getAccessionSeparator()
  51   {
  52     // TODO Auto-generated method stub
  53     return null;
  54   }
  55
  56   /*
  57    * (non-Javadoc)
  58    *
  59    * @see jalview.ws.DbSourceProxy#getAccessionValidator() * Left here for
  60    */
  61   public Regex getAccessionValidator()
  62   {
  63     // TODO Auto-generated method stub
  64     return null;
  65   }
  66
  67   /*
  68    * (non-Javadoc)
  69    *
  70    * Left here for consistency with Pfam class
  71    *
  72    * @see jalview.ws.DbSourceProxy#getDbSource() public String getDbSource() { *
  73    * this doesn't work - DbSource is key for the hash of DbSourceProxy instances
  74    * - 1:many mapping for DbSource to proxy will be lost. * suggest : RFAM is an
  75    * 'alignment' source - means proxy is higher level than a sequence source.
  76    * return DBRefSource.RFAM; }
  77    */
  78
  79   /*
  80    * (non-Javadoc)
  81    *
  82    * @see jalview.ws.DbSourceProxy#getDbVersion()
  83    */
  84   @Override
  85   public String getDbVersion()
  86   {
  87     // TODO Auto-generated method stub
  88     return null;
  89   }
  90
  91   /**
  92    * Returns base URL for selected Rfam alignment type
  93    *
  94    * @return RFAM URL stub for this DbSource
  95    */
  96   @Override
  97   protected abstract String getXFAMURL();
  98
  99   /*
 100    * (non-Javadoc)
 101    *
 102    * @see jalview.ws.DbSourceProxy#isValidReference(java.lang.String)
 103    */
 104   public boolean isValidReference(String accession)
 105   {
 106     return accession.indexOf("RF") == 0;
 107   }
 108
 109   /*
 110    * (non-Javadoc)
 111    *
 112    * @see jalview.ws.dbsources.Xfam#getXfamSource()
 113    */
 114   public String getXfamSource()
 115   {
 116     return DBRefSource.RFAM;
 117   }
 118
 119 }