Merge branch 'develop' into features/r2_11_2_alphafold/JAL-2349_JAL-3855
[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.ws.dbsources.EBIAlfaFold;
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.TDBeacons;
32 import jalview.ws.dbsources.Uniprot;
33 import jalview.ws.seqfetcher.ASequenceFetcher;
34 import jalview.ws.seqfetcher.DbSourceProxy;
35
36 import java.util.ArrayList;
37 import java.util.Collections;
38 import java.util.List;
39
40 /**
41  * This implements the run-time discovery of sequence database clients.
42  * 
43  */
44 public class SequenceFetcher extends ASequenceFetcher
45 {
46   /**
47    * Thread safe construction of database proxies TODO: extend to a configurable
48    * database plugin mechanism where classes are instantiated by reflection and
49    * queried for their DbRefSource and version association.
50    * 
51    */
52   public SequenceFetcher()
53   {
54     addDBRefSourceImpl(EnsemblGene.class);
55     // addDBRefSourceImpl(EnsemblGenomes.class);
56     addDBRefSourceImpl(EmblSource.class);
57     addDBRefSourceImpl(EmblCdsSource.class);
58     addDBRefSourceImpl(Uniprot.class);
59     // not a sequence source yet
60     // addDBRefSourceImpl(TDBeacons.class);
61     addDBRefSourceImpl(Pdb.class);
62     addDBRefSourceImpl(PfamFull.class);
63     addDBRefSourceImpl(PfamSeed.class);
64     addDBRefSourceImpl(RfamSeed.class);
65     addDBRefSourceImpl(EBIAlfaFold.class);
66   }
67
68   /**
69    * return an ordered list of database sources excluding alignment only databases
70    */
71   public String[] getNonAlignmentSources()
72   {
73     String[] srcs = this.getSupportedDb();
74     List<String> src = new ArrayList<>();
75
76     for (int i = 0; i < srcs.length; i++)
77     {
78       boolean accept = true;
79       for (DbSourceProxy dbs : getSourceProxy(srcs[i]))
80       {
81         // Skip the alignment databases for the moment - they're not useful for
82         // verifying a single sequence against its reference source
83         if (dbs.isAlignmentSource())
84         {
85           accept = false;
86           break;
87         }
88       }
89       if (accept)
90       {
91         src.add(srcs[i]);
92       }
93     }
94
95     Collections.sort(src, String.CASE_INSENSITIVE_ORDER);
96     return src.toArray(new String[src.size()]);
97   }
98 }