src/jalview/ws/dbsources/Xfam.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9.0b2)
   3  * Copyright (C) 2015 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   @Override
  44   public abstract String getDbVersion();
  45
  46   abstract String getXfamSource();
  47
  48   @Override
  49   public AlignmentI getSequenceRecords(String queries) throws Exception
  50   {
  51     // TODO: this is not a perfect implementation. We need to be able to add
  52     // individual references to each sequence in each family alignment that's
  53     // retrieved.
  54     startQuery();
  55     // TODO: trap HTTP 404 exceptions and return null
  56     AlignmentI rcds = new jalview.io.FormatAdapter().readFile(getXFAMURL()
  57             + queries.trim().toUpperCase() + getXFAMURLSUFFIX(),
  58             jalview.io.FormatAdapter.URL,
  59             "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    * default suffix to append the retrieval URL for this source.
  78    *
  79    * @return "" for most Xfam sources
  80    */
  81   public String getXFAMURLSUFFIX()
  82   {
  83     return "";
  84   }
  85
  86 }