+/*
+ * 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 <http://www.gnu.org/licenses/>.
+ * 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;
import java.io.InputStreamReader;
import java.util.ArrayList;
import java.util.Collection;
+import java.util.HashMap;
+import java.util.Locale;
import java.util.Objects;
+import jalview.fts.api.FTSDataColumnI;
+import jalview.fts.api.FTSDataColumnI.FTSDataColumnGroupI;
+import jalview.fts.api.FTSRestClientI;
+import jalview.fts.core.FTSDataColumnPreferences.PreferenceSource;
+
/**
* Base class providing implementation for common methods defined in
* FTSRestClientI
*/
public abstract class FTSRestClient implements FTSRestClientI
{
- protected Collection<FTSDataColumnI> dataColumns = new ArrayList<FTSDataColumnI>();
+ protected Collection<FTSDataColumnI> dataColumns = new ArrayList<>();
- protected Collection<FTSDataColumnGroupI> dataColumnGroups = new ArrayList<FTSDataColumnGroupI>();
+ protected Collection<FTSDataColumnGroupI> dataColumnGroups = new ArrayList<>();
- protected Collection<FTSDataColumnI> searchableDataColumns = new ArrayList<FTSDataColumnI>();
+ protected Collection<FTSDataColumnI> searchableDataColumns = new ArrayList<>();
- protected Collection<FTSDataColumnI> defaulDisplayedDataColumns = new ArrayList<FTSDataColumnI>();
+ protected Collection<FTSDataColumnI> defaulDisplayedDataColumns = new ArrayList<>();
protected FTSDataColumnI primaryKeyColumn;
private int defaultResponsePageSize = 100;
+ protected HashMap<String, String> mockQueries = null;
+
protected FTSRestClient()
{
public void parseDataColumnsConfigFile()
{
String fileName = getColumnDataConfigFileName();
-
- InputStream in = getClass().getResourceAsStream(fileName);
-
+
+ InputStream in = getClass().getResourceAsStream(fileName);
+
try (BufferedReader br = new BufferedReader(new InputStreamReader(in)))
{
String line;
{
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]);
}
@Override
public String toString()
{
- return lineData[0];
+ return "ALL".equals(getName()) ? getName()
+ : getName() + " [" + getAltCode() + "]";
}
@Override
@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
public DataTypeI getDataType()
{
final String[] dataTypeString = lineData[2].split("\\|");
- final String classString = dataTypeString[0].toUpperCase();
+ final String classString = dataTypeString[0]
+ .toUpperCase(Locale.ROOT);
return new DataTypeI()
{
if (dataTypeString.length > 1
&& dataTypeString[1] != null)
{
- switch (dataTypeString[1].toUpperCase())
+ switch (dataTypeString[1].toUpperCase(Locale.ROOT))
{
case "T":
case "TRUE":
this.getGroup());
}
-
@Override
public boolean equals(Object otherObject)
{
FTSDataColumnI that = (FTSDataColumnI) otherObject;
- return this.getCode().equals(that.getCode())
- && this.getName().equals(that.getName())
- && this.getGroup().equals(that.getGroup());
+ return otherObject == null ? false
+ : this.getCode().equals(that.getCode())
+ && this.getName().equals(that.getName())
+ && this.getGroup().equals(that.getGroup());
}
-
};
dataColumns.add(dataCol);
}
try
{
- this.primaryKeyColumn = getDataColumnByNameOrCode(primaryKeyColumnCode);
+ this.primaryKeyColumn = getDataColumnByNameOrCode(
+ primaryKeyColumnCode);
} catch (Exception e)
{
e.printStackTrace();
return result;
}
-
@Override
public Collection<FTSDataColumnI> getAllFTSDataColumns()
{
return column;
}
}
- throw new Exception("Couldn't find data column with name : "
- + nameOrCode);
+ throw new Exception(
+ "Couldn't find data column with name : " + nameOrCode);
+ }
+
+ /**
+ *
+ * @param instance
+ * @param mocks
+ * {{working query, working response}, ...}
+ */
+ public static void createMockFTSRestClient(FTSRestClient instance,
+ String[][] mocks)
+ {
+ instance.setMock(mocks);
}
@Override
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:
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.mockQueries = null;
}
protected String getResourceFile(String fileName)
return defaultResponsePageSize;
}
+ protected void setMock(String[][] mocks)
+ {
+ if (mocks == null)
+ {
+ mockQueries = null;
+ return;
+ }
+ mockQueries = new HashMap<String, String>();
+ for (String[] mock : mocks)
+ {
+ mockQueries.put(mock[0], mock[1]);
+ }
+ }
+
+ protected boolean isMocked()
+ {
+ return mockQueries != 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;
+ }
}
git://source.jalview.org / jalview.git / blobdiff