git://source.jalview.org / jabaws.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
remove old datamodel javadoc
[jabaws.git] / website / full_javadoc / compbio / engine / cluster / drmaa / AsyncJobRunner.html
diff --git a/website/full_javadoc/compbio/engine/cluster/drmaa/AsyncJobRunner.html b/website/full_javadoc/compbio/engine/cluster/drmaa/AsyncJobRunner.html
index 779a787..87eeadd 100644 (file)
--- a/website/full_javadoc/compbio/engine/cluster/drmaa/AsyncJobRunner.html
+++ b/website/full_javadoc/compbio/engine/cluster/drmaa/AsyncJobRunner.html
@@ -2,12 +2,12 @@
 <!--NewPage-->\r
 <HTML>\r
 <HEAD>\r
-<!-- Generated by javadoc (build 1.6.0_14) on Wed Feb 17 16:46:49 GMT 2010 -->\r
+<!-- Generated by javadoc (build 1.6.0_24) on Fri Aug 12 14:32:35 BST 2011 -->\r
 <TITLE>\r
 AsyncJobRunner\r
 </TITLE>\r
 \r
-<META NAME="date" CONTENT="2010-02-17">\r
+<META NAME="date" CONTENT="2011-08-12">\r
 \r
 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">\r
 \r
@@ -55,7 +55,7 @@ function windowTitle()
 \r
 <TR>\r
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
-&nbsp;<A HREF="../../../../compbio/engine/cluster/drmaa/_JobStatus.html" title="class in compbio.engine.cluster.drmaa"><B>PREV CLASS</B></A>&nbsp;\r
+&nbsp;PREV CLASS&nbsp;\r
 &nbsp;<A HREF="../../../../compbio/engine/cluster/drmaa/ClusterSession.html" title="class in compbio.engine.cluster.drmaa"><B>NEXT CLASS</B></A></FONT></TD>\r
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
   <A HREF="../../../../index.html?compbio/engine/cluster/drmaa/AsyncJobRunner.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
@@ -92,7 +92,7 @@ compbio.engine.cluster.drmaa</FONT>
 <BR>\r
 Class AsyncJobRunner</H2>\r
 <PRE>\r
-java.lang.Object\r
+<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>\r
   <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>compbio.engine.cluster.drmaa.AsyncJobRunner</B>\r
 </PRE>\r
 <DL>\r
@@ -100,7 +100,7 @@ java.lang.Object
 </DL>\r
 <HR>\r
 <DL>\r
-<DT><PRE>public class <B>AsyncJobRunner</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../compbio/engine/AsyncExecutor.html" title="interface in compbio.engine">AsyncExecutor</A></DL>\r
+<DT><PRE>public class <B>AsyncJobRunner</B><DT>extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="../../../../compbio/engine/AsyncExecutor.html" title="interface in compbio.engine">AsyncExecutor</A></DL>\r
 </PRE>\r
 \r
 <P>\r
@@ -109,6 +109,12 @@ Single cluster job runner class
 \r
 <P>\r
 <DL>\r
+<DT><B>Version:</B></DT>\r
+  <DD>1.0 August 2009
+ 
+          TODO after call to submitJob() no setters really work as the job
+          template gets deleted, this needs to be taken into account in this
+          class design!</DD>\r
 <DT><B>Author:</B></DT>\r
   <DD>pvtroshin</DD>\r
 </DL>\r
@@ -143,7 +149,7 @@ Single cluster job runner class
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../../../compbio/engine/cluster/drmaa/AsyncJobRunner.html#cancelJob(java.lang.String)">cancelJob</A></B>(java.lang.String&nbsp;jobId)</CODE>\r
+<TD><CODE><B><A HREF="../../../../compbio/engine/cluster/drmaa/AsyncJobRunner.html#cancelJob(java.lang.String)">cancelJob</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;jobId)</CODE>\r
 \r
 <BR>\r
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Stop running job.</TD>\r
@@ -151,7 +157,7 @@ Single cluster job runner class
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../../../compbio/engine/cluster/drmaa/AsyncJobRunner.html#cleanup(java.lang.String)">cleanup</A></B>(java.lang.String&nbsp;jobId)</CODE>\r
+<TD><CODE><B><A HREF="../../../../compbio/engine/cluster/drmaa/AsyncJobRunner.html#cleanup(java.lang.String)">cleanup</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;jobId)</CODE>\r
 \r
 <BR>\r
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Remove all files and a job directory for a jobid.</TD>\r
@@ -159,7 +165,7 @@ Single cluster job runner class
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 <CODE>&nbsp;<A HREF="../../../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</A></CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../../../compbio/engine/cluster/drmaa/AsyncJobRunner.html#getJobStatus(java.lang.String)">getJobStatus</A></B>(java.lang.String&nbsp;jobId)</CODE>\r
+<TD><CODE><B><A HREF="../../../../compbio/engine/cluster/drmaa/AsyncJobRunner.html#getJobStatus(java.lang.String)">getJobStatus</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;jobId)</CODE>\r
 \r
 <BR>\r
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This will never return clust.engine.JobStatus.CANCELLED as for sun grid
@@ -168,22 +174,22 @@ Single cluster job runner class
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 <CODE>&nbsp;<A HREF="../../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A>&lt;?&gt;</CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../../../compbio/engine/cluster/drmaa/AsyncJobRunner.html#getResults(java.lang.String)">getResults</A></B>(java.lang.String&nbsp;jobId)</CODE>\r
+<TD><CODE><B><A HREF="../../../../compbio/engine/cluster/drmaa/AsyncJobRunner.html#getResults(java.lang.String)">getResults</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;jobId)</CODE>\r
 \r
 <BR>\r
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieve the results of the job.</TD>\r
 </TR>\r
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../../../compbio/engine/cluster/drmaa/AsyncJobRunner.html#getWorkDirectory(java.lang.String)">getWorkDirectory</A></B>(java.lang.String&nbsp;jobId)</CODE>\r
+<CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../compbio/engine/cluster/drmaa/AsyncJobRunner.html#getWorkDirectory(java.lang.String)">getWorkDirectory</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;jobId)</CODE>\r
 \r
 <BR>\r
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 </TR>\r
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
+<CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>\r
 <TD><CODE><B><A HREF="../../../../compbio/engine/cluster/drmaa/AsyncJobRunner.html#submitJob(compbio.engine.client.ConfiguredExecutable)">submitJob</A></B>(<A HREF="../../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A>&lt;?&gt;&nbsp;executable)</CODE>\r
 \r
 <BR>\r
@@ -194,10 +200,10 @@ Single cluster job runner class
 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
-<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>\r
+<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>\r
 </TR>\r
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
+<TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>\r
 </TR>\r
 </TABLE>\r
 &nbsp;\r
@@ -233,8 +239,8 @@ public <B>AsyncJobRunner</B>()</PRE>
 <A NAME="submitJob(compbio.engine.client.ConfiguredExecutable)"><!-- --></A><H3>\r
 submitJob</H3>\r
 <PRE>\r
-public java.lang.String <B>submitJob</B>(<A HREF="../../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A>&lt;?&gt;&nbsp;executable)\r
-                           throws <A HREF="../../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A></PRE>\r
+public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>submitJob</B>(<A HREF="../../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A>&lt;?&gt;&nbsp;executable)\r
+                 throws <A HREF="../../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A></PRE>\r
 <DL>\r
 <DD><B>Description copied from interface: <CODE><A HREF="../../../../compbio/engine/AsyncExecutor.html#submitJob(compbio.engine.client.ConfiguredExecutable)">AsyncExecutor</A></CODE></B></DD>\r
 <DD>Submits job for the execution
@@ -257,7 +263,7 @@ public java.lang.String <B>submitJob</B>(<A HREF="../../../../compbio/engine/cli
 <A NAME="cancelJob(java.lang.String)"><!-- --></A><H3>\r
 cancelJob</H3>\r
 <PRE>\r
-public boolean <B>cancelJob</B>(java.lang.String&nbsp;jobId)</PRE>\r
+public boolean <B>cancelJob</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;jobId)</PRE>\r
 <DL>\r
 <DD><B>Description copied from interface: <CODE><A HREF="../../../../compbio/engine/AsyncExecutor.html#cancelJob(java.lang.String)">AsyncExecutor</A></CODE></B></DD>\r
 <DD>Stop running job. Please not that this method does not guarantee to remove the job directory and files in it.\r
@@ -275,7 +281,7 @@ public boolean <B>cancelJob</B>(java.lang.String&nbsp;jobId)</PRE>
 <A NAME="getJobStatus(java.lang.String)"><!-- --></A><H3>\r
 getJobStatus</H3>\r
 <PRE>\r
-public <A HREF="../../../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</A> <B>getJobStatus</B>(java.lang.String&nbsp;jobId)</PRE>\r
+public <A HREF="../../../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</A> <B>getJobStatus</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;jobId)</PRE>\r
 <DL>\r
 <DD>This will never return clust.engine.JobStatus.CANCELLED as for sun grid
  engine cancelled job is the same as failed. Cancelled jobs needs to be
@@ -294,7 +300,7 @@ public <A HREF="../../../../compbio/metadata/JobStatus.html" title="enum in comp
 <A NAME="cleanup(java.lang.String)"><!-- --></A><H3>\r
 cleanup</H3>\r
 <PRE>\r
-public boolean <B>cleanup</B>(java.lang.String&nbsp;jobId)</PRE>\r
+public boolean <B>cleanup</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;jobId)</PRE>\r
 <DL>\r
 <DD><B>Description copied from interface: <CODE><A HREF="../../../../compbio/engine/AsyncExecutor.html#cleanup(java.lang.String)">AsyncExecutor</A></CODE></B></DD>\r
 <DD>Remove all files and a job directory for a jobid.\r
@@ -312,7 +318,7 @@ public boolean <B>cleanup</B>(java.lang.String&nbsp;jobId)</PRE>
 <A NAME="getResults(java.lang.String)"><!-- --></A><H3>\r
 getResults</H3>\r
 <PRE>\r
-public <A HREF="../../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A>&lt;?&gt; <B>getResults</B>(java.lang.String&nbsp;jobId)\r
+public <A HREF="../../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A>&lt;?&gt; <B>getResults</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;jobId)\r
                                    throws <A HREF="../../../../compbio/metadata/ResultNotAvailableException.html" title="class in compbio.metadata">ResultNotAvailableException</A></PRE>\r
 <DL>\r
 <DD><B>Description copied from interface: <CODE><A HREF="../../../../compbio/engine/AsyncExecutor.html#getResults(java.lang.String)">AsyncExecutor</A></CODE></B></DD>\r
@@ -336,7 +342,7 @@ public <A HREF="../../../../compbio/engine/client/ConfiguredExecutable.html" tit
 <A NAME="getWorkDirectory(java.lang.String)"><!-- --></A><H3>\r
 getWorkDirectory</H3>\r
 <PRE>\r
-public java.lang.String <B>getWorkDirectory</B>(java.lang.String&nbsp;jobId)</PRE>\r
+public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getWorkDirectory</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;jobId)</PRE>\r
 <DL>\r
 <DD><DL>\r
 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../compbio/engine/AsyncExecutor.html#getWorkDirectory(java.lang.String)">getWorkDirectory</A></CODE> in interface <CODE><A HREF="../../../../compbio/engine/AsyncExecutor.html" title="interface in compbio.engine">AsyncExecutor</A></CODE></DL>\r
@@ -377,7 +383,7 @@ public java.lang.String <B>getWorkDirectory</B>(java.lang.String&nbsp;jobId)</PR
 \r
 <TR>\r
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
-&nbsp;<A HREF="../../../../compbio/engine/cluster/drmaa/_JobStatus.html" title="class in compbio.engine.cluster.drmaa"><B>PREV CLASS</B></A>&nbsp;\r
+&nbsp;PREV CLASS&nbsp;\r
 &nbsp;<A HREF="../../../../compbio/engine/cluster/drmaa/ClusterSession.html" title="class in compbio.engine.cluster.drmaa"><B>NEXT CLASS</B></A></FONT></TD>\r
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
   <A HREF="../../../../index.html?compbio/engine/cluster/drmaa/AsyncJobRunner.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r