com.sun.slamd.report
Interface ReportGenerator

All Known Implementing Classes:

HTMLReportGenerator, PDFReportGenerator, TextReportGenerator

public interface ReportGenerator

This class defines the set of methods that must be implemented by any class that provides a mechanism for generating reports of SLAMD data.

Method Summary

void	addJobReport(Job job) Indicates that information about the provided job should be included in the report.
void	addOptimizingJobReport(OptimizingJob optimizingJob) Indicates that information about the provided optimizing job should be included in the report.
void	generateReport(RequestInfo requestInfo) Generates the report and sends it to the user over the provided servlet response.
java.lang.String	getReportGeneratorName() Retrieves a user-friendly name that can be used to indicate the type of report that will be generated.
ParameterList	getReportParameterStubs() Retrieves a set of parameters that can be used to allow the user to configure the way that the report is generated.
void	initializeReporter(ParameterList reportParameters) Initializes this reporter based on the parameters customized by the end user.
ReportGenerator	newInstance() Retrieves a new instance of this report generator initialized with the default configuration.

Method Detail

getReportGeneratorName

public java.lang.String getReportGeneratorName()

Retrieves a user-friendly name that can be used to indicate the type of report that will be generated.

Returns:

The user-friendly name that can be used to indicate the type of report that will be generated.

newInstance

public ReportGenerator newInstance()

Retrieves a new instance of this report generator initialized with the default configuration.

Returns:

A new instance of this report generator initialized with the default configuration.

getReportParameterStubs

public ParameterList getReportParameterStubs()

Retrieves a set of parameters that can be used to allow the user to configure the way that the report is generated.

Returns:

A set of parameters that can be used to allow the user to configure the way that the report is generated.

initializeReporter

public void initializeReporter(ParameterList reportParameters)

Initializes this reporter based on the parameters customized by the end user.

Parameters:

reportParameters - The set of parameters provided by the end user that should be used to customize the report.

addJobReport

public void addJobReport(Job job)

Indicates that information about the provided job should be included in the report.

Parameters:

job - The job about which to include information in the report.

addOptimizingJobReport

public void addOptimizingJobReport(OptimizingJob optimizingJob)

Indicates that information about the provided optimizing job should be included in the report.

Parameters:

optimizingJob - The optimizing job about which to include information in the report.

generateReport

public void generateReport(RequestInfo requestInfo)

Generates the report and sends it to the user over the provided servlet response.

Parameters:

requestInfo - State information about the request being processed.