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:50 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="LocalRunner";
\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/LocalRunner.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/local/LocalExecutorService.html" title="class in compbio.engine.local"><B>PREV CLASS</B></A>
\r
59 <A HREF="../../../compbio/engine/local/StreamGobbler.html" title="class in compbio.engine.local"><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/local/LocalRunner.html" target="_top"><B>FRAMES</B></A>
\r
62 <A HREF="LocalRunner.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
81 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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.local</FONT>
\r
93 Class LocalRunner</H2>
\r
96 <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>compbio.engine.local.LocalRunner</B>
\r
99 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../compbio/engine/SyncExecutor.html" title="interface in compbio.engine">SyncExecutor</A></DD>
\r
103 <DT><PRE>public final class <B>LocalRunner</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../compbio/engine/SyncExecutor.html" title="interface in compbio.engine">SyncExecutor</A></DL>
\r
111 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
113 <A NAME="constructor_summary"><!-- --></A>
\r
114 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
115 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
116 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
117 <B>Constructor Summary</B></FONT></TH>
\r
119 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
120 <TD><CODE><B><A HREF="../../../compbio/engine/local/LocalRunner.html#LocalRunner(compbio.engine.client.ConfiguredExecutable)">LocalRunner</A></B>(<A HREF="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A><?> executable)</CODE>
\r
123 </TD>
\r
127 <!-- ========== METHOD SUMMARY =========== -->
\r
129 <A NAME="method_summary"><!-- --></A>
\r
130 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
131 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
132 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
133 <B>Method Summary</B></FONT></TH>
\r
135 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
136 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
137 <CODE> boolean</CODE></FONT></TD>
\r
138 <TD><CODE><B><A HREF="../../../compbio/engine/local/LocalRunner.html#cancelJob()">cancelJob</A></B>()</CODE>
\r
141 Stops running job.</TD>
\r
143 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
144 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
145 <CODE> boolean</CODE></FONT></TD>
\r
146 <TD><CODE><B><A HREF="../../../compbio/engine/local/LocalRunner.html#cleanup()">cleanup</A></B>()</CODE>
\r
149 Clean up after the job</TD>
\r
151 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
152 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
153 <CODE> void</CODE></FONT></TD>
\r
154 <TD><CODE><B><A HREF="../../../compbio/engine/local/LocalRunner.html#executeJob()">executeJob</A></B>()</CODE>
\r
157 Execute the job</TD>
\r
159 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
160 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
161 <CODE> <A HREF="../../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</A></CODE></FONT></TD>
\r
162 <TD><CODE><B><A HREF="../../../compbio/engine/local/LocalRunner.html#getJobStatus()">getJobStatus</A></B>()</CODE>
\r
165 Query the status of the job by its id.</TD>
\r
167 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
168 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
169 <CODE> java.lang.String</CODE></FONT></TD>
\r
170 <TD><CODE><B><A HREF="../../../compbio/engine/local/LocalRunner.html#getWorkDirectory()">getWorkDirectory</A></B>()</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> <A HREF="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A><?></CODE></FONT></TD>
\r
178 <TD><CODE><B><A HREF="../../../compbio/engine/local/LocalRunner.html#waitForResult()">waitForResult</A></B>()</CODE>
\r
181 Call to this method block for as long as it is required for an executable to finish its job.</TD>
\r
184 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
\r
185 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
186 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
187 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
\r
189 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
190 <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
\r
196 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
198 <A NAME="constructor_detail"><!-- --></A>
\r
199 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
200 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
201 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
202 <B>Constructor Detail</B></FONT></TH>
\r
206 <A NAME="LocalRunner(compbio.engine.client.ConfiguredExecutable)"><!-- --></A><H3>
\r
209 public <B>LocalRunner</B>(<A HREF="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A><?> executable)</PRE>
\r
213 <!-- ============ METHOD DETAIL ========== -->
\r
215 <A NAME="method_detail"><!-- --></A>
\r
216 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
217 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
218 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
219 <B>Method Detail</B></FONT></TH>
\r
223 <A NAME="getWorkDirectory()"><!-- --></A><H3>
\r
224 getWorkDirectory</H3>
\r
226 public java.lang.String <B>getWorkDirectory</B>()</PRE>
\r
229 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../compbio/engine/SyncExecutor.html#getWorkDirectory()">getWorkDirectory</A></CODE> in interface <CODE><A HREF="../../../compbio/engine/SyncExecutor.html" title="interface in compbio.engine">SyncExecutor</A></CODE></DL>
\r
233 <DT><B>Returns:</B><DD>working directory if the task</DL>
\r
238 <A NAME="cancelJob()"><!-- --></A><H3>
\r
241 public boolean <B>cancelJob</B>()</PRE>
\r
243 <DD><B>Description copied from interface: <CODE><A HREF="../../../compbio/engine/SyncExecutor.html#cancelJob()">SyncExecutor</A></CODE></B></DD>
\r
244 <DD>Stops running job.
245 Clean up is not performed.
\r
248 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../compbio/engine/SyncExecutor.html#cancelJob()">cancelJob</A></CODE> in interface <CODE><A HREF="../../../compbio/engine/SyncExecutor.html" title="interface in compbio.engine">SyncExecutor</A></CODE></DL>
\r
252 <DT><B>Returns:</B><DD>true if job was cancelled successfully, false otherwise</DL>
\r
257 <A NAME="getJobStatus()"><!-- --></A><H3>
\r
260 public <A HREF="../../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</A> <B>getJobStatus</B>()</PRE>
\r
262 <DD><B>Description copied from interface: <CODE><A HREF="../../../compbio/engine/SyncExecutor.html#getJobStatus()">SyncExecutor</A></CODE></B></DD>
\r
263 <DD>Query the status of the job by its id.
\r
266 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../compbio/engine/SyncExecutor.html#getJobStatus()">getJobStatus</A></CODE> in interface <CODE><A HREF="../../../compbio/engine/SyncExecutor.html" title="interface in compbio.engine">SyncExecutor</A></CODE></DL>
\r
270 <DT><B>Returns:</B><DD>- JobStatus</DL>
\r
275 <A NAME="executeJob()"><!-- --></A><H3>
\r
278 public void <B>executeJob</B>()
\r
279 throws <A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A></PRE>
\r
281 <DD><B>Description copied from interface: <CODE><A HREF="../../../compbio/engine/SyncExecutor.html#executeJob()">SyncExecutor</A></CODE></B></DD>
\r
282 <DD>Execute the job
\r
285 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../compbio/engine/SyncExecutor.html#executeJob()">executeJob</A></CODE> in interface <CODE><A HREF="../../../compbio/engine/SyncExecutor.html" title="interface in compbio.engine">SyncExecutor</A></CODE></DL>
\r
290 <DD><CODE><A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A></CODE> - if submission fails</DL>
\r
295 <A NAME="waitForResult()"><!-- --></A><H3>
\r
298 public <A HREF="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A><?> <B>waitForResult</B>()
\r
299 throws <A HREF="../../../compbio/metadata/JobExecutionException.html" title="class in compbio.metadata">JobExecutionException</A></PRE>
\r
301 <DD><B>Description copied from interface: <CODE><A HREF="../../../compbio/engine/SyncExecutor.html#waitForResult()">SyncExecutor</A></CODE></B></DD>
\r
302 <DD>Call to this method block for as long as it is required for an executable to finish its job.
303 If the calculation has been completed already, the this method returns results immediately.
304 This could return the result directly, but that would be type unsafe
\r
307 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../compbio/engine/SyncExecutor.html#waitForResult()">waitForResult</A></CODE> in interface <CODE><A HREF="../../../compbio/engine/SyncExecutor.html" title="interface in compbio.engine">SyncExecutor</A></CODE></DL>
\r
311 <DT><B>Returns:</B><DD>object from wich the result can be obtained
\r
313 <DD><CODE>java.util.concurrent.CancellationException</CODE>
\r
314 <DD><CODE><A HREF="../../../compbio/metadata/JobExecutionException.html" title="class in compbio.metadata">JobExecutionException</A></CODE></DL>
\r
319 <A NAME="cleanup()"><!-- --></A><H3>
\r
322 public boolean <B>cleanup</B>()</PRE>
\r
324 <DD><B>Description copied from interface: <CODE><A HREF="../../../compbio/engine/SyncExecutor.html#cleanup()">SyncExecutor</A></CODE></B></DD>
\r
325 <DD>Clean up after the job
\r
328 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../compbio/engine/SyncExecutor.html#cleanup()">cleanup</A></CODE> in interface <CODE><A HREF="../../../compbio/engine/SyncExecutor.html" title="interface in compbio.engine">SyncExecutor</A></CODE></DL>
\r
332 <DT><B>Returns:</B><DD>true if all the files created by this job have been removed successfully, false otherwise</DL>
\r
335 <!-- ========= END OF CLASS DATA ========= -->
\r
339 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
340 <A NAME="navbar_bottom"><!-- --></A>
\r
341 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
\r
342 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
344 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
345 <A NAME="navbar_bottom_firstrow"><!-- --></A>
\r
346 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
347 <TR ALIGN="center" VALIGN="top">
\r
348 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
349 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
350 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
351 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/LocalRunner.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
352 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
353 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
354 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
355 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
359 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
365 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
366 <A HREF="../../../compbio/engine/local/LocalExecutorService.html" title="class in compbio.engine.local"><B>PREV CLASS</B></A>
\r
367 <A HREF="../../../compbio/engine/local/StreamGobbler.html" title="class in compbio.engine.local"><B>NEXT CLASS</B></A></FONT></TD>
\r
368 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
369 <A HREF="../../../index.html?compbio/engine/local/LocalRunner.html" target="_top"><B>FRAMES</B></A>
\r
370 <A HREF="LocalRunner.html" target="_top"><B>NO FRAMES</B></A>
\r
371 <SCRIPT type="text/javascript">
\r
374 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
379 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
386 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
387 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
388 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
389 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
392 <A NAME="skip-navbar_bottom"></A>
\r
393 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r