net.objectlab.qalab.parser
Interface StatMerger

All Known Implementing Classes:

BaseStatMerge, CheckstyleOrPMDBaseMerge, CheckstyleStatMerge, CoberturaBranchStatMerge, CoberturaLineStatMerge, FindBugsStatMerge, PMDCPDStatMerge, PMDStatMerge, SimianStatMerge

public interface StatMerger

Interface defining the statistics mergers. There will be implementations for Checkstyle, PMD, FindBugs and Simian. Created by IntelliJ IDEA. User: xhensevalb Date: 17-Feb-2004 Time: 10:27:11

Version:

$Revision: 187 $

Author:

Benoit Xhenseval

Method Summary

int	getFileCount()
java.lang.String	getMergerTimeStamp() This may have been changed to "now".
int	getTotalStatistics()
java.lang.String	getType()
void	mergeStats(org.xml.sax.InputSource source, QALabExporter exporter) merge the stats from node to the combined stats document.
void	setMergerTimeStamp(java.lang.String timestamp, boolean timeStampAsDate) set the timestamp (optional) for the merged stats.
void	setQuiet(boolean quiet) if quiet is true, the merger should limit its log output.
void	setSrcDir(java.lang.String srcDir) Stipulates the source directory for the code.
void	setTaskLogger(TaskLogger task) set the task logger, ie mechanism to log issues & debug info.

Method Detail

setQuiet

void setQuiet(boolean quiet)

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

Parameters:

quiet - true to minimise logging.

setTaskLogger

void setTaskLogger(TaskLogger task)

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

Parameters:

task - the logger to use

setSrcDir

void setSrcDir(java.lang.String srcDir)

Stipulates the source directory for the code.

Parameters:

srcDir - the source directory.

getTotalStatistics

int getTotalStatistics()

Returns:

the total number of 'violations' detected.

getFileCount

int getFileCount()

Returns:

the number of files found.

mergeStats

void mergeStats(org.xml.sax.InputSource source,
                QALabExporter exporter)

merge the stats from node to the combined stats document.

Parameters:

source - the XML containing the new statistics.

exporter - the exporter to use for the compiled stats.

getType

java.lang.String getType()

Returns:

the statistics type handled by this merger.

setMergerTimeStamp

void setMergerTimeStamp(java.lang.String timestamp,
                        boolean timeStampAsDate)

set the timestamp (optional) for the merged stats.

Parameters:

timestamp - the time stamp in format YYYY-MM-dd HH:mm:ss

timeStampAsDate - The timeStampAsDateOnly to set.

getMergerTimeStamp

java.lang.String getMergerTimeStamp()

This may have been changed to "now".

Returns:

timestamp the time stamp in format YYYY-MM-dd HH:mm:ss