src/jalview/ws/dbsources/Pfam.java

   1 /*\r
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)\r
   3  * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, 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 Xfam implements DbSourceProxy\r
  41 {\r
  42 \r
  43   public Pfam()\r
  44   {\r
  45     super();\r
  46     // all extensions of this PFAM source base class are DOMAINDB sources\r
  47     addDbSourceProperty(jalview.datamodel.DBRefSource.DOMAINDB);\r
  48     addDbSourceProperty(jalview.datamodel.DBRefSource.ALIGNMENTDB);\r
  49   }\r
  50 \r
  51   /*\r
  52    * (non-Javadoc)\r
  53    * \r
  54    * @see jalview.ws.DbSourceProxy#getAccessionSeparator()\r
  55    */\r
  56   public String getAccessionSeparator()\r
  57   {\r
  58     // TODO Auto-generated method stub\r
  59     return null;\r
  60   }\r
  61 \r
  62   /*\r
  63    * (non-Javadoc)\r
  64    * \r
  65    * @see jalview.ws.DbSourceProxy#getAccessionValidator()\r
  66    */\r
  67   public Regex getAccessionValidator()\r
  68   {\r
  69     // TODO Auto-generated method stub\r
  70     return null;\r
  71   }\r
  72 \r
  73   /*\r
  74    * (non-Javadoc)\r
  75    * \r
  76    * @see jalview.ws.DbSourceProxy#getDbSource() public String getDbSource() { *\r
  77    * this doesn't work - DbSource is key for the hash of DbSourceProxy instances\r
  78    * - 1:many mapping for DbSource to proxy will be lost. * suggest : PFAM is an\r
  79    * 'alignment' source - means proxy is higher level than a sequence source.\r
  80    * return jalview.datamodel.DBRefSource.PFAM; }\r
  81    */\r
  82 \r
  83   /*\r
  84    * (non-Javadoc)\r
  85    * \r
  86    * @see jalview.ws.DbSourceProxy#getDbSourceProperties() public Hashtable\r
  87    * getDbSourceProperties() {\r
  88    * \r
  89    * return null; }\r
  90    */\r
  91 \r
  92   /*\r
  93    * (non-Javadoc)\r
  94    * \r
  95    * @see jalview.ws.DbSourceProxy#getDbVersion()\r
  96    */\r
  97   @Override\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    * Returns base URL for selected Pfam alignment type\r
 106    * \r
 107    * @return PFAM URL stub for this DbSource\r
 108    */\r
 109   @Override\r
 110   protected abstract String getXFAMURL();\r
 111 \r
 112   /*\r
 113    * (non-Javadoc)\r
 114    * \r
 115    * @see jalview.ws.DbSourceProxy#getSequenceRecords(java.lang.String[])\r
 116    */\r
 117   public AlignmentI getSequenceRecords(String queries) throws Exception\r
 118   {\r
 119     // TODO: this is not a perfect implementation. We need to be able to add\r
 120     // individual references to each sequence in each family alignment that's\r
 121     // retrieved.\r
 122     startQuery();\r
 123     AlignmentI rcds = new jalview.io.FormatAdapter().readFile(getXFAMURL()\r
 124             + queries.trim().toUpperCase(), jalview.io.FormatAdapter.URL,\r
 125             "STH");\r
 126     for (int s = 0, sNum = rcds.getHeight(); s < sNum; s++)\r
 127     {\r
 128       rcds.getSequenceAt(s).addDBRef(\r
 129               new DBRefEntry(jalview.datamodel.DBRefSource.PFAM,\r
 130               // getDbSource(),\r
 131                       getDbVersion(), queries.trim().toUpperCase()));\r
 132       if (!getDbSource().equals(jalview.datamodel.DBRefSource.PFAM))\r
 133       { // add the specific ref too\r
 134         rcds.getSequenceAt(s).addDBRef(\r
 135                 new DBRefEntry(getDbSource(), getDbVersion(), queries\r
 136                         .trim().toUpperCase()));\r
 137       }\r
 138     }\r
 139     stopQuery();\r
 140     return rcds;\r
 141   }\r
 142 \r
 143   /*\r
 144    * (non-Javadoc)\r
 145    * \r
 146    * @see jalview.ws.DbSourceProxy#isValidReference(java.lang.String)\r
 147    */\r
 148   public boolean isValidReference(String accession)\r
 149   {\r
 150     return accession.indexOf("PF") == 0;\r
 151   }\r
 152 \r
 153   /*\r
 154    * public String getDbName() { return "PFAM"; // getDbSource(); }\r
 155    */\r
 156 \r
 157   public String getXfamSource()\r
 158   {\r
 159     return jalview.datamodel.DBRefSource.PFAM;\r
 160   }\r
 161 \r
 162 }\r