org.perfcake.reporting

Class ReportManager

java.lang.Object

org.perfcake.reporting.ReportManager

public class ReportManager
extends Object

Controls the reporting facilities.

Author:

Martin Večeřa

Constructor Summary

Constructors

Constructor and Description
ReportManager()

Method Summary

Modifier and Type	Method and Description
Set<Reporter>	getReporters() Gets an immutable list of current reporters.
RunInfo	getRunInfo() Gets RunInfo associated with this reporter.
MeasurementUnit	newMeasurementUnit() Creates a new measurement unit with a unique iteration number.
void	registerReporter(Reporter reporter) Registers a new Reporter.
void	report(MeasurementUnit measurementUnit) Reports a newly measured MeasurementUnit.
void	reset() Resets reporting to the zero state.
void	setRunInfo(RunInfo runInfo) Sets RunInfo for the current measurement run.
void	start() Starts the reporting facility.
void	stop() Stops the reporting facility.
void	unregisterReporter(Reporter reporter) Removes a registered Reporter.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportManager

public ReportManager()

Method Detail

newMeasurementUnit

public MeasurementUnit newMeasurementUnit()

Creates a new measurement unit with a unique iteration number.

Returns:

A measurement unit unit with a unique iteration number, or null if a measurement is not running or is already finished.

setRunInfo

public void setRunInfo(RunInfo runInfo)

Sets RunInfo for the current measurement run.

Parameters:

runInfo - The RunInfo that contains information about the current measurement.

getRunInfo

public RunInfo getRunInfo()

Gets RunInfo associated with this reporter.

Returns:

The RunInfo associated with this reporter.

report

public void report(MeasurementUnit measurementUnit)
            throws ReportingException

Reports a newly measured MeasurementUnit. Each Measurement Unit must be reported exactly once.

Parameters:

measurementUnit - A MeasurementUnit to be reported.

Throws:

ReportingException - If reporting could not be done properly.

reset

public void reset()

Resets reporting to the zero state. It is used after the warm-up period.

registerReporter

public void registerReporter(Reporter reporter)

Registers a new Reporter.

Parameters:

reporter - A reporter to be registered.

unregisterReporter

public void unregisterReporter(Reporter reporter)

Removes a registered Reporter.

Parameters:

reporter - A reporter to unregistered.

getReporters

public Set<Reporter> getReporters()

Gets an immutable list of current reporters.

Returns:

An immutable list of currently registered reporters.

start

public void start()

Starts the reporting facility.

stop

public void stop()

Stops the reporting facility. It must not be called sooner than all SenderTasks have been completed.