net.paissad.tools.reqcoco.core.report

Class ReqReportBuilderHtml

java.lang.Object

net.paissad.tools.reqcoco.core.report.AbstractReqReportBuilder

net.paissad.tools.reqcoco.core.report.ReqReportBuilderHtml

All Implemented Interfaces:

ReqReportBuilder

public class ReqReportBuilderHtml
extends AbstractReqReportBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static String	HTML_REPORT_FILE_DEFAULT_EXTENSION The default extension for the HTML report builder.

Fields inherited from class net.paissad.tools.reqcoco.core.report.AbstractReqReportBuilder

DEFAULT_REPORT_FILENAME_WITHOUT_EXTENSION

Constructor Summary

Constructors

Constructor and Description
ReqReportBuilderHtml(Path reportOutputDirPath)
ReqReportBuilderHtml(Path reportOutputDirPath, String reportFilename)

Method Summary

Modifier and Type	Method and Description
void	configure(Collection<Requirement> requirements, ReqReportConfig config)
protected String	getDefaultFileReporttExtension()
void	run()

Methods inherited from class net.paissad.tools.reqcoco.core.report.AbstractReqReportBuilder

getCodeDoneCount, getCodeDoneCount, getCodeDoneRatio, getCodeDoneRatio, getCodeUndoneCount, getCodeUndoneCount, getDefaultReportConfig, getDefaultReportFilename, getIgnoredRequirementsCount, getIgnoredRequirementsCount, getRequirementByVersion, getTestDoneRatio, getTestDoneRatio, getTestsDoneCount, getTestsDoneCount, getTestsUndoneCount, getTestsUndoneCount

Methods inherited from class java.lang.Object

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

Field Detail

HTML_REPORT_FILE_DEFAULT_EXTENSION

public static final String HTML_REPORT_FILE_DEFAULT_EXTENSION

The default extension for the HTML report builder.

See Also:

Constant Field Values

Constructor Detail

ReqReportBuilderHtml

public ReqReportBuilderHtml(Path reportOutputDirPath)

Parameters:

reportOutputDirPath - - The directory where to generate the report.

See Also:

ReqReportBuilderHtml(Path, String)

ReqReportBuilderHtml

public ReqReportBuilderHtml(Path reportOutputDirPath,
                            String reportFilename)

Parameters:

reportOutputDirPath - - The directory where to generate the report.

reportFilename - - The name of the output HTML output file to generate. If null or blank, the default name will be used.

Method Detail

configure

public void configure(Collection<Requirement> requirements,
                      ReqReportConfig config)
               throws ReqReportBuilderException

Specified by:

configure in interface ReqReportBuilder

Overrides:

configure in class AbstractReqReportBuilder

Throws:

ReqReportBuilderException

run

public void run()
         throws ReqReportBuilderException

Throws:

ReqReportBuilderException

getDefaultFileReporttExtension

protected String getDefaultFileReporttExtension()

Specified by:

getDefaultFileReporttExtension in class AbstractReqReportBuilder

Returns:

The default expected extension to use for the report filename if needed.