com.asakusafw.testdata.generator.excel

Class WorkbookGenerator

java.lang.Object

com.asakusafw.testdata.generator.excel.WorkbookGenerator

All Implemented Interfaces:

TemplateGenerator

public class WorkbookGenerator
extends Object
implements TemplateGenerator

Generates Excel workbooks for testing each data model.

Since:

0.2.0

Version:

0.5.3

Constructor Summary

Constructors

Constructor and Description
WorkbookGenerator(File output, WorkbookFormat format) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
static org.apache.poi.ss.usermodel.Workbook	createEmptyWorkbook(org.apache.poi.ss.SpreadsheetVersion version) Creates a new empty workbook for the target version.
void	generate(ModelDeclaration model) Generates a workbook for the specified model.
static org.apache.poi.ss.SpreadsheetVersion	getSpreadsheetVersion(String fileName) Returns spreadsheet version for the target workbook.
static org.apache.poi.ss.SpreadsheetVersion	getSpreadsheetVersion(org.apache.poi.ss.usermodel.Workbook workbook) Returns spreadsheet version for the target workbook.
String	getTitle() Returns the title of this generator.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkbookGenerator

public WorkbookGenerator(File output,
                         WorkbookFormat format)

Creates a new instance.

Parameters:

output - output directory

format - workbook format to be generated

Throws:

IllegalArgumentException - if some parameters were null

Method Detail

generate

public void generate(ModelDeclaration model)
              throws IOException

Generates a workbook for the specified model.

Specified by:

generate in interface TemplateGenerator

Parameters:

model - the target model

Throws:

IOException - if failed to generate a workbook

IllegalArgumentException - if some parameters were null

getSpreadsheetVersion

public static org.apache.poi.ss.SpreadsheetVersion getSpreadsheetVersion(String fileName)

Returns spreadsheet version for the target workbook.

Parameters:

fileName - the target workbook path

Returns:

the target version

Since:

0.7.0

getSpreadsheetVersion

public static org.apache.poi.ss.SpreadsheetVersion getSpreadsheetVersion(org.apache.poi.ss.usermodel.Workbook workbook)

Returns spreadsheet version for the target workbook.

Parameters:

workbook - the target workbook

Returns:

the target version

Since:

0.7.0

createEmptyWorkbook

public static org.apache.poi.ss.usermodel.Workbook createEmptyWorkbook(org.apache.poi.ss.SpreadsheetVersion version)
                                                                throws IOException

Creates a new empty workbook for the target version.

Parameters:

version - the target version

Returns:

the created workbook

Throws:

IOException - if failed to create the workbook

Since:

0.5.3

getTitle

public String getTitle()

Description copied from interface: TemplateGenerator

Returns the title of this generator.

Specified by:

getTitle in interface TemplateGenerator

Returns:

the title