Package com.github.toolarium.processing.unit.util

Class ProcessingUnitProgressFormatter

java.lang.Object

com.github.toolarium.processing.unit.util.ProcessingUnitProgressFormatter

public class ProcessingUnitProgressFormatter
extends java.lang.Object

Defines a processing unit progress formatter.

Constructor Summary

Constructors

Constructor	Description
ProcessingUnitProgressFormatter(java.lang.String id, java.lang.String name, java.lang.Class<? extends IProcessingUnit> processingUnitClass)	Constructor for ProcessUnitProgressFormatter

Method Summary

Modifier and Type	Method	Description
java.lang.String	formatProgress(IProcessingProgress processingProgress, ProcessingActionStatus processingActionStatus, ProcessingRuntimeStatus processingRuntimeStatus, java.util.List<java.lang.String> messages, IProcessingUnitRuntimeTimeMeasurement timeMeasurement, com.github.toolarium.common.bandwidth.IBandwidthThrottling processingUnitThrottling)	Format process unit progress
java.lang.StringBuilder	prepareBandwidthThrottling(java.lang.String header, com.github.toolarium.common.bandwidth.IBandwidthThrottling bandwidthThrottling)	Prepare process unit bandwidth throttling
java.lang.StringBuilder	prepareMessages(java.lang.String header, java.util.List<java.lang.String> messages)	Prepare process unit messages
java.lang.StringBuilder	prepareProgressNumbers(java.lang.String header, IProcessingProgress processingProgress, boolean includeUnprocessed)	Prepare process unit runtime time measurement
java.lang.StringBuilder	prepareStatistic(java.lang.String header, IProcessingStatistic processingStatistic)	Prepare process unit statistic
java.lang.StringBuilder	prepareTimeMeasurement(java.lang.String header, IProcessingUnitRuntimeTimeMeasurement timeMeasurement)	Prepare process unit runtime time measurement
void	setStartTag(java.lang.String startTag)	Format process unit progress

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessingUnitProgressFormatter

public ProcessingUnitProgressFormatter(java.lang.String id,
                                       java.lang.String name,
                                       java.lang.Class<? extends IProcessingUnit> processingUnitClass)

Constructor for ProcessUnitProgressFormatter

Parameters:

id - the id

name - the name

processingUnitClass - the processing unit class

Method Detail

setStartTag

public void setStartTag(java.lang.String startTag)

Format process unit progress

Parameters:

startTag - the start tag

formatProgress

public java.lang.String formatProgress(IProcessingProgress processingProgress,
                                       ProcessingActionStatus processingActionStatus,
                                       ProcessingRuntimeStatus processingRuntimeStatus,
                                       java.util.List<java.lang.String> messages,
                                       IProcessingUnitRuntimeTimeMeasurement timeMeasurement,
                                       com.github.toolarium.common.bandwidth.IBandwidthThrottling processingUnitThrottling)

Format process unit progress

Parameters:

processingProgress - the progress

processingActionStatus - the action status

processingRuntimeStatus - the runtime status

messages - the messages

timeMeasurement - the time measurement

processingUnitThrottling - the processing unit throttling

Returns:

the formatted message

prepareProgressNumbers

public java.lang.StringBuilder prepareProgressNumbers(java.lang.String header,
                                                      IProcessingProgress processingProgress,
                                                      boolean includeUnprocessed)

Prepare process unit runtime time measurement

Parameters:

header - the message header

processingProgress - the processing progress

includeUnprocessed - true to include unprocessed units

Returns:

the prepared string

prepareTimeMeasurement

public java.lang.StringBuilder prepareTimeMeasurement(java.lang.String header,
                                                      IProcessingUnitRuntimeTimeMeasurement timeMeasurement)

Prepare process unit runtime time measurement

Parameters:

header - the message header

timeMeasurement - the runtime time measurement

Returns:

the prepared string

prepareMessages

public java.lang.StringBuilder prepareMessages(java.lang.String header,
                                               java.util.List<java.lang.String> messages)

Prepare process unit messages

Parameters:

header - the message header

messages - the processing unit messages

Returns:

the prepared string

prepareStatistic

public java.lang.StringBuilder prepareStatistic(java.lang.String header,
                                                IProcessingStatistic processingStatistic)

Prepare process unit statistic

Parameters:

header - the message header

processingStatistic - the processing unit statistic

Returns:

the prepared string

prepareBandwidthThrottling

public java.lang.StringBuilder prepareBandwidthThrottling(java.lang.String header,
                                                          com.github.toolarium.common.bandwidth.IBandwidthThrottling bandwidthThrottling)

Prepare process unit bandwidth throttling

Parameters:

header - the message header

bandwidthThrottling - the bandwidth throttling

Returns:

the prepared string