com.togethersoft.sca.core.plugin.report
Interface IReporter

public interface IReporter

Interface for report generator

Method Summary

java.lang.String[]	analyzersRequired() get array of names of analyzers required to produce input for this report generator
java.lang.String	description() get the description of the report generation module
IMessageFilter[]	filtersRequired() get array of filters required for this report generator to run correctly
void	generate(java.io.File dir, java.io.PrintStream out, MessageList in, java.lang.String theProjectName, JobControl jobControl) convert the message list to "text form".
IParameterRegistry	getParameterRegistry() Returns the parameter registry that holds the parameters of this extension.
java.lang.String	name() get the name of the report generation module

Method Detail

analyzersRequired

public java.lang.String[] analyzersRequired()

get array of names of analyzers required to produce input for this report generator

description

public java.lang.String description()

get the description of the report generation module

filtersRequired

public IMessageFilter[] filtersRequired()

get array of filters required for this report generator to run correctly

generate

public void generate(java.io.File dir,
                     java.io.PrintStream out,
                     MessageList in,
                     java.lang.String theProjectName,
                     JobControl jobControl)

convert the message list to "text form". In current system we assume that the output is in HTML or XML

Parameters:

dir - the directory in which additional report files must be stored

out - the stream where to print the text representation

in - the message list to be printed

the - name of the project being processed

getParameterRegistry

public IParameterRegistry getParameterRegistry()

Returns the parameter registry that holds the parameters of this extension. Returns an empty registry, if no parameters are provided.

Returns:

the parameter registry of this extension.

name

public java.lang.String name()

get the name of the report generation module