Classes

Class	Line #	Total Statements	Complexity	TOTAL Coverage	Actions
EBIFetchClient	44	68	31	0.327102832.7%	Show methods

Class EBIFetchClient

Class EBIFetchClient	Line # 44	Total Statements 68	Complexity 31	TOTAL Coverage 0.327102832.7%
EBIFetchClient()   EBIFetchClient()	5050	0.00	1.01	-1.0 -1.0 -
getSupportedDBs() : String[]   getSupportedDBs() : String[]	5959	1.01	1.01	0.0 0.00%
getSupportedFormats() : String[]   getSupportedFormats() : String[]	7070	1.01	1.01	0.0 0.00%
getSupportedStyles() : String[]   getSupportedStyles() : String[]	8181	1.01	1.01	0.0 0.00%
fetchDataAsFile(String,String,String) : File   fetchDataAsFile(String,String,String) : File	100100	9.09	3.03	0.0 0.00%
fetchData(String,String,File) : String[]   fetchData(String,String,File) : String[]	130130	8.08	4.04	0.0 0.00%
parseIds(String,StringBuilder) : String   parseIds(String,StringBuilder) : String	159159	16.016	6.06	1.0 1.0100%
fetchBatch(String,String,String,File) : String[]   fetchBatch(String,String,String,File) : String[]	200200	27.027	9.09	0.0 0.00%
buildUrl(String,String,String) : String   buildUrl(String,String,String) : String	266266	5.05	5.05	0.8181818 0.818181881.8%

 

Contributing tests

Contributing tests

Select all

	Test contribution	Test	Result	Actions
	0.23364486	jalview.ws.ebi.EBIFetchClientTest.testParseIdsjalview.ws.ebi.EBIFetchClientTest.testParseIds	1PASS
	0.093457945	jalview.ws.ebi.EBIFetchClientTest.testBuildUrljalview.ws.ebi.EBIFetchClientTest.testBuildUrl	1PASS

 

Source view

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.ebi;
22
23		import jalview.datamodel.DBRefSource;
24		import jalview.util.MessageManager;
25		import jalview.util.Platform;
26
27		import java.io.BufferedReader;
28		import java.io.File;
29		import java.io.IOException;
30		import java.io.InputStream;
31		import java.io.InputStreamReader;
32		import java.net.HttpURLConnection;
33		import java.net.URL;
34		import java.util.ArrayList;
35		import java.util.List;
36		import java.util.StringTokenizer;
37
38		/**
39		* DOCUMENT ME!
40		*
41		* @author $author$
42		* @version $Revision$
43		*/
		32.7% Uncovered Elements: 72 (107) Complexity: 31 Complexity Density: 0.46
44		public class EBIFetchClient
45		{
46
47		/**
48		* Creates a new EBIFetchClient object.
49		*/
		- Uncovered Elements: 0 (0) Complexity: 1 Complexity Density: -
50	0	public EBIFetchClient()...
51		{
52		}
53
54		/**
55		* DOCUMENT ME!
56		*
57		* @return DOCUMENT ME!
58		*/
		0% Uncovered Elements: 1 (1) Complexity: 1 Complexity Density: 1
59	0	public String[] getSupportedDBs()...
60		{
61		// TODO - implement rest call for dbfetch getSupportedDBs
62	0	throw new Error(MessageManager.getString("error.not_yet_implemented"));
63		}
64
65		/**
66		* DOCUMENT ME!
67		*
68		* @return DOCUMENT ME!
69		*/
		0% Uncovered Elements: 1 (1) Complexity: 1 Complexity Density: 1
70	0	public String[] getSupportedFormats()...
71		{
72		// TODO - implement rest call for dbfetch getSupportedFormats
73	0	throw new Error(MessageManager.getString("error.not_yet_implemented"));
74		}
75
76		/**
77		* DOCUMENT ME!
78		*
79		* @return DOCUMENT ME!
80		*/
		0% Uncovered Elements: 1 (1) Complexity: 1 Complexity Density: 1
81	0	public String[] getSupportedStyles()...
82		{
83		// TODO - implement rest call for dbfetch getSupportedStyles
84	0	throw new Error(MessageManager.getString("error.not_yet_implemented"));
85		}
86
87		/**
88		* Send an HTTP fetch request to EBI and save the reply in a temporary file.
89		*
90		* @param ids
91		* the query formatted as db:query1;query2;query3
92		* @param format
93		* the format wanted
94		* @param extension
95		* for the temporary file to hold response (without separator)
96		* @return the file holding the response
97		* @throws OutOfMemoryError
98		*/
99
		0% Uncovered Elements: 11 (11) Complexity: 3 Complexity Density: 0.33
100	0	public File fetchDataAsFile(String ids, String format, String ext)...
101		throws OutOfMemoryError
102		{
103	0	File outFile = null;
104	0	try
105		{
106	0	outFile = File.createTempFile("jalview", "." + ext);
107	0	outFile.deleteOnExit();
108	0	fetchData(ids, format, outFile);
109	0	if (outFile.length() == 0)
110		{
111	0	outFile.delete();
112	0	return null;
113		}
114		} catch (Exception ex)
115		{
116		}
117	0	return outFile;
118		}
119
120		/**
121		* Fetches queries and either saves the response to a file or returns as
122		* string data
123		*
124		* @param ids
125		* @param format
126		* @param outFile
127		* @return
128		* @throws OutOfMemoryError
129		*/
		0% Uncovered Elements: 12 (12) Complexity: 4 Complexity Density: 0.5
130	0	String[] fetchData(String ids, String format, File outFile)...
131		throws OutOfMemoryError
132		{
133	0	StringBuilder querystring = new StringBuilder(ids.length());
134	0	String database = parseIds(ids, querystring);
135	0	if (database == null)
136		{
137	0	System.err.println("Invalid Query string : '" + ids + "'");
138	0	System.err.println("Should be of form 'dbname:q1;q2;q3;q4'");
139	0	return null;
140		}
141
142		// note: outFile is currently always specified, so return value is null
143	0	String[] rslt = fetchBatch(querystring.toString(), database, format,
144		outFile);
145
146	0	return (rslt != null && rslt.length > 0 ? rslt : null);
147		}
148
149		/**
150		* Parses ids formatted as dbname:q1;q2;q3, returns the dbname and adds
151		* queries as comma-separated items to the querystring. dbname must be
152		* specified for at least one queryId. Returns null if a mixture of different
153		* dbnames is found (ignoring case).
154		*
155		* @param ids
156		* @param queryString
157		* @return
158		*/
		100% Uncovered Elements: 0 (24) Complexity: 6 Complexity Density: 0.38
159	7	static String parseIds(String ids, StringBuilder queryString)...
160		{
161	7	String database = null;
162	7	StringTokenizer queries = new StringTokenizer(ids, ";");
163	7	boolean appending = queryString.length() > 0;
164	19	while (queries.hasMoreTokens())
165		{
166	13	String query = queries.nextToken();
167	13	int p = query.indexOf(':');
168	13	if (p > -1)
169		{
170	9	String db = query.substring(0, p);
171	9	if (database != null && !db.equalsIgnoreCase(database))
172		{
173		/*
174		* different databases mixed in together - invalid
175		*/
176	1	return null;
177		}
178	8	database = db;
179	8	query = query.substring(p + 1);
180		}
181	12	queryString.append(appending ? "," : "");
182	12	queryString.append(query);
183	12	appending = true;
184		}
185	6	return database;
186		}
187
188		/**
189		* Fetches queries and either saves the response to a file or (if no file
190		* specified) returns as string data
191		*
192		* @param ids
193		* @param database
194		* @param format
195		* @param outFile
196		* @return array of lines from EBI only if outFile is null (which it will not
197		* be)
198		* @throws OutOfMemoryError
199		*/
		0% Uncovered Elements: 37 (37) Complexity: 9 Complexity Density: 0.33
200	0	String[] fetchBatch(String ids, String database, String format,...
201		File outFile) throws OutOfMemoryError
202		{
203	0	String url = buildUrl(ids, database, format);
204	0	InputStream is = null;
205	0	try
206		{
207	0	URL rcall = new URL(url);
208	0	HttpURLConnection conn = (HttpURLConnection) rcall.openConnection();
209	0	int responseCode = conn.getResponseCode();
210	0	if (responseCode == 200)
211		{
212	0	is = conn.getInputStream();
213	0	if (outFile != null)
214		{
215	0	Platform.streamToFile(is, outFile);
216	0	return null;
217		}
218	0	BufferedReader br = new BufferedReader(new InputStreamReader(is));
219	0	String rtn;
220	0	List<String> arl = new ArrayList<>();
221	0	while ((rtn = br.readLine()) != null)
222		{
223	0	arl.add(rtn);
224		}
225	0	return (String[]) arl.toArray();
226		}
227	0	System.err.println(
228		"Warning: response code " + responseCode + " for " + url);
229		} catch (OutOfMemoryError er)
230		{
231	0	System.out.println("OUT OF MEMORY DOWNLOADING QUERY FROM " + database
232		+ ":\n" + ids);
233	0	throw er;
234		} catch (Exception ex)
235		{
236	0	if (!ex.getMessage().startsWith(
237		"uk.ac.ebi.jdbfetch.exceptions.DbfNoEntryFoundException"))
238		{
239	0	System.err.println("Unexpected exception when retrieving from "
240		+ database + "\nQuery was : '" + ids + "'");
241	0	ex.printStackTrace(System.err);
242		}
243		} finally
244		{
245	0	if (is != null)
246		{
247	0	try
248		{
249	0	is.close();
250		} catch (IOException e)
251		{
252		}
253		}
254		}
255	0	return null;
256		}
257
258		/**
259		* Constructs the URL to fetch from
260		*
261		* @param ids
262		* @param database
263		* @param format
264		* @return
265		*/
		81.8% Uncovered Elements: 2 (11) Complexity: 5 Complexity Density: 1
266	4	static String buildUrl(String ids, String database, String format)...
267		{
268	4	String url;
269	4	if (database.equalsIgnoreCase(DBRefSource.EMBL)
270		|| database.equalsIgnoreCase(DBRefSource.EMBLCDS))
271		{
272	2	url = "https://www.ebi.ac.uk/ena/data/view/" + ids.toLowerCase()
273	2	+ (format != null ? "&" + format : "");
274		}
275		else
276		{
277	2	url = "https://www.ebi.ac.uk/Tools/dbfetch/dbfetch/"
278		+ database.toLowerCase() + "/" + ids.toLowerCase()
279	2	+ (format != null ? "/" + format : "");
280		}
281	4	return url;
282		}
283		}