Jalview 2.8 Source Header
[jalview.git] / src / jalview / ws / dbsources / das / api / DasSourceRegistryI.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
3  * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
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 of the License, or (at your option) any later version.
10  *  
11  * Jalview is distributed in the hope that it will be useful, but 
12  * WITHOUT ANY WARRANTY; without even the implied warranty 
13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
14  * PURPOSE.  See the GNU General Public License for more details.
15  * 
16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
17  */
18 package jalview.ws.dbsources.das.api;
19
20 import java.util.Hashtable;
21 import java.util.List;
22 import java.util.Map;
23
24 import org.biodas.jdas.client.ConnectionPropertyProviderI;
25 import org.biodas.jdas.client.threads.MultipleConnectionPropertyProviderI;
26 import org.biodas.jdas.schema.sources.SOURCE;
27
28 /**
29  * API for a registry that provides datasources that jalview can access
30  * 
31  * @author jprocter
32  * 
33  */
34 public interface DasSourceRegistryI
35 {
36
37   List<jalviewSourceI> getSources();
38
39   String getDasRegistryURL();
40
41   jalviewSourceI getSource(String nickname);
42
43   // TODO: re JAL-424 - introduce form where local source is queried for
44   // metadata, rather than have it all provided by caller.
45   jalviewSourceI createLocalSource(String uri, String name,
46           boolean sequence, boolean features);
47
48   boolean removeLocalSource(jalviewSourceI source);
49
50   void refreshSources();
51
52   String getLocalSourceString();
53
54   List<jalviewSourceI> resolveSourceNicknames(List<String> sources);
55
56   // TODO: refactor to jDAS specific interface
57   MultipleConnectionPropertyProviderI getSessionHandler();
58 }