com.sun.slamd.report
Class TextReportGenerator

java.lang.Object
  com.sun.slamd.report.TextReportGenerator

All Implemented Interfaces:

ReportGenerator

public class TextReportGenerator

extends java.lang.Object

implements ReportGenerator

This class provides an implementation of a SLAMD report generator that will write the report information to a plain text file.

Field Summary

static java.lang.String	EOL The end-of-line string that will be used.
static java.lang.String	PARAM_INCLUDE_DETAILED_STATISTICS The name of the configuration parameter that indicates whether to include detailed statistical information in the report.
static java.lang.String	PARAM_INCLUDE_JOB_CONFIG The name of the configuration parameter that indicates whether to include the job-specific configuration in the report.
static java.lang.String	PARAM_INCLUDE_MONITOR_STATS The name of the configuration parameter that indicates whether to include resource monitor statistics in the report.
static java.lang.String	PARAM_INCLUDE_SCHEDULE_CONFIG The name of the configuration parameter that indicates whether to include the schedule configuration in the report.
static java.lang.String	PARAM_INCLUDE_STATS The name of the configuration parameter that indicates whether to include job statistics in the report.
static java.lang.String	PARAM_REQUIRE_STATS The name of the configuration parameter that indicates whether to only include jobs that contain statistics in the generated report.
static java.lang.String	PARAM_SUMMARIZE_OPTIMIZING_ITERATIONS The name of the configuration parameter that indicates whether to summarize the individual iterations of an optimizing job.

Constructor Summary

TextReportGenerator()
Creates a new text report generator.

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.

Methods inherited from class java.lang.Object

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

Field Detail

EOL

public static final java.lang.String EOL

The end-of-line string that will be used.

PARAM_INCLUDE_DETAILED_STATISTICS

public static final java.lang.String PARAM_INCLUDE_DETAILED_STATISTICS

The name of the configuration parameter that indicates whether to include detailed statistical information in the report.

See Also:

Constant Field Values

PARAM_INCLUDE_MONITOR_STATS

public static final java.lang.String PARAM_INCLUDE_MONITOR_STATS

The name of the configuration parameter that indicates whether to include resource monitor statistics in the report.

See Also:

Constant Field Values

PARAM_INCLUDE_JOB_CONFIG

public static final java.lang.String PARAM_INCLUDE_JOB_CONFIG

The name of the configuration parameter that indicates whether to include the job-specific configuration in the report.

See Also:

Constant Field Values

PARAM_INCLUDE_SCHEDULE_CONFIG

public static final java.lang.String PARAM_INCLUDE_SCHEDULE_CONFIG

The name of the configuration parameter that indicates whether to include the schedule configuration in the report.

See Also:

Constant Field Values

PARAM_INCLUDE_STATS

public static final java.lang.String PARAM_INCLUDE_STATS

The name of the configuration parameter that indicates whether to include job statistics in the report.

See Also:

Constant Field Values

PARAM_REQUIRE_STATS

public static final java.lang.String PARAM_REQUIRE_STATS

The name of the configuration parameter that indicates whether to only include jobs that contain statistics in the generated report.

See Also:

Constant Field Values

PARAM_SUMMARIZE_OPTIMIZING_ITERATIONS

public static final java.lang.String PARAM_SUMMARIZE_OPTIMIZING_ITERATIONS

The name of the configuration parameter that indicates whether to summarize the individual iterations of an optimizing job.

See Also:

Constant Field Values

Constructor Detail

TextReportGenerator

public TextReportGenerator()

Creates a new text report generator.

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.

Specified by:

getReportGeneratorName in interface ReportGenerator

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.

Specified by:

newInstance in interface ReportGenerator

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.

Specified by:

getReportParameterStubs in interface ReportGenerator

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.

Specified by:

initializeReporter in interface ReportGenerator

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.

Specified by:

addJobReport in interface ReportGenerator

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.

Specified by:

addOptimizingJobReport in interface ReportGenerator

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.

Specified by:

generateReport in interface ReportGenerator

Parameters:

requestInfo - State information about the request being processed.