Package org.opencms.report
Class CmsWorkplaceReport
- java.lang.Object
-
- org.opencms.report.A_CmsReport
-
- org.opencms.report.CmsWorkplaceReport
-
- All Implemented Interfaces:
I_CmsReport
public class CmsWorkplaceReport extends A_CmsReport
Report class for displaying reports to the user in the workplace.The difference to the older CmsHtmlReport class is that this can be used from both the old and the new Vaadin-based workplace, without having to decide when the report is created. Instead, the 'client' requesting report updates has to pass in a report update formatter instance, which is then used to format the report update for each case.
-
-
Field Summary
Fields Modifier and Type Field Description static int
FORMAT_NEWLINE
Format constant for newlines.-
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
Constructors Constructor Description CmsWorkplaceReport(java.util.Locale locale, java.lang.String siteRoot, boolean isTransient, java.lang.Object logChannel)
Constructs a new report using the provided locale for the output language.CmsWorkplaceReport(java.util.Locale locale, java.lang.String siteRoot, java.lang.Object logChannel)
Constructs a new report using the provided locale for the output language.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getReportUpdate()
Updates this report, this processes all new output added since the last call to this method.java.lang.String
getReportUpdate(I_CmsReportUpdateFormatter formatter)
Fetches the report update for this report since the last time this method was called.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.void
rewind()
Rewinds the report update to the start of the report.-
Methods inherited from class org.opencms.report.A_CmsReport
addError, addWarning, formatRuntime, getErrors, getLastEntryTime, getLocale, getMessages, getRuntime, getSiteRoot, getWarnings, hasError, hasWarning, init, print, print, print, println, println, println, println, printMessageWithParam, printMessageWithParam, removeSiteRoot, resetRuntime, setLastEntryTime
-
-
-
-
Field Detail
-
FORMAT_NEWLINE
public static final int FORMAT_NEWLINE
Format constant for newlines.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsWorkplaceReport
public CmsWorkplaceReport(java.util.Locale locale, java.lang.String siteRoot, boolean isTransient, java.lang.Object logChannel)
Constructs a new report using the provided locale for the output language.- Parameters:
locale
- the locale to use for the output languagesiteRoot
- the site root of the user who started this report (may benull
)isTransient
- If set totrue
nothing is kept in memorylogChannel
- the log channel to send the report output to (or null if this shouldn't be done)
-
CmsWorkplaceReport
public CmsWorkplaceReport(java.util.Locale locale, java.lang.String siteRoot, java.lang.Object logChannel)
Constructs a new report using the provided locale for the output language.- Parameters:
locale
- the locale to use for the output languagesiteRoot
- the site root of the user who started this report (may benull
)logChannel
- the log channel to send the report output to (or null if this shouldn't be done)
-
-
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()
-
getReportUpdate
public java.lang.String getReportUpdate(I_CmsReportUpdateFormatter formatter)
Description copied from interface:I_CmsReport
Fetches the report update for this report since the last time this method was called.- Specified by:
getReportUpdate
in interfaceI_CmsReport
- Overrides:
getReportUpdate
in classA_CmsReport
- Parameters:
formatter
- the formatter to use for formatting the report output- Returns:
- the output for report elements that have been added to the report and not yet processed
- See Also:
A_CmsReport.getReportUpdate(org.opencms.report.I_CmsReportUpdateFormatter)
-
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 constants starting with
FORMAT
from this interface to indicate which formatting to use.- Specified by:
print
in classA_CmsReport
- Parameters:
value
- the message container to addformat
- 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)
-
rewind
public void rewind()
Rewinds the report update to the start of the report.
-
-