src/jalview/ws/dbsources/Rfam.java

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