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

Class ProcessingProgress

java.lang.Object

com.github.toolarium.processing.unit.runtime.ProcessingProgress

All Implemented Interfaces:

IProcessingProgress, java.io.Serializable

public class ProcessingProgress
extends java.lang.Object
implements IProcessingProgress, java.io.Serializable

Implements the IProcessingProgress.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ProcessingProgress()	Constructor

Method Summary

Modifier and Type	Method	Description
void	addStatistic(java.lang.String key, java.lang.Double value)	Adds a statistic value
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.
IProcessingStatistic	getProcesingStatistic()	The processing statistic.
ProcessingRuntimeStatus	getProcessingRuntimeStatus()	The processing runtime status which covers the overall status
java.lang.String	getProcessingStatusMessage()	Returns the current processing status message
int	hashCode()
void	increaseNumberOfFailedUnits()	Increase the number of failed units
void	increaseNumberOfProcessedUnits()	Increase the number of processed units
void	increaseTotalUnits()	Increase the total units
void	init(IProcessingProgress processingProgress)	Initialize a previous state
void	resetProcessingStatusMessage()	Reset the processing status message.
void	setNumberOfFailedUnits(long numberOfFailedUnits)	Sets the number of failed units
void	setNumberOfProcessedUnits(long processedUnits)	Sets the number of processed units
void	setNumberOfUnitsToProcess(long numberOfUnitsToProcess)	Sets the number of units to process in total
void	setProcessingRuntimeStatus(ProcessingRuntimeStatus processingRuntimeStatus)	Sets the processing status type
void	setStatusMessage(java.lang.String processingStatusMessage)	Sets the processing status message
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessingProgress

public ProcessingProgress()

Constructor

Method Detail

init

public void init(IProcessingProgress processingProgress)

Initialize a previous state

Parameters:

processingProgress - the processing progress to initialize

getNumberOfUnitsToProcess

public long getNumberOfUnitsToProcess()

Description copied from interface: IProcessingProgress

Get the number of units to process in total.

Specified by:

getNumberOfUnitsToProcess in interface IProcessingProgress

Returns:

the number of units to process in total.

See Also:

IProcessingProgress.getNumberOfUnitsToProcess()

setNumberOfUnitsToProcess

public void setNumberOfUnitsToProcess(long numberOfUnitsToProcess)

Sets the number of units to process in total

Parameters:

numberOfUnitsToProcess - the number of units to process in total

getNumberOfUnprocessedUnits

public long getNumberOfUnprocessedUnits()

Description copied from interface: IProcessingProgress

Get the number of unprocessed units.

Specified by:

getNumberOfUnprocessedUnits in interface IProcessingProgress

Returns:

the number of unprocessed units.

See Also:

IProcessingProgress.getNumberOfUnprocessedUnits()

getNumberOfProcessedUnits

public long getNumberOfProcessedUnits()

Description copied from interface: IProcessingProgress

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

Specified by:

getNumberOfProcessedUnits in interface IProcessingProgress

Returns:

the number of processed units (failed units included).

See Also:

IProcessingProgress.getNumberOfProcessedUnits()

setNumberOfProcessedUnits

public void setNumberOfProcessedUnits(long processedUnits)

Sets the number of processed units

Parameters:

processedUnits - the number of processed units

getNumberOfSuccessfulUnits

public long getNumberOfSuccessfulUnits()

Description copied from interface: IProcessingProgress

Gets the number of successful units.

Specified by:

getNumberOfSuccessfulUnits in interface IProcessingProgress

Returns:

the number of successful units.

See Also:

IProcessingProgress.getNumberOfSuccessfulUnits()

getNumberOfFailedUnits

public long getNumberOfFailedUnits()

Description copied from interface: IProcessingProgress

Gets the number of failed units.

Specified by:

getNumberOfFailedUnits in interface IProcessingProgress

Returns:

the number of failed units.

See Also:

IProcessingProgress.getNumberOfFailedUnits()

setNumberOfFailedUnits

public void setNumberOfFailedUnits(long numberOfFailedUnits)

Sets the number of failed units

Parameters:

numberOfFailedUnits - the number of failed units

getProcesingStatistic

public IProcessingStatistic getProcesingStatistic()

Description copied from interface: IProcessingProgress

The processing statistic.

Specified by:

getProcesingStatistic in interface IProcessingProgress

Returns:

the processing statistic.

See Also:

IProcessingProgress.getProcesingStatistic()

getProcessingRuntimeStatus

public ProcessingRuntimeStatus getProcessingRuntimeStatus()

Description copied from interface: IProcessingProgress

The processing runtime status which covers the overall status

Specified by:

getProcessingRuntimeStatus in interface IProcessingProgress

Returns:

the processing status type.

See Also:

IProcessingProgress.getProcessingRuntimeStatus()

setProcessingRuntimeStatus

public void setProcessingRuntimeStatus(ProcessingRuntimeStatus processingRuntimeStatus)

Sets the processing status type

Parameters:

processingRuntimeStatus - the processing runtime status

getProcessingStatusMessage

public java.lang.String getProcessingStatusMessage()

Description copied from interface: IProcessingProgress

Returns the current processing status message

Specified by:

getProcessingStatusMessage in interface IProcessingProgress

Returns:

the current processing status message

See Also:

IProcessingProgress.getProcessingStatusMessage()

resetProcessingStatusMessage

public void resetProcessingStatusMessage()

Description copied from interface: IProcessingProgress

Reset the processing status message. This will be called before the processUnit call

Specified by:

resetProcessingStatusMessage in interface IProcessingProgress

See Also:

IProcessingProgress.resetProcessingStatusMessage()

setStatusMessage

public void setStatusMessage(java.lang.String processingStatusMessage)

Sets the processing status message

Parameters:

processingStatusMessage - the processing status message

increaseTotalUnits

public void increaseTotalUnits()

Increase the total units

increaseNumberOfProcessedUnits

public void increaseNumberOfProcessedUnits()

Increase the number of processed units

increaseNumberOfFailedUnits

public void increaseNumberOfFailedUnits()

Increase the number of failed units

addStatistic

public void addStatistic(java.lang.String key,
                         java.lang.Double value)
                  throws java.lang.IllegalArgumentException

Adds a statistic value

Parameters:

key - the key

value - the value

Throws:

java.lang.IllegalArgumentException - In case of invalid key

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