uml4net.Reporting.project

Introduction

The uml4net.Reporting project contains multiple report generator that generate reports on the contents of a UML model. The following report generators are included:

• ModelInspector
• XlReportGenerator
• HtmlReportGenerator

ModelInspector

The purpose of this report is to provide an overview of the contents of a UML model. It is a simple text based report that supports code-generation activities. When generating code for a UML model it is good practice to create a set of expected classes that are hand-coded to determine best practices and design patterns for the generated code. When code-generation templates or helper classes are updated, the expected output (the expected classes and other kinds of code) should remain the same. By generating code for the variations in a model, a developer can be sure that all other code is generated properly as well and will function as expected.

The report includes the following information:

• The variation of value-types, reference-types and enumerations.
• An overview of the variation of used multiplicities.
• an overview of interesting classes. Interesting classes are those classes that should be used when writing unit tests for code generation. By writing tests for these classes all variations of types and multiplicities are covered. The report lists each class and property that does not contain any documentation

XlReportGenerator

The XlReportGenerator is used to generate an Excel report of a UML model. It is focussed around understanding the contents of a UML model and the provided documentation. The following Elements are inlcuded in the Excel report (each kind of Element on a dedicated sheet):

• Primitive Types
• Enumerations
• Other Data Types (other than Primitive Types and Enumerations)
• Classes and their properties
• Interfaces and their properties

HtmlReportGenerator

The HtmlReportGenerator is used to generate an HTML report of a UML model through which a reader can navigate. It is focussed around understanding the contents of a UML model and the provided documentation. The following Elements are inlcuded in the HTML report:

• Primitive Types
• Enumerations
• Other Data Types (other than Primitive Types and Enumerations)
• Classes and their properties
• Interfaces and their properties