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

Class ProcessingUnitStatus

java.lang.Object

com.github.toolarium.processing.unit.runtime.ProcessingUnitStatus

All Implemented Interfaces:

IProcessingUnitStatus, java.io.Serializable

public class ProcessingUnitStatus
extends java.lang.Object
implements IProcessingUnitStatus, java.io.Serializable

Implements the IProcessingUnitStatus.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ProcessingUnitStatus()	Constructor

Method Summary

Modifier and Type	Method	Description
void	addStatistic(java.lang.String key, java.lang.Double value)	Add statistic
void	addStatistic(java.lang.String key, java.lang.Long value)	Add statistic
boolean	equals(java.lang.Object obj)
java.lang.Long	getNumberOfFailedUnits()	Gets the number of failed units processed in this run.
java.lang.Long	getNumberOfSuccessfulUnits()	Gets the number of successful units.
java.lang.Long	getNumberOfUnprocessedUnits()	Optional the number of unprocessed units can be returned.
ProcessingRuntimeStatus	getProcessingRuntimeStatus()	The processing runtime status for this run.
IProcessingUnitStatistic	getProcessingUnitStatistic()	Get the processing unit statistic just a the last call.
com.github.toolarium.common.statistic.StatisticCounter	getStatisticCounter(java.lang.String key)	Get statistic counter
java.lang.String	getStatusMessage()	A return message can be passed.
int	hashCode()
ProcessingUnitStatus	hasMoreUnitsToProcess()	Mark there are more units to process
boolean	hasNext()	Defines if there is more to process or not.
ProcessingUnitStatus	increaseNumberOfFailedUnits()	Increase the number of failed units
ProcessingUnitStatus	increaseNumberOfSuccessfulUnits()	Increase the number of successful units
ProcessingUnitStatus	setHasNext(boolean hasNext)	Set has next
ProcessingUnitStatus	setNumberOfFailedUnits(java.lang.Long numberOfFailedUnits)	Set the number of failed units
ProcessingUnitStatus	setNumberOfSuccessfulUnits(java.lang.Long numberOfSuccessfulUnits)	Set the number of successful units
ProcessingUnitStatus	setNumberOfUnprocessedUnits(java.lang.Long numberOfUnprocessedUnits)	Set the number of unprocessed units
ProcessingUnitStatus	setProcessingRuntimeStatus(ProcessingRuntimeStatus processingRuntimeStatus)	Set the processing runtime statis
ProcessingUnitStatus	setStatusMessage(java.lang.String statusMessage)	Sets the status message
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessingUnitStatus

public ProcessingUnitStatus()

Constructor

Method Detail

hasNext

public boolean hasNext()

Description copied from interface: IProcessingUnitStatus

Defines if there is more to process or not.

Specified by:

hasNext in interface IProcessingUnitStatus

Returns:

true if it has more element; otherwise it has ended.

See Also:

IProcessingUnitStatus.hasNext()

hasMoreUnitsToProcess

public ProcessingUnitStatus hasMoreUnitsToProcess()

Mark there are more units to process

Returns:

this instance

setHasNext

public ProcessingUnitStatus setHasNext(boolean hasNext)

Set has next

Parameters:

hasNext - true if it has more to process.

Returns:

this instance

getNumberOfSuccessfulUnits

public java.lang.Long getNumberOfSuccessfulUnits()

Description copied from interface: IProcessingUnitStatus

Gets the number of successful units.

Specified by:

getNumberOfSuccessfulUnits in interface IProcessingUnitStatus

Returns:

the number of successful units or null.

See Also:

IProcessingUnitStatus.getNumberOfSuccessfulUnits()

setNumberOfSuccessfulUnits

public ProcessingUnitStatus setNumberOfSuccessfulUnits(java.lang.Long numberOfSuccessfulUnits)

Set the number of successful units

Parameters:

numberOfSuccessfulUnits - the number of successful units

Returns:

this instance

increaseNumberOfSuccessfulUnits

public ProcessingUnitStatus increaseNumberOfSuccessfulUnits()

Increase the number of successful units

Returns:

this instance

getNumberOfFailedUnits

public java.lang.Long getNumberOfFailedUnits()

Description copied from interface: IProcessingUnitStatus

Gets the number of failed units processed in this run.

Specified by:

getNumberOfFailedUnits in interface IProcessingUnitStatus

Returns:

the number of failed units or null.

See Also:

IProcessingUnitStatus.getNumberOfFailedUnits()

setNumberOfFailedUnits

public ProcessingUnitStatus setNumberOfFailedUnits(java.lang.Long numberOfFailedUnits)

Set the number of failed units

Parameters:

numberOfFailedUnits - the number of failed units

Returns:

this instance

increaseNumberOfFailedUnits

public ProcessingUnitStatus increaseNumberOfFailedUnits()

Increase the number of failed units

Returns:

this instance

getNumberOfUnprocessedUnits

public java.lang.Long getNumberOfUnprocessedUnits()

Description copied from interface: IProcessingUnitStatus

Optional the number of unprocessed units can be returned.

Specified by:

getNumberOfUnprocessedUnits in interface IProcessingUnitStatus

Returns:

the number of unprocessed units.

See Also:

IProcessingUnitStatus.getNumberOfFailedUnits()

setNumberOfUnprocessedUnits

public ProcessingUnitStatus setNumberOfUnprocessedUnits(java.lang.Long numberOfUnprocessedUnits)

Set the number of unprocessed units

Parameters:

numberOfUnprocessedUnits - the number of unprocessed units

Returns:

this instance

getProcessingRuntimeStatus

public ProcessingRuntimeStatus getProcessingRuntimeStatus()

Description copied from interface: IProcessingUnitStatus

The processing runtime status for this run. If it's null then it will be interpreted as successful.

Specified by:

getProcessingRuntimeStatus in interface IProcessingUnitStatus

Returns:

the processing runtime status or null

See Also:

IProcessingUnitStatus.getProcessingRuntimeStatus()

setProcessingRuntimeStatus

public ProcessingUnitStatus setProcessingRuntimeStatus(ProcessingRuntimeStatus processingRuntimeStatus)

Set the processing runtime statis

Parameters:

processingRuntimeStatus - the processing runtime statis

Returns:

this instance

getStatusMessage

public java.lang.String getStatusMessage()

Description copied from interface: IProcessingUnitStatus

A return message can be passed. In case it's null then no status message is available.

Specified by:

getStatusMessage in interface IProcessingUnitStatus

Returns:

a status message or null

See Also:

IProcessingUnitStatus.getStatusMessage()

setStatusMessage

public ProcessingUnitStatus setStatusMessage(java.lang.String statusMessage)

Sets the status message

Parameters:

statusMessage - the status message

Returns:

this instance

getProcessingUnitStatistic

public IProcessingUnitStatistic getProcessingUnitStatistic()

Description copied from interface: IProcessingUnitStatus

Get the processing unit statistic just a the last call.

Specified by:

getProcessingUnitStatistic in interface IProcessingUnitStatus

Returns:

the processing unit statistic of last call or null.

See Also:

IProcessingUnitStatus.getProcessingUnitStatistic()

addStatistic

public void addStatistic(java.lang.String key,
                         java.lang.Long value)

Add statistic

Parameters:

key - the key / name of the statistic

value - the value to add

addStatistic

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

Add statistic

Parameters:

key - the key / name of the statistic

value - the value to add

getStatisticCounter

public com.github.toolarium.common.statistic.StatisticCounter getStatisticCounter(java.lang.String key)

Get statistic counter

Parameters:

key - the key / name of the statistic

Returns:

the statistic counter

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