X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2Fjalview%2Ffts%2Fcore%2FFTSRestClient.java;h=ac5b2806519e9db4a0f5b11b53baca346ec81ea3;hb=3f5088fe082c479c0de91f897ed26a5adf540f98;hp=0605fef2c065db6beb38df254837201ba7c07420;hpb=9259191d7265f8004f7cf51a62d9365a5c84067b;p=jalview.git

diff --git a/src/jalview/fts/core/FTSRestClient.java b/src/jalview/fts/core/FTSRestClient.java
index 0605fef..ac5b280 100644
--- a/src/jalview/fts/core/FTSRestClient.java
+++ b/src/jalview/fts/core/FTSRestClient.java
@@ -1,8 +1,26 @@
+/*
+ * 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 java.util.Locale;
 
 import java.io.BufferedReader;
 import java.io.IOException;
@@ -10,8 +28,15 @@ import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.util.ArrayList;
 import java.util.Collection;
+import java.util.HashMap;
 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
@@ -22,13 +47,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;
 
@@ -36,6 +61,8 @@ public abstract class FTSRestClient implements FTSRestClientI
 
   private int defaultResponsePageSize = 100;
 
+  protected HashMap<String, String> mockQueries = null;
+
   protected FTSRestClient()
   {
 
@@ -44,9 +71,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;
@@ -61,8 +88,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]);
             }
@@ -131,25 +158,75 @@ public abstract class FTSRestClient implements FTSRestClientI
               @Override
               public String getCode()
               {
-                return lineData[1];
+                return lineData[1].split("\\|")[0];
+              }
+
+              @Override
+              public String getAltCode()
+              {
+                return lineData[1].split("\\|").length > 1
+                        ? lineData[1].split("\\|")[1]
+                        : getCode();
               }
 
               @Override
-              public Class<?> getDataColumnClass()
+              public DataTypeI getDataType()
               {
-                String classString = lineData[2];
-                classString = classString.toUpperCase();
-                switch (classString)
+                final String[] dataTypeString = lineData[2].split("\\|");
+                final String classString = dataTypeString[0]
+                        .toUpperCase(Locale.ROOT);
+
+                return new DataTypeI()
                 {
-                case "INT":
-                case "INTEGER":
-                  return Integer.class;
-                case "DOUBLE":
-                  return Double.class;
-                case "STRING":
-                default:
-                  return String.class;
-                }
+
+                  @Override
+                  public boolean isFormtted()
+                  {
+                    if (dataTypeString.length > 1
+                            && dataTypeString[1] != null)
+                    {
+                      switch (dataTypeString[1].toUpperCase(Locale.ROOT))
+                      {
+                      case "T":
+                      case "TRUE":
+                        return true;
+                      case "F":
+                      case "False":
+                      default:
+                        return false;
+                      }
+                    }
+                    return false;
+                  }
+
+                  @Override
+                  public int getSignificantFigures()
+                  {
+                    if (dataTypeString.length > 2
+                            && dataTypeString[2] != null)
+                    {
+                      return Integer.valueOf(dataTypeString[2]);
+                    }
+                    return 0;
+                  }
+
+                  @Override
+                  public Class getDataTypeClass()
+                  {
+                    switch (classString)
+                    {
+                    case "INT":
+                    case "INTEGER":
+                      return Integer.class;
+                    case "DOUBLE":
+                      return Double.class;
+                    case "STRING":
+                    default:
+                      return String.class;
+                    }
+                  }
+                };
+
               }
 
               @Override
@@ -210,14 +287,14 @@ public abstract class FTSRestClient implements FTSRestClientI
                         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());
               }
 
             };
@@ -245,7 +322,8 @@ public abstract class FTSRestClient implements FTSRestClientI
       }
       try
       {
-        this.primaryKeyColumn = getDataColumnByNameOrCode(primaryKeyColumnCode);
+        this.primaryKeyColumn = getDataColumnByNameOrCode(
+                primaryKeyColumnCode);
       } catch (Exception e)
       {
         e.printStackTrace();
@@ -295,32 +373,6 @@ public abstract class FTSRestClient implements FTSRestClientI
     return result;
   }
 
-  /**
-   * Takes a collection of FTSDataColumnI and converts its 'code' values into a
-   * tab delimited string.
-   * 
-   * @param dataColumnFields
-   *          the collection of FTSDataColumnI to process
-   * @return the generated comma delimited string from the supplied
-   *         FTSDataColumnI collection
-   */
-  public String getDataColumnsFieldsAsTabDelimitedString(
-          Collection<FTSDataColumnI> dataColumnFields)
-  {
-    String result = "";
-    if (dataColumnFields != null && !dataColumnFields.isEmpty())
-    {
-      StringBuilder returnedFields = new StringBuilder();
-      for (FTSDataColumnI field : dataColumnFields)
-      {
-        returnedFields.append("\t").append(field.getName());
-      }
-      returnedFields.deleteCharAt(0);
-      result = returnedFields.toString();
-    }
-    return result;
-  }
-
   @Override
   public Collection<FTSDataColumnI> getAllFTSDataColumns()
   {
@@ -342,7 +394,7 @@ public abstract class FTSRestClient implements FTSRestClientI
   }
 
   @Override
-  public Collection<FTSDataColumnI> getAllDefaulDisplayedDataColumns()
+  public Collection<FTSDataColumnI> getAllDefaultDisplayedFTSDataColumns()
   {
     if (defaulDisplayedDataColumns == null
             || defaulDisplayedDataColumns.isEmpty())
@@ -379,8 +431,20 @@ 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);
+  }
+
+  /**
+   * 
+   * @param instance
+   * @param mocks
+   *          {{working query, working response}, ...}
+   */
+  public static void createMockFTSRestClient(FTSRestClient instance,
+          String[][] mocks)
+  {
+    instance.setMock(mocks);
   }
 
   @Override
@@ -401,6 +465,46 @@ public abstract class FTSRestClient implements FTSRestClientI
     throw new Exception("Couldn't find data column group with id : " + id);
   }
 
+  public static String getMessageByHTTPStatusCode(int code, String service)
+  {
+    String message = "";
+    switch (code)
+    {
+    case 400:
+      message = "Bad request. There is a problem with your input.";
+      break;
+
+    case 410:
+      message = service + " rest services no longer available!";
+      break;
+    case 403:
+    case 404:
+      message = "The requested resource could not be found";
+      break;
+    case 408:
+    case 409:
+    case 500:
+    case 501:
+    case 502:
+    case 504:
+    case 505:
+      message = "There seems to be an error from the " + service
+              + " server";
+      break;
+    case 503:
+      message = "Service not available. The server is being updated, try again later.";
+      break;
+    default:
+      break;
+    }
+    return String.valueOf(code) + " " + message;
+  }
+
+  public static void unMock(FTSRestClient instance)
+  {
+    instance.mockQueries = null;
+  }
+
   protected String getResourceFile(String fileName)
   {
     String result = "";
@@ -418,7 +522,46 @@ public abstract class FTSRestClient implements FTSRestClientI
   @Override
   public int getDefaultResponsePageSize()
   {
+    if (dataColumns == null || dataColumns.isEmpty())
+    {
+      parseDataColumnsConfigFile();
+    }
     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;
+  }
 }