com.github.mkolisnyk.cucumber.reporting.interfaces

Class CucumberResultsCommon

java.lang.Object

com.github.mkolisnyk.cucumber.reporting.interfaces.CucumberResultsCommon

Direct Known Subclasses:

SimpleReport

public abstract class CucumberResultsCommon
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHART_HEIGHT
static int	CHART_THICKNESS
static int	CHART_WIDTH
private String	outputDirectory
private String	outputName
private String	pdfPageSize
private String[]	sourceFiles
private String	templatesLocation

Constructor Summary

Constructors

Constructor and Description
CucumberResultsCommon()
CucumberResultsCommon(ExtendedRuntimeOptions extendedOptions)

Method Summary

Modifier and Type	Method and Description
String	constructErrorMessage(CucumberReportError error, String suffix)
private void	convertSvgToPng(File svg, File png)
void	dumpOverviewStats(File outFile, CucumberFeatureResult[] results)
void	export(File htmlFile, String suffix, String[] formats, boolean isImageExportable)
private void	exportToImage(File htmlFile, String suffix, String format)
private void	exportToPDF(File htmlFile, String suffix)
private File	generateBackupFile(File htmlFile)
protected <T extends CommonDataBean> void	generateReportFromTemplate(File outFile, String templateName, T bean)
String	getOutputDirectory()
String	getOutputName()
String	getPdfPageSize()
abstract CucumberReportLink	getReportDocLink()
abstract CucumberReportTypes	getReportType()
String	getSourceFile()
String[]	getSourceFiles()
int[][]	getStatuses(CucumberFeatureResult[] results)
String	getTemplatesLocation()
boolean	isImageExportable()
CucumberFeatureResult[]	readFileContent(String sourceFileValue)
String	replaceSvgWithPng(File htmlFile)
void	setOutputDirectory(String outputDirectoryValue)
void	setOutputName(String outputNameValue)
void	setPdfPageSize(String pdfPageSizeValue)
void	setSourceFile(String sourceFileValue)
void	setSourceFiles(String[] sourceFilesValue)
void	setTemplatesLocation(String templatesLocationValue)
abstract void	validateParameters()

Methods inherited from class java.lang.Object

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

Field Detail

CHART_WIDTH

public static final int CHART_WIDTH

See Also:

Constant Field Values

CHART_HEIGHT

public static final int CHART_HEIGHT

See Also:

Constant Field Values

CHART_THICKNESS

public static final int CHART_THICKNESS

See Also:

Constant Field Values

sourceFiles

private String[] sourceFiles

outputDirectory

private String outputDirectory

outputName

private String outputName

pdfPageSize

private String pdfPageSize

templatesLocation

private String templatesLocation

Constructor Detail

CucumberResultsCommon

public CucumberResultsCommon()

CucumberResultsCommon

public CucumberResultsCommon(ExtendedRuntimeOptions extendedOptions)

Method Detail

getReportType

public abstract CucumberReportTypes getReportType()

getReportDocLink

public abstract CucumberReportLink getReportDocLink()

validateParameters

public abstract void validateParameters()

constructErrorMessage

public String constructErrorMessage(CucumberReportError error,
                                    String suffix)

getOutputDirectory

public final String getOutputDirectory()

Returns:

the outputDirectory

setOutputDirectory

public final void setOutputDirectory(String outputDirectoryValue)

Parameters:

outputDirectoryValue - the outputDirectory to set

getOutputName

public final String getOutputName()

Returns:

the outputName

setOutputName

public final void setOutputName(String outputNameValue)

Parameters:

outputNameValue - the outputName to set

getSourceFile

public final String getSourceFile()

Returns:

the sourceFile

setSourceFile

public final void setSourceFile(String sourceFileValue)

Parameters:

sourceFileValue - the sourceFile to set

getSourceFiles

public String[] getSourceFiles()

setSourceFiles

public void setSourceFiles(String[] sourceFilesValue)

getPdfPageSize

public String getPdfPageSize()

setPdfPageSize

public void setPdfPageSize(String pdfPageSizeValue)

isImageExportable

public boolean isImageExportable()

getTemplatesLocation

public String getTemplatesLocation()

setTemplatesLocation

public void setTemplatesLocation(String templatesLocationValue)

readFileContent

public CucumberFeatureResult[] readFileContent(String sourceFileValue)
                                        throws Exception

Throws:

Exception

dumpOverviewStats

public void dumpOverviewStats(File outFile,
                              CucumberFeatureResult[] results)
                       throws IOException

Throws:

IOException

convertSvgToPng

private void convertSvgToPng(File svg,
                             File png)
                      throws Exception

Throws:

Exception

replaceSvgWithPng

public String replaceSvgWithPng(File htmlFile)
                         throws Exception

Throws:

Exception

generateReportFromTemplate

protected <T extends CommonDataBean> void generateReportFromTemplate(File outFile,
                                                                     String templateName,
                                                                     T bean)
                                                              throws Exception

Throws:

Exception

generateBackupFile

private File generateBackupFile(File htmlFile)
                         throws Exception

Throws:

Exception

exportToPDF

private void exportToPDF(File htmlFile,
                         String suffix)
                  throws Exception

Throws:

Exception

exportToImage

private void exportToImage(File htmlFile,
                           String suffix,
                           String format)
                    throws Exception

Throws:

Exception

export

public void export(File htmlFile,
                   String suffix,
                   String[] formats,
                   boolean isImageExportable)
            throws Exception

Throws:

Exception

getStatuses

public int[][] getStatuses(CucumberFeatureResult[] results)