JAL-3070 core service descriptors for JABAWS services abstracted to jalview.ws.api...

[jalview.git] / src / jalview / ws / jws2 / jabaws2 / Jws2Instance.java

diff --git a/src/jalview/ws/jws2/jabaws2/Jws2Instance.java b/src/jalview/ws/jws2/jabaws2/Jws2Instance.java
index aa42ff7..69f9072 100644 (file)
--- a/src/jalview/ws/jws2/jabaws2/Jws2Instance.java
+++ b/src/jalview/ws/jws2/jabaws2/Jws2Instance.java
@@ -1,24 +1,29 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
- * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
+ * 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.
+ * 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/>.
+ * 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.ws.jws2.jabaws2;
 
 import jalview.gui.AlignFrame;
 import jalview.gui.Desktop;
+import jalview.util.MessageManager;
+import jalview.ws.api.UIinfo;
 import jalview.ws.jws2.JabaParamStore;
 import jalview.ws.jws2.MsaWSClient;
 import jalview.ws.jws2.SequenceAnnotationWSClient;
@@ -34,29 +39,34 @@ import compbio.data.msa.SequenceAnnotation;
 import compbio.metadata.PresetManager;
 import compbio.metadata.RunnerConfig;
 
-public class Jws2Instance
+public class Jws2Instance extends UIinfo
 {
   public String hosturl;
 
-  public String serviceType;
-
-  public String action;
-
   public JABAService service;
 
-  public String description;
-
   public String docUrl;
 
+  /**
+   * 
+   * @param hosturl
+   *          Service endpoint
+   * @param serviceType
+   *          Category for this service's analysis
+   * @param action
+   *          text describing their action that service performs (eg 'aligning',
+   *          'analysing')
+   * @param description
+   *          Description from JABAWS registry
+   * @param service
+   *          JABAWS registry ID for service
+   */
   public Jws2Instance(String hosturl, String serviceType, String action,
           String description, JABAService service)
   {
-    super();
+    super(action, action, serviceType, description);
     this.hosturl = hosturl;
-    this.serviceType = serviceType;
     this.service = service;
-    this.action = action;
-    this.description = description;
     int p = description.indexOf("MORE INFORMATION:");
     if (p > -1)
     {
@@ -97,7 +107,7 @@ public class Jws2Instance
       } catch (Exception ex)
       {
         System.err.println("Exception when retrieving presets for service "
-                + serviceType + " at " + hosturl);
+                + getServiceType() + " at " + hosturl);
       }
     }
     return presets;
@@ -120,7 +130,7 @@ public class Jws2Instance
    */
   public String getActionText()
   {
-    return action + " with " + serviceType;
+    return getAction() + " with " + getServiceType();
   }
 
   /**
@@ -139,9 +149,10 @@ public class Jws2Instance
     {
       return ((SequenceAnnotation) service).getRunnerOptions();
     }
-    throw new Error(
-            "Implementation Error: Runner Config not available for a JABAWS service of type "
-                    + serviceType + " (" + service.getClass() + ")");
+    throw new Error(MessageManager.formatMessage(
+            "error.implementation_error_runner_config_not_available",
+            new String[]
+            { getServiceType(), service.getClass().toString() }));
   }
 
   @Override
@@ -151,13 +162,11 @@ public class Jws2Instance
     {
       try
       {
-        Closeable svc = (Closeable) service;
-        service = null;
-        svc.close();
-      } catch (Exception e)
+        ((Closeable) service).close();
+      } catch (Throwable t)
       {
+        // ignore
       }
-      ;
     }
     super.finalize();
   }
@@ -186,7 +195,8 @@ public class Jws2Instance
     // this is only valid for Jaba 1.0 - this formula might have to change!
     return hosturl
             + (hosturl.lastIndexOf("/") == (hosturl.length() - 1) ? ""
-                    : "/") + serviceType;
+                    : "/")
+            + getServiceType();
   }
 
   private boolean hasParams = false, lookedForParams = false;
@@ -220,8 +230,15 @@ public class Jws2Instance
     }
   }
 
-  public String getServiceTypeURI()
+  public String getNameURI()
+  {
+    return "java:" + getName();
+  }
+
+  jalview.ws.uimodel.AlignAnalysisUIText aaui;
+
+  public jalview.ws.uimodel.AlignAnalysisUIText getAlignAnalysisUI()
   {
-    return "java:" + serviceType;
+    return aaui;
   }
 }