Package com.github.toolarium.processing.unit.runtime.test

Class TestProcessingUnit

java.lang.Object

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

com.github.toolarium.processing.unit.base.AbstractProcessingUnitPersistenceImpl<com.github.toolarium.processing.unit.runtime.test.TestProcessingUnit.TestPersistence>

com.github.toolarium.processing.unit.runtime.test.TestProcessingUnit

All Implemented Interfaces:

IProcessingUnit

public class TestProcessingUnit
extends AbstractProcessingUnitPersistenceImpl<com.github.toolarium.processing.unit.runtime.test.TestProcessingUnit.TestPersistence>

Test processing unit.

Field Summary

Fields

Modifier and Type	Field	Description
static ParameterDefinition	END_AS_ERROR_PARAMTER
static ParameterDefinition	END_AS_WARNING_PARAMTER
static ParameterDefinition	NUMBER_OF_UNITS_TO_PROCESS_PARAMETER
static ParameterDefinition	PERCENTAGE_NUMBER_OF_UNITS_TO_FAIL_PARAMTER
static ParameterDefinition	SLEEP_TIME_BY_A_PROCESSING_PARAMTER
static ParameterDefinition	STATISIIC_KEYS_PARAMTER
static ParameterDefinition	STATISIIC_MAX_NUMBER_PARAMTER
static ParameterDefinition	THROW_PROCESSING_EXCEPTION_AND_ABORT_PARAMTER
static ParameterDefinition	THROW_PROCESSING_EXCEPTION_PARAMTER
static ParameterDefinition	THROW_RUNTIME_EXCEPTION_IN_VALIDATION_PARAMTER
static ParameterDefinition	THROW_RUNTIME_EXCEPTION_PARAMTER
static ParameterDefinition	THROW_VALIDATION_EXCEPTION_IN_VALIDATION_PARAMTER

Constructor Summary

Constructors

Constructor	Description
TestProcessingUnit()

Method Summary

Modifier and Type	Method	Description
long	estimateNumberOfUnitsToProcess()	Estimate the number of units to process.
void	initialize(java.util.List<Parameter> parameterList, IProcessingUnitContext processingUnitContext)	Initializes the processing unit.
void	initializeParameterDefinition()	Initialize the parameter definition: This method is used to register the parameter definition of this processing unit.
protected com.github.toolarium.processing.unit.runtime.test.TestProcessingUnit.TestPersistence	newPersistenceInstance()	Get a new persistence instance
IProcessingUnitStatus	processUnit(ProcessingUnitStatusBuilder processingUnitStatusBuilder)	Process unit: This method will be called until the IProcessingUnitStatus.hasNext() returns false.

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

getProcessingPersistence, removePersistenceInstance, resumeProcessing, suspendProcessing

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

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

Methods inherited from class java.lang.Object

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

Field Detail

NUMBER_OF_UNITS_TO_PROCESS_PARAMETER

public static final ParameterDefinition NUMBER_OF_UNITS_TO_PROCESS_PARAMETER

PERCENTAGE_NUMBER_OF_UNITS_TO_FAIL_PARAMTER

public static final ParameterDefinition PERCENTAGE_NUMBER_OF_UNITS_TO_FAIL_PARAMTER

SLEEP_TIME_BY_A_PROCESSING_PARAMTER

public static final ParameterDefinition SLEEP_TIME_BY_A_PROCESSING_PARAMTER

END_AS_WARNING_PARAMTER

public static final ParameterDefinition END_AS_WARNING_PARAMTER

END_AS_ERROR_PARAMTER

public static final ParameterDefinition END_AS_ERROR_PARAMTER

THROW_RUNTIME_EXCEPTION_PARAMTER

public static final ParameterDefinition THROW_RUNTIME_EXCEPTION_PARAMTER

THROW_PROCESSING_EXCEPTION_PARAMTER

public static final ParameterDefinition THROW_PROCESSING_EXCEPTION_PARAMTER

THROW_PROCESSING_EXCEPTION_AND_ABORT_PARAMTER

public static final ParameterDefinition THROW_PROCESSING_EXCEPTION_AND_ABORT_PARAMTER

THROW_RUNTIME_EXCEPTION_IN_VALIDATION_PARAMTER

public static final ParameterDefinition THROW_RUNTIME_EXCEPTION_IN_VALIDATION_PARAMTER

THROW_VALIDATION_EXCEPTION_IN_VALIDATION_PARAMTER

public static final ParameterDefinition THROW_VALIDATION_EXCEPTION_IN_VALIDATION_PARAMTER

STATISIIC_KEYS_PARAMTER

public static final ParameterDefinition STATISIIC_KEYS_PARAMTER

STATISIIC_MAX_NUMBER_PARAMTER

public static final ParameterDefinition STATISIIC_MAX_NUMBER_PARAMTER

Constructor Detail

TestProcessingUnit

public TestProcessingUnit()

Method Detail

newPersistenceInstance

protected com.github.toolarium.processing.unit.runtime.test.TestProcessingUnit.TestPersistence newPersistenceInstance()

Description copied from class: AbstractProcessingUnitPersistenceImpl

Get a new persistence instance

Specified by:

newPersistenceInstance in class AbstractProcessingUnitPersistenceImpl<com.github.toolarium.processing.unit.runtime.test.TestProcessingUnit.TestPersistence>

Returns:

the persistence instance

See Also:

AbstractProcessingUnitPersistenceImpl.newPersistenceInstance()

initializeParameterDefinition

public void initializeParameterDefinition()

Description copied from class: AbstractProcessingUnitImpl

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

Overrides:

initializeParameterDefinition in class AbstractProcessingUnitImpl

See Also:

AbstractProcessingUnitImpl.initializeParameterDefinition()

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

Overrides:

initialize in class AbstractProcessingUnitImpl

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()

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

Overrides:

estimateNumberOfUnitsToProcess in class AbstractProcessingUnitImpl

Returns:

returns the number of units to process

See Also:

AbstractProcessingUnitImpl.estimateNumberOfUnitsToProcess()

processUnit

public IProcessingUnitStatus processUnit(ProcessingUnitStatusBuilder processingUnitStatusBuilder)
                                  throws ProcessingException

Description copied from class: AbstractProcessingUnitImpl

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

Parameters:

processingUnitStatusBuilder - the processing unit status builder

Returns:

the process unit status

Throws:

ProcessingException - In case of any failures occurs.

See Also:

AbstractProcessingUnitImpl.processUnit()