src/jalview/ws/dbsources/Xfam.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ 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 import jalview.datamodel.AlignmentI;
  24 import jalview.datamodel.DBRefEntry;
  25 import jalview.io.FormatAdapter;
  26 import jalview.ws.seqfetcher.DbSourceProxyImpl;
  27
  28 /**
  29  * Acts as a superclass for the Rfam and Pfam classes
  30  *
  31  * @author Lauren Michelle Lui
  32  *
  33  */
  34 public abstract class Xfam extends DbSourceProxyImpl
  35 {
  36
  37   public Xfam()
  38   {
  39     super();
  40   }
  41
  42   protected abstract String getXFAMURL();
  43
  44   @Override
  45   public abstract String getDbVersion();
  46
  47   abstract String getXfamSource();
  48
  49   @Override
  50   public AlignmentI getSequenceRecords(String queries) throws Exception
  51   {
  52     // TODO: this is not a perfect implementation. We need to be able to add
  53     // individual references to each sequence in each family alignment that's
  54     // retrieved.
  55     startQuery();
  56     // TODO: trap HTTP 404 exceptions and return null
  57     AlignmentI rcds = new FormatAdapter().readFile(getXFAMURL()
  58             + queries.trim().toUpperCase() + getXFAMURLSUFFIX(),
  59             jalview.io.FormatAdapter.URL, "STH");
  60     for (int s = 0, sNum = rcds.getHeight(); s < sNum; s++)
  61     {
  62       rcds.getSequenceAt(s).addDBRef(new DBRefEntry(getXfamSource(),
  63       // getDbSource(),
  64               getDbVersion(), queries.trim().toUpperCase()));
  65       if (!getDbSource().equals(getXfamSource()))
  66       { // add the specific ref too
  67         rcds.getSequenceAt(s).addDBRef(
  68                 new DBRefEntry(getDbSource(), getDbVersion(), queries
  69                         .trim().toUpperCase()));
  70       }
  71     }
  72     stopQuery();
  73     return rcds;
  74   }
  75
  76   /**
  77    * Pfam and Rfam provide alignments
  78    */
  79   @Override
  80   public boolean isAlignmentSource()
  81   {
  82     return true;
  83   }
  84
  85   /**
  86    * default suffix to append the retrieval URL for this source.
  87    *
  88    * @return "" for most Xfam sources
  89    */
  90   public String getXFAMURLSUFFIX()
  91   {
  92     return "";
  93   }
  94
  95 }