com.mulesoft.mule.runtime.module.batch.internal

Class DefaultBatchJobResult

java.lang.Object

com.mulesoft.mule.runtime.module.batch.internal.DefaultBatchJobResult

All Implemented Interfaces:

BatchJobResult, BatchJobResultAdapter, Serializable

public class DefaultBatchJobResult
extends Object
implements BatchJobResultAdapter

Default implementation for BatchJobResultAdapter

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefaultBatchJobResult(String batchJodInstanceId)

Method Summary

Modifier and Type	Method and Description
String	getBatchJobInstanceId() The id of the owning BatchJobInstance
Map<String,BatchStepResult>	getBatchStepResults() Returns a Map in which the key is the name of a step and the value is a BatchStepResult
long	getElapsedTimeInMillis() How many milliseconds the BatchJobInstance has been in executing state.
long	getFailedRecords() How many records were processed and failed in at least one step
Exception	getInputPhaseException() If the input phase failed, this method returns an exception info object
long	getLoadedRecords() How many records were loaded so far.
Exception	getLoadingPhaseException() If the loading phase failed, this method returns an exception info object
Exception	getOnCompletePhaseException() If the on complete phase failed, this method returns an exception info object
long	getProcessedRecords() How many records already went through all steps so far.
BatchStepResult	getResultForStep(String stepId) Retrieves information about the execution of a particular step
long	getSuccessfulRecords() How many records were processed through all the steps without failing any of them
long	getTotalRecords() Total number of records in the batch
long	incrementLoadedRecords(long howMany) Increments the load records count by howMany
boolean	isFailedOnCompletePhase() Wether an exeption was found on the on complete phase
boolean	isFailedOnInputPhase() Wether an exeption was found on the on input phase
boolean	isFailedOnLoadingPhase() Wether an exeption was found on the on loading phase
void	setInputPhaseException(Exception inputPhaseException) Sets an Exception thrown in the input phase
void	setLoadingPhaseException(Exception loadingPhaseException) Sets an Exception thrown in the loading phase
void	setOnCompletePhaseException(Exception onCompleteStepException) Sets an Exception thrown in the on complete phase
void	setTotalRecords(long totalRecords) sets the amount of total records that make for the owning BatchJobInstance
long	startClock() Starts tracking the time that a BatchJobInstance has been processing since the moment that this method has been invoked.
long	stopClock() Signals that the owning BatchJobInstance has stopped processing at the time this method was invoked
void	updateFor(BatchJobAdapter job, Collection<Record> records) Updates the values in this instance

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultBatchJobResult

public DefaultBatchJobResult(String batchJodInstanceId)

Method Detail

updateFor

public void updateFor(BatchJobAdapter job,
                      Collection<Record> records)

Updates the values in this instance

Specified by:

updateFor in interface BatchJobResultAdapter

Parameters:

job - the owning BatchJobAdapter

records - a collection of Record processed

getResultForStep

public BatchStepResult getResultForStep(String stepId)

Retrieves information about the execution of a particular step

Specified by:

getResultForStep in interface BatchJobResult

Parameters:

stepId - the id of a step in the owning BatchJob

Returns:

a BatchStepResult

startClock

public long startClock()

Starts tracking the time that a BatchJobInstance has been processing since the moment that this method has been invoked. After invoking this method, BatchJobResultAdapter.stopClock() has to be invoked at some point so that BatchJobResult.getElapsedTimeInMillis() can eventually return a valid value

Specified by:

startClock in interface BatchJobResultAdapter

Returns:

the instant in milliseconds in which this method was invoked

stopClock

public long stopClock()

Signals that the owning BatchJobInstance has stopped processing at the time this method was invoked

Specified by:

stopClock in interface BatchJobResultAdapter

Returns:

the time in millis that the owning BatchJobInstance has been processing

getElapsedTimeInMillis

public long getElapsedTimeInMillis()

How many milliseconds the BatchJobInstance has been in executing state. If the job is stopped and then resumed, this method is smart enough to filter the interval

Specified by:

getElapsedTimeInMillis in interface BatchJobResult

getSuccessfulRecords

public long getSuccessfulRecords()

How many records were processed through all the steps without failing any of them

Specified by:

getSuccessfulRecords in interface BatchJobResult

getFailedRecords

public long getFailedRecords()

How many records were processed and failed in at least one step

Specified by:

getFailedRecords in interface BatchJobResult

getProcessedRecords

public long getProcessedRecords()

How many records already went through all steps so far. When execution phase has finished, this method's return value should match the one of BatchJobResult.getTotalRecords()

Specified by:

getProcessedRecords in interface BatchJobResult

getTotalRecords

public long getTotalRecords()

Total number of records in the batch

Specified by:

getTotalRecords in interface BatchJobResult

getBatchJobInstanceId

public String getBatchJobInstanceId()

The id of the owning BatchJobInstance

Specified by:

getBatchJobInstanceId in interface BatchJobResult

Returns:

a non empty String

getLoadedRecords

public long getLoadedRecords()

How many records were loaded so far. When loading phase has finished, this method's return value should match the one of BatchJobResult.getTotalRecords()

Specified by:

getLoadedRecords in interface BatchJobResult

incrementLoadedRecords

public long incrementLoadedRecords(long howMany)

Increments the load records count by howMany

Specified by:

incrementLoadedRecords in interface BatchJobResultAdapter

Parameters:

howMany - the amount of new records that have been loaded

Returns:

the updated count of records that have been loaded

setTotalRecords

public void setTotalRecords(long totalRecords)

sets the amount of total records that make for the owning BatchJobInstance

Specified by:

setTotalRecords in interface BatchJobResultAdapter

Parameters:

totalRecords - the total amount of records

isFailedOnInputPhase

public boolean isFailedOnInputPhase()

Wether an exeption was found on the on input phase

Specified by:

isFailedOnInputPhase in interface BatchJobResult

getInputPhaseException

public Exception getInputPhaseException()

If the input phase failed, this method returns an exception info object

Specified by:

getInputPhaseException in interface BatchJobResult

Returns:

a Exception

getLoadingPhaseException

public Exception getLoadingPhaseException()

Description copied from interface: BatchJobResult

If the loading phase failed, this method returns an exception info object

Specified by:

getLoadingPhaseException in interface BatchJobResult

Returns:

a Exception

isFailedOnLoadingPhase

public boolean isFailedOnLoadingPhase()

Description copied from interface: BatchJobResult

Wether an exeption was found on the on loading phase

Specified by:

isFailedOnLoadingPhase in interface BatchJobResult

isFailedOnCompletePhase

public boolean isFailedOnCompletePhase()

Wether an exeption was found on the on complete phase

Specified by:

isFailedOnCompletePhase in interface BatchJobResult

getOnCompletePhaseException

public Exception getOnCompletePhaseException()

If the on complete phase failed, this method returns an exception info object

Specified by:

getOnCompletePhaseException in interface BatchJobResult

Returns:

a Exception

setOnCompletePhaseException

public void setOnCompletePhaseException(Exception onCompleteStepException)

Sets an Exception thrown in the on complete phase

Specified by:

setOnCompletePhaseException in interface BatchJobResultAdapter

Parameters:

onCompleteStepException - a Exception

setInputPhaseException

public void setInputPhaseException(Exception inputPhaseException)

Sets an Exception thrown in the input phase

Specified by:

setInputPhaseException in interface BatchJobResultAdapter

Parameters:

inputPhaseException - a Exception

setLoadingPhaseException

public void setLoadingPhaseException(Exception loadingPhaseException)

Sets an Exception thrown in the loading phase

Specified by:

setLoadingPhaseException in interface BatchJobResultAdapter

Parameters:

loadingPhaseException - a Exception

getBatchStepResults

public Map<String,BatchStepResult> getBatchStepResults()

Returns a Map in which the key is the name of a step and the value is a BatchStepResult

Specified by:

getBatchStepResults in interface BatchJobResultAdapter