FlowRunner (marklogic-data-hub 3.0.0 API)

All Known Implementing Classes:

FlowRunnerImpl
```
public interface FlowRunner
```
Executes a flow with options

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`awaitCompletion()` Blocks until the job is complete.
`void`	`awaitCompletion(long timeout, java.util.concurrent.TimeUnit unit)` Blocks until the job is complete.
`FlowRunner`	`onFinished(FlowFinishedListener listener)` Sets the finished listener for when the item has processed (similar to a finally)
`FlowRunner`	`onItemComplete(FlowItemCompleteListener listener)` Sets a listener on each item completing
`FlowRunner`	`onItemFailed(FlowItemFailureListener listener)` Sets the failure listener for each item in the flow
`FlowRunner`	`onStatusChanged(FlowStatusListener listener)` Sets the status change listener on the flowrunner object
`com.marklogic.client.datamovement.JobTicket`	`run()` Runs the flow and creates the job
`FlowRunner`	`withBatchSize(int batchSize)` Sets the batch size for the flow runner
`FlowRunner`	`withDestinationDatabase(java.lang.String destinationDatabase)` Sets the database where flow output data will be presisted to
`FlowRunner`	`withFlow(Flow flow)` Sets the flow to be used with the flow runner
`FlowRunner`	`withOptions(java.util.Map<java.lang.String,java.lang.Object> options)` Sets the options to be passed into the xqy or sjs flow in the $options or options variables of main.
`FlowRunner`	`withSourceClient(com.marklogic.client.DatabaseClient sourceClient)` Sets the source client on the flow runner.
`FlowRunner`	`withStopOnFailure(boolean stopOnFailure)` Sets if this will stop the job on a failure, or if it will continue on
`FlowRunner`	`withThreadCount(int threadCount)` Sets the thread count for the flowrunner

- Method Detail
  - withFlow
```
FlowRunner withFlow(Flow flow)
```
    Sets the flow to be used with the flow runner
    
    Parameters:
    
    flow - the flow object to be used
    
    Returns:
    
    the flow runner object
  - withBatchSize
```
FlowRunner withBatchSize(int batchSize)
```
    Sets the batch size for the flow runner
    
    Parameters:
    
    batchSize - - the size of the batch in integer form
    
    Returns:
    
    the flow runner object
  - withThreadCount
```
FlowRunner withThreadCount(int threadCount)
```
    Sets the thread count for the flowrunner
    
    Parameters:
    
    threadCount - - the number of threads for the flow runner to use
    
    Returns:
    
    the flow runner object
  - withSourceClient
```
FlowRunner withSourceClient(com.marklogic.client.DatabaseClient sourceClient)
```
    Sets the source client on the flow runner. The source client determines which database to run against for building the envelope.
    
    Parameters:
    
    sourceClient - - the client that will be used
    
    Returns:
    
    the flow runner object
  - withDestinationDatabase
```
FlowRunner withDestinationDatabase(java.lang.String destinationDatabase)
```
    Sets the database where flow output data will be presisted to
    
    Parameters:
    
    destinationDatabase - - the name of the database
    
    Returns:
    
    the flow runner object
  - withOptions
```
FlowRunner withOptions(java.util.Map<java.lang.String,java.lang.Object> options)
```
    Sets the options to be passed into the xqy or sjs flow in the $options or options variables of main.
    
    Parameters:
    
    options - - the object map of options as string/object pair
    
    Returns:
    
    the flow runner object
  - withStopOnFailure
```
FlowRunner withStopOnFailure(boolean stopOnFailure)
```
    Sets if this will stop the job on a failure, or if it will continue on
    
    Parameters:
    
    stopOnFailure -
    
    Returns:
    
    the flow runner object
  - onItemComplete
```
FlowRunner onItemComplete(FlowItemCompleteListener listener)
```
    Sets a listener on each item completing
    
    Parameters:
    
    listener - the listen object to set
    
    Returns:
    
    the flow runner object
  - onItemFailed
```
FlowRunner onItemFailed(FlowItemFailureListener listener)
```
    Sets the failure listener for each item in the flow
    
    Parameters:
    
    listener - the listener for the failures in the flow
    
    Returns:
    
    the flow runner object
  - onStatusChanged
```
FlowRunner onStatusChanged(FlowStatusListener listener)
```
    Sets the status change listener on the flowrunner object
    
    Parameters:
    
    listener - - the listener for when the status changes
    
    Returns:
    
    the flow runner object
  - onFinished
```
FlowRunner onFinished(FlowFinishedListener listener)
```
    Sets the finished listener for when the item has processed (similar to a finally)
    
    Parameters:
    
    listener - - the listener for the flow item when it finishes
    
    Returns:
    
    the flow runner object
  - awaitCompletion
```
void awaitCompletion()
```
    Blocks until the job is complete.
  - awaitCompletion
```
void awaitCompletion(long timeout,
                     java.util.concurrent.TimeUnit unit)
              throws java.lang.InterruptedException
```
    Blocks until the job is complete.
    
    Parameters:
    
    timeout - the maximum time to wait
    
    unit - the time unit of the timeout argument
    
    Throws:
    
    java.lang.InterruptedException - if interrupted while waiting
  - run
```
com.marklogic.client.datamovement.JobTicket run()
```
    Runs the flow and creates the job
    
    Returns:
    
    jobticket object for the flow that is run

Interface FlowRunner

Method Summary

Method Detail

withFlow

withBatchSize

withThreadCount

withSourceClient

withDestinationDatabase

withOptions

withStopOnFailure

onItemComplete

onItemFailed

onStatusChanged

onFinished

awaitCompletion

awaitCompletion

run