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_24) on Wed Dec 07 12:30:41 GMT 2011 -->
\r
10 <META NAME="date" CONTENT="2011-12-07">
\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="SyncExecutor";
\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/SyncExecutor.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/SubmissionManager.html" title="class in compbio.engine"><B>PREV CLASS</B></A>
\r
59 NEXT CLASS</FONT></TD>
\r
60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
61 <A HREF="../../index.html?compbio/engine/SyncExecutor.html" target="_top"><B>FRAMES</B></A>
\r
62 <A HREF="SyncExecutor.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 | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
81 DETAIL: FIELD | 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</FONT>
\r
93 Interface SyncExecutor</H2>
\r
95 <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../compbio/engine/cluster/drmaa/JobRunner.html" title="class in compbio.engine.cluster.drmaa">JobRunner</A>, <A HREF="../../compbio/engine/local/LocalRunner.html" title="class in compbio.engine.local">LocalRunner</A></DD>
\r
99 <DT><PRE>public interface <B>SyncExecutor</B></DL>
\r
103 Synchronous executor, is an engine to run the Executable synchronously.
\r
108 <DT><B>Author:</B></DT>
\r
110 Date October 2009</DD>
\r
116 <!-- ========== METHOD SUMMARY =========== -->
\r
118 <A NAME="method_summary"><!-- --></A>
\r
119 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
120 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
121 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
122 <B>Method Summary</B></FONT></TH>
\r
124 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
125 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
126 <CODE> boolean</CODE></FONT></TD>
\r
127 <TD><CODE><B><A HREF="../../compbio/engine/SyncExecutor.html#cancelJob()">cancelJob</A></B>()</CODE>
\r
130 Stops running job.</TD>
\r
132 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
133 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
134 <CODE> boolean</CODE></FONT></TD>
\r
135 <TD><CODE><B><A HREF="../../compbio/engine/SyncExecutor.html#cleanup()">cleanup</A></B>()</CODE>
\r
138 Clean up after the job</TD>
\r
140 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
141 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
142 <CODE> void</CODE></FONT></TD>
\r
143 <TD><CODE><B><A HREF="../../compbio/engine/SyncExecutor.html#executeJob()">executeJob</A></B>()</CODE>
\r
146 Execute the job</TD>
\r
148 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
149 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
150 <CODE> <A HREF="../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</A></CODE></FONT></TD>
\r
151 <TD><CODE><B><A HREF="../../compbio/engine/SyncExecutor.html#getJobStatus()">getJobStatus</A></B>()</CODE>
\r
154 Query the status of the job by its id.</TD>
\r
156 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
157 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
158 <CODE> <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
159 <TD><CODE><B><A HREF="../../compbio/engine/SyncExecutor.html#getWorkDirectory()">getWorkDirectory</A></B>()</CODE>
\r
162 </TD>
\r
164 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
165 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
166 <CODE> <A HREF="../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A><?></CODE></FONT></TD>
\r
167 <TD><CODE><B><A HREF="../../compbio/engine/SyncExecutor.html#waitForResult()">waitForResult</A></B>()</CODE>
\r
170 Call to this method block for as long as it is required for an executable to finish its job.</TD>
\r
176 <!-- ============ METHOD DETAIL ========== -->
\r
178 <A NAME="method_detail"><!-- --></A>
\r
179 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
180 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
181 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
182 <B>Method Detail</B></FONT></TH>
\r
186 <A NAME="executeJob()"><!-- --></A><H3>
\r
189 void <B>executeJob</B>()
\r
190 throws <A HREF="../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A></PRE>
\r
192 <DD>Execute the job
\r
197 <DD><CODE><A HREF="../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A></CODE> - if submission fails</DL>
\r
202 <A NAME="cleanup()"><!-- --></A><H3>
\r
205 boolean <B>cleanup</B>()</PRE>
\r
207 <DD>Clean up after the job
\r
211 <DT><B>Returns:</B><DD>true if all the files created by this job have been removed successfully, false otherwise</DL>
\r
216 <A NAME="waitForResult()"><!-- --></A><H3>
\r
219 <A HREF="../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A><?> <B>waitForResult</B>()
\r
220 throws <A HREF="../../compbio/metadata/JobExecutionException.html" title="class in compbio.metadata">JobExecutionException</A></PRE>
\r
222 <DD>Call to this method block for as long as it is required for an executable to finish its job.
223 If the calculation has been completed already, the this method returns results immediately.
224 This could return the result directly, but that would be type unsafe
\r
228 <DT><B>Returns:</B><DD>object from wich the result can be obtained
\r
230 <DD><CODE><A HREF="../../compbio/metadata/JobExecutionException.html" title="class in compbio.metadata">JobExecutionException</A></CODE></DL>
\r
235 <A NAME="getWorkDirectory()"><!-- --></A><H3>
\r
236 getWorkDirectory</H3>
\r
238 <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>()</PRE>
\r
242 <DT><B>Returns:</B><DD>working directory if the task</DL>
\r
247 <A NAME="cancelJob()"><!-- --></A><H3>
\r
250 boolean <B>cancelJob</B>()</PRE>
\r
252 <DD>Stops running job.
253 Clean up is not performed.
\r
257 <DT><B>Returns:</B><DD>true if job was cancelled successfully, false otherwise</DL>
\r
262 <A NAME="getJobStatus()"><!-- --></A><H3>
\r
265 <A HREF="../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</A> <B>getJobStatus</B>()</PRE>
\r
267 <DD>Query the status of the job by its id.
\r
271 <DT><B>Returns:</B><DD>- JobStatus</DL>
\r
274 <!-- ========= END OF CLASS DATA ========= -->
\r
278 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
279 <A NAME="navbar_bottom"><!-- --></A>
\r
280 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
\r
281 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
283 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
284 <A NAME="navbar_bottom_firstrow"><!-- --></A>
\r
285 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
286 <TR ALIGN="center" VALIGN="top">
\r
287 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
288 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
289 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
290 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SyncExecutor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
291 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
292 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
293 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
294 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
298 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
304 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
305 <A HREF="../../compbio/engine/SubmissionManager.html" title="class in compbio.engine"><B>PREV CLASS</B></A>
\r
306 NEXT CLASS</FONT></TD>
\r
307 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
308 <A HREF="../../index.html?compbio/engine/SyncExecutor.html" target="_top"><B>FRAMES</B></A>
\r
309 <A HREF="SyncExecutor.html" target="_top"><B>NO FRAMES</B></A>
\r
310 <SCRIPT type="text/javascript">
\r
313 document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
318 <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
\r
325 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
326 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
327 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
328 DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
331 <A NAME="skip-navbar_bottom"></A>
\r
332 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r