com.marklogic.hub.flow.impl

Class FlowRunnerImpl

java.lang.Object

com.marklogic.hub.flow.impl.FlowRunnerImpl

All Implemented Interfaces:

FlowRunner

public class FlowRunnerImpl
extends java.lang.Object
implements FlowRunner

Constructor Summary

Constructors

Constructor and Description
FlowRunnerImpl(HubConfig hubConfig)

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FlowRunnerImpl

public FlowRunnerImpl(HubConfig hubConfig)

Method Detail

withFlow

public FlowRunner withFlow(Flow flow)

Description copied from interface: FlowRunner

Sets the flow to be used with the flow runner

Specified by:

withFlow in interface FlowRunner

Parameters:

flow - the flow object to be used

Returns:

the flow runner object

withBatchSize

public FlowRunner withBatchSize(int batchSize)

Description copied from interface: FlowRunner

Sets the batch size for the flow runner

Specified by:

withBatchSize in interface FlowRunner

Parameters:

batchSize - - the size of the batch in integer form

Returns:

the flow runner object

withThreadCount

public FlowRunner withThreadCount(int threadCount)

Description copied from interface: FlowRunner

Sets the thread count for the flowrunner

Specified by:

withThreadCount in interface FlowRunner

Parameters:

threadCount - - the number of threads for the flow runner to use

Returns:

the flow runner object

withSourceClient

public FlowRunner withSourceClient(com.marklogic.client.DatabaseClient sourceClient)

Description copied from interface: FlowRunner

Sets the source client on the flow runner. The source client determines which database to run against for building the envelope.

Specified by:

withSourceClient in interface FlowRunner

Parameters:

sourceClient - - the client that will be used

Returns:

the flow runner object

withDestinationDatabase

public FlowRunner withDestinationDatabase(java.lang.String destinationDatabase)

Description copied from interface: FlowRunner

Sets the database where flow output data will be presisted to

Specified by:

withDestinationDatabase in interface FlowRunner

Parameters:

destinationDatabase - - the name of the database

Returns:

the flow runner object

withStopOnFailure

public FlowRunner withStopOnFailure(boolean stopOnFailure)

Description copied from interface: FlowRunner

Sets if this will stop the job on a failure, or if it will continue on

Specified by:

withStopOnFailure in interface FlowRunner

Returns:

the flow runner object

withOptions

public FlowRunner withOptions(java.util.Map<java.lang.String,java.lang.Object> options)

Description copied from interface: FlowRunner

Sets the options to be passed into the xqy or sjs flow in the $options or options variables of main.

Specified by:

withOptions in interface FlowRunner

Parameters:

options - - the object map of options as string/object pair

Returns:

the flow runner object

onItemComplete

public FlowRunner onItemComplete(FlowItemCompleteListener listener)

Description copied from interface: FlowRunner

Sets a listener on each item completing

Specified by:

onItemComplete in interface FlowRunner

Parameters:

listener - the listen object to set

Returns:

the flow runner object

onItemFailed

public FlowRunner onItemFailed(FlowItemFailureListener listener)

Description copied from interface: FlowRunner

Sets the failure listener for each item in the flow

Specified by:

onItemFailed in interface FlowRunner

Parameters:

listener - the listener for the failures in the flow

Returns:

the flow runner object

onStatusChanged

public FlowRunner onStatusChanged(FlowStatusListener listener)

Description copied from interface: FlowRunner

Sets the status change listener on the flowrunner object

Specified by:

onStatusChanged in interface FlowRunner

Parameters:

listener - - the listener for when the status changes

Returns:

the flow runner object

onFinished

public FlowRunner onFinished(FlowFinishedListener listener)

Description copied from interface: FlowRunner

Sets the finished listener for when the item has processed (similar to a finally)

Specified by:

onFinished in interface FlowRunner

Parameters:

listener - - the listener for the flow item when it finishes

Returns:

the flow runner object

awaitCompletion

public void awaitCompletion()

Description copied from interface: FlowRunner

Blocks until the job is complete.

Specified by:

awaitCompletion in interface FlowRunner

awaitCompletion

public void awaitCompletion(long timeout,
                            java.util.concurrent.TimeUnit unit)
                     throws java.lang.InterruptedException

Description copied from interface: FlowRunner

Blocks until the job is complete.

Specified by:

awaitCompletion in interface FlowRunner

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Throws:

java.lang.InterruptedException - if interrupted while waiting

run

public com.marklogic.client.datamovement.JobTicket run()

Description copied from interface: FlowRunner

Runs the flow and creates the job

Specified by:

run in interface FlowRunner

Returns:

jobticket object for the flow that is run