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