build client source when build all
[jabaws.git] / website / full_javadoc / compbio / engine / client / package-summary.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
2 <!--NewPage-->\r
3 <HTML>\r
4 <HEAD>\r
5 <!-- Generated by javadoc (build 1.6.0_14) on Wed Feb 17 16:46:50 GMT 2010 -->\r
6 <TITLE>\r
7 compbio.engine.client\r
8 </TITLE>\r
9 \r
10 <META NAME="date" CONTENT="2010-02-17">\r
11 \r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">\r
13 \r
14 <SCRIPT type="text/javascript">\r
15 function windowTitle()\r
16 {\r
17     if (location.href.indexOf('is-external=true') == -1) {\r
18         parent.document.title="compbio.engine.client";\r
19     }\r
20 }\r
21 </SCRIPT>\r
22 <NOSCRIPT>\r
23 </NOSCRIPT>\r
24 \r
25 </HEAD>\r
26 \r
27 <BODY BGCOLOR="white" onload="windowTitle();">\r
28 <HR>\r
29 \r
30 \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
35 <TR>\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>&nbsp;</TD>\r
41   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>\r
42   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>\r
43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
46   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
47   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
48   </TR>\r
49 </TABLE>\r
50 </TD>\r
51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
52 </EM>\r
53 </TD>\r
54 </TR>\r
55 \r
56 <TR>\r
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
58 &nbsp;<A HREF="../../../compbio/engine/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;\r
59 &nbsp;<A HREF="../../../compbio/engine/cluster/drmaa/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>\r
60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
61   <A HREF="../../../index.html?compbio/engine/client/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
62 &nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
63 &nbsp;<SCRIPT type="text/javascript">\r
64   <!--\r
65   if(window==top) {\r
66     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
67   }\r
68   //-->\r
69 </SCRIPT>\r
70 <NOSCRIPT>\r
71   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
72 </NOSCRIPT>\r
73 \r
74 \r
75 </FONT></TD>\r
76 </TR>\r
77 </TABLE>\r
78 <A NAME="skip-navbar_top"></A>\r
79 <!-- ========= END OF TOP NAVBAR ========= -->\r
80 \r
81 <HR>\r
82 <H2>\r
83 Package compbio.engine.client\r
84 </H2>\r
85 Classes and interfaces representing an input for engines.\r
86 <P>\r
87 <B>See:</B>\r
88 <BR>\r
89 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#package_description"><B>Description</B></A>\r
90 <P>\r
91 \r
92 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
93 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
94 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
95 <B>Interface Summary</B></FONT></TH>\r
96 </TR>\r
97 <TR BGCOLOR="white" CLASS="TableRowColor">\r
98 <TD WIDTH="15%"><B><A HREF="../../../compbio/engine/client/ClusterNativeSpecExecutable.html" title="interface in compbio.engine.client">ClusterNativeSpecExecutable&lt;T&gt;</A></B></TD>\r
99 <TD>&nbsp;</TD>\r
100 </TR>\r
101 <TR BGCOLOR="white" CLASS="TableRowColor">\r
102 <TD WIDTH="15%"><B><A HREF="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable&lt;T&gt;</A></B></TD>\r
103 <TD>&nbsp;</TD>\r
104 </TR>\r
105 <TR BGCOLOR="white" CLASS="TableRowColor">\r
106 <TD WIDTH="15%"><B><A HREF="../../../compbio/engine/client/Executable.html" title="interface in compbio.engine.client">Executable&lt;T&gt;</A></B></TD>\r
107 <TD>Interface to a native executable.</TD>\r
108 </TR>\r
109 <TR BGCOLOR="white" CLASS="TableRowColor">\r
110 <TD WIDTH="15%"><B><A HREF="../../../compbio/engine/client/PipedExecutable.html" title="interface in compbio.engine.client">PipedExecutable&lt;T&gt;</A></B></TD>\r
111 <TD>This is a marker interface to indicate that the output of the process must be\r
112  captured.</TD>\r
113 </TR>\r
114 </TABLE>\r
115 &nbsp;\r
116 \r
117 <P>\r
118 \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>Class Summary</B></FONT></TH>\r
123 </TR>\r
124 <TR BGCOLOR="white" CLASS="TableRowColor">\r
125 <TD WIDTH="15%"><B><A HREF="../../../compbio/engine/client/CommandBuilder.html" title="class in compbio.engine.client">CommandBuilder&lt;T&gt;</A></B></TD>\r
126 <TD>&nbsp;</TD>\r
127 </TR>\r
128 <TR BGCOLOR="white" CLASS="TableRowColor">\r
129 <TD WIDTH="15%"><B><A HREF="../../../compbio/engine/client/ConfExecutable.html" title="class in compbio.engine.client">ConfExecutable&lt;T&gt;</A></B></TD>\r
130 <TD>&nbsp;</TD>\r
131 </TR>\r
132 <TR BGCOLOR="white" CLASS="TableRowColor">\r
133 <TD WIDTH="15%"><B><A HREF="../../../compbio/engine/client/EnvVariableProcessor.html" title="class in compbio.engine.client">EnvVariableProcessor</A></B></TD>\r
134 <TD>&nbsp;</TD>\r
135 </TR>\r
136 <TR BGCOLOR="white" CLASS="TableRowColor">\r
137 <TD WIDTH="15%"><B><A HREF="../../../compbio/engine/client/PathValidator.html" title="class in compbio.engine.client">PathValidator</A></B></TD>\r
138 <TD>&nbsp;</TD>\r
139 </TR>\r
140 <TR BGCOLOR="white" CLASS="TableRowColor">\r
141 <TD WIDTH="15%"><B><A HREF="../../../compbio/engine/client/RunConfiguration.html" title="class in compbio.engine.client">RunConfiguration</A></B></TD>\r
142 <TD>Value class for persisting ConfExecutable instances</TD>\r
143 </TR>\r
144 <TR BGCOLOR="white" CLASS="TableRowColor">\r
145 <TD WIDTH="15%"><B><A HREF="../../../compbio/engine/client/SkeletalExecutable.html" title="class in compbio.engine.client">SkeletalExecutable&lt;T&gt;</A></B></TD>\r
146 <TD>&nbsp;</TD>\r
147 </TR>\r
148 <TR BGCOLOR="white" CLASS="TableRowColor">\r
149 <TD WIDTH="15%"><B><A HREF="../../../compbio/engine/client/Util.html" title="class in compbio.engine.client">Util</A></B></TD>\r
150 <TD>&nbsp;</TD>\r
151 </TR>\r
152 </TABLE>\r
153 &nbsp;\r
154 \r
155 <P>\r
156 \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>Enum Summary</B></FONT></TH>\r
161 </TR>\r
162 <TR BGCOLOR="white" CLASS="TableRowColor">\r
163 <TD WIDTH="15%"><B><A HREF="../../../compbio/engine/client/Executable.ExecProvider.html" title="enum in compbio.engine.client">Executable.ExecProvider</A></B></TD>\r
164 <TD>&nbsp;</TD>\r
165 </TR>\r
166 </TABLE>\r
167 &nbsp;\r
168 \r
169 <P>\r
170 <A NAME="package_description"><!-- --></A><H2>\r
171 Package compbio.engine.client Description\r
172 </H2>\r
173 \r
174 <P>\r
175 Classes and interfaces representing an input for engines. These classes are known to runners, \r
176  which form the next layer of the JABAWS hierarchy.\r
177 <P>\r
178 \r
179 <P>\r
180 <DL>\r
181 <DT><B>Author:</B></DT>\r
182   <DD>Petr Troshin \r
183  \r
184         Date January 2010</DD>\r
185 </DL>\r
186 <HR>\r
187 \r
188 \r
189 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
190 <A NAME="navbar_bottom"><!-- --></A>\r
191 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
192 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
193 <TR>\r
194 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
195 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
196 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
197   <TR ALIGN="center" VALIGN="top">\r
198   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
199   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>\r
200   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>\r
201   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
202   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
203   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
204   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
205   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
206   </TR>\r
207 </TABLE>\r
208 </TD>\r
209 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
210 </EM>\r
211 </TD>\r
212 </TR>\r
213 \r
214 <TR>\r
215 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
216 &nbsp;<A HREF="../../../compbio/engine/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;\r
217 &nbsp;<A HREF="../../../compbio/engine/cluster/drmaa/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>\r
218 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
219   <A HREF="../../../index.html?compbio/engine/client/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
220 &nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
221 &nbsp;<SCRIPT type="text/javascript">\r
222   <!--\r
223   if(window==top) {\r
224     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
225   }\r
226   //-->\r
227 </SCRIPT>\r
228 <NOSCRIPT>\r
229   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
230 </NOSCRIPT>\r
231 \r
232 \r
233 </FONT></TD>\r
234 </TR>\r
235 </TABLE>\r
236 <A NAME="skip-navbar_bottom"></A>\r
237 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
238 \r
239 <HR>\r
240 \r
241 </BODY>\r
242 </HTML>\r