Clover icon

Coverage Report

  1. Project Clover database Wed Dec 3 2025 17:03:17 GMT
  2. Package jalview.ws2.client.slivka

File SlivkaWSDiscoverer.java

 

Coverage histogram

../../../../img/srcFileCovDistChart10.png
0% of files have more coverage

Code metrics

18
121
10
1
254
224
30
0.25
12.1
10
3

Classes

Class Line # Actions
SlivkaWSDiscoverer 22 121 30
0.9530201695.3%
 

Contributing tests

This file is covered by 378 tests. .

Source view

1    package jalview.ws2.client.slivka;
2   
3    import java.io.IOException;
4    import java.net.MalformedURLException;
5    import java.net.URI;
6    import java.net.URISyntaxException;
7    import java.net.URL;
8    import java.util.ArrayList;
9    import java.util.List;
10    import java.util.function.Function;
11   
12    import jalview.bin.Cache;
13    import jalview.bin.Console;
14    import jalview.ws.params.ParamManager;
15    import jalview.ws2.actions.alignment.AlignmentAction;
16    import jalview.ws2.actions.annotation.AnnotationAction;
17    import jalview.ws2.api.WebService;
18    import jalview.ws2.client.api.AbstractWebServiceDiscoverer;
19    import uk.ac.dundee.compbio.slivkaclient.SlivkaClient;
20    import uk.ac.dundee.compbio.slivkaclient.SlivkaService;
21   
 
22    public class SlivkaWSDiscoverer extends AbstractWebServiceDiscoverer
23    {
24    private static final String SLIVKA_HOST_URLS = "SLIVKAHOSTURLS";
25   
26    private static final URL DEFAULT_URL;
 
27  11 toggle static
28    {
29  11 try
30    {
31  11 DEFAULT_URL = new URL("https://www.compbio.dundee.ac.uk/slivka/");
32    } catch (MalformedURLException e)
33    {
34  0 throw new AssertionError(e);
35    }
36    }
37   
38    private static SlivkaWSDiscoverer instance = null;
39   
40    private static ParamManager paramManager = null;
41   
42    private final Function<URI, SlivkaClient> clientFactory;
43   
 
44  66 toggle SlivkaWSDiscoverer(Function<URI, SlivkaClient> clientFactory)
45    {
46  66 this.clientFactory = clientFactory;
47    }
48   
 
49  9051 toggle public static SlivkaWSDiscoverer getInstance()
50    {
51  9051 if (instance == null)
52  11 instance = new SlivkaWSDiscoverer(SlivkaClient::newInstance);
53  9051 return instance;
54    }
55   
 
56  0 toggle public static void setParamManager(ParamManager manager)
57    {
58  0 paramManager = manager;
59    }
60   
 
61  14 toggle @Override
62    public int getStatusForUrl(URL url)
63    {
64  14 try
65    {
66  14 List<?> services = clientFactory.apply(url.toURI()).getServices();
67  8 return services.isEmpty() ? STATUS_NO_SERVICES : STATUS_OK;
68    } catch (URISyntaxException e)
69    {
70  0 Console.error("invalid URL " + url, e);
71  0 return STATUS_INVALID;
72    } catch (IOException e)
73    {
74  1 Console.error("slivka could not retrieve services from " + url, e);
75  1 return STATUS_INVALID;
76    }
77    }
78   
 
79  142 toggle @Override
80    protected String getUrlsPropertyKey()
81    {
82  142 return SLIVKA_HOST_URLS;
83    }
84   
 
85  127 toggle @Override
86    protected URL getDefaultUrl()
87    {
88  127 return DEFAULT_URL;
89    }
90   
 
91  167 toggle @Override
92    protected List<WebService<?>> fetchServices(URL url) throws IOException
93    {
94  167 ArrayList<WebService<?>> allServices = new ArrayList<>();
95  167 SlivkaClient slivkaClient;
96  167 try
97    {
98  167 slivkaClient = clientFactory.apply(url.toURI());
99    } catch (URISyntaxException e)
100    {
101  0 throw new MalformedURLException(e.getMessage());
102    }
103  167 for (var slivkaService : slivkaClient.getServices())
104    {
105  1717 int serviceClass = getServiceClass(slivkaService);
106  1717 if (serviceClass == SERVICE_CLASS_MSA)
107    {
108  810 var wsb = WebService.<AlignmentAction> newBuilder();
109  810 initServiceBuilder(slivkaClient, slivkaService, wsb);
110  810 wsb.category("Alignment");
111  810 wsb.interactive(false);
112  810 wsb.actionClass(AlignmentAction.class);
113  810 var msaService = wsb.build();
114   
115  810 boolean canRealign = msaService.getName().contains("lustal");
116  810 var client = new SlivkaAlignmentWSClient(slivkaClient, slivkaService);
117  810 var actionBuilder = AlignmentAction.newBuilder(client);
118  810 actionBuilder.name("Alignment");
119  810 actionBuilder.webService(msaService);
120  810 if (canRealign)
121  225 actionBuilder.subcategory("Align");
122  810 actionBuilder.minSequences(2);
123  810 msaService.addAction(actionBuilder.build());
124  810 if (canRealign)
125    {
126  225 actionBuilder.name("Re-alignment");
127  225 actionBuilder.subcategory("Realign");
128  225 actionBuilder.submitGaps(true);
129  225 msaService.addAction(actionBuilder.build());
130    }
131  810 allServices.add(msaService);
132    }
133  907 else if (serviceClass == SERVICE_CLASS_PROT_SEQ_ANALYSIS)
134    {
135  445 var wsb = WebService.<AnnotationAction> newBuilder();
136  445 initServiceBuilder(slivkaClient, slivkaService, wsb);
137  445 wsb.category("Protein Disorder");
138  445 wsb.interactive(false);
139  445 wsb.actionClass(AnnotationAction.class);
140  445 var psaService = wsb.build();
141  445 var client = new SlivkaAnnotationWSClient(slivkaClient, slivkaService);
142  445 var actionBuilder = AnnotationAction.newBuilder(client);
143  445 actionBuilder.webService(psaService);
144  445 actionBuilder.name("Analysis");
145  445 psaService.addAction(actionBuilder.build());
146  445 allServices.add(psaService);
147    }
148  462 else if (serviceClass == SERVICE_CLASS_CONSERVATION)
149    {
150  116 var wsb = WebService.<AnnotationAction> newBuilder();
151  116 initServiceBuilder(slivkaClient, slivkaService, wsb);
152  116 wsb.category("Conservation");
153  116 wsb.interactive(true);
154  116 wsb.actionClass(AnnotationAction.class);
155  116 var conService = wsb.build();
156  116 var client = new SlivkaAnnotationWSClient(slivkaClient, slivkaService);
157  116 var actionBuilder = AnnotationAction.newBuilder(client);
158  116 actionBuilder.webService(conService);
159  116 actionBuilder.name("");
160  116 actionBuilder.alignmentAnalysis(true);
161  116 actionBuilder.requireAlignedSequences(true);
162  116 actionBuilder.filterSymbols(true);
163  116 conService.addAction(actionBuilder.build());
164  116 allServices.add(conService);
165    }
166  346 else if (serviceClass == SERVICE_CLASS_RNA_SEC_STR_PRED)
167    {
168  123 var wsb = WebService.<AnnotationAction> newBuilder();
169  123 initServiceBuilder(slivkaClient, slivkaService, wsb);
170  123 wsb.category("Secondary Structure Prediction");
171  123 wsb.interactive(true);
172  123 wsb.actionClass(AnnotationAction.class);
173  123 var predService = wsb.build();
174  123 var client = new SlivkaAnnotationWSClient(slivkaClient, slivkaService);
175  123 var actionBuilder = AnnotationAction.newBuilder(client);
176  123 actionBuilder.webService(predService);
177  123 actionBuilder.name("Prediction");
178  123 actionBuilder.minSequences(2);
179  123 actionBuilder.allowNucleotide(true);
180  123 actionBuilder.allowProtein(false);
181  123 actionBuilder.alignmentAnalysis(true);
182  123 actionBuilder.requireAlignedSequences(true);
183  123 actionBuilder.filterSymbols(false);
184  123 predService.addAction(actionBuilder.build());
185  123 allServices.add(predService);
186    }
187    else
188    {
189  223 continue;
190    }
191    }
192  163 return allServices;
193    }
194   
 
195  1494 toggle private void initServiceBuilder(SlivkaClient client, SlivkaService service, WebService.Builder<?> wsBuilder)
196    {
197  1494 try
198    {
199  1494 wsBuilder.url(client.getUrl().toURL());
200    } catch (MalformedURLException e)
201    {
202  0 e.printStackTrace();
203    }
204  1494 wsBuilder.clientName("slivka");
205  1494 wsBuilder.name(service.getName());
206  1494 wsBuilder.description(service.getDescription());
207  1494 var storeBuilder = new SlivkaParamStoreFactory(service, paramManager);
208  1494 wsBuilder.paramDatastore(storeBuilder.createParamDatastore());
209    }
210   
211    static final int SERVICE_CLASS_UNSUPPORTED = -1;
212   
213    static final int SERVICE_CLASS_MSA = 1;
214   
215    static final int SERVICE_CLASS_RNA_SEC_STR_PRED = 2;
216   
217    static final int SERVICE_CLASS_CONSERVATION = 3;
218   
219    static final int SERVICE_CLASS_PROT_SEQ_ANALYSIS = 4;
220   
221    static final int SERVICE_CLASS_PROT_SEC_STR_PRED = 5;
222   
223    /**
224    * Scan service classifiers starting with operation :: analysis to decide the
225    * operation class.
226    *
227    * @return service class flag
228    */
 
229  1717 toggle private static int getServiceClass(SlivkaService service)
230    {
231  1717 for (String classifier : service.getClassifiers())
232    {
233  3944 String[] path = classifier.split("\\s*::\\s*");
234  3944 if (path.length < 3 || !path[0].equalsIgnoreCase("operation"))
235  2228 continue;
236    // classifier is operation :: *
237  1716 var tail = path[path.length - 1].toLowerCase();
238  1716 switch (tail)
239    {
240  810 case "multiple sequence alignment":
241  810 return SERVICE_CLASS_MSA;
242  123 case "rna secondary structure prediction":
243  123 return SERVICE_CLASS_RNA_SEC_STR_PRED;
244  116 case "sequence alignment analysis (conservation)":
245  116 return SERVICE_CLASS_CONSERVATION;
246  445 case "protein sequence analysis":
247  445 return SERVICE_CLASS_PROT_SEQ_ANALYSIS;
248  111 case "protein secondary structure prediction":
249  111 return SERVICE_CLASS_PROT_SEC_STR_PRED;
250    }
251    }
252  112 return SERVICE_CLASS_UNSUPPORTED;
253    }
254    }