Breadcrumbs

Excel Generator

With the Excel Generator you can create Excel documents out of complex structured data.

The Excel Generator uses the HSSF and XSSF component of Apache POI.



icon_download_example.png

<your example path>\Libraries\ExcelGenerator.zip



Data Model of the Excel Generator

This adapter uses a template file (Excel 97-2003 or Excel 2007 format) to create an Excel document. The data are specified by a map. The key values are used to reference their corresponding Data structure.

excel_generator_data_model.png

Procedure for Using the Excel Generator

  1. The adapter uses jXLS for configuring and building the resulting Excel documents. Create an Excel template file containing your jXLS.

    excel_generator_jxls.png

    To get a deeper understanding of the syntax used in the XLS templates, refer to the jXLS documentation.

  2. Create the needed objects in an action script in your UML model and provide the data.

    excel_generator_action_script.PNG


  3. Call the Excel generator.

Building an Excel Document

excel_generator_relationships.png

generateExcel( filename : String, data : StringData[], templateFilename : String )

Parameter

Direction

Description

filename

in

The filename of the Excel output file.

data

in

The map holding the data to be written to the Excel file.

templateFilename

in

The filename of the Excel template file.

The creation of an Excel document then is as simple as shown in the activity diagram below. Action create data contains the action script.

excel_generator_activity_diagram.PNG

You can extract the javadoc folder from excelgenerator.jar to get additional information on the Java methods wrapped by this adapter.