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

Class AbstractProcessingUnitPersistenceImpl<T extends IProcessingUnitPersistence>

java.lang.Object

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

com.github.toolarium.processing.unit.base.AbstractProcessingUnitPersistenceImpl<T>

All Implemented Interfaces:

IProcessingUnit

Direct Known Subclasses:

ParallelProcessingUnit, TestProcessingUnit

public abstract class AbstractProcessingUnitPersistenceImpl<T extends IProcessingUnitPersistence>
extends AbstractProcessingUnitImpl

Abstract base implementation of the IProcessingUnit which supports own persistence class

Constructor Summary

Constructors

Constructor	Description
AbstractProcessingUnitPersistenceImpl()

Method Summary

Modifier and Type	Method	Description
protected T	getProcessingPersistence()	Returns the processing persistence instance
protected abstract T	newPersistenceInstance()	Get a new persistence instance
protected void	removePersistenceInstance()	Remove the persistence instance
void	resumeProcessing(IProcessingUnitProgress processingUnitProgress, IProcessingUnitPersistence processingPersistence)	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.

Methods inherited from class com.github.toolarium.processing.unit.base.AbstractProcessingUnitImpl

estimateNumberOfUnitsToProcess, getObjectLockManager, getParameterDefinition, getParameterRuntime, getProcessingUnitContext, getProcessingUnitProgress, initialize, initializeParameterDefinition, onAborting, onEnding, processUnit, processUnit, releaseResource, setObjectLockManager, validateParameterList

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractProcessingUnitPersistenceImpl

public AbstractProcessingUnitPersistenceImpl()

Method Detail

newPersistenceInstance

protected abstract T newPersistenceInstance()

Get a new persistence instance

Returns:

the persistence instance

getProcessingPersistence

protected T getProcessingPersistence()

Returns the processing persistence instance

Returns:

the processing persistence instance

removePersistenceInstance

protected void removePersistenceInstance()

Remove the persistence instance

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

Overrides:

suspendProcessing in class AbstractProcessingUnitImpl

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:

AbstractProcessingUnitImpl.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

Overrides:

resumeProcessing in class AbstractProcessingUnitImpl

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:

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