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

Class ProcessingUnitProgress

java.lang.Object

com.github.toolarium.processing.unit.runtime.ProcessingUnitProgress

All Implemented Interfaces:

IProcessingUnitProgress, IProcessingUnitUpdateProgress, java.io.Serializable

public class ProcessingUnitProgress
extends java.lang.Object
implements IProcessingUnitUpdateProgress, java.io.Serializable

Implements the IProcessingUnitProgress.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ProcessingUnitProgress()	Constructor
ProcessingUnitProgress(IProcessingUnitProgress processingProgress)	Constructor

Method Summary

Modifier and Type	Method	Description
void	addProcessingUnitStatistic(IProcessingUnitStatistic processingUnitStatistic)	Add a processing unit statistic
long	addProcessingUnitStatus(IProcessingUnitStatus processingUnitStatus)	Add the processing unit status
ProcessingUnitProgress	decreaseNumberOfUnitsToProcess(long numberOfUnitsToProcess)	Increase the number of units to process in total
boolean	equals(java.lang.Object obj)
long	getNumberOfFailedUnits()	Gets the number of failed units.
long	getNumberOfProcessedUnits()	Gets the number of processed units (failed units included).
long	getNumberOfSuccessfulUnits()	Gets the number of successful units.
long	getNumberOfUnitsToProcess()	Get the number of units to process in total.
long	getNumberOfUnprocessedUnits()	Get the number of unprocessed units.
ProcessingRuntimeStatus	getProcessingRuntimeStatus()	The overall processing runtime status.
IProcessingUnitStatistic	getProcessingUnitStatistic()	Get the processing unit statistic
int	getProgress()	Get the progress in percentage
int	hashCode()
ProcessingUnitProgress	increaseNumberOfFailedUnits()	Increase the number of failed units
ProcessingUnitProgress	increaseNumberOfFailedUnits(long numberOfFailedUnits)	Increase the number of failed units
ProcessingUnitProgress	increaseNumberOfProcessedUnits()	Increase the number of processed units
ProcessingUnitProgress	increaseNumberOfProcessedUnits(long processedUnits)	Increase the number of processed units
ProcessingUnitProgress	increaseNumberOfUnitsToProcess(long numberOfUnitsToProcess)	Increase the number of units to process in total
ProcessingUnitProgress	increaseTotalUnits()	Increase the total units
ProcessingUnitProgress	setNumberOfFailedUnits(long numberOfFailedUnits)	Sets the number of failed units
ProcessingUnitProgress	setNumberOfProcessedUnits(long processedUnits)	Sets the number of processed units
long	setNumberOfUnitsToProcess(long numberOfUnitsToProcess)	Sets the number of units to process in total
ProcessingUnitProgress	setProcessingRuntimeStatus(ProcessingRuntimeStatus processingRuntimeStatus)	Sets the processing status type
java.lang.String	toString()
ProcessingUnitProgress	updateProcessingRuntimeStatus(ProcessingRuntimeStatus processingRuntimeStatus)	Update processing runtime status

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ProcessingUnitProgress

public ProcessingUnitProgress()

Constructor

ProcessingUnitProgress

public ProcessingUnitProgress(IProcessingUnitProgress processingProgress)

Constructor

Parameters:

processingProgress - the processing progress to initialize

Method Detail

addProcessingUnitStatus

public long addProcessingUnitStatus(IProcessingUnitStatus processingUnitStatus)

Add the processing unit status

Parameters:

processingUnitStatus - the processing unit status to add

Returns:

the number of processed units

getNumberOfUnitsToProcess

public long getNumberOfUnitsToProcess()

Description copied from interface: IProcessingUnitProgress

Get the number of units to process in total.

Specified by:

getNumberOfUnitsToProcess in interface IProcessingUnitProgress

Returns:

the number of units to process in total.

See Also:

IProcessingUnitProgress.getNumberOfUnitsToProcess()

increaseNumberOfUnitsToProcess

public ProcessingUnitProgress increaseNumberOfUnitsToProcess(long numberOfUnitsToProcess)

Increase the number of units to process in total

Parameters:

numberOfUnitsToProcess - the number of units to process in total

Returns:

this instance

decreaseNumberOfUnitsToProcess

public ProcessingUnitProgress decreaseNumberOfUnitsToProcess(long numberOfUnitsToProcess)

Increase the number of units to process in total

Parameters:

numberOfUnitsToProcess - the number of units to process in total

Returns:

this instance

setNumberOfUnitsToProcess

public long setNumberOfUnitsToProcess(long numberOfUnitsToProcess)

Description copied from interface: IProcessingUnitUpdateProgress

Sets the number of units to process in total

Specified by:

setNumberOfUnitsToProcess in interface IProcessingUnitUpdateProgress

Parameters:

numberOfUnitsToProcess - the number of units to process in total

Returns:

the number of set units to process

See Also:

IProcessingUnitUpdateProgress.setNumberOfUnitsToProcess(long)

getNumberOfUnprocessedUnits

public long getNumberOfUnprocessedUnits()

Description copied from interface: IProcessingUnitProgress

Get the number of unprocessed units. It's calculated by the number of units to process minus the number of processed units.

Specified by:

getNumberOfUnprocessedUnits in interface IProcessingUnitProgress

Returns:

the number of unprocessed units.

See Also:

IProcessingUnitProgress.getNumberOfUnprocessedUnits()

getNumberOfProcessedUnits

public long getNumberOfProcessedUnits()

Description copied from interface: IProcessingUnitProgress

Gets the number of processed units (failed units included).

Specified by:

getNumberOfProcessedUnits in interface IProcessingUnitProgress

Returns:

the number of processed units (failed units included).

See Also:

IProcessingUnitProgress.getNumberOfProcessedUnits()

increaseNumberOfProcessedUnits

public ProcessingUnitProgress increaseNumberOfProcessedUnits()

Increase the number of processed units

Returns:

this instance

increaseNumberOfProcessedUnits

public ProcessingUnitProgress increaseNumberOfProcessedUnits(long processedUnits)

Increase the number of processed units

Parameters:

processedUnits - the number of processed units

Returns:

this instance

setNumberOfProcessedUnits

public ProcessingUnitProgress setNumberOfProcessedUnits(long processedUnits)

Sets the number of processed units

Parameters:

processedUnits - the number of processed units

Returns:

this instance

getNumberOfSuccessfulUnits

public long getNumberOfSuccessfulUnits()

Description copied from interface: IProcessingUnitProgress

Gets the number of successful units. It's calculated by the number of units to process minus the failed units.

Specified by:

getNumberOfSuccessfulUnits in interface IProcessingUnitProgress

Returns:

the number of successful units.

See Also:

IProcessingUnitProgress.getNumberOfSuccessfulUnits()

getNumberOfFailedUnits

public long getNumberOfFailedUnits()

Description copied from interface: IProcessingUnitProgress

Gets the number of failed units.

Specified by:

getNumberOfFailedUnits in interface IProcessingUnitProgress

Returns:

the number of failed units.

See Also:

IProcessingUnitProgress.getNumberOfFailedUnits()

increaseNumberOfFailedUnits

public ProcessingUnitProgress increaseNumberOfFailedUnits()

Increase the number of failed units

Returns:

this instance

increaseNumberOfFailedUnits

public ProcessingUnitProgress increaseNumberOfFailedUnits(long numberOfFailedUnits)

Increase the number of failed units

Parameters:

numberOfFailedUnits - the number of failed units

Returns:

this instance

setNumberOfFailedUnits

public ProcessingUnitProgress setNumberOfFailedUnits(long numberOfFailedUnits)

Sets the number of failed units

Parameters:

numberOfFailedUnits - the number of failed units

Returns:

this instance

getProcessingRuntimeStatus

public ProcessingRuntimeStatus getProcessingRuntimeStatus()

Description copied from interface: IProcessingUnitProgress

The overall processing runtime status.

Specified by:

getProcessingRuntimeStatus in interface IProcessingUnitProgress

Returns:

the processing status type.

See Also:

IProcessingUnitProgress.getProcessingRuntimeStatus()

setProcessingRuntimeStatus

public ProcessingUnitProgress setProcessingRuntimeStatus(ProcessingRuntimeStatus processingRuntimeStatus)

Sets the processing status type

Parameters:

processingRuntimeStatus - the processing runtime status

Returns:

this instance

updateProcessingRuntimeStatus

public ProcessingUnitProgress updateProcessingRuntimeStatus(ProcessingRuntimeStatus processingRuntimeStatus)

Update processing runtime status

Parameters:

processingRuntimeStatus - the processing runtime status

Returns:

the instance

increaseTotalUnits

public ProcessingUnitProgress increaseTotalUnits()

Increase the total units

Returns:

this instance

getProcessingUnitStatistic

public IProcessingUnitStatistic getProcessingUnitStatistic()

Description copied from interface: IProcessingUnitProgress

Get the processing unit statistic

Specified by:

getProcessingUnitStatistic in interface IProcessingUnitProgress

Returns:

the processing unit statistic

See Also:

IProcessingUnitProgress.getProcessingUnitStatistic()

addProcessingUnitStatistic

public void addProcessingUnitStatistic(IProcessingUnitStatistic processingUnitStatistic)

Add a processing unit statistic

Parameters:

processingUnitStatistic - the processing unit statistic to add

getProgress

public int getProgress()

Description copied from interface: IProcessingUnitProgress

Get the progress in percentage

Specified by:

getProgress in interface IProcessingUnitProgress

Returns:

the progress

See Also:

IProcessingUnitProgress.getProgress()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()