You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<li><ahref="biolockj/exception/ConfigPathException.html" title="class in biolockj.exception" target="classFrame">ConfigPathException</a></li>
34
34
<li><ahref="biolockj/exception/ConfigViolationException.html" title="class in biolockj.exception" target="classFrame">ConfigViolationException</a></li>
35
35
<li><ahref="biolockj/Constants.html" title="class in biolockj" target="classFrame">Constants</a></li>
36
+
<li><ahref="biolockj/module/DatabaseModule.html" title="interface in biolockj.module" target="classFrame"><spanclass="interfaceName">DatabaseModule</span></a></li>
36
37
<li><ahref="biolockj/module/implicit/Demultiplexer.html" title="class in biolockj.module.implicit" target="classFrame">Demultiplexer</a></li>
37
38
<li><ahref="biolockj/util/DemuxUtil.html" title="class in biolockj.util" target="classFrame">DemuxUtil</a></li>
38
39
<li><ahref="biolockj/util/DockerUtil.html" title="class in biolockj.util" target="classFrame">DockerUtil</a></li>
<divclass="block">Create a copy of the sequence files in property <ahref="../biolockj/Constants.html#INPUT_DIRS">"input.dirPaths"</a>, output to a directory
149
-
named <ahref="../biolockj/Constants.html#PROJECT_PIPELINE_DIR">"project.pipelineDir"</a>/input.</div>
149
+
named <ahref="../biolockj/Constants.html#PIPELINE_DIR">"pipeline.pipelineDir"</a>/input.</div>
150
150
</td>
151
151
</tr>
152
152
<trid="i2" class="altColor">
153
153
<tdclass="colFirst"><code>protected static <ahref="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td>
<divclass="block">Create the pipeline root directory under $DOCKER_PROJ and save the path to
156
-
<ahref="../biolockj/Config.html" title="class in biolockj"><code>Config</code></a>.<ahref="../biolockj/Constants.html#PROJECT_PIPELINE_DIR">"project.pipelineDir"</a>.</div>
156
+
<ahref="../biolockj/Config.html" title="class in biolockj"><code>Config</code></a>.<ahref="../biolockj/Constants.html#PIPELINE_DIR">"pipeline.pipelineDir"</a>.</div>
157
157
</td>
158
158
</tr>
159
159
<trid="i3" class="rowColor">
@@ -248,7 +248,7 @@ <h3>Method Summary</h3>
248
248
249
249
Call <ahref="../biolockj/Pipeline.html#initializePipeline--"><code>Pipeline.initializePipeline()</code></a> to initialize Pipeline modules
250
250
For direct module execution call <ahref="../biolockj/Pipeline.html#runDirectModule-java.lang.Integer-"><code>Pipeline.runDirectModule(Integer)</code></a>
251
-
Otherwise execute <ahref="../biolockj/Pipeline.html#runPipeline--"><code>Pipeline.runPipeline()</code></a> and save MASTER <ahref="../biolockj/Config.html" title="class in biolockj"><code>Config</code></a>
251
+
Otherwise execute <ahref="../biolockj/Pipeline.html#runPipeline--"><code>Pipeline.runPipeline()</code></a> and save MASTER <ahref="../biolockj/Config.html" title="class in biolockj"><code>Config</code></a>
252
252
If initializing AWS Cloud manager, call <ahref="../biolockj/BioLockJ.html#initAwsManager--"><code>initAwsManager()</code></a>.</div>
<divclass="block">Determine project status based on existence of <ahref="../biolockj/Constants.html#BLJ_COMPLETE">"biolockjComplete"</a> in pipeline root
318
+
directory.</div>
319
+
<dl>
320
+
<dt><spanclass="returnLabel">Returns:</span></dt>
321
+
<dd>true if <ahref="../biolockj/Constants.html#BLJ_COMPLETE">"biolockjComplete"</a> exists in the pipeline root directory, otherwise false</dd>
322
+
</dl>
323
+
</li>
324
+
</ul>
310
325
<aname="main-java.lang.String:A-">
311
326
<!-- -->
312
327
</a>
@@ -330,6 +345,39 @@ <h4>main</h4>
330
345
</dl>
331
346
</li>
332
347
</ul>
348
+
<aname="pipelineInputDir--">
349
+
<!-- -->
350
+
</a>
351
+
<ulclass="blockList">
352
+
<liclass="blockList">
353
+
<h4>pipelineInputDir</h4>
354
+
<pre>public static <ahref="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> pipelineInputDir()
355
+
throws <ahref="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
356
+
<divclass="block">Return the pipeline input directory</div>
357
+
<dl>
358
+
<dt><spanclass="returnLabel">Returns:</span></dt>
359
+
<dd>Input dir</dd>
360
+
<dt><spanclass="throwsLabel">Throws:</span></dt>
361
+
<dd><code><ahref="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if unable to obtain file</dd>
throws <ahref="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
373
+
<divclass="block">Create a copy of the sequence files in property <ahref="../biolockj/Constants.html#INPUT_DIRS">"input.dirPaths"</a>, output to a directory
374
+
named <ahref="../biolockj/Constants.html#PIPELINE_DIR">"pipeline.pipelineDir"</a>/input.</div>
375
+
<dl>
376
+
<dt><spanclass="throwsLabel">Throws:</span></dt>
377
+
<dd><code><ahref="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if unable to copy the files</dd>
<pre>protected static <ahref="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> createPipelineDirectory()
340
388
throws <ahref="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
341
389
<divclass="block">Create the pipeline root directory under $DOCKER_PROJ and save the path to
342
-
<ahref="../biolockj/Config.html" title="class in biolockj"><code>Config</code></a>.<ahref="../biolockj/Constants.html#PROJECT_PIPELINE_DIR">"project.pipelineDir"</a>.
390
+
<ahref="../biolockj/Config.html" title="class in biolockj"><code>Config</code></a>.<ahref="../biolockj/Constants.html#PIPELINE_DIR">"pipeline.pipelineDir"</a>.
343
391
<p>
344
392
For example, the following <ahref="../biolockj/Config.html" title="class in biolockj"><code>Config</code></a> settings will create:
throws <ahref="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<li>Update pipeline root directory to EFS directory
421
+
<li>Update EFS MASTER <ahref="../biolockj/Config.html" title="class in biolockj"><code>Config</code></a> with new pipeline root directory path
422
+
<li>Save pipeline input files to EFS for faster processing
423
+
</ol></div>
424
+
<dl>
425
+
<dt><spanclass="throwsLabel">Throws:</span></dt>
426
+
<dd><code><ahref="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if runtime errors occur</dd>
427
+
</dl>
428
+
</li>
429
+
</ul>
359
430
<aname="initBioLockJ-java.lang.String:A-">
360
431
<!-- -->
361
432
</a>
@@ -413,7 +484,7 @@ <h4>initRestart</h4>
413
484
<h4>markProjectStatus</h4>
414
485
<pre>protected static void markProjectStatus(<ahref="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> status)</pre>
415
486
<divclass="block">Create indicator file in pipeline root directory, with name = status parameter.
416
-
<ahref="../biolockj/Config.html" title="class in biolockj"><code>Config</code></a>.<ahref="../biolockj/Constants.html#PROJECT_PIPELINE_DIR">"project.pipelineDir"</a>.</div>
487
+
<ahref="../biolockj/Config.html" title="class in biolockj"><code>Config</code></a>.<ahref="../biolockj/Constants.html#PIPELINE_DIR">"pipeline.pipelineDir"</a>.</div>
<li>Call <ahref="../biolockj/Pipeline.html#initializePipeline--"><code>Pipeline.initializePipeline()</code></a> to initialize Pipeline modules
449
520
<li>For direct module execution call <ahref="../biolockj/Pipeline.html#runDirectModule-java.lang.Integer-"><code>Pipeline.runDirectModule(Integer)</code></a>
450
-
<li>Otherwise execute <ahref="../biolockj/Pipeline.html#runPipeline--"><code>Pipeline.runPipeline()</code></a> and save MASTER <ahref="../biolockj/Config.html" title="class in biolockj"><code>Config</code></a>
521
+
<li>Otherwise execute <ahref="../biolockj/Pipeline.html#runPipeline--"><code>Pipeline.runPipeline()</code></a> and save MASTER <ahref="../biolockj/Config.html" title="class in biolockj"><code>Config</code></a>
<li>If <ahref="../biolockj/Config.html" title="class in biolockj"><code>Config</code></a>.<ahref="../biolockj/Constants.html#PROJECT_DELETE_TEMP_FILES">"project.deleteTempFiles"</a> =
523
+
<li>If <ahref="../biolockj/Config.html" title="class in biolockj"><code>Config</code></a>.<ahref="../biolockj/Constants.html#PIPELINE_DELETE_TEMP_FILES">"pipeline.deleteTempFiles"</a> =
453
524
<ahref="../biolockj/Constants.html#TRUE">"Y"</a>, Call <ahref="../biolockj/BioLockJ.html#removeTempFiles--"><code>removeTempFiles()</code></a> to delete tem files
454
525
<li>Call <ahref="../biolockj/BioLockJ.html#markProjectStatus-java.lang.String-"><code>markProjectStatus(String)</code></a> to set the overall pipeline status as successful
throws <ahref="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<li>Update pipeline root directory to EFS directory
476
-
<li>Update EFS MASTER <ahref="../biolockj/Config.html" title="class in biolockj"><code>Config</code></a> with new pipeline root directory path
477
-
<li>Save pipeline input files to EFS for faster processing
478
-
</ol></div>
479
-
<dl>
480
-
<dt><spanclass="throwsLabel">Throws:</span></dt>
481
-
<dd><code><ahref="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if runtime errors occur</dd>
throws <ahref="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
493
-
<divclass="block">Create a copy of the sequence files in property <ahref="../biolockj/Constants.html#INPUT_DIRS">"input.dirPaths"</a>, output to a directory
494
-
named <ahref="../biolockj/Constants.html#PROJECT_PIPELINE_DIR">"project.pipelineDir"</a>/input.</div>
495
-
<dl>
496
-
<dt><spanclass="throwsLabel">Throws:</span></dt>
497
-
<dd><code><ahref="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if unable to copy the files</dd>
498
-
</dl>
499
-
</li>
500
-
</ul>
501
-
<aname="pipelineInputDir--">
502
-
<!-- -->
503
-
</a>
504
-
<ulclass="blockList">
505
-
<liclass="blockList">
506
-
<h4>pipelineInputDir</h4>
507
-
<pre>public static <ahref="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> pipelineInputDir()
508
-
throws <ahref="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
509
-
<divclass="block">Return the pipeline input directory</div>
510
-
<dl>
511
-
<dt><spanclass="returnLabel">Returns:</span></dt>
512
-
<dd>Input dir</dd>
513
-
<dt><spanclass="throwsLabel">Throws:</span></dt>
514
-
<dd><code><ahref="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if unable to obtain file</dd>
<divclass="block">Determine project status based on existence of <ahref="../biolockj/Constants.html#BLJ_COMPLETE">"biolockjComplete"</a> in pipeline root
526
-
directory.</div>
527
-
<dl>
528
-
<dt><spanclass="returnLabel">Returns:</span></dt>
529
-
<dd>true if <ahref="../biolockj/Constants.html#BLJ_COMPLETE">"biolockjComplete"</a> exists in the pipeline root directory, otherwise false</dd>
<pre>public static void setPipelineDir(<ahref="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> dir)
1225
+
throws <ahref="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
1226
+
<divclass="block">Set the root pipeline directory path</div>
<dd><code><ahref="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if errors occur</dd>
<pre>public static void setPipelineDir(<ahref="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> dir)
1261
-
throws <ahref="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
1262
-
<divclass="block">Set the root pipeline directory path</div>
<dd><code><ahref="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if errors occur</dd>
0 commit comments