org.squashtest.tm.service.internal.batchimport.testcase.excel

Class ExcelWorkbookParser

java.lang.Object

org.squashtest.tm.service.internal.batchimport.testcase.excel.ExcelWorkbookParser

public class ExcelWorkbookParser
extends Object

Parses an excel import workbook and creates instructions.

Usage :

 {
        @code
        ExcelWorkbookParser parser = ExcelWorkbookParser.createParser(xlsxFile);
        parser.parse().releaseResources();
        List<Instructions> instructions = parser.getInstructions();
 }
 

Author:

Gregory Fouquet

Method Summary

Methods

Modifier and Type	Method and Description
static ExcelWorkbookParser	createParser(File xls) Factory method which should be used to create a parser.
List<RequirementVersionInstruction>	getCoverageInstructions()
List<DatasetParamValueInstruction>	getDatasetInstructions()
List<DatasetParamValueInstruction>	getDatasetParamValuesInstructions()
List<ParameterInstruction>	getParameterInstructions()
List<RequirementLinkInstruction>	getRequirementLinkgsInstruction()
List<RequirementVersionInstruction>	getRequirementVersionInstructions()
List<TestCaseInstruction>	getTestCaseInstructions()
List<StepInstruction>	getTestStepInstructions()
boolean	isEmpty(org.apache.poi.ss.usermodel.Row row)
LogTrain	logUnknownHeaders()
ExcelWorkbookParser	parse() Parses the file and creates instructions accordingly.
ExcelWorkbookParser	releaseResources() Releases resources held by this parser.

Methods inherited from class java.lang.Object

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

Method Detail

logUnknownHeaders

public LogTrain logUnknownHeaders()

parse

public ExcelWorkbookParser parse()

Parses the file and creates instructions accordingly.

Returns:

this

releaseResources

public ExcelWorkbookParser releaseResources()

Releases resources held by this parser. The result of parsing is still available but the parse() method should no longer be called.

Returns:

this

getTestCaseInstructions

public List<TestCaseInstruction> getTestCaseInstructions()

getTestStepInstructions

public List<StepInstruction> getTestStepInstructions()

getParameterInstructions

public List<ParameterInstruction> getParameterInstructions()

getDatasetInstructions

public List<DatasetParamValueInstruction> getDatasetInstructions()

getDatasetParamValuesInstructions

public List<DatasetParamValueInstruction> getDatasetParamValuesInstructions()

getRequirementVersionInstructions

public List<RequirementVersionInstruction> getRequirementVersionInstructions()

getCoverageInstructions

public List<RequirementVersionInstruction> getCoverageInstructions()

getRequirementLinkgsInstruction

public List<RequirementLinkInstruction> getRequirementLinkgsInstruction()

isEmpty

public boolean isEmpty(org.apache.poi.ss.usermodel.Row row)

createParser

public static final ExcelWorkbookParser createParser(File xls)
                                              throws org.squashtest.tm.exception.SheetCorruptedException,
                                                     TemplateMismatchException

Factory method which should be used to create a parser.

Parameters:

xls -

Returns:

Throws:

org.squashtest.tm.exception.SheetCorruptedException - when the excel file is unreadable

TemplateMismatchException - when the workbook does not match the template in an unrecoverable way.