Package com.jcoverage.reporting

Provides classes for the reporting framework.

See:
          Description

Interface Summary
Closeable An object that can be closed, generally this means a formattable object.
Collator An object that collects pages and sends them to format object for formatting.
Format An object which knows how to format a report.
Line A line of information in a page of a report.
LineCategory Instances of this class are analogous to a database table, but not the same.
MultiViewCollator  
Page A page containing information at the same report level.
Report A full report, which may contain a great number of pages, and be formatted into many files.
Serializer An object that can construct Writers on behalf of report formatters.
View An object which has the capability to order lines.
 

Class Summary
AbstractCollator This class implements a simple Collator.
AbstractLine This class provides a skeletal implementation of a Line.
AbstractPage This class provides a skeletal implementation of a Page.
AbstractReport  
Column Instances of this class represent an information type.
DefaultLineCategory Default line category.
FileSerializer  
FormattingContext This class gives formats access to contextual information, such as the collator responsible for handling reports and the serializer to send the report output to.
ViewFormattingContext This class provides additional contextual information regarding views, and which of these views is currently being formatted.
 

Exception Summary
ReportingException A nestable exception supporting exception chaining.
 

Package com.jcoverage.reporting Description

Provides classes for the reporting framework.

The reporting framework is used to assist the process of generating reports. Reports are usually made up of multiple files, and the reporting framework can support a number of different back-ends: HTML, XML, PDF and SVG being prime examples.

The reporting framework is particularly suited to large reports that require a master-detail representation. Often data needs to be presented in such a way that summaries are available for high-level browsing, and that further details are accessible on demand. In HTML, this is typcially achieved by hyperlinking between master reports and their corresponding detail reports.

Reports are generated by formats, which are classes that take the information collated in an object graph provided by the reporting framework and output the content in the desired format. Each format takes responsibility for formatting the report into a file hierarchy.