net.objectlab.qalab.exporter
Class QALabXMLExporter

java.lang.Object
  net.objectlab.qalab.exporter.QALabXMLExporter

All Implemented Interfaces:

QALabExporter

public class QALabXMLExporter
extends java.lang.Object
implements QALabExporter

This is the main exporter to an XML file following the QALab DTD.

Version:

$Revision$

Author:

Benoit Xhenseval

Constructor Summary

QALabXMLExporter()

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) For instance for the XML Exporter.
org.w3c.dom.Document	getDocument()
protected TaskLogger	getTaskLogger()
boolean	isQuiet()
void	save() Save the stats (called when the parsing of input statistics is completed).
void	setQuiet(boolean noLog) 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

QALabXMLExporter

public QALabXMLExporter()

Method Detail

configure

public final void configure(java.util.Properties properties)

For instance for the XML Exporter.

• qalab.outputfile = the output file name and path.
• qalab.merge.output.classname = alternatively, the XML could be a resource for this class
• qalab.merge.output.resourcename = the resource name for the qalab.merge.output.classname given
• qalab.merge.timestamp = the timestamp YYYY-MM-dd HH:mm:ss
• qalab.merge.type = the type of statistics being merged. (eg checkstyle,findbugs,simian, pmd)
• qalab.merge.action = the action to take in case of clash type/timetstamp

Specified by:

configure in interface QALabExporter

Parameters:

properties - the properties.

See Also:

QALabExporter#configure(java.util.Properties)

addSummary

public final void addSummary(int violationCount,
                             int fileCount)

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

Specified by:

addSummary in interface QALabExporter

Parameters:

violationCount - total number of violations for this type

fileCount - total number of files affected by this type.

addFileResult

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

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

Specified by:

addFileResult in interface QALabExporter

Parameters:

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

fileName - file name

See Also:

net.objectlab.qalab.interfaces.QALabExporter#addFileResult( java.util.Date, int, java.lang.String, java.lang.String)

save

public final void save()
                throws java.io.IOException

Save the stats (called when the parsing of input statistics is completed).

Specified by:

save in interface QALabExporter

Throws:

java.io.IOException - any IO issue.

See Also:

QALabExporter.save()

getTaskLogger

protected final TaskLogger getTaskLogger()

Returns:

logger to use if not quiet.

setTaskLogger

public final void setTaskLogger(TaskLogger task)

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

Specified by:

setTaskLogger in interface QALabExporter

Parameters:

task - the logger to use

isQuiet

public final boolean isQuiet()

Returns:

true means that no debug info is logged.

setQuiet

public final void setQuiet(boolean noLog)

Description copied from interface: QALabExporter

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

Specified by:

setQuiet in interface QALabExporter

Parameters:

noLog - true if no log required.

getDocument

public final org.w3c.dom.Document getDocument()

Returns:

the compiled document.