Changeset 1130

Timestamp:

Jun 16, 2009, 1:34:46 PM (14 years ago)

Author:

Nicklas Nordborg

Message:

References #229: Implement API for additional GenePattern? web services

Added convenience method that waits (interruptable) for a GP job to complete.

File:

• extensions/net.sf.basedb.genepattern/trunk/src/net/sf/basedb/genepattern/wrapper/GPClient.java (modified) (2 diffs)

extensions/net.sf.basedb.genepattern/trunk/src/net/sf/basedb/genepattern/wrapper/GPClient.java

@@ -1 +1 @@
 package net.sf.basedb.genepattern.wrapper;
 
+import net.sf.basedb.core.signal.SignalException;
 import net.sf.basedb.genepattern.GPServer;
 import net.sf.basedb.util.filter.Filter;
@@ -176 +177 @@
   
   /**
+    Submit a job to the GenePattern server and wait for the 
+    result to complete. This is a convenience method for calling
+    {@link #runAnalysisNoWait(String, Parameter...)} and then
+    {@link #waitFor(int, int)}, but it throws a {@link SignalException}
+    instead of a {@link InterruptedException}.
+    
+    @param module The name or LSID of the module/pipeline to execute
+    @param parameters An array with the parameter values
+    @return The result of the job
+    @throws WebServiceException If there is a problem submitting the job
+    @throws SignalException If the wait was interrupted
+  */
+  public JobResult runAnalysis(String module, Parameter... parameters)
+    throws WebServiceException
+  {
+    int jobId = runAnalysisNoWait(module, parameters);
+    JobResult result = null;
+    try
+    {
+      result = waitFor(jobId, 5);
+    }
+    catch (InterruptedException ex)
+    {
+      throw new SignalException("Aborted by user");
+    }
+    return result;
+  }
+  
+  /**
     Has the job finished?
     @param jobId The ID of the job