com.togethersoft.sca.core.plugin.report
Class ReportManager

java.lang.Object
  |
  +--com.togethersoft.sca.core.plugin.report.ReportManager

All Implemented Interfaces:

ICodeInspectorExecutable, IExtensionExecutable

public class ReportManager

extends java.lang.Object

implements ICodeInspectorExecutable

Manages report generation activities

Constructor Summary

ReportManager()

Method Summary

void	configureRegistry(IAnalyzerRegistry registry) Configures the analyzer registry.
IMessageFilter[]	filtersAvailable() Get all available message filters.
void	loadModules() load (connect to) all report activities related modules
IReporter[]	reportersAvailable() Get all available reporters.
void	run(IProject[] projects, java.io.File output, IReportMessage[] messages, JobControl jobControl)
void	run(IProject[] projects, IAnalyzerDescriptor[] analyzers, IReporter[] reportersSelected, IMessageFilter[] filtersSelected, java.io.File output, JobControl jobControl) Produce specified set of reports applying specified and required set of filters, after running the required set of analyzers
void	run(IProject project, IAnalyzerDescriptor[] analyzers, JobControl jobControl) Performs analysis of the project.
void	setParameters(IParameterRegistry registry) Sets the parameters of this extension.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportManager

public ReportManager()

Method Detail

configureRegistry

public void configureRegistry(IAnalyzerRegistry registry)

Description copied from interface: ICodeInspectorExecutable

Configures the analyzer registry.

Specified by:

configureRegistry in interface ICodeInspectorExecutable

filtersAvailable

public IMessageFilter[] filtersAvailable()

Get all available message filters. If there is no available message filters returns empty array

loadModules

public void loadModules()

load (connect to) all report activities related modules

reportersAvailable

public IReporter[] reportersAvailable()

Get all available reporters. If there is no available reporters returns empty array

run

public void run(IProject[] projects,
                java.io.File output,
                IReportMessage[] messages,
                JobControl jobControl)

run

public void run(IProject[] projects,
                IAnalyzerDescriptor[] analyzers,
                IReporter[] reportersSelected,
                IMessageFilter[] filtersSelected,
                java.io.File output,
                JobControl jobControl)

Produce specified set of reports applying specified and required set of filters, after running the required set of analyzers

Parameters:

projects - the projects to which the analyzis should be applied

reportersSelected - reporters which should be invoked to produce reports

filtersSelected - reporters which should be invoked to produce reports

output - the file to which the reports should be printed

run

public void run(IProject project,
                IAnalyzerDescriptor[] analyzers,
                JobControl jobControl)

Description copied from interface: ICodeInspectorExecutable

Performs analysis of the project.

The clients should not call this method directly. The framework will call it on behalf of (@link IStaticAnalyzer.run()}.

Specified by:

run in interface ICodeInspectorExecutable

Following copied from interface: com.togethersoft.sca.core.ICodeInspectorExecutable

Parameters:

project - the Java project to be inspected.

analyzers - specifies code anlyzers to run. This may be null for code inspectors that do not define code analyzers.

jobControl - a job control object.

setParameters

public void setParameters(IParameterRegistry registry)

Description copied from interface: IExtensionExecutable

Sets the parameters of this extension. This method is called when the extension object is created or when the parameter values are changed.

Specified by:

setParameters in interface IExtensionExecutable

Following copied from interface: com.togethersoft.sca.core.IExtensionExecutable

Returns:

registry the parameter registry that holds the parameters of this extension.