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
long	estimateNumberOfUnitsToProcess()	Estimate the number of units to process.
com.github.toolarium.common.object.IObjectLockManager	getObjectLockManager()	Gets the object lock manager
java.util.List<ParameterDefinition>	getParameterDefinition()	Gets the parameter definition list of the processing.
protected IParameterRuntime	getParameterRuntime()	Get the parameter runtime information.
protected IProcessingUnitContext	getProcessingUnitContext()	Get the process context
protected IProcessingUnitUpdateProgress	getProcessingUnitProgress()	Get the processing unit progress
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	onAborting()	This method is called in case of an abort (status aborting) before the resources are released.
void	onEnding()	This method is called on ending after a successful end (status ending) before the resources are released.
IProcessingUnitStatus	processUnit()	Process unit: This method will be called until the IProcessingUnitStatus.hasNext() returns false.
abstract IProcessingUnitStatus	processUnit(ProcessingUnitStatusBuilder processingUnitStatusBuilder)	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(IProcessingUnitProgress processingUnitProgress, IProcessingUnitPersistence processingPersistence)	After suspending a processing unit can be resumed.
void	setObjectLockManager(com.github.toolarium.common.object.IObjectLockManager objectLockManager)	Sets the object lock manager
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. It is also used when processing is interrupted and resumed.

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)

estimateNumberOfUnitsToProcess

public long estimateNumberOfUnitsToProcess()
                                    throws ProcessingException

Description copied from interface: IProcessingUnit

Estimate the number of units to process. It will be called once after IProcessingUnit.initialize(List, IProcessingUnitContext). It set the the number of units to process in the object IProcessingUnitProgress. In case there are more elements to process than estimated, the progress will adapted. In case of a IProcessingUnit.resumeProcessing(IProcessingUnitProgress, IProcessingUnitPersistence) it will not be called again.

Specified by:

estimateNumberOfUnitsToProcess in interface IProcessingUnit

Returns:

returns the number of units to process

Throws:

ProcessingException - Throws this exception in case of initialization failures.

See Also:

IProcessingUnit.estimateNumberOfUnitsToProcess()

processUnit

public IProcessingUnitStatus processUnit()
                                  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

Returns:

the process unit status

Throws:

ProcessingException - In case of any failures occurs.

See Also:

IProcessingUnit.processUnit()

processUnit

public abstract IProcessingUnitStatus processUnit(ProcessingUnitStatusBuilder processingUnitStatusBuilder)
                                           throws ProcessingException

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.

Parameters:

processingUnitStatusBuilder - the processing unit status builder

Returns:

the process unit status

Throws:

ProcessingException - In case of any failures occurs.

onEnding

public void onEnding()

Description copied from interface: IProcessingUnit

This method is called on ending after a successful end (status ending) before the resources are released.

Specified by:

onEnding in interface IProcessingUnit

See Also:

IProcessingUnit.onEnding()

onAborting

public void onAborting()

Description copied from interface: IProcessingUnit

This method is called in case of an abort (status aborting) before the resources are released.

Specified by:

onAborting in interface IProcessingUnit

See Also:

IProcessingUnit.onAborting()

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 IProcessingUnit.onEnding() or IProcessingUnit.onAborting().

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). The IProcessingUnitPersistence don't need to contain any parameters or additional statuses. They are covered by the framework.

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(IProcessingUnitProgress processingUnitProgress,
                             IProcessingUnitPersistence processingPersistence)
                      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. The main purpose of this call is to set the processing persistence.

Specified by:

resumeProcessing in interface IProcessingUnit

Parameters:

processingUnitProgress - the processing unit progress of the processing unit before suspending.

processingPersistence - the processing persistence to resume after suspending.

Throws:

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

See Also:

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

getObjectLockManager

public com.github.toolarium.common.object.IObjectLockManager getObjectLockManager()

Gets the object lock manager

Returns:

the object lock manager

setObjectLockManager

public void setObjectLockManager(com.github.toolarium.common.object.IObjectLockManager objectLockManager)

Sets the object lock manager

Parameters:

objectLockManager - the object lock manager

getParameterRuntime

protected IParameterRuntime getParameterRuntime()

Get the parameter runtime information.

Returns:

the parameter runtime information.

getProcessingUnitContext

protected IProcessingUnitContext getProcessingUnitContext()

Get the process context

Returns:

the process context

getProcessingUnitProgress

protected IProcessingUnitUpdateProgress getProcessingUnitProgress()

Get the processing unit progress

Returns:

the processing unit progress