com.marklogic.hub.legacy.flow.impl

Class LegacyFlowRunnerImpl

java.lang.Object

com.marklogic.hub.legacy.flow.impl.LegacyFlowRunnerImpl

All Implemented Interfaces:

LegacyFlowRunner

public class LegacyFlowRunnerImpl
extends java.lang.Object
implements LegacyFlowRunner

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LegacyFlowRunnerImpl()
	LegacyFlowRunnerImpl(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.
protected RunFlowResponse	handleFlowRunnerException(java.lang.Exception e)
LegacyFlowRunner	onFinished(LegacyFlowFinishedListener listener) Sets the finished listener for when the item has processed (similar to a finally)
LegacyFlowRunner	onItemComplete(LegacyFlowItemCompleteListener listener) Sets a listener on each item completing
LegacyFlowRunner	onItemFailed(LegacyFlowItemFailureListener listener) Sets the failure listener for each item in the flow
LegacyFlowRunner	onStatusChanged(LegacyFlowStatusListener listener) Sets the status change listener on the flowrunner object
com.marklogic.client.datamovement.JobTicket	run() Runs the flow and creates the job
LegacyFlowRunner	withBatchSize(int batchSize) Sets the batch size for the flow runner
LegacyFlowRunner	withDestinationDatabase(java.lang.String destinationDatabase) Sets the database where flow output data will be presisted to
LegacyFlowRunner	withFlow(LegacyFlow flow) Sets the flow to be used with the flow runner
LegacyFlowRunner	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.
LegacyFlowRunner	withSourceClient(com.marklogic.client.DatabaseClient stagingClient) Sets the source client on the flow runner.
LegacyFlowRunner	withStopOnFailure(boolean stopOnFailure) Sets if this will stop the job on a failure, or if it will continue on
LegacyFlowRunner	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

LegacyFlowRunnerImpl

public LegacyFlowRunnerImpl(HubConfig hubConfig)

LegacyFlowRunnerImpl

protected LegacyFlowRunnerImpl()

Method Detail

withFlow

public LegacyFlowRunner withFlow(LegacyFlow flow)

Description copied from interface: LegacyFlowRunner

Sets the flow to be used with the flow runner

Specified by:

withFlow in interface LegacyFlowRunner

Parameters:

flow - the flow object to be used

Returns:

the flow runner object

withBatchSize

public LegacyFlowRunner withBatchSize(int batchSize)

Description copied from interface: LegacyFlowRunner

Sets the batch size for the flow runner

Specified by:

withBatchSize in interface LegacyFlowRunner

Parameters:

batchSize - - the size of the batch in integer form

Returns:

the flow runner object

withThreadCount

public LegacyFlowRunner withThreadCount(int threadCount)

Description copied from interface: LegacyFlowRunner

Sets the thread count for the flowrunner

Specified by:

withThreadCount in interface LegacyFlowRunner

Parameters:

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

Returns:

the flow runner object

withSourceClient

public LegacyFlowRunner withSourceClient(com.marklogic.client.DatabaseClient stagingClient)

Description copied from interface: LegacyFlowRunner

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 LegacyFlowRunner

Parameters:

stagingClient - - the client that will be used

Returns:

the flow runner object

withDestinationDatabase

public LegacyFlowRunner withDestinationDatabase(java.lang.String destinationDatabase)

Description copied from interface: LegacyFlowRunner

Sets the database where flow output data will be presisted to

Specified by:

withDestinationDatabase in interface LegacyFlowRunner

Parameters:

destinationDatabase - - the name of the database

Returns:

the flow runner object

withStopOnFailure

public LegacyFlowRunner withStopOnFailure(boolean stopOnFailure)

Description copied from interface: LegacyFlowRunner

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

Specified by:

withStopOnFailure in interface LegacyFlowRunner

Parameters:

stopOnFailure - - true to stop the job if a failure happens

Returns:

the flow runner object

withOptions

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

Description copied from interface: LegacyFlowRunner

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 LegacyFlowRunner

Parameters:

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

Returns:

the flow runner object

onItemComplete

public LegacyFlowRunner onItemComplete(LegacyFlowItemCompleteListener listener)

Description copied from interface: LegacyFlowRunner

Sets a listener on each item completing

Specified by:

onItemComplete in interface LegacyFlowRunner

Parameters:

listener - the listen object to set

Returns:

the flow runner object

onItemFailed

public LegacyFlowRunner onItemFailed(LegacyFlowItemFailureListener listener)

Description copied from interface: LegacyFlowRunner

Sets the failure listener for each item in the flow

Specified by:

onItemFailed in interface LegacyFlowRunner

Parameters:

listener - the listener for the failures in the flow

Returns:

the flow runner object

onStatusChanged

public LegacyFlowRunner onStatusChanged(LegacyFlowStatusListener listener)

Description copied from interface: LegacyFlowRunner

Sets the status change listener on the flowrunner object

Specified by:

onStatusChanged in interface LegacyFlowRunner

Parameters:

listener - - the listener for when the status changes

Returns:

the flow runner object

onFinished

public LegacyFlowRunner onFinished(LegacyFlowFinishedListener listener)

Description copied from interface: LegacyFlowRunner

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

Specified by:

onFinished in interface LegacyFlowRunner

Parameters:

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

Returns:

the flow runner object

awaitCompletion

public void awaitCompletion()

Description copied from interface: LegacyFlowRunner

Blocks until the job is complete.

Specified by:

awaitCompletion in interface LegacyFlowRunner

awaitCompletion

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

Description copied from interface: LegacyFlowRunner

Blocks until the job is complete.

Specified by:

awaitCompletion in interface LegacyFlowRunner

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: LegacyFlowRunner

Runs the flow and creates the job

Specified by:

run in interface LegacyFlowRunner

Returns:

jobticket object for the flow that is run

handleFlowRunnerException

protected RunFlowResponse handleFlowRunnerException(java.lang.Exception e)