net.paissad.tools.reqcoco.core.report

Class AbstractReqReportBuilder

java.lang.Object

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

All Implemented Interfaces:

ReqReportBuilder

Direct Known Subclasses:

ReqReportBuilderConsole, ReqReportBuilderExcel, ReqReportBuilderHtml, ReqReportBuilderJson

public abstract class AbstractReqReportBuilder
extends Object
implements ReqReportBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_REPORT_FILENAME_WITHOUT_EXTENSION The default name of the file containing the report, without the extension.

Constructor Summary

Constructors

Constructor and Description
AbstractReqReportBuilder()

Method Summary

Modifier and Type	Method and Description
protected Collection<ReqReport>	buildReqReports()
void	configure(Collection<Requirement> requirements, ReqReportConfig config)
protected long	getCodeDoneCount()
protected long	getCodeDoneCount(String version)
protected Float	getCodeDoneRatio()
protected Float	getCodeDoneRatio(String version)
protected long	getCodeUndoneCount()
protected long	getCodeUndoneCount(String version)
protected abstract String	getDefaultFileReportExtension()
protected ReqReportConfig	getDefaultReportConfig()
protected String	getDefaultReportFilename()
protected long	getIgnoredRequirementsCount()
protected long	getIgnoredRequirementsCount(String version)
protected Collection<Requirement>	getRequirementByVersion(String version)
protected float	getRequirementsIgnoredRatio(String version)
protected Float	getTestDoneRatio()
protected Float	getTestDoneRatio(String version)
protected long	getTestsDoneCount()
protected long	getTestsDoneCount(String version)
protected long	getTestsUndoneCount()
protected long	getTestsUndoneCount(String version)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.paissad.tools.reqcoco.api.report.ReqReportBuilder

run

Field Detail

DEFAULT_REPORT_FILENAME_WITHOUT_EXTENSION

public static final String DEFAULT_REPORT_FILENAME_WITHOUT_EXTENSION

The default name of the file containing the report, without the extension.

See Also:

Constant Field Values

Constructor Detail

AbstractReqReportBuilder

public AbstractReqReportBuilder()

Method Detail

configure

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

Specified by:

configure in interface ReqReportBuilder

Throws:

ReqReportBuilderException

getCodeDoneCount

protected long getCodeDoneCount()

Returns:

The number of code marked as done for any version.

getCodeUndoneCount

protected long getCodeUndoneCount()

Returns:

The number of requirements for which the code is not done yet.

getCodeDoneCount

protected long getCodeDoneCount(String version)

Parameters:

version - - The version to use for filtering.

Returns:

The number of code marked as done for the specified version.

getCodeUndoneCount

protected long getCodeUndoneCount(String version)

Parameters:

version - - The version to use for filtering.

Returns:

The number of requirements for which the code is not done yet.

getCodeDoneRatio

protected Float getCodeDoneRatio()

Returns:

The ratio of requirements for which the codes are marked as done !

getCodeDoneRatio

protected Float getCodeDoneRatio(String version)

Parameters:

version - : The version to use for filtering

Returns:

The ratio of requirements for which the codes are marked as done !

getTestsDoneCount

protected long getTestsDoneCount()

Returns:

The number of tests marked as done for any version

getTestsUndoneCount

protected long getTestsUndoneCount()

Returns:

The number of tests marked as done for any version

getTestsDoneCount

protected long getTestsDoneCount(String version)

Parameters:

version - - The version to use for filtering.

Returns:

The number of tests marked as done for the specified version.

getTestsUndoneCount

protected long getTestsUndoneCount(String version)

Parameters:

version - - The version to use for filtering.

Returns:

The number of tests marked as done for the specified version.

getTestDoneRatio

protected Float getTestDoneRatio()

Returns:

The ratio of requirements for which the tests are marked as done !

getTestDoneRatio

protected Float getTestDoneRatio(String version)

Parameters:

version - : The version to use for filtering

Returns:

The ratio of requirements for which the tests are marked as done !

getIgnoredRequirementsCount

protected long getIgnoredRequirementsCount()

Returns:

The number of declared/input requirements which are marked as to be ignored for the coverage report.

getIgnoredRequirementsCount

protected long getIgnoredRequirementsCount(String version)

Parameters:

version - - The version to use for filtering.

Returns:

The number of declared/input requirements which are marked as to be ignored for the coverage report.

getRequirementByVersion

protected Collection<Requirement> getRequirementByVersion(String version)

getDefaultReportConfig

protected ReqReportConfig getDefaultReportConfig()

getRequirementsIgnoredRatio

protected float getRequirementsIgnoredRatio(String version)

buildReqReports

protected Collection<ReqReport> buildReqReports()

getDefaultReportFilename

protected String getDefaultReportFilename()

Returns:

The default name of the file containing the report WITH the extension.

See Also:

DEFAULT_REPORT_FILENAME_WITHOUT_EXTENSION, getDefaultFileReportExtension()

getDefaultFileReportExtension

protected abstract String getDefaultFileReportExtension()

Returns:

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