org.perfcake.reporting.reporter

Class AbstractReporter

java.lang.Object

org.perfcake.reporting.reporter.AbstractReporter

All Implemented Interfaces:

Reporter

Direct Known Subclasses:

ClassifyingReporter, GeolocationReporter, IterationsPerSecondReporter, MemoryUsageReporter, RawReporter, ResponseTimeHistogramReporter, StatsReporter, WarmUpReporter

public abstract class AbstractReporter
extends Object
implements Reporter

Represents a basic reporter that makes sure that the contract defined as part of Reporter is held. The class is also well tested.

Author:

Martin Večeřa

Constructor Summary

Constructors

Constructor and Description
AbstractReporter()

Method Summary

Modifier and Type	Method and Description
Set<Destination>	getDestinations() Gets an unmodifiable set of all registered destinations.
Set<BoundPeriod<Destination>>	getReportingPeriods() Gets an unmodifiable set of registered reporting periods.
Measurement	newMeasurement() Gets a new measurement pre-filled with values from current run info.
void	registerDestination(Destination destination, Period period) Registers a destination to receive resulting Measurements in a given period.
void	registerDestination(Destination destination, Set<Period> periods) Registers a destination to receive resulting Measurements in given periods.
void	report(MeasurementUnit measurementUnit) Reports a single MeasurementUnit to this reporter.
void	reset() Resets the reporter statistics to the initial state.
void	setReportManager(ReportManager reportManager) Sets Report Manager for the report to be able to control and monitor the current status of reporting.
void	setRunInfo(RunInfo runInfo) Sets Run Info for the current measurement run.
void	start() Starts the reporter.
void	stop() Stops the reporter.
void	unregisterDestination(Destination destination) Removes a previously registered Destination.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.perfcake.reporting.reporter.Reporter

publishResult

Constructor Detail

AbstractReporter

public AbstractReporter()

Method Detail

report

public final void report(MeasurementUnit measurementUnit)
                  throws ReportingException

Reports a single MeasurementUnit to this reporter. This calls doReport(MeasurementUnit) overridden by a child, accumulates results and reports iteration change and percentage change (if any).

Specified by:

report in interface Reporter

Parameters:

measurementUnit - Measurement Unit from a run iteration

Throws:

ReportingException - When it was not possible to report the MeasurementUnit.

newMeasurement

public Measurement newMeasurement()

Gets a new measurement pre-filled with values from current run info.

Returns:

The new measurement with current values from run info.

setReportManager

public void setReportManager(ReportManager reportManager)

Description copied from interface: Reporter

Sets Report Manager for the report to be able to control and monitor the current status of reporting.

Specified by:

setReportManager in interface Reporter

Parameters:

reportManager - ReportManager that owns this Reporter.

registerDestination

public final void registerDestination(Destination destination,
                                      Period period)

Description copied from interface: Reporter

Registers a destination to receive resulting Measurements in a given period.

Specified by:

registerDestination in interface Reporter

Parameters:

destination - The Destination to which the results should be published

period - The period interval in which the destination should publish results

registerDestination

public final void registerDestination(Destination destination,
                                      Set<Period> periods)

Description copied from interface: Reporter

Registers a destination to receive resulting Measurements in given periods. It is the goal of Reporter to make sure the results are published to the registered destinations. For an easier development it is advised to extend AbstractReporter which already takes care of this. A destination cannot be registered with the same period type multiple times (i.e. one cannot register a destination with a period of iteration type that reports every 10 iterations, and with a period of iteration type that reports every 100 iterations at the same time).

Specified by:

registerDestination in interface Reporter

Parameters:

destination - The Destination to which the results should be published.

periods - The set of period intervals in which the destination should publish results.

unregisterDestination

public final void unregisterDestination(Destination destination)

Description copied from interface: Reporter

Removes a previously registered Destination. The method removes all occurrences of the destination should it be registered with multiple periods. A Reporter should close the Destination if it is still open.

Specified by:

unregisterDestination in interface Reporter

Parameters:

destination - The Destination to be unregistered (and stopped)

reset

public final void reset()

Description copied from interface: Reporter

Resets the reporter statistics to the initial state. This is mainly used for clean up after a warm-up period.

Specified by:

reset in interface Reporter

getDestinations

public final Set<Destination> getDestinations()

Description copied from interface: Reporter

Gets an unmodifiable set of all registered destinations.

Specified by:

getDestinations in interface Reporter

Returns:

An unmodifiable set of all currently registered destinations.

start

public void start()

Description copied from interface: Reporter

Starts the reporter. After a call to this method, reporter will report measurement results to the registered destinations. All destinations are started as well.

Specified by:

start in interface Reporter

stop

public void stop()

Description copied from interface: Reporter

Stops the reporter. After a call to this method, no more results will be reported to the destinatons. All destinations are stopped as well.

Specified by:

stop in interface Reporter

setRunInfo

public final void setRunInfo(RunInfo runInfo)

Description copied from interface: Reporter

Sets Run Info for the current measurement run. This must be set prior to starting the reporter. Failed to do so can lead to an assertion error.

Specified by:

setRunInfo in interface Reporter

Parameters:

runInfo - RunInfo for the current measurement run.

getReportingPeriods

public final Set<BoundPeriod<Destination>> getReportingPeriods()

Description copied from interface: Reporter

Gets an unmodifiable set of registered reporting periods.

Specified by:

getReportingPeriods in interface Reporter

Returns:

The unmodifiable set of registered reporting periods.