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