updated javadoc
[jabaws.git] / website / full_javadoc / compbio / engine / 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_24) on Fri Aug 12 14:32:36 BST 2011 -->\r
6 <TITLE>\r
7 compbio.engine\r
8 </TITLE>\r
9 \r
10 <META NAME="date" CONTENT="2011-08-12">\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";\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/data/sequence/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;\r
59 &nbsp;<A HREF="../../compbio/engine/client/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/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\r
84 </H2>\r
85 \r
86 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
87 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
88 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
89 <B>Interface Summary</B></FONT></TH>\r
90 </TR>\r
91 <TR BGCOLOR="white" CLASS="TableRowColor">\r
92 <TD WIDTH="15%"><B><A HREF="../../compbio/engine/AsyncExecutor.html" title="interface in compbio.engine">AsyncExecutor</A></B></TD>\r
93 <TD>An asynchronous executor engine, capable of running, cancelling, 
94  obtaining results calculated by a native executable wrapper in Executable interface.</TD>\r
95 </TR>\r
96 <TR BGCOLOR="white" CLASS="TableRowColor">\r
97 <TD WIDTH="15%"><B><A HREF="../../compbio/engine/SyncExecutor.html" title="interface in compbio.engine">SyncExecutor</A></B></TD>\r
98 <TD>Synchronous executor, is an engine to run the Executable synchronously.</TD>\r
99 </TR>\r
100 </TABLE>\r
101 &nbsp;\r
102 \r
103 <P>\r
104 \r
105 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
106 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
107 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
108 <B>Class Summary</B></FONT></TH>\r
109 </TR>\r
110 <TR BGCOLOR="white" CLASS="TableRowColor">\r
111 <TD WIDTH="15%"><B><A HREF="../../compbio/engine/Cleaner.html" title="class in compbio.engine">Cleaner</A></B></TD>\r
112 <TD><B>Deprecated.</B></TD>\r
113 </TR>\r
114 <TR BGCOLOR="white" CLASS="TableRowColor">\r
115 <TD WIDTH="15%"><B><A HREF="../../compbio/engine/ClusterJobId.html" title="class in compbio.engine">ClusterJobId</A></B></TD>\r
116 <TD>&nbsp;</TD>\r
117 </TR>\r
118 <TR BGCOLOR="white" CLASS="TableRowColor">\r
119 <TD WIDTH="15%"><B><A HREF="../../compbio/engine/Configurator.html" title="class in compbio.engine">Configurator</A></B></TD>\r
120 <TD>&nbsp;</TD>\r
121 </TR>\r
122 <TR BGCOLOR="white" CLASS="TableRowColor">\r
123 <TD WIDTH="15%"><B><A HREF="../../compbio/engine/FilePuller.html" title="class in compbio.engine">FilePuller</A></B></TD>\r
124 <TD>&nbsp;</TD>\r
125 </TR>\r
126 <TR BGCOLOR="white" CLASS="TableRowColor">\r
127 <TD WIDTH="15%"><B><A HREF="../../compbio/engine/Job.html" title="class in compbio.engine">Job</A></B></TD>\r
128 <TD>&nbsp;</TD>\r
129 </TR>\r
130 <TR BGCOLOR="white" CLASS="TableRowColor">\r
131 <TD WIDTH="15%"><B><A HREF="../../compbio/engine/LoadBalancer.html" title="class in compbio.engine">LoadBalancer</A></B></TD>\r
132 <TD>This class decides where to execute the job.</TD>\r
133 </TR>\r
134 <TR BGCOLOR="white" CLASS="TableRowColor">\r
135 <TD WIDTH="15%"><B><A HREF="../../compbio/engine/ProgressGetter.html" title="class in compbio.engine">ProgressGetter</A></B></TD>\r
136 <TD>&nbsp;</TD>\r
137 </TR>\r
138 <TR BGCOLOR="white" CLASS="TableRowColor">\r
139 <TD WIDTH="15%"><B><A HREF="../../compbio/engine/PulledFileCache.html" title="class in compbio.engine">PulledFileCache</A></B></TD>\r
140 <TD>&nbsp;</TD>\r
141 </TR>\r
142 <TR BGCOLOR="white" CLASS="TableRowColor">\r
143 <TD WIDTH="15%"><B><A HREF="../../compbio/engine/SubmissionManager.html" title="class in compbio.engine">SubmissionManager</A></B></TD>\r
144 <TD>Submit jobs for execution</TD>\r
145 </TR>\r
146 </TABLE>\r
147 &nbsp;\r
148 \r
149 <P>\r
150 <DL>\r
151 </DL>\r
152 <HR>\r
153 \r
154 \r
155 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
156 <A NAME="navbar_bottom"><!-- --></A>\r
157 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
158 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
159 <TR>\r
160 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
161 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
162 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
163   <TR ALIGN="center" VALIGN="top">\r
164   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
165   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>\r
166   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>\r
167   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
168   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
169   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
170   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
171   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
172   </TR>\r
173 </TABLE>\r
174 </TD>\r
175 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
176 </EM>\r
177 </TD>\r
178 </TR>\r
179 \r
180 <TR>\r
181 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
182 &nbsp;<A HREF="../../compbio/data/sequence/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;\r
183 &nbsp;<A HREF="../../compbio/engine/client/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>\r
184 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
185   <A HREF="../../index.html?compbio/engine/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
186 &nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
187 &nbsp;<SCRIPT type="text/javascript">\r
188   <!--\r
189   if(window==top) {\r
190     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
191   }\r
192   //-->\r
193 </SCRIPT>\r
194 <NOSCRIPT>\r
195   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
196 </NOSCRIPT>\r
197 \r
198 \r
199 </FONT></TD>\r
200 </TR>\r
201 </TABLE>\r
202 <A NAME="skip-navbar_bottom"></A>\r
203 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
204 \r
205 <HR>\r
206 \r
207 </BODY>\r
208 </HTML>\r