JAL-4036 add search fieldname to dropdown list

[jalview.git] / src / jalview / fts / core / FTSRestClient.java

diff --git a/src/jalview/fts/core/FTSRestClient.java b/src/jalview/fts/core/FTSRestClient.java
index 076e212..2d79432 100644 (file)
--- a/src/jalview/fts/core/FTSRestClient.java
+++ b/src/jalview/fts/core/FTSRestClient.java
@@ -20,19 +20,21 @@
  */
 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
@@ -43,13 +45,13 @@ import java.util.Objects;
  */
 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;
 
@@ -57,6 +59,8 @@ public abstract class FTSRestClient implements FTSRestClientI
 
   private int defaultResponsePageSize = 100;
 
+  protected HashMap<String, String> mockQueries = null;
+
   protected FTSRestClient()
   {
 
@@ -140,7 +144,8 @@ public abstract class FTSRestClient implements FTSRestClientI
               @Override
               public String toString()
               {
-                return lineData[0];
+                return "ALL".equals(getName()) ? getName()
+                        : getName() + " [" + getAltCode() + "]";
               }
 
               @Override
@@ -167,7 +172,8 @@ public abstract class FTSRestClient implements FTSRestClientI
               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()
                 {
@@ -178,7 +184,7 @@ public abstract class FTSRestClient implements FTSRestClientI
                     if (dataTypeString.length > 1
                             && dataTypeString[1] != null)
                     {
-                      switch (dataTypeString[1].toUpperCase())
+                      switch (dataTypeString[1].toUpperCase(Locale.ROOT))
                       {
                       case "T":
                       case "TRUE":
@@ -284,9 +290,10 @@ public abstract class FTSRestClient implements FTSRestClientI
               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());
               }
 
             };
@@ -427,6 +434,18 @@ public abstract class FTSRestClient implements FTSRestClientI
             "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
   public FTSDataColumnGroupI getDataColumnGroupById(String id)
           throws Exception
@@ -445,22 +464,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:
@@ -469,16 +487,21 @@ public abstract class FTSRestClient implements FTSRestClientI
     case 502:
     case 504:
     case 505:
-      message = MessageManager.formatMessage("exception.fts_server_error",
-              service);
+      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)
@@ -505,4 +528,39 @@ public abstract class FTSRestClient implements FTSRestClientI
     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;
+  }
 }