website/docs/full_javadoc/compbio/engine/Job.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <!-- NewPage -->
   3 <html lang="en">
   4 <head>
   5 <!-- Generated by javadoc (1.8.0_121) on Fri Apr 21 15:32:50 BST 2017 -->
   6 <title>Job</title>
   7 <meta name="date" content="2017-04-21">
   8 <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
   9 <script type="text/javascript" src="../../script.js"></script>
  10 </head>
  11 <body>
  12 <script type="text/javascript"><!--
  13     try {
  14         if (location.href.indexOf('is-external=true') == -1) {
  15             parent.document.title="Job";
  16         }
  17     }
  18     catch(err) {
  19     }
  20 //-->
  21 var methods = {"i0":10,"i1":9,"i2":9,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
  22 var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
  23 var altColor = "altColor";
  24 var rowColor = "rowColor";
  25 var tableTab = "tableTab";
  26 var activeTableTab = "activeTableTab";
  27 </script>
  28 <noscript>
  29 <div>JavaScript is disabled on your browser.</div>
  30 </noscript>
  31 <!-- ========= START OF TOP NAVBAR ======= -->
  32 <div class="topNav"><a name="navbar.top">
  33 <!--   -->
  34 </a>
  35 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36 <a name="navbar.top.firstrow">
  37 <!--   -->
  38 </a>
  39 <ul class="navList" title="Navigation">
  40 <li><a href="../../overview-summary.html">Overview</a></li>
  41 <li><a href="package-summary.html">Package</a></li>
  42 <li class="navBarCell1Rev">Class</li>
  43 <li><a href="class-use/Job.html">Use</a></li>
  44 <li><a href="package-tree.html">Tree</a></li>
  45 <li><a href="../../deprecated-list.html">Deprecated</a></li>
  46 <li><a href="../../index-files/index-1.html">Index</a></li>
  47 <li><a href="../../help-doc.html">Help</a></li>
  48 </ul>
  49 </div>
  50 <div class="subNav">
  51 <ul class="navList">
  52 <li><a href="../../compbio/engine/FilePuller.html" title="class in compbio.engine"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53 <li><a href="../../compbio/engine/LoadBalancer.html" title="class in compbio.engine"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54 </ul>
  55 <ul class="navList">
  56 <li><a href="../../index.html?compbio/engine/Job.html" target="_top">Frames</a></li>
  57 <li><a href="Job.html" target="_top">No&nbsp;Frames</a></li>
  58 </ul>
  59 <ul class="navList" id="allclasses_navbar_top">
  60 <li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  61 </ul>
  62 <div>
  63 <script type="text/javascript"><!--
  64   allClassesLink = document.getElementById("allclasses_navbar_top");
  65   if(window==top) {
  66     allClassesLink.style.display = "block";
  67   }
  68   else {
  69     allClassesLink.style.display = "none";
  70   }
  71   //-->
  72 </script>
  73 </div>
  74 <div>
  75 <ul class="subNavList">
  76 <li>Summary:&nbsp;</li>
  77 <li>Nested&nbsp;|&nbsp;</li>
  78 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
  79 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  80 <li><a href="#method.summary">Method</a></li>
  81 </ul>
  82 <ul class="subNavList">
  83 <li>Detail:&nbsp;</li>
  84 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
  85 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  86 <li><a href="#method.detail">Method</a></li>
  87 </ul>
  88 </div>
  89 <a name="skip.navbar.top">
  90 <!--   -->
  91 </a></div>
  92 <!-- ========= END OF TOP NAVBAR ========= -->
  93 <!-- ======== START OF CLASS DATA ======== -->
  94 <div class="header">
  95 <div class="subTitle">compbio.engine</div>
  96 <h2 title="Class Job" class="title">Class Job</h2>
  97 </div>
  98 <div class="contentContainer">
  99 <ul class="inheritance">
 100 <li>java.lang.Object</li>
 101 <li>
 102 <ul class="inheritance">
 103 <li>compbio.engine.Job</li>
 104 </ul>
 105 </li>
 106 </ul>
 107 <div class="description">
 108 <ul class="blockList">
 109 <li class="blockList">
 110 <hr>
 111 <br>
 112 <pre>@Immutable
 113 public final class <span class="typeNameLabel">Job</span>
 114 extends java.lang.Object</pre>
 115 </li>
 116 </ul>
 117 </div>
 118 <div class="summary">
 119 <ul class="blockList">
 120 <li class="blockList">
 121 <!-- =========== FIELD SUMMARY =========== -->
 122 <ul class="blockList">
 123 <li class="blockList"><a name="field.summary">
 124 <!--   -->
 125 </a>
 126 <h3>Field Summary</h3>
 127 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
 128 <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
 129 <tr>
 130 <th class="colFirst" scope="col">Modifier and Type</th>
 131 <th class="colLast" scope="col">Field and Description</th>
 132 </tr>
 133 <tr class="altColor">
 134 <td class="colFirst"><code>private <a href="../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</a>&lt;?&gt;</code></td>
 135 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/engine/Job.html#cexecutable">cexecutable</a></span></code>&nbsp;</td>
 136 </tr>
 137 <tr class="rowColor">
 138 <td class="colFirst"><code>private <a href="../../compbio/engine/ClusterJobId.html" title="class in compbio.engine">ClusterJobId</a></code></td>
 139 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/engine/Job.html#jobId">jobId</a></span></code>&nbsp;</td>
 140 </tr>
 141 <tr class="altColor">
 142 <td class="colFirst"><code>private java.lang.String</code></td>
 143 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/engine/Job.html#taskId">taskId</a></span></code>&nbsp;</td>
 144 </tr>
 145 </table>
 146 </li>
 147 </ul>
 148 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 149 <ul class="blockList">
 150 <li class="blockList"><a name="constructor.summary">
 151 <!--   -->
 152 </a>
 153 <h3>Constructor Summary</h3>
 154 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
 155 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 156 <tr>
 157 <th class="colOne" scope="col">Constructor and Description</th>
 158 </tr>
 159 <tr class="altColor">
 160 <td class="colOne"><code><span class="memberNameLink"><a href="../../compbio/engine/Job.html#Job-java.lang.String-java.lang.String-compbio.engine.client.ConfiguredExecutable-">Job</a></span>(java.lang.String&nbsp;taskId,
 161    java.lang.String&nbsp;jobId,
 162    <a href="../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</a>&lt;?&gt;&nbsp;cexecutable)</code>&nbsp;</td>
 163 </tr>
 164 </table>
 165 </li>
 166 </ul>
 167 <!-- ========== METHOD SUMMARY =========== -->
 168 <ul class="blockList">
 169 <li class="blockList"><a name="method.summary">
 170 <!--   -->
 171 </a>
 172 <h3>Method Summary</h3>
 173 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 174 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 175 <tr>
 176 <th class="colFirst" scope="col">Modifier and Type</th>
 177 <th class="colLast" scope="col">Method and Description</th>
 178 </tr>
 179 <tr id="i0" class="altColor">
 180 <td class="colFirst"><code>boolean</code></td>
 181 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/engine/Job.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>&nbsp;</td>
 182 </tr>
 183 <tr id="i1" class="rowColor">
 184 <td class="colFirst"><code>static <a href="../../compbio/engine/Job.html" title="class in compbio.engine">Job</a></code></td>
 185 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/engine/Job.html#getByJobId-java.lang.String-java.util.List-">getByJobId</a></span>(java.lang.String&nbsp;jobId,
 186           java.util.List&lt;<a href="../../compbio/engine/Job.html" title="class in compbio.engine">Job</a>&gt;&nbsp;jobs)</code>&nbsp;</td>
 187 </tr>
 188 <tr id="i2" class="altColor">
 189 <td class="colFirst"><code>static <a href="../../compbio/engine/Job.html" title="class in compbio.engine">Job</a></code></td>
 190 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/engine/Job.html#getByTaskId-java.lang.String-java.util.List-">getByTaskId</a></span>(java.lang.String&nbsp;taskId,
 191            java.util.List&lt;<a href="../../compbio/engine/Job.html" title="class in compbio.engine">Job</a>&gt;&nbsp;jobs)</code>&nbsp;</td>
 192 </tr>
 193 <tr id="i3" class="rowColor">
 194 <td class="colFirst"><code><a href="../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</a>&lt;?&gt;</code></td>
 195 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/engine/Job.html#getConfExecutable--">getConfExecutable</a></span>()</code>&nbsp;</td>
 196 </tr>
 197 <tr id="i4" class="altColor">
 198 <td class="colFirst"><code><a href="../../compbio/engine/ClusterJobId.html" title="class in compbio.engine">ClusterJobId</a></code></td>
 199 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/engine/Job.html#getJobId--">getJobId</a></span>()</code>&nbsp;</td>
 200 </tr>
 201 <tr id="i5" class="rowColor">
 202 <td class="colFirst"><code>java.lang.String</code></td>
 203 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/engine/Job.html#getTaskId--">getTaskId</a></span>()</code>&nbsp;</td>
 204 </tr>
 205 <tr id="i6" class="altColor">
 206 <td class="colFirst"><code>int</code></td>
 207 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/engine/Job.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
 208 </tr>
 209 <tr id="i7" class="rowColor">
 210 <td class="colFirst"><code>java.lang.String</code></td>
 211 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/engine/Job.html#toString--">toString</a></span>()</code>&nbsp;</td>
 212 </tr>
 213 </table>
 214 <ul class="blockList">
 215 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
 216 <!--   -->
 217 </a>
 218 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
 219 <code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
 220 </ul>
 221 </li>
 222 </ul>
 223 </li>
 224 </ul>
 225 </div>
 226 <div class="details">
 227 <ul class="blockList">
 228 <li class="blockList">
 229 <!-- ============ FIELD DETAIL =========== -->
 230 <ul class="blockList">
 231 <li class="blockList"><a name="field.detail">
 232 <!--   -->
 233 </a>
 234 <h3>Field Detail</h3>
 235 <a name="jobId">
 236 <!--   -->
 237 </a>
 238 <ul class="blockList">
 239 <li class="blockList">
 240 <h4>jobId</h4>
 241 <pre>private final&nbsp;<a href="../../compbio/engine/ClusterJobId.html" title="class in compbio.engine">ClusterJobId</a> jobId</pre>
 242 </li>
 243 </ul>
 244 <a name="taskId">
 245 <!--   -->
 246 </a>
 247 <ul class="blockList">
 248 <li class="blockList">
 249 <h4>taskId</h4>
 250 <pre>private final&nbsp;java.lang.String taskId</pre>
 251 </li>
 252 </ul>
 253 <a name="cexecutable">
 254 <!--   -->
 255 </a>
 256 <ul class="blockListLast">
 257 <li class="blockList">
 258 <h4>cexecutable</h4>
 259 <pre>private final&nbsp;<a href="../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</a>&lt;?&gt; cexecutable</pre>
 260 </li>
 261 </ul>
 262 </li>
 263 </ul>
 264 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 265 <ul class="blockList">
 266 <li class="blockList"><a name="constructor.detail">
 267 <!--   -->
 268 </a>
 269 <h3>Constructor Detail</h3>
 270 <a name="Job-java.lang.String-java.lang.String-compbio.engine.client.ConfiguredExecutable-">
 271 <!--   -->
 272 </a>
 273 <ul class="blockListLast">
 274 <li class="blockList">
 275 <h4>Job</h4>
 276 <pre>public&nbsp;Job(java.lang.String&nbsp;taskId,
 277            java.lang.String&nbsp;jobId,
 278            <a href="../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</a>&lt;?&gt;&nbsp;cexecutable)</pre>
 279 </li>
 280 </ul>
 281 </li>
 282 </ul>
 283 <!-- ============ METHOD DETAIL ========== -->
 284 <ul class="blockList">
 285 <li class="blockList"><a name="method.detail">
 286 <!--   -->
 287 </a>
 288 <h3>Method Detail</h3>
 289 <a name="getJobId--">
 290 <!--   -->
 291 </a>
 292 <ul class="blockList">
 293 <li class="blockList">
 294 <h4>getJobId</h4>
 295 <pre>public&nbsp;<a href="../../compbio/engine/ClusterJobId.html" title="class in compbio.engine">ClusterJobId</a>&nbsp;getJobId()</pre>
 296 </li>
 297 </ul>
 298 <a name="getTaskId--">
 299 <!--   -->
 300 </a>
 301 <ul class="blockList">
 302 <li class="blockList">
 303 <h4>getTaskId</h4>
 304 <pre>public&nbsp;java.lang.String&nbsp;getTaskId()</pre>
 305 </li>
 306 </ul>
 307 <a name="getConfExecutable--">
 308 <!--   -->
 309 </a>
 310 <ul class="blockList">
 311 <li class="blockList">
 312 <h4>getConfExecutable</h4>
 313 <pre>public&nbsp;<a href="../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</a>&lt;?&gt;&nbsp;getConfExecutable()</pre>
 314 </li>
 315 </ul>
 316 <a name="hashCode--">
 317 <!--   -->
 318 </a>
 319 <ul class="blockList">
 320 <li class="blockList">
 321 <h4>hashCode</h4>
 322 <pre>public&nbsp;int&nbsp;hashCode()</pre>
 323 <dl>
 324 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 325 <dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
 326 </dl>
 327 </li>
 328 </ul>
 329 <a name="equals-java.lang.Object-">
 330 <!--   -->
 331 </a>
 332 <ul class="blockList">
 333 <li class="blockList">
 334 <h4>equals</h4>
 335 <pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;obj)</pre>
 336 <dl>
 337 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 338 <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
 339 </dl>
 340 </li>
 341 </ul>
 342 <a name="toString--">
 343 <!--   -->
 344 </a>
 345 <ul class="blockList">
 346 <li class="blockList">
 347 <h4>toString</h4>
 348 <pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
 349 <dl>
 350 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 351 <dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
 352 </dl>
 353 </li>
 354 </ul>
 355 <a name="getByTaskId-java.lang.String-java.util.List-">
 356 <!--   -->
 357 </a>
 358 <ul class="blockList">
 359 <li class="blockList">
 360 <h4>getByTaskId</h4>
 361 <pre>public static&nbsp;<a href="../../compbio/engine/Job.html" title="class in compbio.engine">Job</a>&nbsp;getByTaskId(java.lang.String&nbsp;taskId,
 362                               java.util.List&lt;<a href="../../compbio/engine/Job.html" title="class in compbio.engine">Job</a>&gt;&nbsp;jobs)</pre>
 363 </li>
 364 </ul>
 365 <a name="getByJobId-java.lang.String-java.util.List-">
 366 <!--   -->
 367 </a>
 368 <ul class="blockListLast">
 369 <li class="blockList">
 370 <h4>getByJobId</h4>
 371 <pre>public static&nbsp;<a href="../../compbio/engine/Job.html" title="class in compbio.engine">Job</a>&nbsp;getByJobId(java.lang.String&nbsp;jobId,
 372                              java.util.List&lt;<a href="../../compbio/engine/Job.html" title="class in compbio.engine">Job</a>&gt;&nbsp;jobs)</pre>
 373 </li>
 374 </ul>
 375 </li>
 376 </ul>
 377 </li>
 378 </ul>
 379 </div>
 380 </div>
 381 <!-- ========= END OF CLASS DATA ========= -->
 382 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 383 <div class="bottomNav"><a name="navbar.bottom">
 384 <!--   -->
 385 </a>
 386 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 387 <a name="navbar.bottom.firstrow">
 388 <!--   -->
 389 </a>
 390 <ul class="navList" title="Navigation">
 391 <li><a href="../../overview-summary.html">Overview</a></li>
 392 <li><a href="package-summary.html">Package</a></li>
 393 <li class="navBarCell1Rev">Class</li>
 394 <li><a href="class-use/Job.html">Use</a></li>
 395 <li><a href="package-tree.html">Tree</a></li>
 396 <li><a href="../../deprecated-list.html">Deprecated</a></li>
 397 <li><a href="../../index-files/index-1.html">Index</a></li>
 398 <li><a href="../../help-doc.html">Help</a></li>
 399 </ul>
 400 </div>
 401 <div class="subNav">
 402 <ul class="navList">
 403 <li><a href="../../compbio/engine/FilePuller.html" title="class in compbio.engine"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 404 <li><a href="../../compbio/engine/LoadBalancer.html" title="class in compbio.engine"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 405 </ul>
 406 <ul class="navList">
 407 <li><a href="../../index.html?compbio/engine/Job.html" target="_top">Frames</a></li>
 408 <li><a href="Job.html" target="_top">No&nbsp;Frames</a></li>
 409 </ul>
 410 <ul class="navList" id="allclasses_navbar_bottom">
 411 <li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 412 </ul>
 413 <div>
 414 <script type="text/javascript"><!--
 415   allClassesLink = document.getElementById("allclasses_navbar_bottom");
 416   if(window==top) {
 417     allClassesLink.style.display = "block";
 418   }
 419   else {
 420     allClassesLink.style.display = "none";
 421   }
 422   //-->
 423 </script>
 424 </div>
 425 <div>
 426 <ul class="subNavList">
 427 <li>Summary:&nbsp;</li>
 428 <li>Nested&nbsp;|&nbsp;</li>
 429 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
 430 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 431 <li><a href="#method.summary">Method</a></li>
 432 </ul>
 433 <ul class="subNavList">
 434 <li>Detail:&nbsp;</li>
 435 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
 436 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
 437 <li><a href="#method.detail">Method</a></li>
 438 </ul>
 439 </div>
 440 <a name="skip.navbar.bottom">
 441 <!--   -->
 442 </a></div>
 443 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 444 </body>
 445 </html>