JAL-2386 avoid duplicate pdbids in free text query
[jalview.git] / src / jalview / fts / core / FTSRestClient.java
index f2df461..8b1c785 100644 (file)
@@ -1,3 +1,23 @@
+/*
+ * 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;
@@ -23,13 +43,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;
 
@@ -45,9 +65,9 @@ public abstract class FTSRestClient implements FTSRestClientI
   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;
@@ -62,8 +82,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 +158,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 +280,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 +315,8 @@ public abstract class FTSRestClient implements FTSRestClientI
       }
       try
       {
-        this.primaryKeyColumn = getDataColumnByNameOrCode(primaryKeyColumnCode);
+        this.primaryKeyColumn = getDataColumnByNameOrCode(
+                primaryKeyColumnCode);
       } catch (Exception e)
       {
         e.printStackTrace();
@@ -345,7 +366,6 @@ public abstract class FTSRestClient implements FTSRestClientI
     return result;
   }
 
-
   @Override
   public Collection<FTSDataColumnI> getAllFTSDataColumns()
   {
@@ -367,7 +387,7 @@ public abstract class FTSRestClient implements FTSRestClientI
   }
 
   @Override
-  public Collection<FTSDataColumnI> getAllDefaulDisplayedDataColumns()
+  public Collection<FTSDataColumnI> getAllDefaultDisplayedFTSDataColumns()
   {
     if (defaulDisplayedDataColumns == null
             || defaulDisplayedDataColumns.isEmpty())
@@ -404,8 +424,8 @@ 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);
   }
 
   @Override
@@ -426,23 +446,22 @@ 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);
+              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 +470,16 @@ 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;
   }
 
   protected String getResourceFile(String fileName)