2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
21 package jalview.ws.dbsources;
23 import jalview.datamodel.AlignmentI;
24 import jalview.datamodel.DBRefEntry;
25 import jalview.io.DataSourceType;
26 import jalview.io.FileFormat;
27 import jalview.io.FormatAdapter;
28 import jalview.ws.seqfetcher.DbSourceProxyImpl;
31 * Acts as a superclass for the Rfam and Pfam classes
33 * @author Lauren Michelle Lui
36 public abstract class Xfam extends DbSourceProxyImpl
44 protected abstract String getXFAMURL();
47 public abstract String getDbVersion();
49 abstract String getXfamSource();
52 public AlignmentI getSequenceRecords(String queries) throws Exception
54 // TODO: this is not a perfect implementation. We need to be able to add
55 // individual references to each sequence in each family alignment that's
58 // TODO: trap HTTP 404 exceptions and return null
59 AlignmentI rcds = new FormatAdapter().readFile(getXFAMURL()
60 + queries.trim().toUpperCase() + getXFAMURLSUFFIX(),
61 DataSourceType.URL, FileFormat.Stockholm);
62 for (int s = 0, sNum = rcds.getHeight(); s < sNum; s++)
64 rcds.getSequenceAt(s).addDBRef(new DBRefEntry(getXfamSource(),
66 getDbVersion(), queries.trim().toUpperCase()));
67 if (!getDbSource().equals(getXfamSource()))
68 { // add the specific ref too
69 rcds.getSequenceAt(s).addDBRef(
70 new DBRefEntry(getDbSource(), getDbVersion(), queries
71 .trim().toUpperCase()));
79 * Pfam and Rfam provide alignments
82 public boolean isAlignmentSource()
88 * default suffix to append the retrieval URL for this source.
90 * @return "" for most Xfam sources
92 public String getXFAMURLSUFFIX()