src/jalview/ws/dbsources/Pfam.java

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