1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
\r
5 <!-- Generated by javadoc (build 1.6.0_14) on Wed Feb 17 16:46:49 GMT 2010 -->
\r
10 <META NAME="date" CONTENT="2010-02-17">
\r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
\r
14 <SCRIPT type="text/javascript">
\r
15 function windowTitle()
\r
17 if (location.href.indexOf('is-external=true') == -1) {
\r
18 parent.document.title="ClusterSession";
\r
27 <BODY BGCOLOR="white" onload="windowTitle();">
\r
31 <!-- ========= START OF TOP NAVBAR ======= -->
\r
32 <A NAME="navbar_top"><!-- --></A>
\r
33 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
\r
34 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
36 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
37 <A NAME="navbar_top_firstrow"><!-- --></A>
\r
38 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
39 <TR ALIGN="center" VALIGN="top">
\r
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ClusterSession.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
58 <A HREF="../../../../compbio/engine/cluster/drmaa/AsyncJobRunner.html" title="class in compbio.engine.cluster.drmaa"><B>PREV CLASS</B></A>
\r
59 <A HREF="../../../../compbio/engine/cluster/drmaa/ClusterUtil.html" title="class in compbio.engine.cluster.drmaa"><B>NEXT CLASS</B></A></FONT></TD>
\r
60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
61 <A HREF="../../../../index.html?compbio/engine/cluster/drmaa/ClusterSession.html" target="_top"><B>FRAMES</B></A>
\r
62 <A HREF="ClusterSession.html" target="_top"><B>NO FRAMES</B></A>
\r
63 <SCRIPT type="text/javascript">
\r
66 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
71 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
79 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
81 DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
84 <A NAME="skip-navbar_top"></A>
\r
85 <!-- ========= END OF TOP NAVBAR ========= -->
\r
88 <!-- ======== START OF CLASS DATA ======== -->
\r
91 compbio.engine.cluster.drmaa</FONT>
\r
93 Class ClusterSession</H2>
\r
96 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>compbio.engine.cluster.drmaa.ClusterSession</B>
\r
100 <DT><PRE>public final class <B>ClusterSession</B><DT>extends java.lang.Object</DL>
\r
107 <!-- =========== FIELD SUMMARY =========== -->
\r
109 <A NAME="field_summary"><!-- --></A>
\r
110 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
111 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
112 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
113 <B>Field Summary</B></FONT></TH>
\r
115 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
116 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
117 <CODE>static java.lang.String</CODE></FONT></TD>
\r
118 <TD><CODE><B><A HREF="../../../../compbio/engine/cluster/drmaa/ClusterSession.html#JOBID">JOBID</A></B></CODE>
\r
121 </TD>
\r
125 <!-- ========== METHOD SUMMARY =========== -->
\r
127 <A NAME="method_summary"><!-- --></A>
\r
128 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
129 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
130 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
131 <B>Method Summary</B></FONT></TH>
\r
133 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
134 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
135 <CODE> void</CODE></FONT></TD>
\r
136 <TD><CODE><B><A HREF="../../../../compbio/engine/cluster/drmaa/ClusterSession.html#close()">close</A></B>()</CODE>
\r
139 </TD>
\r
141 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
142 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
143 <CODE>static <A HREF="../../../../compbio/engine/ClusterJobId.html" title="class in compbio.engine">ClusterJobId</A></CODE></FONT></TD>
\r
144 <TD><CODE><B><A HREF="../../../../compbio/engine/cluster/drmaa/ClusterSession.html#getClusterJobId(java.lang.String)">getClusterJobId</A></B>(java.lang.String taskId)</CODE>
\r
147 </TD>
\r
149 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
150 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
151 <CODE> int</CODE></FONT></TD>
\r
152 <TD><CODE><B><A HREF="../../../../compbio/engine/cluster/drmaa/ClusterSession.html#getJobStatus(compbio.engine.ClusterJobId)">getJobStatus</A></B>(<A HREF="../../../../compbio/engine/ClusterJobId.html" title="class in compbio.engine">ClusterJobId</A> jobId)</CODE>
\r
155 Apparently completed jobs cannot be found! If this happened most likely
156 that the job is not running any more and Most likely it has been
157 cancelled, finished or failed.</TD>
\r
159 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
160 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
161 <CODE>static java.lang.String</CODE></FONT></TD>
\r
162 <TD><CODE><B><A HREF="../../../../compbio/engine/cluster/drmaa/ClusterSession.html#getJobStatus(int)">getJobStatus</A></B>(int status)</CODE>
\r
165 <B>Deprecated.</B> </TD>
\r
167 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
168 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
169 <CODE> <A HREF="../../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A><?></CODE></FONT></TD>
\r
170 <TD><CODE><B><A HREF="../../../../compbio/engine/cluster/drmaa/ClusterSession.html#getResults(java.lang.String)">getResults</A></B>(java.lang.String taskId)</CODE>
\r
173 </TD>
\r
175 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
176 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
177 <CODE> org.ggf.drmaa.Session</CODE></FONT></TD>
\r
178 <TD><CODE><B><A HREF="../../../../compbio/engine/cluster/drmaa/ClusterSession.html#getSession()">getSession</A></B>()</CODE>
\r
181 </TD>
\r
183 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
184 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
185 <CODE>static <A HREF="../../../../compbio/engine/cluster/drmaa/StatisticManager.html" title="class in compbio.engine.cluster.drmaa">StatisticManager</A></CODE></FONT></TD>
\r
186 <TD><CODE><B><A HREF="../../../../compbio/engine/cluster/drmaa/ClusterSession.html#getStatistics(org.ggf.drmaa.JobInfo)">getStatistics</A></B>(org.ggf.drmaa.JobInfo status)</CODE>
\r
189 </TD>
\r
191 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
192 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
193 <CODE> void</CODE></FONT></TD>
\r
194 <TD><CODE><B><A HREF="../../../../compbio/engine/cluster/drmaa/ClusterSession.html#removeJob(java.lang.String)">removeJob</A></B>(java.lang.String taskId)</CODE>
\r
197 </TD>
\r
199 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
200 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
201 <CODE> org.ggf.drmaa.JobInfo</CODE></FONT></TD>
\r
202 <TD><CODE><B><A HREF="../../../../compbio/engine/cluster/drmaa/ClusterSession.html#waitForJob(java.lang.String)">waitForJob</A></B>(java.lang.String taskId)</CODE>
\r
205 </TD>
\r
207 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
208 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
209 <CODE> org.ggf.drmaa.JobInfo</CODE></FONT></TD>
\r
210 <TD><CODE><B><A HREF="../../../../compbio/engine/cluster/drmaa/ClusterSession.html#waitForJob(java.lang.String, long)">waitForJob</A></B>(java.lang.String jobId,
\r
211 long waitingTime)</CODE>
\r
214 </TD>
\r
217 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
\r
218 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
219 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
220 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
\r
222 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
223 <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
\r
229 <!-- ============ FIELD DETAIL =========== -->
\r
231 <A NAME="field_detail"><!-- --></A>
\r
232 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
233 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
234 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
235 <B>Field Detail</B></FONT></TH>
\r
239 <A NAME="JOBID"><!-- --></A><H3>
\r
242 public static final java.lang.String <B>JOBID</B></PRE>
\r
245 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#compbio.engine.cluster.drmaa.ClusterSession.JOBID">Constant Field Values</A></DL>
\r
248 <!-- ============ METHOD DETAIL ========== -->
\r
250 <A NAME="method_detail"><!-- --></A>
\r
251 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
252 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
253 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
254 <B>Method Detail</B></FONT></TH>
\r
258 <A NAME="getSession()"><!-- --></A><H3>
\r
261 public org.ggf.drmaa.Session <B>getSession</B>()</PRE>
\r
269 <A NAME="close()"><!-- --></A><H3>
\r
272 public void <B>close</B>()</PRE>
\r
280 <A NAME="removeJob(java.lang.String)"><!-- --></A><H3>
\r
283 public void <B>removeJob</B>(java.lang.String taskId)</PRE>
\r
291 <A NAME="waitForJob(java.lang.String)"><!-- --></A><H3>
\r
294 public org.ggf.drmaa.JobInfo <B>waitForJob</B>(java.lang.String taskId)
\r
295 throws org.ggf.drmaa.DrmaaException,
\r
296 java.io.IOException</PRE>
\r
301 <DD><CODE>org.ggf.drmaa.DrmaaException</CODE>
\r
302 <DD><CODE>java.io.IOException</CODE></DL>
\r
307 <A NAME="getClusterJobId(java.lang.String)"><!-- --></A><H3>
\r
308 getClusterJobId</H3>
\r
310 public static <A HREF="../../../../compbio/engine/ClusterJobId.html" title="class in compbio.engine">ClusterJobId</A> <B>getClusterJobId</B>(java.lang.String taskId)
\r
311 throws java.io.IOException</PRE>
\r
316 <DD><CODE>java.io.IOException</CODE></DL>
\r
321 <A NAME="waitForJob(java.lang.String, long)"><!-- --></A><H3>
\r
324 public org.ggf.drmaa.JobInfo <B>waitForJob</B>(java.lang.String jobId,
\r
325 long waitingTime)
\r
326 throws org.ggf.drmaa.DrmaaException,
\r
327 java.io.IOException</PRE>
\r
332 <DD><CODE>org.ggf.drmaa.DrmaaException</CODE>
\r
333 <DD><CODE>java.io.IOException</CODE></DL>
\r
338 <A NAME="getResults(java.lang.String)"><!-- --></A><H3>
\r
341 public <A HREF="../../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A><?> <B>getResults</B>(java.lang.String taskId)
\r
342 throws org.ggf.drmaa.DrmaaException,
\r
343 <A HREF="../../../../compbio/metadata/ResultNotAvailableException.html" title="class in compbio.metadata">ResultNotAvailableException</A></PRE>
\r
348 <DD><CODE>org.ggf.drmaa.DrmaaException</CODE>
\r
349 <DD><CODE><A HREF="../../../../compbio/metadata/ResultNotAvailableException.html" title="class in compbio.metadata">ResultNotAvailableException</A></CODE></DL>
\r
354 <A NAME="getStatistics(org.ggf.drmaa.JobInfo)"><!-- --></A><H3>
\r
357 public static <A HREF="../../../../compbio/engine/cluster/drmaa/StatisticManager.html" title="class in compbio.engine.cluster.drmaa">StatisticManager</A> <B>getStatistics</B>(org.ggf.drmaa.JobInfo status)
\r
358 throws org.ggf.drmaa.DrmaaException</PRE>
\r
363 <DD><CODE>org.ggf.drmaa.DrmaaException</CODE></DL>
\r
368 <A NAME="getJobStatus(compbio.engine.ClusterJobId)"><!-- --></A><H3>
\r
371 public int <B>getJobStatus</B>(<A HREF="../../../../compbio/engine/ClusterJobId.html" title="class in compbio.engine">ClusterJobId</A> jobId)
\r
372 throws org.ggf.drmaa.DrmaaException,
\r
373 org.ggf.drmaa.InvalidJobException</PRE>
\r
375 <DD>Apparently completed jobs cannot be found! If this happened most likely
376 that the job is not running any more and Most likely it has been
377 cancelled, finished or failed.
\r
382 <DD><CODE>org.ggf.drmaa.InvalidJobException</CODE> - if the job is no longer in the queue or running. basically it
383 will throw this exception for all finished or cancelled jobs
\r
384 <DD><CODE>org.ggf.drmaa.DrmaaException</CODE></DL>
\r
389 <A NAME="getJobStatus(int)"><!-- --></A><H3>
\r
392 <FONT SIZE="-1">@Deprecated
\r
393 </FONT>public static java.lang.String <B>getJobStatus</B>(int status)
\r
394 throws org.ggf.drmaa.DrmaaException</PRE>
\r
396 <DD><B>Deprecated.</B>
\r
398 <DD>Method for getting jobs status by quering the cluster, It returns status
399 in therms of a Sessions, not a JobStatus Should only be used for testing!
\r
402 <DT><B>Parameters:</B><DD><CODE>status</CODE> -
\r
403 <DT><B>Returns:</B><DD>
\r
405 <DD><CODE>org.ggf.drmaa.DrmaaException</CODE></DL>
\r
408 <!-- ========= END OF CLASS DATA ========= -->
\r
412 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
413 <A NAME="navbar_bottom"><!-- --></A>
\r
414 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
\r
415 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
417 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
418 <A NAME="navbar_bottom_firstrow"><!-- --></A>
\r
419 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
420 <TR ALIGN="center" VALIGN="top">
\r
421 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
422 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
423 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
424 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ClusterSession.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
425 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
426 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
427 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
428 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
432 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
438 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
439 <A HREF="../../../../compbio/engine/cluster/drmaa/AsyncJobRunner.html" title="class in compbio.engine.cluster.drmaa"><B>PREV CLASS</B></A>
\r
440 <A HREF="../../../../compbio/engine/cluster/drmaa/ClusterUtil.html" title="class in compbio.engine.cluster.drmaa"><B>NEXT CLASS</B></A></FONT></TD>
\r
441 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
442 <A HREF="../../../../index.html?compbio/engine/cluster/drmaa/ClusterSession.html" target="_top"><B>FRAMES</B></A>
\r
443 <A HREF="ClusterSession.html" target="_top"><B>NO FRAMES</B></A>
\r
444 <SCRIPT type="text/javascript">
\r
447 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
452 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
459 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
460 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
461 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
462 DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
465 <A NAME="skip-navbar_bottom"></A>
\r
466 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r