29d4ec790de4508477b4d0325d7dd2d5b5c1e98c
[jalview.git] / src / jalview / ws / SequenceFetcher.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;
22
23 import jalview.ext.ensembl.EnsemblGene;
24 import jalview.ext.ensembl.EnsemblGenomes;
25 import jalview.ws.dbsources.EmblCdsSource;
26 import jalview.ws.dbsources.EmblSource;
27 import jalview.ws.dbsources.Pdb;
28 import jalview.ws.dbsources.PfamFull;
29 import jalview.ws.dbsources.PfamSeed;
30 import jalview.ws.dbsources.RfamSeed;
31 import jalview.ws.dbsources.Uniprot;
32 import jalview.ws.seqfetcher.ASequenceFetcher;
33 import jalview.ws.seqfetcher.DbSourceProxy;
34
35 import java.util.ArrayList;
36
37 /**
38  * This implements the run-time discovery of sequence database clients.
39  * 
40  */
41 public class SequenceFetcher extends ASequenceFetcher
42 {
43   /**
44    * Thread safe construction of database proxies TODO: extend to a configurable
45    * database plugin mechanism where classes are instantiated by reflection and
46    * queried for their DbRefSource and version association.
47    * 
48    */
49   public SequenceFetcher()
50   {
51     addDBRefSourceImpl(EnsemblGene.class);
52     addDBRefSourceImpl(EnsemblGenomes.class);
53     addDBRefSourceImpl(EmblSource.class);
54     addDBRefSourceImpl(EmblCdsSource.class);
55     addDBRefSourceImpl(Uniprot.class);
56     addDBRefSourceImpl(Pdb.class);
57     addDBRefSourceImpl(PfamFull.class);
58     addDBRefSourceImpl(PfamSeed.class);
59     addDBRefSourceImpl(RfamSeed.class);
60   }
61
62   /**
63    * return an ordered list of database sources excluding alignment only databases
64    */
65   public String[] getOrderedSupportedSources()
66   {
67     String[] srcs = this.getSupportedDb();
68     ArrayList<String> src = new ArrayList<>();
69
70     for (int i = 0; i < srcs.length; i++)
71     {
72       boolean skip = false;
73       for (DbSourceProxy dbs : getSourceProxy(srcs[i]))
74       {
75         // Skip the alignment databases for the moment - they're not useful for
76         // verifying a single sequence against its reference source
77         if (dbs.isAlignmentSource())
78         {
79           skip = true;
80         }
81       }
82       if (skip)
83       {
84         continue;
85       }
86       {
87         src.add(srcs[i]);
88       }
89     }
90     String[] tosort = src.toArray(new String[0]),
91             sorted = src.toArray(new String[0]);
92     for (int j = 0, jSize = sorted.length; j < jSize; j++)
93     {
94       tosort[j] = tosort[j].toLowerCase();
95     }
96     jalview.util.QuickSort.sort(tosort, sorted);
97     // construct array with all sources listed
98     int i = 0;
99     for (int j = sorted.length - 1; j >= 0; j--, i++)
100     {
101       srcs[i] = sorted[j];
102     }
103     return srcs;
104   }
105 }