src/jalview/ws/dbsources/Rfam.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
   3  * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
   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 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18 package jalview.ws.dbsources;
  19
  20 import com.stevesoft.pat.Regex;
  21
  22 import jalview.ws.seqfetcher.DbSourceProxy;
  23
  24 /**
  25  * Contains methods for fetching sequences from Rfam database
  26  *
  27  * @author Lauren Michelle Lui
  28  */
  29 abstract public class Rfam extends Xfam implements DbSourceProxy
  30 {
  31
  32   public Rfam()
  33   {
  34     super();
  35     // all extensions of this RFAM source base class are DOMAINDB sources
  36     addDbSourceProperty(jalview.datamodel.DBRefSource.DOMAINDB);
  37     addDbSourceProperty(jalview.datamodel.DBRefSource.ALIGNMENTDB);
  38   }
  39
  40   /*
  41    * (non-Javadoc)
  42    *
  43    * @see jalview.ws.DbSourceProxy#getAccessionSeparator() Left here for
  44    * consistency with Pfam class
  45    */
  46   public String getAccessionSeparator()
  47   {
  48     // TODO Auto-generated method stub
  49     return null;
  50   }
  51
  52   /*
  53    * (non-Javadoc)
  54    *
  55    * @see jalview.ws.DbSourceProxy#getAccessionValidator() * Left here for
  56    */
  57   public Regex getAccessionValidator()
  58   {
  59     // TODO Auto-generated method stub
  60     return null;
  61   }
  62
  63   /*
  64    * (non-Javadoc)
  65    *
  66    * Left here for consistency with Pfam class
  67    *
  68    * @see jalview.ws.DbSourceProxy#getDbSource() public String getDbSource() { *
  69    * this doesn't work - DbSource is key for the hash of DbSourceProxy instances
  70    * - 1:many mapping for DbSource to proxy will be lost. * suggest : RFAM is an
  71    * 'alignment' source - means proxy is higher level than a sequence source.
  72    * return jalview.datamodel.DBRefSource.RFAM; }
  73    */
  74
  75   /*
  76    * (non-Javadoc)
  77    *
  78    * @see jalview.ws.DbSourceProxy#getDbVersion()
  79    */
  80   @Override
  81   public String getDbVersion()
  82   {
  83     // TODO Auto-generated method stub
  84     return null;
  85   }
  86
  87   /**
  88    * Returns base URL for selected Rfam alignment type
  89    *
  90    * @return RFAM URL stub for this DbSource
  91    */
  92   @Override
  93   protected abstract String getXFAMURL();
  94
  95   /*
  96    * (non-Javadoc)
  97    *
  98    * @see jalview.ws.DbSourceProxy#isValidReference(java.lang.String)
  99    */
 100   public boolean isValidReference(String accession)
 101   {
 102     return accession.indexOf("RF") == 0;
 103   }
 104
 105   /*
 106    * (non-Javadoc)
 107    *
 108    * @see jalview.ws.dbsources.Xfam#getXfamSource()
 109    */
 110   public String getXfamSource()
 111   {
 112     return jalview.datamodel.DBRefSource.RFAM;
 113   }
 114
 115 }