Package org.opencms.report

Classes used to generate the OpenCms reports, which are displayed during publish, import, export etc.

The resource files needed for the localization are contained in the file org.opencms.workplace.workplace.properties.

Since:

6.0.0

Interface Summary

Interface	Description
I_CmsReport	This is the interface for the report classes which are used for the output during operations that run on a spearate Thread in OpenCms, like publish, import, export etc.
I_CmsReportThread	Identifies a class that can be used as a report thread .
I_CmsReportUpdateFormatter	Interface used to format report updates.

Class Summary

Class	Description
A_CmsReport	Base report class.
A_CmsReportThread	Provides a common Thread class for the reports.
CmsClassicJavascriptReportUpdateFormatter	Report update formatter for the Javascript-based report update format, which was used in the old workplace most of the time.
CmsHtmlReport	HTML report output to be used for import / export / publish operations in the entire OpenCms system.
CmsLogReport	Report class used for the logfile.
CmsMultiplexReport	Report proxy that multiplexes to all contained I_CmsReport instances.
CmsPrintStreamReport	Stream report where the output is streamed to the given print stream instance.
CmsReportUpdateItem	Represents a single report entry.
CmsShellLogReport	Report for shell which writes to LOG.
CmsShellReport	Report class used for the shell.
CmsStringBufferReport	Report class used to write the output of a report to a StringBuffer.
CmsVaadinHtmlReportUpdateFormatter	Report update formatter for the new Vaadin-based workplace.
CmsWorkplaceReport	Report class for displaying reports to the user in the workplace.
Messages	Convenience class to access the localized messages of this OpenCms package.

Enum Summary

Enum	Description
CmsReportFormatType	Enum representing report entry types.