src/jalview/ws/dbsources/Pfam.java

   1 /*\r
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)\r
   3  * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle\r
   4  * \r
   5  * This file is part of Jalview.\r
   6  * \r
   7  * Jalview is free software: you can redistribute it and/or\r
   8  * modify it under the terms of the GNU General Public License \r
   9  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.\r
  10  * \r
  11  * Jalview is distributed in the hope that it will be useful, but \r
  12  * WITHOUT ANY WARRANTY; without even the implied warranty \r
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR \r
  14  * PURPOSE.  See the GNU General Public License for more details.\r
  15  * \r
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.\r
  17  */\r
  18 package jalview.ws.dbsources;\r
  19 \r
  20 import java.util.Hashtable;\r
  21 \r
  22 import com.stevesoft.pat.Regex;\r
  23 \r
  24 import jalview.datamodel.AlignmentI;\r
  25 import jalview.datamodel.DBRefEntry;\r
  26 import jalview.io.AppletFormatAdapter;\r
  27 import jalview.io.FastaFile;\r
  28 import jalview.io.StockholmFile;\r
  29 import jalview.ws.seqfetcher.DbSourceProxy;\r
  30 import jalview.ws.seqfetcher.DbSourceProxyImpl;\r
  31 \r
  32 /**\r
  33  * TODO: later PFAM is a complex datasource - it could return a tree in addition\r
  34  * to an alignment TODO: create interface to pass alignment properties and tree\r
  35  * back to sequence fetcher\r
  36  * \r
  37  * @author JimP\r
  38  * \r
  39  */\r
  40 abstract public class Pfam extends DbSourceProxyImpl implements\r
  41         DbSourceProxy\r
  42 {\r
  43 \r
  44   public Pfam()\r
  45   {\r
  46     super();\r
  47     // all extensions of this PFAM source base class are DOMAINDB sources\r
  48     addDbSourceProperty(jalview.datamodel.DBRefSource.DOMAINDB);\r
  49     addDbSourceProperty(jalview.datamodel.DBRefSource.ALIGNMENTDB);\r
  50   }\r
  51 \r
  52   /*\r
  53    * (non-Javadoc)\r
  54    * \r
  55    * @see jalview.ws.DbSourceProxy#getAccessionSeparator()\r
  56    */\r
  57   public String getAccessionSeparator()\r
  58   {\r
  59     // TODO Auto-generated method stub\r
  60     return null;\r
  61   }\r
  62 \r
  63   /*\r
  64    * (non-Javadoc)\r
  65    * \r
  66    * @see jalview.ws.DbSourceProxy#getAccessionValidator()\r
  67    */\r
  68   public Regex getAccessionValidator()\r
  69   {\r
  70     // TODO Auto-generated method stub\r
  71     return null;\r
  72   }\r
  73 \r
  74   /*\r
  75    * (non-Javadoc)\r
  76    * \r
  77    * @see jalview.ws.DbSourceProxy#getDbSource() public String getDbSource() { *\r
  78    * this doesn't work - DbSource is key for the hash of DbSourceProxy instances\r
  79    * - 1:many mapping for DbSource to proxy will be lost. * suggest : PFAM is an\r
  80    * 'alignment' source - means proxy is higher level than a sequence source.\r
  81    * return jalview.datamodel.DBRefSource.PFAM; }\r
  82    */\r
  83 \r
  84   /*\r
  85    * (non-Javadoc)\r
  86    * \r
  87    * @see jalview.ws.DbSourceProxy#getDbSourceProperties() public Hashtable\r
  88    * getDbSourceProperties() {\r
  89    * \r
  90    * return null; }\r
  91    */\r
  92 \r
  93   /*\r
  94    * (non-Javadoc)\r
  95    * \r
  96    * @see jalview.ws.DbSourceProxy#getDbVersion()\r
  97    */\r
  98   public String getDbVersion()\r
  99   {\r
 100     // TODO Auto-generated method stub\r
 101     return null;\r
 102   }\r
 103 \r
 104   /**\r
 105    * \r
 106    * @return PFAM URL stub for this DbSource\r
 107    */\r
 108   protected abstract String getPFAMURL();\r
 109 \r
 110   /*\r
 111    * (non-Javadoc)\r
 112    * \r
 113    * @see jalview.ws.DbSourceProxy#getSequenceRecords(java.lang.String[])\r
 114    */\r
 115   public AlignmentI getSequenceRecords(String queries) throws Exception\r
 116   {\r
 117     // TODO: this is not a perfect implementation. We need to be able to add\r
 118     // individual references to each sequence in each family alignment that's\r
 119     // retrieved.\r
 120     startQuery();\r
 121     AlignmentI rcds = new jalview.io.FormatAdapter().readFile(getPFAMURL()\r
 122             + queries.trim().toUpperCase(), jalview.io.FormatAdapter.URL,\r
 123             "STH");\r
 124     for (int s = 0, sNum = rcds.getHeight(); s < sNum; s++)\r
 125     {\r
 126       rcds.getSequenceAt(s).addDBRef(\r
 127               new DBRefEntry(jalview.datamodel.DBRefSource.PFAM,\r
 128               // getDbSource(),\r
 129                       getDbVersion(), queries.trim().toUpperCase()));\r
 130       if (!getDbSource().equals(jalview.datamodel.DBRefSource.PFAM))\r
 131       { // add the specific ref too\r
 132         rcds.getSequenceAt(s).addDBRef(\r
 133                 new DBRefEntry(getDbSource(), getDbVersion(), queries\r
 134                         .trim().toUpperCase()));\r
 135       }\r
 136     }\r
 137     stopQuery();\r
 138     return rcds;\r
 139   }\r
 140 \r
 141   /*\r
 142    * (non-Javadoc)\r
 143    * \r
 144    * @see jalview.ws.DbSourceProxy#isValidReference(java.lang.String)\r
 145    */\r
 146   public boolean isValidReference(String accession)\r
 147   {\r
 148     return accession.indexOf("PF") == 0;\r
 149   }\r
 150 \r
 151   /*\r
 152    * public String getDbName() { return "PFAM"; // getDbSource(); }\r
 153    */\r
 154 }\r