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)
IProcessingStatistic	getProcesingStatistic()	The processing statistic.
long	getProcessedUnits()	Gets the number of processed units.
java.lang.String	getProcessingStatusMessage()	Returns the processing status message
ProcessingStatusType	getProcessingStatusType()	The processing status type which covers the overall status
long	getTotalFailedUnits()	Gets the number of failed units.
long	getTotalUnits()	Gets the number of total processed unit.
int	hashCode()
void	increaseTotalFailedUnits()	Increase the total failed units
void	increaseTotalProcessedUnits()	Increase the total processed units
void	increaseTotalUnits()	Increase the total units
void	init(IProcessingProgress processingProgress)	Initialize a previous state
void	setProcessedUnits(long processedUnits)	Sets the total processed units
void	setProcessingStatusType(ProcessingStatusType processingStatusType)	Sets the processing status type
void	setStatusMessage(java.lang.String processingStatusMessage)	Sets the processing status message
void	setTotalFailedUnits(long totalFailedUnits)	Sets the total failed units
void	setTotalUnits(long totalUnits)	Sets the total units
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

getTotalUnits

public long getTotalUnits()

Description copied from interface: IProcessingProgress

Gets the number of total processed unit.

Specified by:

getTotalUnits in interface IProcessingProgress

Returns:

the total units.

See Also:

IProcessingProgress.getTotalUnits()

setTotalUnits

public void setTotalUnits(long totalUnits)

Sets the total units

Parameters:

totalUnits - the total units

getProcessedUnits

public long getProcessedUnits()

Description copied from interface: IProcessingProgress

Gets the number of processed units.

Specified by:

getProcessedUnits in interface IProcessingProgress

Returns:

the number of processed units.

See Also:

IProcessingProgress.getProcessedUnits()

setProcessedUnits

public void setProcessedUnits(long processedUnits)

Sets the total processed units

Parameters:

processedUnits - the total processed units

getTotalFailedUnits

public long getTotalFailedUnits()

Description copied from interface: IProcessingProgress

Gets the number of failed units.

Specified by:

getTotalFailedUnits in interface IProcessingProgress

Returns:

the number of failed units.

See Also:

IProcessingProgress.getTotalFailedUnits()

setTotalFailedUnits

public void setTotalFailedUnits(long totalFailedUnits)

Sets the total failed units

Parameters:

totalFailedUnits - the total 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()

getProcessingStatusType

public ProcessingStatusType getProcessingStatusType()

Description copied from interface: IProcessingProgress

The processing status type which covers the overall status

Specified by:

getProcessingStatusType in interface IProcessingProgress

Returns:

the processing status type.

See Also:

IProcessingProgress.getProcessingStatusType()

setProcessingStatusType

public void setProcessingStatusType(ProcessingStatusType processingStatusType)

Sets the processing status type

Parameters:

processingStatusType - the processing status type

getProcessingStatusMessage

public java.lang.String getProcessingStatusMessage()

Description copied from interface: IProcessingProgress

Returns the processing status message

Specified by:

getProcessingStatusMessage in interface IProcessingProgress

Returns:

the processing status message

See Also:

IProcessingProgress.getProcessingStatusMessage()

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

increaseTotalProcessedUnits

public void increaseTotalProcessedUnits()

Increase the total processed units

increaseTotalFailedUnits

public void increaseTotalFailedUnits()

Increase the total 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()