updated javadoc
[jabaws.git] / website / full_javadoc / compbio / engine / LoadBalancer.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:35 BST 2011 -->\r
6 <TITLE>\r
7 LoadBalancer\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="LoadBalancer";\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="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
42   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/LoadBalancer.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/Job.html" title="class in compbio.engine"><B>PREV CLASS</B></A>&nbsp;\r
59 &nbsp;<A HREF="../../compbio/engine/ProgressGetter.html" title="class in compbio.engine"><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/LoadBalancer.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
62 &nbsp;<A HREF="LoadBalancer.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 <TR>\r
78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
79   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
81 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
82 </TR>\r
83 </TABLE>\r
84 <A NAME="skip-navbar_top"></A>\r
85 <!-- ========= END OF TOP NAVBAR ========= -->\r
86 \r
87 <HR>\r
88 <!-- ======== START OF CLASS DATA ======== -->\r
89 <H2>\r
90 <FONT SIZE="-1">\r
91 compbio.engine</FONT>\r
92 <BR>\r
93 Class LoadBalancer</H2>\r
94 <PRE>\r
95 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>\r
96   <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>compbio.engine.LoadBalancer</B>\r
97 </PRE>\r
98 <HR>\r
99 <DL>\r
100 <DT><PRE>public class <B>LoadBalancer</B><DT>extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>\r
101 </PRE>\r
102 \r
103 <P>\r
104 This class decides where to execute the job. If the local engine is enabled
105  in the configuration file and it has free threads and the size of the tasks
106  permits the local execution, then the local execution will be favoured.\r
107 <P>\r
108 \r
109 <P>\r
110 <DL>\r
111 <DT><B>Version:</B></DT>\r
112   <DD>1.0 March 2009</DD>\r
113 <DT><B>Author:</B></DT>\r
114   <DD>pvtroshin</DD>\r
115 </DL>\r
116 <HR>\r
117 \r
118 <P>\r
119 \r
120 <!-- ========== METHOD SUMMARY =========== -->\r
121 \r
122 <A NAME="method_summary"><!-- --></A>\r
123 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
124 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
125 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
126 <B>Method Summary</B></FONT></TH>\r
127 </TR>\r
128 <TR BGCOLOR="white" CLASS="TableRowColor">\r
129 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
130 <CODE>static&nbsp;<A HREF="../../compbio/engine/client/Executable.ExecProvider.html" title="enum in compbio.engine.client">Executable.ExecProvider</A></CODE></FONT></TD>\r
131 <TD><CODE><B><A HREF="../../compbio/engine/LoadBalancer.html#getEngine(compbio.engine.client.Executable)">getEngine</A></B>(<A HREF="../../compbio/engine/client/Executable.html" title="interface in compbio.engine.client">Executable</A>&lt;?&gt;&nbsp;executable)</CODE>\r
132 \r
133 <BR>\r
134 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
135 </TR>\r
136 <TR BGCOLOR="white" CLASS="TableRowColor">\r
137 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
138 <CODE>static\r
139 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">\r
140 <TR ALIGN="right" VALIGN="">\r
141 <TD NOWRAP><FONT SIZE="-1">\r
142 <CODE>&lt;T,V&gt; <A HREF="../../compbio/engine/client/Executable.ExecProvider.html" title="enum in compbio.engine.client">Executable.ExecProvider</A></CODE></FONT></TD>\r
143 </TR>\r
144 </TABLE>\r
145 </CODE></FONT></TD>\r
146 <TD><CODE><B><A HREF="../../compbio/engine/LoadBalancer.html#getEngine(compbio.engine.client.Executable, java.util.List)">getEngine</A></B>(<A HREF="../../compbio/engine/client/Executable.html" title="interface in compbio.engine.client">Executable</A>&lt;V&gt;&nbsp;executable,\r
147           <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;dataSet)</CODE>\r
148 \r
149 <BR>\r
150 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
151 </TR>\r
152 </TABLE>\r
153 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
154 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
155 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
156 <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>\r
157 </TR>\r
158 <TR BGCOLOR="white" CLASS="TableRowColor">\r
159 <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>\r
160 </TR>\r
161 </TABLE>\r
162 &nbsp;\r
163 <P>\r
164 \r
165 <!-- ============ METHOD DETAIL ========== -->\r
166 \r
167 <A NAME="method_detail"><!-- --></A>\r
168 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
169 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
170 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
171 <B>Method Detail</B></FONT></TH>\r
172 </TR>\r
173 </TABLE>\r
174 \r
175 <A NAME="getEngine(compbio.engine.client.Executable)"><!-- --></A><H3>\r
176 getEngine</H3>\r
177 <PRE>\r
178 public static <A HREF="../../compbio/engine/client/Executable.ExecProvider.html" title="enum in compbio.engine.client">Executable.ExecProvider</A> <B>getEngine</B>(<A HREF="../../compbio/engine/client/Executable.html" title="interface in compbio.engine.client">Executable</A>&lt;?&gt;&nbsp;executable)</PRE>\r
179 <DL>\r
180 <DD><DL>\r
181 </DL>\r
182 </DD>\r
183 </DL>\r
184 <HR>\r
185 \r
186 <A NAME="getEngine(compbio.engine.client.Executable, java.util.List)"><!-- --></A><H3>\r
187 getEngine</H3>\r
188 <PRE>\r
189 public static &lt;T,V&gt; <A HREF="../../compbio/engine/client/Executable.ExecProvider.html" title="enum in compbio.engine.client">Executable.ExecProvider</A> <B>getEngine</B>(<A HREF="../../compbio/engine/client/Executable.html" title="interface in compbio.engine.client">Executable</A>&lt;V&gt;&nbsp;executable,\r
190                                                       <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;dataSet)</PRE>\r
191 <DL>\r
192 <DD><DL>\r
193 </DL>\r
194 </DD>\r
195 </DL>\r
196 <!-- ========= END OF CLASS DATA ========= -->\r
197 <HR>\r
198 \r
199 \r
200 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
201 <A NAME="navbar_bottom"><!-- --></A>\r
202 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
203 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
204 <TR>\r
205 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
206 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
207 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
208   <TR ALIGN="center" VALIGN="top">\r
209   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
210   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
211   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
212   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/LoadBalancer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
213   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
214   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
215   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
216   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
217   </TR>\r
218 </TABLE>\r
219 </TD>\r
220 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
221 </EM>\r
222 </TD>\r
223 </TR>\r
224 \r
225 <TR>\r
226 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
227 &nbsp;<A HREF="../../compbio/engine/Job.html" title="class in compbio.engine"><B>PREV CLASS</B></A>&nbsp;\r
228 &nbsp;<A HREF="../../compbio/engine/ProgressGetter.html" title="class in compbio.engine"><B>NEXT CLASS</B></A></FONT></TD>\r
229 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
230   <A HREF="../../index.html?compbio/engine/LoadBalancer.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
231 &nbsp;<A HREF="LoadBalancer.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
232 &nbsp;<SCRIPT type="text/javascript">\r
233   <!--\r
234   if(window==top) {\r
235     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
236   }\r
237   //-->\r
238 </SCRIPT>\r
239 <NOSCRIPT>\r
240   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
241 </NOSCRIPT>\r
242 \r
243 \r
244 </FONT></TD>\r
245 </TR>\r
246 <TR>\r
247 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
248   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
249 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
250 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
251 </TR>\r
252 </TABLE>\r
253 <A NAME="skip-navbar_bottom"></A>\r
254 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
255 \r
256 <HR>\r
257 \r
258 </BODY>\r
259 </HTML>\r