org.opencms.report
Class CmsHtmlReport

java.lang.Object
  extended byorg.opencms.report.A_CmsReport
      extended byorg.opencms.report.CmsHtmlReport
All Implemented Interfaces:
I_CmsReport

public class CmsHtmlReport
extends A_CmsReport

HTML report output to be used for import / export / publish operations in the entire OpenCms system.

Since:
6.0.0
Version:
$Revision: 1.33 $
Author:
Alexander Kandzior, Thomas Weckert, Jan Baudisch

Field Summary
 
Fields inherited from interface org.opencms.report.I_CmsReport
FORMAT_DEFAULT, FORMAT_ERROR, FORMAT_HEADLINE, FORMAT_NOTE, FORMAT_OK, FORMAT_WARNING, REPORT_TYPE_EXTENDED, REPORT_TYPE_SIMPLE
 
Constructor Summary
  CmsHtmlReport(java.util.Locale locale, java.lang.String siteRoot)
          Constructs a new report using the provided locale for the output language.
protected CmsHtmlReport(java.util.Locale locale, java.lang.String siteRoot, boolean writeHtml)
          Constructs a new report using the provided locale for the output language.
 
Method Summary
protected  java.lang.String getLineBreak()
          Returns the corrent linebreak notation depending on the output style of this report.
 java.lang.String getReportUpdate()
          Updates this report, this processes all new output added since the last call to this method.
 void print(java.lang.String value, int format)
          Prints a String to the report, using the indicated formatting.
 void println()
          Adds a line break to the report.
 void println(java.lang.Throwable t)
          Adds an Exception to the report, ensuring that the Exception content is processed to generate a valid output esp. for HTML pages.
 
Methods inherited from class org.opencms.report.A_CmsReport
addError, formatRuntime, getErrors, getLocale, getMessages, getRuntime, getSiteRoot, hasError, init, print, print, print, println, println, println, println, printMessageWithParam, printMessageWithParam, removeSiteRoot, resetRuntime
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CmsHtmlReport

public CmsHtmlReport(java.util.Locale locale,
                     java.lang.String siteRoot)
Constructs a new report using the provided locale for the output language.

Parameters:
locale - the locale to use for the output language
siteRoot - the site root of the user who started this report (may be null)

CmsHtmlReport

protected CmsHtmlReport(java.util.Locale locale,
                        java.lang.String siteRoot,
                        boolean writeHtml)
Constructs a new report using the provided locale for the output language.

Parameters:
locale - the locale to use for the output language
siteRoot - the site root of the user who started this report (may be null)
writeHtml - if true, this report should generate HTML instead of JavaScript output
Method Detail

getReportUpdate

public java.lang.String getReportUpdate()
Description copied from interface: I_CmsReport
Updates this report, this processes all new output added since the last call to this method.

This is only required in case the output is written to a HTML page, if the shell output is used, this will just return an empty String.

Returns:
new elements that have been added to the report and not yet processed.
See Also:
I_CmsReport.getReportUpdate()

print

public void print(java.lang.String value,
                  int format)
Description copied from class: A_CmsReport
Prints a String to the report, using the indicated formatting.

Use the contants starting with FORMAT from this interface to indicate which formatting to use.

Specified by:
print in class A_CmsReport
Parameters:
value - the message container to add
format - the formatting to use for the output
See Also:
A_CmsReport.print(java.lang.String, int)

println

public void println()
Description copied from interface: I_CmsReport
Adds a line break to the report.

See Also:
I_CmsReport.println()

println

public void println(java.lang.Throwable t)
Description copied from interface: I_CmsReport
Adds an Exception to the report, ensuring that the Exception content is processed to generate a valid output esp. for HTML pages.

The exception will be stored and the output will later be processed in a special way.

Parameters:
t - the exception to add
See Also:
I_CmsReport.println(java.lang.Throwable)

getLineBreak

protected java.lang.String getLineBreak()
Returns the corrent linebreak notation depending on the output style of this report.

Returns:
the corrent linebreak notation