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