com.marklogic.hub.step

Interface StepRunner

All Known Implementing Classes:

QueryStepRunner, WriteStepRunner

public interface StepRunner

Executes a step with options

Method Summary

Modifier and Type	Method and Description
void	awaitCompletion() Blocks until the step execution is complete.
void	awaitCompletion(long timeout, java.util.concurrent.TimeUnit unit) Blocks until the step execution is complete.
int	getBatchSize() Returns the batch size
StepRunner	onFinished(StepFinishedListener listener) Sets the finished listener for when the item has processed (similar to a finally)
StepRunner	onItemComplete(StepItemCompleteListener listener) Sets a listener on each item completing
StepRunner	onItemFailed(StepItemFailureListener listener) Sets the failure listener for each item in the flow
StepRunner	onStatusChanged(StepStatusListener listener) Sets the status change listener on the flowrunner object
RunStepResponse	run() Runs the flow and creates the job
RunStepResponse	run(java.util.Collection<java.lang.String> uris) Runs the flow and creates the job.
void	stop() Stops the step run
StepRunner	withBatchSize(int batchSize) Sets the batch size for the step runner
StepRunner	withFlow(Flow flow) Sets the flow to be used with the step runner
StepRunner	withJobId(java.lang.String jobId) Sets the batch size for the step runner
StepRunner	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.
StepRunner	withStep(java.lang.String step) Sets the batch size for the step runner
StepRunner	withStepConfig(java.util.Map<java.lang.String,java.lang.Object> stepConfig) Sets the config to be used in orchestrating the step.
StepRunner	withStopOnFailure(boolean stopOnFailure) Sets if this will stop the job on a failure, or if it will continue on
StepRunner	withThreadCount(int threadCount) Sets the thread count for the flowrunner

Method Detail

withFlow

StepRunner withFlow(Flow flow)

Sets the flow to be used with the step runner

Parameters:

flow - the flow object to be used

Returns:

the step runner object

withBatchSize

StepRunner withBatchSize(int batchSize)

Sets the batch size for the step runner

Parameters:

batchSize - - the size of the batch in integer form

Returns:

the step runner object

withStep

StepRunner withStep(java.lang.String step)

Sets the batch size for the step runner

Parameters:

step - - the step to be run in the flow

Returns:

the step runner object

withJobId

StepRunner withJobId(java.lang.String jobId)

Sets the batch size for the step runner

Parameters:

jobId - - the id of the job

Returns:

the step runner object

withThreadCount

StepRunner withThreadCount(int threadCount)

Sets the thread count for the flowrunner

Parameters:

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

Returns:

the step runner object

withOptions

StepRunner 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 step runner object

withStepConfig

StepRunner withStepConfig(java.util.Map<java.lang.String,java.lang.Object> stepConfig)

Sets the config to be used in orchestrating the step.

Parameters:

stepConfig - - the object map of configurations for the step to execute as string/object pair

Returns:

the step runner object

withStopOnFailure

StepRunner withStopOnFailure(boolean stopOnFailure)

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

Parameters:

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

Returns:

the step runner object

onItemComplete

StepRunner onItemComplete(StepItemCompleteListener listener)

Sets a listener on each item completing

Parameters:

listener - the listen object to set

Returns:

the step runner object

onItemFailed

StepRunner onItemFailed(StepItemFailureListener listener)

Sets the failure listener for each item in the flow

Parameters:

listener - the listener for the failures in the flow

Returns:

the step runner object

onStatusChanged

StepRunner onStatusChanged(StepStatusListener listener)

Sets the status change listener on the flowrunner object

Parameters:

listener - - the listener for when the status changes

Returns:

the step runner object

onFinished

StepRunner onFinished(StepFinishedListener 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 step runner object

awaitCompletion

void awaitCompletion()

Blocks until the step execution is complete.

awaitCompletion

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

Blocks until the step execution 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

java.util.concurrent.TimeoutException - if times out

run

RunStepResponse run()

Runs the flow and creates the job

Returns:

RunStepResponse object for the flow that is run

run

RunStepResponse run(java.util.Collection<java.lang.String> uris)

Runs the flow and creates the job. This bypasses the collector

Parameters:

uris - the ids to pass to the harmonization flow

Returns:

RunStepResponse object for the flow that is run

stop

void stop()

Stops the step run

getBatchSize

int getBatchSize()

Returns the batch size

Returns:

batch size for step runner