org.opencms.report
Interface I_CmsReport

All Known Implementing Classes:
A_CmsReport

public interface 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.

Since:
6.0.0
Version:
$Revision: 1.31 $
Author:
Alexander Kandzior, Jan Baudisch, Peter Bonrad

Field Summary
static int FORMAT_DEFAULT
          Indicates default formatting.
static int FORMAT_ERROR
          Indicates error formatting.
static int FORMAT_HEADLINE
          Indicates headline formatting.
static int FORMAT_NOTE
          Indicates note formatting.
static int FORMAT_OK
          Indicates OK formatting.
static int FORMAT_WARNING
          Indicates warning formatting.
static java.lang.String REPORT_TYPE_EXTENDED
          Request parameter value that this report should create an "extended" output.
static java.lang.String REPORT_TYPE_SIMPLE
          Request parameter value that this report should create a "simple" output.
 
Method Summary
 void addError(java.lang.Object obj)
          Adds an error object to the list of errors that occured during the report.
 void addWarning(java.lang.Object obj)
          Adds a warning object to the list of warnings that occured during the report.
 java.lang.String formatRuntime()
          Formats the runtime formatted as "hh:mm:ss".
 java.util.List getErrors()
          Returns a list of all errors that occured during the report.
 java.util.Locale getLocale()
          Returns the locale this report was initialized with.
 java.lang.String getReportUpdate()
          Updates this report, this processes all new output added since the last call to this method.
 long getRuntime()
          Returns the time this report has been running.
 java.lang.String getSiteRoot()
          Returns the original site root of the user who started this report, or null if the original site root has not been set.
 java.util.List getWarnings()
          Returns a list of all warnings that occured during the report.
 boolean hasError()
          Returns if the report generated an error output.
 boolean hasWarning()
          Returns if the report generated a warning output.
 void print(CmsMessageContainer container)
          Prints a localized message to the report.
 void print(CmsMessageContainer container, int format)
          Prints a localized message to the report, using the indicated formatting.
 void println()
          Adds a line break to the report.
 void println(CmsMessageContainer container)
          Prints a localized message to the report.
 void println(CmsMessageContainer container, int format)
          Prints a localized message to the report, using the indicated formatting.
 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.
 void printMessageWithParam(CmsMessageContainer container, java.lang.Object param)
          Prints a localized message followed by a parametera and dots to the report.
 void printMessageWithParam(int m, int n, CmsMessageContainer container, java.lang.Object param)
          Convenience method to print a localized message, followed by a parameter and dots to the report.
 java.lang.String removeSiteRoot(java.lang.String resourcename)
          Removes the report site root prefix from the absolute path in the resource name, that is adjusts the resource name for the report site root.
 void resetRuntime()
          Resets the runtime to 0 milliseconds.
 

Field Detail

FORMAT_DEFAULT

public static final int FORMAT_DEFAULT
Indicates default formatting.

See Also:
Constant Field Values

FORMAT_ERROR

public static final int FORMAT_ERROR
Indicates error formatting.

See Also:
Constant Field Values

FORMAT_HEADLINE

public static final int FORMAT_HEADLINE
Indicates headline formatting.

See Also:
Constant Field Values

FORMAT_NOTE

public static final int FORMAT_NOTE
Indicates note formatting.

See Also:
Constant Field Values

FORMAT_OK

public static final int FORMAT_OK
Indicates OK formatting.

See Also:
Constant Field Values

FORMAT_WARNING

public static final int FORMAT_WARNING
Indicates warning formatting.

See Also:
Constant Field Values

REPORT_TYPE_EXTENDED

public static final java.lang.String REPORT_TYPE_EXTENDED
Request parameter value that this report should create an "extended" output.

See Also:
Constant Field Values

REPORT_TYPE_SIMPLE

public static final java.lang.String REPORT_TYPE_SIMPLE
Request parameter value that this report should create a "simple" output.

See Also:
Constant Field Values
Method Detail

addError

public void addError(java.lang.Object obj)
Adds an error object to the list of errors that occured during the report.

Parameters:
obj - the error object

addWarning

public void addWarning(java.lang.Object obj)
Adds a warning object to the list of warnings that occured during the report.

Parameters:
obj - the error object

formatRuntime

public java.lang.String formatRuntime()
Formats the runtime formatted as "hh:mm:ss".

Returns:
the runtime formatted as "hh:mm:ss"

getErrors

public java.util.List getErrors()
Returns a list of all errors that occured during the report.

Returns:
an error list that occured during the report

getLocale

public java.util.Locale getLocale()
Returns the locale this report was initialized with.

Returns:
the locale this report was initialized with

getReportUpdate

public java.lang.String getReportUpdate()
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.

getRuntime

public long getRuntime()
Returns the time this report has been running.

Returns:
the time this report has been running

getSiteRoot

public java.lang.String getSiteRoot()
Returns the original site root of the user who started this report, or null if the original site root has not been set.

Returns:
the original site root of the user who started this report

getWarnings

public java.util.List getWarnings()
Returns a list of all warnings that occured during the report.

Returns:
a warning list that occured during the report

hasError

public boolean hasError()
Returns if the report generated an error output.

Returns:
true if the report generated an error, otherwise false

hasWarning

public boolean hasWarning()
Returns if the report generated a warning output.

Returns:
true if the report generated a warning, otherwise false

print

public void print(CmsMessageContainer container)
Prints a localized message to the report.

Parameters:
container - the String to add

print

public void print(CmsMessageContainer container,
                  int format)
Prints a localized message to the report, using the indicated formatting.

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

Parameters:
container - the String to add
format - the formatting to use for the output

println

public void println()
Adds a line break to the report.


println

public void println(CmsMessageContainer container)
Prints a localized message to the report.

Parameters:
container - the message container to add

println

public void println(CmsMessageContainer container,
                    int format)
Prints a localized message to the report, using the indicated formatting.

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

Parameters:
container - the message container to add
format - the formatting to use for the output

println

public 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.

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

Parameters:
t - the exception to add

printMessageWithParam

public void printMessageWithParam(CmsMessageContainer container,
                                  java.lang.Object param)
Prints a localized message followed by a parametera and dots to the report.

Parameters:
container - the Message to add
param - the Parameter to add

printMessageWithParam

public void printMessageWithParam(int m,
                                  int n,
                                  CmsMessageContainer container,
                                  java.lang.Object param)
Convenience method to print a localized message, followed by a parameter and dots to the report.

The output follows the pattern: ( 3 / 8 ) Deleting filename.txt ...

Parameters:
m - the number of the report output
n - the total number of report outputs
container - the Message to add
param - the Parameter to add

removeSiteRoot

public java.lang.String removeSiteRoot(java.lang.String resourcename)
Removes the report site root prefix from the absolute path in the resource name, that is adjusts the resource name for the report site root.

If the site root for this report has not been set, or the resource name does not start with the report site root, the name it is left untouched.

Parameters:
resourcename - the resource name (full path)
Returns:
the resource name adjusted for the report site root
See Also:
CmsRequestContext.removeSiteRoot(String)

resetRuntime

public void resetRuntime()
Resets the runtime to 0 milliseconds.