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="ExecutableWrapper";
\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/ExecutableWrapper.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/AsyncLocalRunner.html" title="class in compbio.engine.local"><B>PREV CLASS</B></A>
\r
59 <A HREF="../../../compbio/engine/local/LocalEngineUtil.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/ExecutableWrapper.html" target="_top"><B>FRAMES</B></A>
\r
62 <A HREF="ExecutableWrapper.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> | <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: <A HREF="#field_detail">FIELD</A> | <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 ExecutableWrapper</H2>
\r
96 <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>compbio.engine.local.ExecutableWrapper</B>
\r
99 <DT><B>All Implemented Interfaces:</B> <DD>java.util.concurrent.Callable<<A HREF="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A><?>></DD>
\r
103 <DT><PRE><FONT SIZE="-1">@Immutable
\r
104 </FONT>public final class <B>ExecutableWrapper</B><DT>extends java.lang.Object<DT>implements java.util.concurrent.Callable<<A HREF="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A><?>></DL>
\r
111 <!-- =========== FIELD SUMMARY =========== -->
\r
113 <A NAME="field_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>Field Summary</B></FONT></TH>
\r
119 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
120 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
121 <CODE>static java.lang.String</CODE></FONT></TD>
\r
122 <TD><CODE><B><A HREF="../../../compbio/engine/local/ExecutableWrapper.html#PROC_ERR_FILE">PROC_ERR_FILE</A></B></CODE>
\r
125 </TD>
\r
127 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
128 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
129 <CODE>static java.lang.String</CODE></FONT></TD>
\r
130 <TD><CODE><B><A HREF="../../../compbio/engine/local/ExecutableWrapper.html#PROC_OUT_FILE">PROC_OUT_FILE</A></B></CODE>
\r
133 </TD>
\r
137 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
139 <A NAME="constructor_summary"><!-- --></A>
\r
140 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
141 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
142 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
143 <B>Constructor Summary</B></FONT></TH>
\r
145 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
146 <TD><CODE><B><A HREF="../../../compbio/engine/local/ExecutableWrapper.html#ExecutableWrapper(compbio.engine.client.ConfiguredExecutable, java.lang.String)">ExecutableWrapper</A></B>(<A HREF="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A><?> executable,
\r
147 java.lang.String workDirectory)</CODE>
\r
150 </TD>
\r
154 <!-- ========== METHOD SUMMARY =========== -->
\r
156 <A NAME="method_summary"><!-- --></A>
\r
157 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
158 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
159 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
160 <B>Method Summary</B></FONT></TH>
\r
162 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
163 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
164 <CODE> <A HREF="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A><?></CODE></FONT></TD>
\r
165 <TD><CODE><B><A HREF="../../../compbio/engine/local/ExecutableWrapper.html#call()">call</A></B>()</CODE>
\r
168 It is vital that output and error streams are captured immediately for
169 this call() to succeed.</TD>
\r
172 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
\r
173 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
174 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
175 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
\r
177 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
178 <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
\r
184 <!-- ============ FIELD DETAIL =========== -->
\r
186 <A NAME="field_detail"><!-- --></A>
\r
187 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
188 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
189 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
190 <B>Field Detail</B></FONT></TH>
\r
194 <A NAME="PROC_OUT_FILE"><!-- --></A><H3>
\r
197 public static final java.lang.String <B>PROC_OUT_FILE</B></PRE>
\r
200 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#compbio.engine.local.ExecutableWrapper.PROC_OUT_FILE">Constant Field Values</A></DL>
\r
204 <A NAME="PROC_ERR_FILE"><!-- --></A><H3>
\r
207 public static final java.lang.String <B>PROC_ERR_FILE</B></PRE>
\r
210 <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#compbio.engine.local.ExecutableWrapper.PROC_ERR_FILE">Constant Field Values</A></DL>
\r
213 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
215 <A NAME="constructor_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>Constructor Detail</B></FONT></TH>
\r
223 <A NAME="ExecutableWrapper(compbio.engine.client.ConfiguredExecutable, java.lang.String)"><!-- --></A><H3>
\r
224 ExecutableWrapper</H3>
\r
226 public <B>ExecutableWrapper</B>(<A HREF="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A><?> executable,
\r
227 java.lang.String workDirectory)
\r
228 throws <A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A></PRE>
\r
233 <DD><CODE><A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A></CODE></DL>
\r
236 <!-- ============ METHOD DETAIL ========== -->
\r
238 <A NAME="method_detail"><!-- --></A>
\r
239 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
240 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
241 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
242 <B>Method Detail</B></FONT></TH>
\r
246 <A NAME="call()"><!-- --></A><H3>
\r
249 public <A HREF="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A><?> <B>call</B>()
\r
250 throws java.io.IOException</PRE>
\r
252 <DD>It is vital that output and error streams are captured immediately for
253 this call() to succeed. Thus each instance if ExecutableWrapper has 2 its
254 own thread ready to capture the output. If executor could not execute
255 capture immediately this could lead to the call method to stale, as
256 execution could not proceed without output being captured. Every call to
257 call() method will use 2 threads
\r
260 <DT><B>Specified by:</B><DD><CODE>call</CODE> in interface <CODE>java.util.concurrent.Callable<<A HREF="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A><?>></CODE></DL>
\r
265 <DD><CODE>java.io.IOException</CODE></DL>
\r
268 <!-- ========= END OF CLASS DATA ========= -->
\r
272 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
273 <A NAME="navbar_bottom"><!-- --></A>
\r
274 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
\r
275 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
277 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
278 <A NAME="navbar_bottom_firstrow"><!-- --></A>
\r
279 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
280 <TR ALIGN="center" VALIGN="top">
\r
281 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
282 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
283 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
284 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ExecutableWrapper.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
285 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
286 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
287 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
288 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
292 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
298 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
299 <A HREF="../../../compbio/engine/local/AsyncLocalRunner.html" title="class in compbio.engine.local"><B>PREV CLASS</B></A>
\r
300 <A HREF="../../../compbio/engine/local/LocalEngineUtil.html" title="class in compbio.engine.local"><B>NEXT CLASS</B></A></FONT></TD>
\r
301 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
302 <A HREF="../../../index.html?compbio/engine/local/ExecutableWrapper.html" target="_top"><B>FRAMES</B></A>
\r
303 <A HREF="ExecutableWrapper.html" target="_top"><B>NO FRAMES</B></A>
\r
304 <SCRIPT type="text/javascript">
\r
307 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
312 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
319 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
320 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
321 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
322 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
325 <A NAME="skip-navbar_bottom"></A>
\r
326 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r