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="Util";
\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/Util.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/client/SkeletalExecutable.html" title="class in compbio.engine.client"><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/client/Util.html" target="_top"><B>FRAMES</B></A>
\r
62 <A HREF="Util.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.client</FONT>
\r
96 <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>compbio.engine.client.Util</B>
\r
100 <DT><PRE>public final class <B>Util</B><DT>extends java.lang.Object</DL>
\r
108 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
110 <A NAME="constructor_summary"><!-- --></A>
\r
111 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
112 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
113 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
114 <B>Constructor Summary</B></FONT></TH>
\r
116 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
117 <TD><CODE><B><A HREF="../../../compbio/engine/client/Util.html#Util()">Util</A></B>()</CODE>
\r
120 </TD>
\r
124 <!-- ========== METHOD SUMMARY =========== -->
\r
126 <A NAME="method_summary"><!-- --></A>
\r
127 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
128 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
129 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
130 <B>Method Summary</B></FONT></TH>
\r
132 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
133 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
134 <CODE>static java.lang.String</CODE></FONT></TD>
\r
135 <TD><CODE><B><A HREF="../../../compbio/engine/client/Util.html#convertToAbsolute(java.lang.String)">convertToAbsolute</A></B>(java.lang.String relativePath)</CODE>
\r
138 </TD>
\r
140 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
141 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
142 <CODE>static java.lang.String</CODE></FONT></TD>
\r
143 <TD><CODE><B><A HREF="../../../compbio/engine/client/Util.html#getCommand(compbio.engine.client.Executable.ExecProvider, java.lang.Class)">getCommand</A></B>(<A HREF="../../../compbio/engine/client/Executable.ExecProvider.html" title="enum in compbio.engine.client">Executable.ExecProvider</A> provider,
\r
144 java.lang.Class<?> clazz)</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>static java.lang.String</CODE></FONT></TD>
\r
152 <TD><CODE><B><A HREF="../../../compbio/engine/client/Util.html#getExecProperty(java.lang.String, java.lang.Class)">getExecProperty</A></B>(java.lang.String propertySpec,
\r
153 java.lang.Class<?> clazz)</CODE>
\r
156 </TD>
\r
158 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
159 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
160 <CODE>static java.lang.String</CODE></FONT></TD>
\r
161 <TD><CODE><B><A HREF="../../../compbio/engine/client/Util.html#getExecProperty(java.lang.String, compbio.engine.client.Executable)">getExecProperty</A></B>(java.lang.String propertySpec,
\r
162 <A HREF="../../../compbio/engine/client/Executable.html" title="interface in compbio.engine.client">Executable</A><?> exec)</CODE>
\r
165 </TD>
\r
167 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
168 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
169 <CODE>static java.lang.String</CODE></FONT></TD>
\r
170 <TD><CODE><B><A HREF="../../../compbio/engine/client/Util.html#getFullPath(java.lang.String, java.lang.String)">getFullPath</A></B>(java.lang.String workDirectory,
\r
171 java.lang.String fileName)</CODE>
\r
174 </TD>
\r
176 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
177 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
178 <CODE>static <A HREF="../../../compbio/engine/client/Executable.ExecProvider.html" title="enum in compbio.engine.client">Executable.ExecProvider</A></CODE></FONT></TD>
\r
179 <TD><CODE><B><A HREF="../../../compbio/engine/client/Util.html#getSupportedRuntimes(java.lang.Class)">getSupportedRuntimes</A></B>(java.lang.Class<?> clazz)</CODE>
\r
182 </TD>
\r
184 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
185 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
186 <CODE>static boolean</CODE></FONT></TD>
\r
187 <TD><CODE><B><A HREF="../../../compbio/engine/client/Util.html#isMarked(java.lang.String, compbio.metadata.JobStatus)">isMarked</A></B>(java.lang.String workDirectory,
\r
188 <A HREF="../../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</A> marker)</CODE>
\r
191 </TD>
\r
193 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
194 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
195 <CODE>static boolean</CODE></FONT></TD>
\r
196 <TD><CODE><B><A HREF="../../../compbio/engine/client/Util.html#isValidJobId(java.lang.String)">isValidJobId</A></B>(java.lang.String key)</CODE>
\r
199 </TD>
\r
201 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
202 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
203 <CODE>static <A HREF="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A><?></CODE></FONT></TD>
\r
204 <TD><CODE><B><A HREF="../../../compbio/engine/client/Util.html#loadExecutable(java.lang.String)">loadExecutable</A></B>(java.lang.String taskId)</CODE>
\r
207 </TD>
\r
209 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
210 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
211 <CODE>static java.util.Map<java.lang.String,java.lang.String></CODE></FONT></TD>
\r
212 <TD><CODE><B><A HREF="../../../compbio/engine/client/Util.html#mergeEnvVariables(java.util.Map, java.util.Map)">mergeEnvVariables</A></B>(java.util.Map<java.lang.String,java.lang.String> sysEnvTobeModified,
\r
213 java.util.Map<java.lang.String,java.lang.String> variables)</CODE>
\r
216 </TD>
\r
218 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
219 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
220 <CODE>static void</CODE></FONT></TD>
\r
221 <TD><CODE><B><A HREF="../../../compbio/engine/client/Util.html#writeFile(java.lang.String, java.lang.String, java.lang.String, boolean)">writeFile</A></B>(java.lang.String workDirectory,
\r
222 java.lang.String fileAndEventName,
\r
223 java.lang.String content,
\r
224 boolean override)</CODE>
\r
227 </TD>
\r
229 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
230 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
231 <CODE>static boolean</CODE></FONT></TD>
\r
232 <TD><CODE><B><A HREF="../../../compbio/engine/client/Util.html#writeMarker(java.lang.String, compbio.metadata.JobStatus)">writeMarker</A></B>(java.lang.String workDirectory,
\r
233 <A HREF="../../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</A> fileType)</CODE>
\r
236 </TD>
\r
238 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
239 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
240 <CODE>static void</CODE></FONT></TD>
\r
241 <TD><CODE><B><A HREF="../../../compbio/engine/client/Util.html#writeStatFile(java.lang.String, java.lang.String)">writeStatFile</A></B>(java.lang.String workDirectory,
\r
242 java.lang.String fileAndEventName)</CODE>
\r
245 </TD>
\r
248 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
\r
249 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
250 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
251 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
\r
253 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
254 <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
\r
260 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
262 <A NAME="constructor_detail"><!-- --></A>
\r
263 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
264 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
265 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
266 <B>Constructor Detail</B></FONT></TH>
\r
270 <A NAME="Util()"><!-- --></A><H3>
\r
273 public <B>Util</B>()</PRE>
\r
277 <!-- ============ METHOD DETAIL ========== -->
\r
279 <A NAME="method_detail"><!-- --></A>
\r
280 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
281 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
282 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
283 <B>Method Detail</B></FONT></TH>
\r
287 <A NAME="isValidJobId(java.lang.String)"><!-- --></A><H3>
\r
290 public static boolean <B>isValidJobId</B>(java.lang.String key)</PRE>
\r
298 <A NAME="writeStatFile(java.lang.String, java.lang.String)"><!-- --></A><H3>
\r
301 public static void <B>writeStatFile</B>(java.lang.String workDirectory,
\r
302 java.lang.String fileAndEventName)</PRE>
\r
310 <A NAME="writeFile(java.lang.String, java.lang.String, java.lang.String, boolean)"><!-- --></A><H3>
\r
313 public static void <B>writeFile</B>(java.lang.String workDirectory,
\r
314 java.lang.String fileAndEventName,
\r
315 java.lang.String content,
\r
316 boolean override)</PRE>
\r
324 <A NAME="writeMarker(java.lang.String, compbio.metadata.JobStatus)"><!-- --></A><H3>
\r
327 public static final boolean <B>writeMarker</B>(java.lang.String workDirectory,
\r
328 <A HREF="../../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</A> fileType)</PRE>
\r
336 <A NAME="isMarked(java.lang.String, compbio.metadata.JobStatus)"><!-- --></A><H3>
\r
339 public static boolean <B>isMarked</B>(java.lang.String workDirectory,
\r
340 <A HREF="../../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</A> marker)</PRE>
\r
348 <A NAME="mergeEnvVariables(java.util.Map, java.util.Map)"><!-- --></A><H3>
\r
349 mergeEnvVariables</H3>
\r
351 public static java.util.Map<java.lang.String,java.lang.String> <B>mergeEnvVariables</B>(java.util.Map<java.lang.String,java.lang.String> sysEnvTobeModified,
\r
352 java.util.Map<java.lang.String,java.lang.String> variables)</PRE>
\r
360 <A NAME="convertToAbsolute(java.lang.String)"><!-- --></A><H3>
\r
361 convertToAbsolute</H3>
\r
363 public static java.lang.String <B>convertToAbsolute</B>(java.lang.String relativePath)</PRE>
\r
371 <A NAME="getExecProperty(java.lang.String, compbio.engine.client.Executable)"><!-- --></A><H3>
\r
372 getExecProperty</H3>
\r
374 public static java.lang.String <B>getExecProperty</B>(java.lang.String propertySpec,
\r
375 <A HREF="../../../compbio/engine/client/Executable.html" title="interface in compbio.engine.client">Executable</A><?> exec)</PRE>
\r
383 <A NAME="getExecProperty(java.lang.String, java.lang.Class)"><!-- --></A><H3>
\r
384 getExecProperty</H3>
\r
386 public static java.lang.String <B>getExecProperty</B>(java.lang.String propertySpec,
\r
387 java.lang.Class<?> clazz)</PRE>
\r
395 <A NAME="getFullPath(java.lang.String, java.lang.String)"><!-- --></A><H3>
\r
398 public static java.lang.String <B>getFullPath</B>(java.lang.String workDirectory,
\r
399 java.lang.String fileName)</PRE>
\r
407 <A NAME="getCommand(compbio.engine.client.Executable.ExecProvider, java.lang.Class)"><!-- --></A><H3>
\r
410 public static java.lang.String <B>getCommand</B>(<A HREF="../../../compbio/engine/client/Executable.ExecProvider.html" title="enum in compbio.engine.client">Executable.ExecProvider</A> provider,
\r
411 java.lang.Class<?> clazz)</PRE>
\r
419 <A NAME="getSupportedRuntimes(java.lang.Class)"><!-- --></A><H3>
\r
420 getSupportedRuntimes</H3>
\r
422 public static <A HREF="../../../compbio/engine/client/Executable.ExecProvider.html" title="enum in compbio.engine.client">Executable.ExecProvider</A> <B>getSupportedRuntimes</B>(java.lang.Class<?> clazz)</PRE>
\r
430 <A NAME="loadExecutable(java.lang.String)"><!-- --></A><H3>
\r
431 loadExecutable</H3>
\r
433 public static <A HREF="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A><?> <B>loadExecutable</B>(java.lang.String taskId)
\r
434 throws <A HREF="../../../compbio/metadata/ResultNotAvailableException.html" title="class in compbio.metadata">ResultNotAvailableException</A></PRE>
\r
439 <DD><CODE><A HREF="../../../compbio/metadata/ResultNotAvailableException.html" title="class in compbio.metadata">ResultNotAvailableException</A></CODE></DL>
\r
442 <!-- ========= END OF CLASS DATA ========= -->
\r
446 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
447 <A NAME="navbar_bottom"><!-- --></A>
\r
448 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
\r
449 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
451 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
452 <A NAME="navbar_bottom_firstrow"><!-- --></A>
\r
453 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
454 <TR ALIGN="center" VALIGN="top">
\r
455 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
456 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
457 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
458 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Util.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
459 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
460 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
461 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
462 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
466 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
472 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
473 <A HREF="../../../compbio/engine/client/SkeletalExecutable.html" title="class in compbio.engine.client"><B>PREV CLASS</B></A>
\r
474 NEXT CLASS</FONT></TD>
\r
475 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
476 <A HREF="../../../index.html?compbio/engine/client/Util.html" target="_top"><B>FRAMES</B></A>
\r
477 <A HREF="Util.html" target="_top"><B>NO FRAMES</B></A>
\r
478 <SCRIPT type="text/javascript">
\r
481 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
486 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
493 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
494 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
495 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
496 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
499 <A NAME="skip-navbar_bottom"></A>
\r
500 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r