X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Ffts%2Fcore%2FFTSRestClient.java;h=b262f64a1922b9bb896ef455926f6b1329e89dfc;hb=bb3748fd2cc3ee8e8e0409599569e24e88974a17;hp=00a081b8d3fbf4c21a9ba29d9d55265171188f66;hpb=2051c117e19e8b7c72bf5a9f1db48f2b4687f71e;p=jalview.git
diff --git a/src/jalview/fts/core/FTSRestClient.java b/src/jalview/fts/core/FTSRestClient.java
index 00a081b..b262f64 100644
--- a/src/jalview/fts/core/FTSRestClient.java
+++ b/src/jalview/fts/core/FTSRestClient.java
@@ -1,10 +1,25 @@
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ *
+ * This file is part of Jalview.
+ *
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *
+ * Jalview is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ * PURPOSE. See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview. If not, see .
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
package jalview.fts.core;
-import jalview.fts.api.FTSDataColumnI;
-import jalview.fts.api.FTSDataColumnI.FTSDataColumnGroupI;
-import jalview.fts.api.FTSRestClientI;
-import jalview.util.MessageManager;
-
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
@@ -13,6 +28,12 @@ import java.util.ArrayList;
import java.util.Collection;
import java.util.Objects;
+import jalview.fts.api.FTSDataColumnI;
+import jalview.fts.api.FTSDataColumnI.FTSDataColumnGroupI;
+import jalview.fts.core.FTSDataColumnPreferences.PreferenceSource;
+import jalview.fts.service.threedbeacons.TDBeaconsFTSRestClient;
+import jalview.fts.api.FTSRestClientI;
+
/**
* Base class providing implementation for common methods defined in
* FTSRestClientI
@@ -23,13 +44,13 @@ import java.util.Objects;
*/
public abstract class FTSRestClient implements FTSRestClientI
{
- protected Collection dataColumns = new ArrayList();
+ protected Collection dataColumns = new ArrayList<>();
- protected Collection dataColumnGroups = new ArrayList();
+ protected Collection dataColumnGroups = new ArrayList<>();
- protected Collection searchableDataColumns = new ArrayList();
+ protected Collection searchableDataColumns = new ArrayList<>();
- protected Collection defaulDisplayedDataColumns = new ArrayList();
+ protected Collection defaulDisplayedDataColumns = new ArrayList<>();
protected FTSDataColumnI primaryKeyColumn;
@@ -37,6 +58,10 @@ public abstract class FTSRestClient implements FTSRestClientI
private int defaultResponsePageSize = 100;
+ protected String mockQuery = null;
+
+ protected String mockResponse = null;
+
protected FTSRestClient()
{
@@ -45,10 +70,10 @@ public abstract class FTSRestClient implements FTSRestClientI
public void parseDataColumnsConfigFile()
{
String fileName = getColumnDataConfigFileName();
-
- InputStream in = getClass().getResourceAsStream(fileName);
-
- try (BufferedReader br = new BufferedReader(new InputStreamReader(in)))
+
+ InputStream in = getClass().getResourceAsStream(fileName);
+
+ try (BufferedReader br = new BufferedReader(new InputStreamReader(in)))
{
String line;
while ((line = br.readLine()) != null)
@@ -62,8 +87,8 @@ public abstract class FTSRestClient implements FTSRestClientI
{
primaryKeyColumnCode = lineData[1];
}
- if (lineData[0]
- .equalsIgnoreCase("_data_column.default_response_page_size"))
+ if (lineData[0].equalsIgnoreCase(
+ "_data_column.default_response_page_size"))
{
defaultResponsePageSize = Integer.valueOf(lineData[1]);
}
@@ -138,8 +163,9 @@ public abstract class FTSRestClient implements FTSRestClientI
@Override
public String getAltCode()
{
- return lineData[1].split("\\|").length > 1 ? lineData[1]
- .split("\\|")[1] : getCode();
+ return lineData[1].split("\\|").length > 1
+ ? lineData[1].split("\\|")[1]
+ : getCode();
}
@Override
@@ -259,17 +285,16 @@ public abstract class FTSRestClient implements FTSRestClientI
this.getGroup());
}
-
@Override
public boolean equals(Object otherObject)
{
FTSDataColumnI that = (FTSDataColumnI) otherObject;
- return this.getCode().equals(that.getCode())
+ return otherObject == null ? false
+ : this.getCode().equals(that.getCode())
&& this.getName().equals(that.getName())
&& this.getGroup().equals(that.getGroup());
}
-
};
dataColumns.add(dataCol);
@@ -295,7 +320,8 @@ public abstract class FTSRestClient implements FTSRestClientI
}
try
{
- this.primaryKeyColumn = getDataColumnByNameOrCode(primaryKeyColumnCode);
+ this.primaryKeyColumn = getDataColumnByNameOrCode(
+ primaryKeyColumnCode);
} catch (Exception e)
{
e.printStackTrace();
@@ -345,7 +371,6 @@ public abstract class FTSRestClient implements FTSRestClientI
return result;
}
-
@Override
public Collection getAllFTSDataColumns()
{
@@ -404,8 +429,14 @@ public abstract class FTSRestClient implements FTSRestClientI
return column;
}
}
- throw new Exception("Couldn't find data column with name : "
- + nameOrCode);
+ throw new Exception(
+ "Couldn't find data column with name : " + nameOrCode);
+ }
+
+ public static void createMockFTSRestClient(FTSRestClient instance,String workingQuery,
+ String jsonResponse)
+ {
+ instance.setMock(workingQuery,jsonResponse);
}
@Override
@@ -426,23 +457,21 @@ public abstract class FTSRestClient implements FTSRestClientI
throw new Exception("Couldn't find data column group with id : " + id);
}
- public String getMessageByHTTPStatusCode(int code, String service)
+ public static String getMessageByHTTPStatusCode(int code, String service)
{
String message = "";
switch (code)
{
case 400:
- message = MessageManager
- .getString("exception.bad_request");
+ message = "Bad request. There is a problem with your input.";
break;
-
+
case 410:
- message = MessageManager.formatMessage(
- "exception.fts_rest_service_no_longer_available", service);
+ message = service + " rest services no longer available!";
break;
case 403:
case 404:
- message = MessageManager.getString("exception.resource_not_be_found");
+ message = "The requested resource could not be found";
break;
case 408:
case 409:
@@ -451,15 +480,22 @@ public abstract class FTSRestClient implements FTSRestClientI
case 502:
case 504:
case 505:
- message = MessageManager.getString("exception.fts_server_error");
+ message = "There seems to be an error from the " + service
+ + " server";
break;
case 503:
- message = MessageManager.getString("exception.service_not_available");
+ message = "Service not available. The server is being updated, try again later.";
break;
default:
break;
}
- return message;
+ return String.valueOf(code) + " " + message;
+ }
+
+ public static void unMock(FTSRestClient instance)
+ {
+ instance.mockQuery =null;
+ instance.mockResponse =null;
}
protected String getResourceFile(String fileName)
@@ -486,4 +522,30 @@ public abstract class FTSRestClient implements FTSRestClientI
return defaultResponsePageSize;
}
+ protected void setMock(String workingQuery, String jsonResponse)
+ {
+ mockQuery=workingQuery;
+ mockResponse = jsonResponse;
+ }
+
+ protected boolean isMocked()
+ {
+ return mockQuery != null && mockResponse!=null;
+ }
+
+ @Override
+ public String[] getPreferencesColumnsFor(PreferenceSource source)
+ {
+ String[] columnNames = null;
+ switch (source)
+ {
+ case SEARCH_SUMMARY:
+ columnNames = new String[] { "", "Display", "Group" };
+ break;
+ default:
+ // non structure sources don't return any other kind of preferences columns
+ break;
+ }
+ return columnNames;
+ }
}