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 getXFAMURL();
  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 = getXFAMURL() + queries.trim().toUpperCase()
  61             + getXFAMURLSUFFIX();
  62
  63     if (Cache.log != null)
  64     {
  65       Cache.log.debug("XFAM URL for retrieval is: " + xfamUrl);
  66     }
  67
  68     AlignmentI rcds = new FormatAdapter().readFile(xfamUrl,
  69             DataSourceType.URL, FileFormat.Stockholm);
  70
  71     for (int s = 0, sNum = rcds.getHeight(); s < sNum; s++)
  72     {
  73       rcds.getSequenceAt(s).addDBRef(new DBRefEntry(getXfamSource(),
  74               // getDbSource(),
  75               getDbVersion(), queries.trim().toUpperCase()));
  76       if (!getDbSource().equals(getXfamSource()))
  77       { // add the specific ref too
  78         rcds.getSequenceAt(s).addDBRef(new DBRefEntry(getDbSource(),
  79                 getDbVersion(), queries.trim().toUpperCase()));
  80       }
  81     }
  82     stopQuery();
  83     return rcds;
  84   }
  85
  86   /**
  87    * Pfam and Rfam provide alignments
  88    */
  89   @Override
  90   public boolean isAlignmentSource()
  91   {
  92     return true;
  93   }
  94
  95   /**
  96    * default suffix to append the retrieval URL for this source.
  97    *
  98    * @return "" for most Xfam sources
  99    */
 100   public String getXFAMURLSUFFIX()
 101   {
 102     return "";
 103   }
 104
 105 }