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.ws.seqfetcher.DbSourceProxyImpl;
  26
  27 /**
  28  * Acts as a superclass for the Rfam and Pfam classes
  29  *
  30  * @author Lauren Michelle Lui
  31  *
  32  */
  33 public abstract class Xfam extends DbSourceProxyImpl
  34 {
  35
  36   public Xfam()
  37   {
  38     super();
  39   }
  40
  41   protected abstract String getXFAMURL();
  42
  43   public abstract String getDbVersion();
  44
  45   abstract String getXfamSource();
  46
  47   public AlignmentI getSequenceRecords(String queries) throws Exception
  48   {
  49     // TODO: this is not a perfect implementation. We need to be able to add
  50     // individual references to each sequence in each family alignment that's
  51     // retrieved.
  52     startQuery();
  53     // TODO: trap HTTP 404 exceptions and return null
  54     AlignmentI rcds = new jalview.io.FormatAdapter().readFile(getXFAMURL()
  55             + queries.trim().toUpperCase(), jalview.io.FormatAdapter.URL,
  56             "STH");
  57     for (int s = 0, sNum = rcds.getHeight(); s < sNum; s++)
  58     {
  59       rcds.getSequenceAt(s).addDBRef(new DBRefEntry(getXfamSource(),
  60       // getDbSource(),
  61               getDbVersion(), queries.trim().toUpperCase()));
  62       if (!getDbSource().equals(getXfamSource()))
  63       { // add the specific ref too
  64         rcds.getSequenceAt(s).addDBRef(
  65                 new DBRefEntry(getDbSource(), getDbVersion(), queries
  66                         .trim().toUpperCase()));
  67       }
  68     }
  69     stopQuery();
  70     return rcds;
  71   }
  72
  73 }