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