WhiteStarWorkflowEngine (SeqWare 1.1.2 API)

java.lang.Object
- io.seqware.pipeline.engines.whitestar.WhiteStarWorkflowEngine

All Implemented Interfaces:

WorkflowEngine
```
public class WhiteStarWorkflowEngine
extends Object
implements WorkflowEngine
```
This is a synchronous bare-bones implementation of the WorkflowEngine for prototyping and debugging. This re-uses much of the OozieWorkflowXml generation code in order to generate the required Bash scripts and supporting files.

Author:

dyuen

Constructor Summary

Constructors
Constructor and Description
`WhiteStarWorkflowEngine(AbstractWorkflowDataModel objectModel, boolean useSge, String threadsSgeParamFormat, String maxMemorySgeParamFormat, boolean createDirectories, boolean parallel)`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getLookupToken()` An engine-specific token for this workflow run that can be used to lookup relevant runtime data.
`String`	`getWorkingDirectory()` The working directory for the prepared workflow run, or null if not yet prepared or if not applicable for the concrete engine.
`void`	`prepareWorkflow(AbstractWorkflowDataModel objectModel)` Prepare the workflow according to the info filled in the input objectModel.
`void`	`prepareWorkflow(AbstractWorkflowDataModel objectModel, File nfsWorkDir)`
`ReturnValue`	`runWorkflow()` Run the prepared workflow.
`ReturnValue`	`runWorkflow(SortedSet<String> set)` Run a workflow, steps contained within set are skipped.
`ReturnValue`	`watchWorkflow(String jobToken)` Watch a workflow and return running information until it completes.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WhiteStarWorkflowEngine
```
public WhiteStarWorkflowEngine(AbstractWorkflowDataModel objectModel,
                       boolean useSge,
                       String threadsSgeParamFormat,
                       String maxMemorySgeParamFormat,
                       boolean createDirectories,
                       boolean parallel)
```
    Parameters:
    objectModel -
    useSge -
    threadsSgeParamFormat -
    maxMemorySgeParamFormat -
    createDirectories - true when creating the engine to launch a job
    parallel -
- Method Detail
  - prepareWorkflow
```
public void prepareWorkflow(AbstractWorkflowDataModel objectModel)
```
    Description copied from interface: WorkflowEngine
    
    Prepare the workflow according to the info filled in the input objectModel.
    
    Specified by:
    
    prepareWorkflow in interface WorkflowEngine
    
    Parameters:
    objectModel - model of the workflow to prepare to run
  - prepareWorkflow
```
public void prepareWorkflow(AbstractWorkflowDataModel objectModel,
                   File nfsWorkDir)
```
    Parameters:
    objectModel -
    nfsWorkDir - pass a working directory to skip creation of scripts in the generated-scripts
  - runWorkflow
```
public ReturnValue runWorkflow()
```
    Description copied from interface: WorkflowEngine
    
    Run the prepared workflow.
    
    Specified by:
    
    runWorkflow in interface WorkflowEngine
    
    Returns:
  - runWorkflow
```
public ReturnValue runWorkflow(SortedSet<String> set)
```
    Run a workflow, steps contained within set are skipped.
    
    Parameters:
    set - a sorted set of workflow steps
    
    Returns:
  - watchWorkflow
```
public ReturnValue watchWorkflow(String jobToken)
```
    Description copied from interface: WorkflowEngine
    
    Watch a workflow and return running information until it completes. The exact nature of the output is arbitrary and likely dependent on the workflow engine.
    
    Specified by:
    
    watchWorkflow in interface WorkflowEngine
    
    Returns:
  - getWorkingDirectory
```
public String getWorkingDirectory()
```
    Description copied from interface: WorkflowEngine
    
    The working directory for the prepared workflow run, or null if not yet prepared or if not applicable for the concrete engine.
    
    Specified by:
    
    getWorkingDirectory in interface WorkflowEngine
    
    Returns:
    the working directory, or null
  - getLookupToken
```
public String getLookupToken()
```
    Description copied from interface: WorkflowEngine
    
    An engine-specific token for this workflow run that can be used to lookup relevant runtime data.
    
    Specified by:
    
    getLookupToken in interface WorkflowEngine
    
    Returns:
    the token

Class WhiteStarWorkflowEngine

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WhiteStarWorkflowEngine

Method Detail

prepareWorkflow

prepareWorkflow

runWorkflow

runWorkflow

watchWorkflow

getWorkingDirectory

getLookupToken