Package com.github.toolarium.processing.unit.base

Class AbstractProcessingUnitImpl

java.lang.Object

com.github.toolarium.processing.unit.base.AbstractProcessingUnitImpl

All Implemented Interfaces:

IProcessingUnit

Direct Known Subclasses:

AbstractProcessingUnitPersistenceImpl

public abstract class AbstractProcessingUnitImpl
extends java.lang.Object
implements IProcessingUnit

Abstract base implementation of the IProcessingUnit.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractProcessingUnitImpl()	Constructor

Method Summary

Modifier and Type	Method	Description
abstract long	estimateNumberOfUnitsToProcess(IProcessingUnitContext processingUnitContext)	Estimate the number of units to process.
java.util.List<ParameterDefinition>	getParameterDefinition()	Gets the parameter definition list of the processing.
protected IParameterRuntime	getParameterRuntime()	Get the parameter runtime information.
void	initialize(java.util.List<Parameter> parameterList, IProcessingUnitContext processingUnitContext)	Initializes the processing unit.
protected void	initializeParameterDefinition()	Initialize the parameter definition: This method is used to register the parameter definition of this processing unit.
void	onStop()	This method will be called in case on a stop before.
void	onSuccess()	This method will be called after a success end.
abstract IProcessingUnitStatus	processUnit(IProcessingUnitProgress processingProgress, IProcessingUnitContext processingUnitContext)	Process unit: This method will be called until the IProcessingUnitStatus.hasNext() returns false.
void	releaseResource()	Release resources will be called to release all internal referenced resources after a processing success, error or by a suspendProcessing (see method below).
void	resumeProcessing(IProcessingUnitPersistence processingPersistence, IProcessingUnitContext processingUnitContext)	After suspending a processing unit can be resumed.
IProcessingUnitPersistence	suspendProcessing()	Suspends the processing: The processing is able to persist its state with the help of the IProcessingUnitPersistence object.
void	validateParameterList(java.util.List<Parameter> parameterList)	Validate the parameter list consistency of this class with the parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractProcessingUnitImpl

protected AbstractProcessingUnitImpl()

Constructor

Method Detail

initializeParameterDefinition

protected void initializeParameterDefinition()

Initialize the parameter definition: This method is used to register the parameter definition of this processing unit. The method addParameterDefinition can be used for convenience.

In case of inheritance the super.initializeParameterDefinition() must be called before or after the

getParameterDefinition

public java.util.List<ParameterDefinition> getParameterDefinition()

Description copied from interface: IProcessingUnit

Gets the parameter definition list of the processing.

Specified by:

getParameterDefinition in interface IProcessingUnit

Returns:

the parameter definition list or null in case of no parameters

See Also:

IProcessingUnit.getParameterDefinition()

validateParameterList

public void validateParameterList(java.util.List<Parameter> parameterList)
                           throws ValidationException

Description copied from interface: IProcessingUnit

Validate the parameter list consistency of this class with the parameters. Typical it will be called during the initialization. It can be used to verify if the parameter of this processing are well defined.

Specified by:

validateParameterList in interface IProcessingUnit

Parameters:

parameterList - the parameter list.

Throws:

ValidationException - This will be throw in case the consistency check failures.

See Also:

IProcessingUnit.validateParameterList(java.util.List)

initialize

public void initialize(java.util.List<Parameter> parameterList,
                       IProcessingUnitContext processingUnitContext)
                throws ValidationException,
                       ProcessingException

Description copied from interface: IProcessingUnit

Initializes the processing unit. This will called as first to initialize the processing unit.

Specified by:

initialize in interface IProcessingUnit

Parameters:

parameterList - the parameter list to run the processing.

processingUnitContext - the processing context.

Throws:

ValidationException - This will be throw in case the consistency check failures.

ProcessingException - Throws this exception in case of initialization failures.

See Also:

IProcessingUnit.initialize(java.util.List, com.github.toolarium.processing.unit.IProcessingUnitContext)

processUnit

public abstract IProcessingUnitStatus processUnit(IProcessingUnitProgress processingProgress,
                                                  IProcessingUnitContext processingUnitContext)
                                           throws ProcessingException

Description copied from interface: IProcessingUnit

Process unit: This method will be called until the IProcessingUnitStatus.hasNext() returns false. Important: this method have to process the sequential or in a small block size.

Specified by:

processUnit in interface IProcessingUnit

Parameters:

processingProgress - the processing progress

processingUnitContext - the processing unit context.

Returns:

the process status

Throws:

ProcessingException - In case of any failures occurs.

See Also:

IProcessingUnit.processUnit(com.github.toolarium.processing.unit.IProcessingUnitProgress, com.github.toolarium.processing.unit.IProcessingUnitContext)

onSuccess

public void onSuccess()

Description copied from interface: IProcessingUnit

This method will be called after a success end.

Specified by:

onSuccess in interface IProcessingUnit

See Also:

IProcessingUnit.onSuccess()

onStop

public void onStop()

Description copied from interface: IProcessingUnit

This method will be called in case on a stop before.

Specified by:

onStop in interface IProcessingUnit

See Also:

IProcessingUnit.onStop()

releaseResource

public void releaseResource()
                     throws ProcessingException

Description copied from interface: IProcessingUnit

Release resources will be called to release all internal referenced resources after a processing success, error or by a suspendProcessing (see method below). It will be called after onSuccess or onStop.

Specified by:

releaseResource in interface IProcessingUnit

Throws:

ProcessingException - Throws this exception in case of releasing failure.

See Also:

IProcessingUnit.releaseResource()

suspendProcessing

public IProcessingUnitPersistence suspendProcessing()
                                             throws ProcessingException

Description copied from interface: IProcessingUnit

Suspends the processing: The processing is able to persist its state with the help of the IProcessingUnitPersistence object. On a resume this instance of the IProcessingUnitPersistence will be returned (see method below).

Specified by:

suspendProcessing in interface IProcessingUnit

Returns:

the processing persistence which contains all information to resume processing later (see resumeProcessing).

Throws:

ProcessingException - Throws this exception in case of while suspend the processing any failures occurs.

See Also:

IProcessingUnit.suspendProcessing()

resumeProcessing

public void resumeProcessing(IProcessingUnitPersistence processingPersistence,
                             IProcessingUnitContext processingUnitContext)
                      throws ProcessingException

Description copied from interface: IProcessingUnit

After suspending a processing unit can be resumed. The parameter list of the initialization is passed as well the IProcessingUnitPersistence which was returned by the suspendProcessing method.

Specified by:

resumeProcessing in interface IProcessingUnit

Parameters:

processingPersistence - the processing persistence to resume after suspending.

processingUnitContext - the processing unit context

Throws:

ProcessingException - Throws this exception in case of while resume the processing any failures occurs.

See Also:

IProcessingUnit.resumeProcessing(com.github.toolarium.processing.unit.IProcessingUnitPersistence, com.github.toolarium.processing.unit.IProcessingUnitContext)

estimateNumberOfUnitsToProcess

public abstract long estimateNumberOfUnitsToProcess(IProcessingUnitContext processingUnitContext)
                                             throws ProcessingException

Estimate the number of units to process. It will be called once in the process of initialization.

Specified by:

estimateNumberOfUnitsToProcess in interface IProcessingUnit

Parameters:

processingUnitContext - the processing context.

Returns:

returns the number of units to process

Throws:

ProcessingException - Throws this exception in case of initialization failures.

getParameterRuntime

protected IParameterRuntime getParameterRuntime()

Get the parameter runtime information.

Returns:

the parameter runtime information.