net.objectlab.qalab.interfaces
Interface QALabExporter

All Known Implementing Classes:

ConsoleExporter, QALabXMLExporter

public interface QALabExporter

This is the interface for exporting the statistics from the input checkstyle, pmd, findbugs or simian; feel free to create your own to say a database or your specific XML.

Version:

$Revision$

Author:

Benoit Xhenseval

Method Summary

void	addFileResult(int violationCount, java.lang.String fileName) Add a result entry for a given file name and type.
void	addSummary(int violationCount, int fileCount) Add summary details for this merger of statistics for this type.
void	configure(java.util.Properties properties) Configure the exporter.
void	save() Save the results wherever required (depending on the Exporter).
void	setQuiet(boolean quiet) if quiet is true, the merger should limit its log output.
void	setTaskLogger(TaskLogger task) set the task logger, ie mechanism to log issues & debug info.

Method Detail

configure

void configure(java.util.Properties properties)

Configure the exporter. For instance for the XML Exporter.

• qalab.outputfile = the output file name and path.
• qalab.classname = alternatively, the XML could be a resource for this class
• qalab.resourcename = the resource name for the qalab.classname given

Parameters:

properties - the properties used to confirgure the exporter.

addSummary

void addSummary(int violationCount,
                int fileCount)

Add summary details for this merger of statistics for this type.

Parameters:

violationCount - total number of violations for this type

fileCount - total number of files affected by this type.

addFileResult

void addFileResult(int violationCount,
                   java.lang.String fileName)

Add a result entry for a given file name and type.

Parameters:

violationCount - total number of violations for this type and file.

fileName - file name simian, pmd)

save

void save()
          throws java.io.IOException

Save the results wherever required (depending on the Exporter).

Throws:

java.io.IOException - any IO issue.

setTaskLogger

void setTaskLogger(TaskLogger task)

set the task logger, ie mechanism to log issues & debug info.

Parameters:

task - the logger to use

setQuiet

void setQuiet(boolean quiet)

if quiet is true, the merger should limit its log output.

Parameters:

quiet - true to minimise logging.