src/jalview/ws/dbsources/Pfam.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 java.util.Hashtable;
  21
  22 import com.stevesoft.pat.Regex;
  23
  24 import jalview.datamodel.AlignmentI;
  25 import jalview.datamodel.DBRefEntry;
  26 import jalview.io.AppletFormatAdapter;
  27 import jalview.io.FastaFile;
  28 import jalview.io.StockholmFile;
  29 import jalview.ws.seqfetcher.DbSourceProxy;
  30 import jalview.ws.seqfetcher.DbSourceProxyImpl;
  31
  32 /**
  33  * TODO: later PFAM is a complex datasource - it could return a tree in addition
  34  * to an alignment TODO: create interface to pass alignment properties and tree
  35  * back to sequence fetcher
  36  *
  37  * @author JimP
  38  *
  39  */
  40 abstract public class Pfam extends Xfam implements DbSourceProxy
  41 {
  42
  43   public Pfam()
  44   {
  45     super();
  46     // all extensions of this PFAM source base class are DOMAINDB sources
  47     addDbSourceProperty(jalview.datamodel.DBRefSource.DOMAINDB);
  48     addDbSourceProperty(jalview.datamodel.DBRefSource.ALIGNMENTDB);
  49   }
  50
  51   /*
  52    * (non-Javadoc)
  53    *
  54    * @see jalview.ws.DbSourceProxy#getAccessionSeparator()
  55    */
  56   public String getAccessionSeparator()
  57   {
  58     // TODO Auto-generated method stub
  59     return null;
  60   }
  61
  62   /*
  63    * (non-Javadoc)
  64    *
  65    * @see jalview.ws.DbSourceProxy#getAccessionValidator()
  66    */
  67   public Regex getAccessionValidator()
  68   {
  69     // TODO Auto-generated method stub
  70     return null;
  71   }
  72
  73   /*
  74    * (non-Javadoc)
  75    *
  76    * @see jalview.ws.DbSourceProxy#getDbSource() public String getDbSource() { *
  77    * this doesn't work - DbSource is key for the hash of DbSourceProxy instances
  78    * - 1:many mapping for DbSource to proxy will be lost. * suggest : PFAM is an
  79    * 'alignment' source - means proxy is higher level than a sequence source.
  80    * return jalview.datamodel.DBRefSource.PFAM; }
  81    */
  82
  83   /*
  84    * (non-Javadoc)
  85    *
  86    * @see jalview.ws.DbSourceProxy#getDbSourceProperties() public Hashtable
  87    * getDbSourceProperties() {
  88    *
  89    * return null; }
  90    */
  91
  92   /*
  93    * (non-Javadoc)
  94    *
  95    * @see jalview.ws.DbSourceProxy#getDbVersion()
  96    */
  97   @Override
  98   public String getDbVersion()
  99   {
 100     // TODO Auto-generated method stub
 101     return null;
 102   }
 103
 104   /**
 105    * Returns base URL for selected Pfam alignment type
 106    *
 107    * @return PFAM URL stub for this DbSource
 108    */
 109   @Override
 110   protected abstract String getXFAMURL();
 111
 112   /*
 113    * (non-Javadoc)
 114    *
 115    * @see jalview.ws.DbSourceProxy#getSequenceRecords(java.lang.String[])
 116    */
 117   public AlignmentI getSequenceRecords(String queries) throws Exception
 118   {
 119     // TODO: this is not a perfect implementation. We need to be able to add
 120     // individual references to each sequence in each family alignment that's
 121     // retrieved.
 122     startQuery();
 123     AlignmentI rcds = new jalview.io.FormatAdapter().readFile(getXFAMURL()
 124             + queries.trim().toUpperCase(), jalview.io.FormatAdapter.URL,
 125             "STH");
 126     for (int s = 0, sNum = rcds.getHeight(); s < sNum; s++)
 127     {
 128       rcds.getSequenceAt(s).addDBRef(
 129               new DBRefEntry(jalview.datamodel.DBRefSource.PFAM,
 130               // getDbSource(),
 131                       getDbVersion(), queries.trim().toUpperCase()));
 132       if (!getDbSource().equals(jalview.datamodel.DBRefSource.PFAM))
 133       { // add the specific ref too
 134         rcds.getSequenceAt(s).addDBRef(
 135                 new DBRefEntry(getDbSource(), getDbVersion(), queries
 136                         .trim().toUpperCase()));
 137       }
 138     }
 139     stopQuery();
 140     return rcds;
 141   }
 142
 143   /*
 144    * (non-Javadoc)
 145    *
 146    * @see jalview.ws.DbSourceProxy#isValidReference(java.lang.String)
 147    */
 148   public boolean isValidReference(String accession)
 149   {
 150     return accession.indexOf("PF") == 0;
 151   }
 152
 153   /*
 154    * public String getDbName() { return "PFAM"; // getDbSource(); }
 155    */
 156
 157   public String getXfamSource()
 158   {
 159     return jalview.datamodel.DBRefSource.PFAM;
 160   }
 161
 162 }